Detailed EDI User Stories

Module: GCX112 1 Consolidated Epic Story

Epic: GCX112 Complete EDI Specification Extracted from Legacy

Contains 271 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX112 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize EDI Segments M10, P4, M15]
The train processing routine begins → The system initializes M10, P4, M15, and M7A segments with their respective identifiers
[Initialize Notification Message]
The system needs to create a notification message → The GCX105 input message structure must be initialized and the security byte set to high values
[Initialize Email Message Structure]
The email configuration retrieval process starts → The system initializes email message structure, sets function code to 'GU', clears all table key values and flags, and sets EOF flag to FALSE
[Initialize Email Message Structure]
The system begins email setup → The email message structure and return status flag are initialized to empty values
[Initialize Text Message Lines]
The email message content area is being prepared → Text message lines are initialized to spaces
[Initialize Email Message Structure]
The email message structure is being prepared → All message fields are cleared, copy user codes are set to spaces, keywords are cleared, and item width is set to 132 characters
[Initialize Email Message Structure]
The email configuration process starts → The email message structure is initialized and the email found flag is reset
[Initialize EDI Segments M10, P4, M15]
The system begins train data mapping → M10 segment is initialized with identifier 'M10', P4 segment is initialized with identifier 'P4', and M15 segment is initialized with identifier 'M15'
[Initialize M10, P4, M15 Segments]
The system begins mapping cargo data to EDI format → M10, P4, and M15 segments are initialized with their respective identifiers
[Initialize Message Security]
The system sets security parameters for the transmission → The security byte should be set to HIGH-VALUES to authorize the transmission
[Initialize Transmission Segment]
The transmission creation process begins → The transmission segment is initialized with empty values

Core Acceptance Criteria

[Handle Train Arrival Action]
The train is not configured to send EDI or deletion is not required → The system creates arrival transaction, calls arrival routine, sets arrived flag to 'A', and updates train record
[Handle Train Delete Action]
The train is not configured to send EDI and deletion is required → The system creates deletion transaction, sets deleted flag to true, sets deleted-confirm flag to true, and clears secondary index
[Map Train Data to EDI]
Train data is mapped to M10, P4, and M15 segments → The system applies country code logic (US for export trains ending in 'T' with valid ports, MX for station '2304', CA as default), sets application type '28' for US export trains, and populates vessel name, dates, and location information
[Map Cargo Data to EDI]
Cargo data is mapped to M10, P4, and M15 segments → The system applies notification qualifier logic based on action codes (arrival, export, transfer, etc.), determines bond vs equipment processing, handles car ID formatting, and populates reference numbers and location data
[Create EDI Transmission Records]
Transmission records are created → The system creates transmission root with unique number and '353' transaction set, then creates dependent segments for M10, P4, and M15 data with sequence numbers
[Update US Train Data]
Train record update is performed → The system updates the train record with new status flags, arrival indicators, enroute status, or deletion markers based on the action processed
[Update US Cargo Data]
Cargo record update is performed → The system updates the cargo record with new arrival flags, export indicators, transfer status, or cargo processing status based on the action processed
[Create Log Entries]
Log entry creation is performed → The system creates GCX105 transaction log with action details, user ID, date, time, and descriptive messages for audit trail purposes
[Finalize EDI Transmission]
Transmission finalization is performed → The system spawns GCX109 transaction with transmission number to trigger EDI processing workflow
[Retrieve User Security Table Segment]
The system calls table segment retrieval process → User security table segment is retrieved and return status is captured
[Load Security Settings]
The return flag indicates successful retrieval → The retrieved table segment is moved to user security segment storage
[Set Default Security Settings]
The return flag indicates unsuccessful retrieval → User security segment is initialized to default values
[Set Transmission Prefix to 112]
Transmission prefix is being set → Transmission prefix is set to value 112
[Set Transmission Number from Machine Time]
Transmission number is being generated → Current machine time is used as the transmission number
[Call READQ to Read Message Queue]
The system calls READQ to retrieve the message → The message is successfully read from the queue using CCCOM communication area and input message length
[Move Message Content to GCX112-INPUT]
The system processes the message content → The message content is moved from AREA-CSI-INPUT to GCX112-INPUT structure for further processing
[Record Type = US Train?]
If the record type and finds it matches the US Train indicator (GCX112-US-TRAIN condition is true) → The system routes the processing to the US Train routine (B200-US-TRAIN-ROUTINE) to handle train-specific business logic
[Record Type = US Cargo?]
If the record type and finds it matches the US Cargo indicator (GCX112-US-CARGO condition is true) → The system routes the processing to the US Cargo routine (B300-US-CARGO-ROUTINE) to handle cargo-specific business logic
[Route to US Train Processing Routine]
The system needs to process the train transaction → The system performs the B200-US-TRAIN-ROUTINE to execute train-specific processing logic including validation, data movement, and transmission creation
[Route to US Cargo Processing Routine]
The system needs to process the cargo transaction → The system performs the B300-US-CARGO-ROUTINE to execute cargo-specific processing logic including validation, status updates, and transmission creation
[Retrieve US Train Data from Database]
The system needs to process the train record → The system retrieves the complete train record from the database using the train identifier
[Check if EDI Send Required]
The system checks the EDI send configuration → If the train is configured to send EDI, processing continues; otherwise, specific action code validations are performed
[Action Code = TD and Delete Required?]
EDI send is not required → The system continues with delete processing
[Action Code = TAR?]
The system processes the action code → The system initiates train arrival processing workflow
[Action Code = TD?]
The system processes the action code → The system initiates train deletion processing workflow
[Action Code = TUA?]
The system processes the action code → The system initiates train un-arrival processing workflow
[Set Train Arrived Flag]
The system processes the train arrival → The system creates a GCX105 message, calls the arrival routine, and exits processing
[Set Train Delete Flags]
The system processes the train deletion → The system creates a GCX105 message, sets deleted and deleted-confirm flags, clears secondary index, and exits processing
[Clear Train Arrived Flag]
The system processes the train un-arrival → The system clears the arrived flag, creates a GCX105 message, and exits processing
[Check Security Settings]
The system checks the UTF change security setting → If UTF change is not 'S', the system performs additional action code validations
[Map Train Data to EDI Segments]
The system prepares EDI transmission → The system maps train data fields to M10, P4, and M15 EDI segments according to business rules
[Create EDI Transmission Record]
The system creates the transmission → The system creates a transmission record with unique number and transaction set '353'
[Create M10 EDI Segment]
The system creates EDI dependent segments → The system creates M10 segment with sequence number '00001'
[Create P4 EDI Segment]
The system creates EDI dependent segments → The system creates P4 segment with sequence number '00002'
[Create M15 EDI Segment]
The system creates EDI dependent segments → The system creates M15 segment with sequence number '00003'
[Update Train Record in Database]
The system updates the train record → The system sets do-not-send-EDI flag and replaces the train record
[Finalize EDI Transmission]
The system finalizes the transmission → The system spawns GCT1091E transaction with transmission number
[Is GCUTR-DO-SEND-EDI Flag Set?]
The system checks the GCUTR-DO-SEND-EDI flag → If flag is set to send EDI, continue with EDI processing, otherwise evaluate alternative processing conditions
[Action Code = 'TD' AND Delete Required?]
The action code is 'TD' and the train record has delete required flag set → Continue with EDI processing for the deletion
[Security Setting: UTF-CHANGE = 'S'?]
The GCSTBRT-US-UTF-CHANGE field equals 'S' → Continue with security override and proceed to EDI data mapping
[Check Train Action Code]
If the action code → The system should route to TAR processing if action code is 'TAR', TD processing if action code is 'TD', TUA processing if action code is 'TUA', or continue to EDI processing for other codes
[Perform SE Table Lookup]
Station code validation is performed → Move the station code to lookup key, set table ID to SE, set function code to GU, and call table segment lookup
[Perform SE Table Lookup]
Location ID validation is performed → Move the location ID to lookup key, set table ID to SE, set function code to GU, and call table segment lookup
[Generate Arrival Log Entry]
EDI transmission segments have been created → The system initializes and populates a GCX105 audit message with train arrival details including train number, action code, user ID, date and time
[Delete Required Flag Set?]
The system processes the TD action code → The system continues with EDI processing without performing delete operations
[Set Train/CCN Information]
The system populates train identification information → The system moves the train or US CCN from input message to the log entry
[Set Record Type Code]
The system populates record type information → The system moves the record type code from input message to the log entry
[Set TD Action Code]
The system populates action code information → The system moves the TD action code from input message to the log entry
[Set Train Control Number]
The train control number needs to be recorded → The train or US CCN from the input message must be copied to the notification message train control number field
[Set Record Type Code]
The record type needs to be specified → The record type code from the input message must be copied to the notification message record type field
[Set Action Code as TUA]
The action code needs to be specified → The action code from the input message must be copied to the notification message action code field
[Set Transaction ID as GCT1121E]
The sending transaction needs to be identified → The sending transaction field must be set to 'GCT1121E'
[Set User ID and Timestamp]
User identification and timing information needs to be recorded → The ACF2 user ID, current date, and current time must be set in the notification message
[Create Log Entry]
The log entry needs to be created → The GCT1051E spawn process must be performed to create the log entry
[Set Cancel Conveyance Arrival Qualifier]
The EDI transmission qualifier needs to be set → The M15 notify entity qualifier must be set to CANCEL-CONVEYANCE-ARRIVAL
[Set EDI Notification Type to Conveyance Enroute]
The train enroute flag is set → The system sets the EDI notification entity qualifier to conveyance enroute
[Action Code IAR or CIR?]
The action code is 'IAR':
'CIR'
→ Immediately exit the cargo processing routine
[Map Cargo Data to EDI Segments]
The cargo data mapping process is initiated → Populate M10 manifest segment with SCAC, transport type, country, vessel details AND populate P4 port segment with location and timing information AND populate M15 notification segment with reference numbers and qualifiers based on action code
[Action Code CAB?]
The in-bond type code is NOT 'TR' AND NOT 'MT' → Create an additional M15 segment with export-by-equipment or export-by-bond qualifier based on CCN status
[Action Code AIA?]
The AIA processing is initiated → Create an additional M15 segment with export-by-equipment or export-by-bond qualifier AND set the yes-no condition flag to 'Y'
[Set Transfer Flag and SCAC Code]
The transfer processing is executed → Set the transfer flag to 'Y' AND update the transfer SCAC code with the carrier SCAC from the input message
[Skip Processing - Exit to B300-END]
The train ID is blank or equals 'TRAIN' → The system should immediately exit the cargo processing routine without further processing
[Update Transfer SCAC Code]
The transfer SCAC update is executed → The RT16 transfer SCAC code field is updated with the carrier SCAC from the input message
[Create TIE Log Entry]
The TIE log entry creation is executed → A GCX105 message with action code 'TIE' is created and spawned for audit trail
[Continue with Normal Processing]
The cargo record either has a SCAC code that is not CPRS:
has CPRS SCAC code with a valid train ID that is not blank and not equal to 'TRAIN'
→ The system should continue with normal cargo processing including validation checks, status updates, and transmission creation
[Continue with Export Processing]
The system checks the cargo export indicator field and finds it is not set to 'Y' (meaning cargo has not been exported yet) → The system continues with normal export processing including setting export flags and creating transmission records
[Set Transfer SCAC Code from Input Message]
The transfer SCAC code assignment is executed → The carrier SCAC code from the input message is assigned to the transfer SCAC field
[Store Transfer SCAC Code]
The system updates the cargo record for transfer → The carrier SCAC code from the input message (GCX112-CARRIER-SCAC) is stored in the cargo record field GCUSRT-RT16-TRANSFER-SCAC-CDE
[Map Transfer Notification Data]
The system creates the M15 notification segment → Transfer notification qualifier is set to TRANSFER-BY-EQUIPMENT, car ID is set as reference number, event date and time are populated, location code is set, tax number is used as reference, carrier SCAC and city information are included
[Generate Transfer Message]
The system generates the GCX105 transfer notification message → A TFT action code message is created containing the carrier SCAC code, 'AT' indicator, and city name for the transfer location
[Build Email Address List]
The system checks if BK table use-internet flag equals 'Y' → The system formats the internet address with 'INTERNET:' prefix and adds it to the email message list
[Send Email via EMCSEND3]
The system calls the email service with report details → The system sends the email report and validates successful transmission
[Purge Message Queue]
The system completes the email transmission process → The system purges the message queue to clean up resources
[Read BK Table Segment]
The system performs BK table lookup → The system calls table segment retrieval function to get email configuration data
[BK Table Record Found?]
The BK table record is not found (return flag not equal to '0') → The system initializes empty BK segment and sets EOF flag to TRUE to terminate the email retrieval loop
[Move Table Data to BK Segment]
The BK table record is found (return flag equals '0') → The system moves the retrieved table segment data to BK segment structure for further processing
[Read B1 Table Segment for Internet Address]
The system needs to get internet address details → The system performs B1 table lookup to retrieve internet address configuration data
[B1 Table Record Found?]
The B1 table record is not found (return flag not equal to '0') → The system initializes empty B1 segment and sets EOF flag to TRUE to terminate the email retrieval process
[Move Table Data to B1 Segment]
The B1 table record is found (return flag equals '0') → The system moves the retrieved table segment data to B1 segment structure for email address processing
[Build Internet Email Address 'INTERNET: ' + Address]
The system needs to format the email address for notification → The system concatenates 'INTERNET: ' prefix with the internet address from B1 segment to create formatted email address
[Store Email Address in Message Line]
The system needs to store the email address for notification → The system stores the formatted email address in the message line corresponding to the current counter position
[Set Email Found Flag to TRUE]
The email address is stored in the message structure → The system sets the email found flag to TRUE to indicate successful email configuration
[Read BK Table for Email Config]
The system performs BK table lookup → The email configuration segment is retrieved from the BK table using the configuration key
[Read B1 Table for Internet Address]
The system performs B1 table lookup → The internet address segment is retrieved from B1 table
[Use Internet Email?]
If the use internet flag → If BK use internet flag equals 'Y', internet email processing is enabled, otherwise sequence counter is incremented
[Build Internet Email Address]
The system builds the email address string → The email message line is populated with 'INTERNET: ' concatenated with the B1 internet address
[TER Email Configuration Found?]
TER email configuration has been found during email lookup process → The report recipient should be set to external email system
[Set Merlin System as Recipient]
No TER email configuration has been found during email lookup process → The report recipient should be set to the Merlin customs application identifier
[Send Report to Merlin System]
The report transmission is initiated → The report should be sent through the EMCSEND3 service to the configured recipient
[Configure Email Parameters]
The system configures email parameters → Clear copy user codes and keywords, set report subject, clear item sequence numbers, and set message width to 132 characters
[Add Report Line 1 to Email Message]
The email message content is being assembled → Report line 1 is added to the email text message lines and the line counter is incremented
[Add Blank Line to Email Message]
The email message formatting requires section separation → A blank line is added to the email text message lines and the line counter is incremented
[Add Report Line 2 to Email Message]
The email message content is being assembled → Report line 2 is added to the email text message lines and the line counter is incremented
[Add Report Line 3 to Email Message]
The email message content is being finalized → Report line 3 is added to the email text message lines
[Send Email Report via EMCSEND3]
The report needs to be transmitted to recipients → The system calls the EMCSEND3 service with sender, recipient, subject, and message content
[Purge Message Queue]
Post-transmission cleanup is required → The system purges the message queue using the CIMS service with PURG function
[Handle Email Send Failure]
The email service indicates unsuccessful transmission → The system logs 'SEND TO FILE OF OM01247 FAILED' error message and calls error handling routine
[Read BK Table Segment]
Accessing the BK table for email configuration → The table segment is read using the configuration key and return status is captured
[Move Table Data to BK Segment]
The table read operation was successful → The table segment data is moved to the BK segment structure for further processing
[Read B1 Table Segment]
Accessing the B1 table for internet addresses → The table segment is read and return status is captured
[Move Table Data to B1 Segment]
The table read operation was successful → The table segment data is moved to the B1 segment structure for email processing
[Store Email Address in Message Line]
Storing the email address for notification use → The email address string is stored in the email message line at the current TER index position
[Set Train ID as Key Value]
The system prepares to retrieve train data from the database → The train identifier should be set as the key value for the database query
[Train Data Retrieved Successfully]
The train record is found and successfully retrieved → The train data should be available in the train root segment for further processing
[Extract CCN Key from Input Message]
The system processes the message for cargo data retrieval → The US cargo control number (CCN) is extracted and assigned as the database search key
[Call Database to Get US Cargo Segment]
The system executes the database retrieval operation → The database is accessed to retrieve the US cargo segment data
[US Cargo Data Retrieved Successfully]
The cargo data is successfully loaded into memory → The US cargo segment data is available for further business processing
[Call Database Replace Function]
The database replace function is called with the train segment data → The US train segment is replaced in the database with the updated information
[Update Transfer SCAC Code]
The action code is 'CTR' (Cargo Transfer) or 'MTR' (Manual Transfer) → The transfer SCAC code is updated with the carrier SCAC from the input message
[Replace US Cargo Segment in Database]
All cargo field updates are ready to be persisted → The cargo segment is replaced in the database using the REPL function to save all changes
[Set Standard SCAC Code to CPRS]
The M10 segment SCAC field needs to be populated → The SCAC code is set to 'CPRS'
[Set Transport Type to Rail]
The transportation type code needs to be assigned → The transport type code is set to 'R' indicating rail transportation
[Map Train ID to Vessel Name]
EDI M10 segment vessel name field needs to be populated → The train key (GCUTR-KEY) is mapped to the M10 vessel name field (M10-05-VESSEL-NAME)
[Handle Country Code Mapping - Set Country to US for Export, Set Country to CA for Import, Set Country to MX for Mexico Station]
The system needs to determine the country code for EDI transmission → If vessel name position 23 is 'T' and port is valid, country code is set to 'US' for export trains; if station code is '2304', country code is set to 'MX' for Mexico; otherwise country code is set to 'CA' for Canada
[Set Export Application Type - Set Type 28 for Export Trains]
The train is being processed as an export shipment → The application type is set to '28' in the M10 segment
[Handle Date Format Conversion - Convert EDA Date Format]
The EDA date needs to be formatted for EDI transmission → If EDA date is spaces or zeroes, century is set to 0; if year is less than 70, century is set to 20; otherwise century is set to 19, and the formatted date is mapped to P4 ETA date field
[Set Manifest Type to Header, Set Conditional Response Code to Yes, Set Record Type to TRAIN]
Standard manifest fields need to be populated → Manifest type code is set to 'H' for header, conditional response code is set to 'Y' for yes, record type is set to 'TRAIN', and quantity is set to '1'
[Map Train ID to Record Number, Map Station Code to Location ID, Map Firms Code to ID Code, Map ETA Time]
EDI segments need to be populated with train details → Train key is mapped to M10 record number and M15 reference number, station code is mapped to P4 location ID and M15 location qualifier, firms code is mapped to P4 ID code, and ETA time is mapped to P4 time field
[Set Current Date, Set Current Time]
Date and time fields need to be populated → Current system date is set in M15 date field and current system time is set in M15 time field
[Clear Optional Fields - Seal, SCAC, City, State, Set Condition Flag to No]
Optional fields need to be initialized → Seal number, SCAC, reference number, city name, and state/province code fields are set to spaces, and yes/no condition flag is set to 'N'
[Set SCAC Code from Cargo Data]
Mapping cargo data to M10 segment → SCAC code from cargo record is assigned to M10-01-SCAC field
[Set Transport Type Code]
Mapping cargo data to M10 segment → Transport type code from cargo record is assigned to M10-02-TRANSP-TYP-CDE field
[Set Country Code]
Mapping cargo data to M10 segment → Country code from cargo record is assigned to M10-03-COUNTRY-CDE field
[Set Vessel Name]
Mapping cargo data to M10 segment → Vessel name from cargo record is assigned to M10-05-VESSEL-NAME field
[Set Flight/Voyage Number]
Mapping cargo data to M10 segment → Flight/voyage number from cargo record is assigned to M10-06-FLIGHT-VOYAGE-NUM field
[Set Reference Numbers and Quantities]
Mapping cargo data to M10 segment → Reference number is assigned to M10-07-REF-NUM and quantity is assigned to M10-08-QUANTITY
[Set Manifest Type to 'H']
Setting manifest type information → Manifest type code 'H' is assigned to M10-09-MANIFEST-TYP-CDE field
[Set Record Type to 'CARGO']
Setting record type information → Record type 'CARGO' is assigned to M10-12-RCD-TYPE field
[Set Record Number to CCN Key]
Setting record identification in M10 segment → US CCN key is assigned to M10-12-RCD-NUM field
[Map Location and Date Information]
Mapping cargo data to P4 segment → Location ID is assigned to P4-01-LOCATION-ID and ETA date is assigned to P4-02-ETA-DATE
[Map Arrival Notification Data]
Mapping notification data to M15 segment → Arrival notification qualifier is set based on bond vs equipment type, reference number is set from entry number or car ID, and condition flag is set appropriately
[Map Export Notification Data]
Mapping notification data to M15 segment → Export notification qualifier is set based on bond vs equipment type, reference number is set from entry number or car ID
[Map Transfer Notification Data]
Mapping notification data to M15 segment → Transfer notification qualifier is set, car ID is used as reference, tax number and carrier SCAC are mapped to reference and SCAC fields, city name and state are mapped accordingly
[Map Cancel Notification Data]
Mapping notification data to M15 segment → Cancel notification qualifier is set based on arrival vs export and bond vs equipment type, reference number is set from entry number or car ID
[Map Diversion Notification Data]
Mapping notification data to M15 segment → Inbond diversion qualifier is set, entry number is used as reference, and diversion reference number is mapped
[Set Reference Number Qualifier]
Setting reference number qualifier in M15 segment → If entry number exists, use 'IB' qualifier with entry number; otherwise if in-bond control number exists, use 'IB' qualifier with control number
[Set Location Qualifier and Time]
Setting location and time information in M15 segment → Current date is assigned to M15-03-DATE, location code is assigned to M15-04-LOCATION-QUALIFIER, and current time is assigned to M15-06-TIME
[Set Location Code from Port]
The system processes cargo data validation → The port code is assigned to the working storage location code field
[Map Basic Cargo Data to EDI Segments]
The system processes cargo data for EDI transmission → The cargo data is mapped to M10 segment fields (SCAC, transport type, country, vessel code, vessel name, flight/voyage number, reference number, quantity, manifest type, vessel code qualifier, condition response code, record type, record number) and P4 segment fields (location ID, ETA date, quantity, ID code, time)
[Map CAB Action - Arrival/Export by Bond or Equipment]
The CCN type is unknown (bond processing) and in-bond type code is 'TR' or 'MT' → The system sets notification entity qualifier to EXPORT-BY-BOND and uses entry number as reference, otherwise sets ARRIVAL-BY-BOND for unknown CCN type, or EXPORT-BY-EQUIPMENT/ARRIVAL-BY-EQUIPMENT for known CCN type based on in-bond type code
[Map CAA/MAA Actions - Arrival Notifications]
The system processes arrival notifications → The system sets notification entity qualifier to ARRIVAL-BY-BOND and uses entry number as reference for unknown CCN type, or ARRIVAL-BY-EQUIPMENT and uses car ID as reference for known CCN type
[Map AIA/MIA Actions - Arrival with Special Conditions]
The system processes in-transit arrival notifications → The system sets notification entity qualifier to ARRIVAL-BY-BOND and uses entry number as reference for unknown CCN type, or ARRIVAL-BY-EQUIPMENT and uses car ID as reference for known CCN type, and sets the yes/no condition flag to 'Y'
[Map MUA Action - Cancel Arrival Notifications]
The system processes arrival cancellation → The system sets notification entity qualifier to CANCEL-BOND-ARRIVAL and uses entry number as reference for unknown CCN type, or CANCEL-EQUIPMENT-ARRIVAL and uses car ID as reference for known CCN type
[Map MUE Action - Cancel Export Notifications]
The system processes export cancellation → The system sets notification entity qualifier to CANCEL-BOND-EXPORT and uses entry number as reference for unknown CCN type, or CANCEL-EQUIPMENT-EXPORT and uses car ID as reference for known CCN type
[Map MEX/CEX/IEX Actions - Export Notifications]
The system processes export notifications → The system sets notification entity qualifier to EXPORT-BY-BOND and uses entry number as reference for unknown CCN type, or EXPORT-BY-EQUIPMENT and uses car ID as reference for known CCN type
[Map CTA/MTA Actions - Transfer Notifications]
The system processes transfer notifications → The system sets notification entity qualifier to TRANSFER-BY-EQUIPMENT, uses car ID as reference number, maps tax number to reference number field, carrier SCAC to SCAC field, city name to city field, and city state to state/province field
[Map DIV Action - Inbound Diversion Notifications]
The system processes diversion notifications → The system sets notification entity qualifier to INBOND-DIVERSION, uses entry number as reference number, and maps the cargo reference number to the secondary reference number field
[Set Application Type = '28']
The system assigns application type for the transmission → The application type is set to '28' to indicate US export manifest processing
[Mark as Export Train]
The train qualifies as an export train based on vessel name and valid station code → The export train status flag is set to true for subsequent processing
[Set Reference Numbers and Qualifiers]
System processes location identification → System sets FIRMS code as location ID in notification and for TE in-bond type sets FIRMS code in port segment
[Use Entry Number as Reference]
The system needs to assign a reference number for the notification → The system uses the entry number (GCUSRT-M1202-ENTRY-NUM) as the reference number in the M15 segment
[Use Car ID as Reference]
The system needs to assign a reference number for the notification → The system uses the car ID (WS-CAR-ID) as the reference number in the M15 segment
[Set Location Code from Port Code]
The system needs to populate notification reference data → The location code should be set to the port code from the input message
[Set Current Date and Time]
Reference data is being populated → The notification date should be set to current system date and time should be set to current system time
[Set Carrier SCAC Code]
Carrier information needs to be populated → Set the secondary SCAC code to the carrier SCAC from input, set tax reference number, city name, and state information from input message
[Set Firms Code for Location ID]
The in-bond type code is TE → Set the P4 segment ID code to the firms code from the cargo record
[Set Equipment Reference in M15 Segment]
The routing logic has determined whether to use bond or equipment reference → Set the M15-02-REFERENCE-NUMBER field with either the entry number for bond routing or the formatted car ID for equipment routing
[Use Entry Number as Reference]
The notification segment is being populated → Set the reference number to the cargo's entry number from M1202 field
[Use Car ID as Reference]
The notification segment is being populated → Set the reference number to the processed car ID
[Set Location and Time Data]
The M15 segment is being populated → Set date to current date, location qualifier to port code, time to current time, and initialize SCAC, seal number, city name, and state fields to spaces
[Set Firms Code for Location ID]
The M15 segment is being finalized → Set the location ID field (M15-17-LOC-ID) to the cargo's firms code
[Set Yes Condition Flag]
The M15 notification segment is being created → Set the yes-no condition field to 'Y'
[Set No Condition Flag]
The M15 notification segment is being created for arrival processing → Set the yes-no condition field to 'N'
[Set Entry Number as Reference]
The CCN classification indicates bond processing → The system sets the entry number as the reference number in the M15 segment
[Set Car ID as Reference]
The CCN classification indicates equipment processing → The system sets the car ID as the reference number in the M15 segment
[Set Current Date and Time]
The notification data is being populated → The system sets the current working date and time in the M15 segment
[Clear Additional Fields]
The M15 segment is being populated → The system sets SCAC, seal number, reference number, city name, and state province code fields to spaces
[Set Condition Flag to N]
The M15 segment condition flag needs to be set → The system sets the yes/no condition flag to 'N'
[Update Transfer SCAC Code]
Transfer processing is not skipped due to existing transfer status → The system updates the RT16 transfer SCAC code field with the carrier SCAC from the input message
[Create Transfer Log Entry with TFT Action]
The transfer status has been updated in the cargo record → The system creates a GCX105 message with action code TFT, includes carrier SCAC code, city name with 'AT' prefix, and schedules it for processing with incremented time
[Map Equipment ID to Reference Number]
Creating the M15 notification segment → The system maps the processed car ID to the M15 reference number field
[Set Transfer Notification Type]
Creating the M15 notification segment → The system sets the notify entity qualifier to TRANSFER-BY-EQUIPMENT
[Set Transfer Location Code, Set Transfer Date and Time]
Creating the M15 notification segment → The system sets the location qualifier to the port code from input, sets date to current working date, and sets time to current working time
[Map Transfer Carrier SCAC Code, Map Transfer City Name, Map Transfer State/Province]
Creating the M15 notification segment → The system maps the tax number to reference number field, maps carrier SCAC to SCAC field, maps city name to city field, and maps city state to state/province field
[Set Notification Date and Time]
The notification segment is populated → The system sets the current working date to M15-03-DATE, current working time to M15-06-TIME, and the location code to M15-04-LOCATION-QUALIFIER with YES-NO condition set to 'N'
[Receive DIV Action Code for US Cargo]
The system processes the diversion action code → The system should set the notification entity qualifier to inbound diversion and proceed with diversion processing
[Set Notification Type to Inbound Diversion]
The system maps the diversion data to the M15 EDI segment → The M15-01-NOTIFY-ENTITY-QUALIFIER should be set to INBOND-DIVERSION
[Set Current Date and Time]
Setting up the M15 segment data → The current working storage date should be moved to M15-03-DATE and current time to M15-06-TIME
[Set Location Code from Port]
Processing a diversion notification → The port code should be moved to M15-04-LOCATION-QUALIFIER via working storage location code
[Set Condition Flag to No]
Setting up the M15 segment condition flags → The M15-12-YES-NO-COND field should be set to 'N'
[Create Descriptive Log Message]
Creating the log message for GCX105 → The message should be formatted as 'CARGO DIVERSION REQUEST FROM [original] TO [destination] SENT'
[Format Diversion Message with From/To Locations]
Preparing to send the log entry → The GCX105-ACTION-CODE should be set to 'ZZZ'
[Set CAA Message: 'CARGO ARRIVAL AUTOMATICALLY AT' + Location]
The system processes the CAA action code for log entry creation → The system sets the message to 'CARGO ARRIVAL AUTOMATICALLY AT ' concatenated with the location code and changes the action code to 'ZZZ'
[Set MAA Message: 'CARGO ARRIVAL MANUALLY AT' + Location]
The system processes the MAA action code for log entry creation → The system sets the message to 'CARGO ARRIVAL MANUALLY AT' concatenated with the location code and changes the action code to 'ZZZ'
[Set MUA Message: 'CARGO ARRIVAL CANCELED AT' + Location]
The system processes the MUA action code for log entry creation → The system sets the message to 'CARGO ARRIVAL CANCELED AT' concatenated with the location code and changes the action code to 'ZZZ'
[Set MUE Message: 'CARGO EXPORT CANCELED AT' + Location]
The system processes the MUE action code for log entry creation → The system sets the message to 'CARGO EXPORT CANCELED AT' concatenated with the location code and changes the action code to 'ZZZ'
[Set CAB Message: 'CARGO AUTO ARRIVED BORDER AT' + Location]
The system processes the CAB action code for log entry creation → The system sets the message to 'CARGO AUTO ARRIVED BORDER AT' concatenated with the location code and changes the action code to 'ZZZ'
[Set MAB Message: 'CARGO MAN ARRIVED BORDER AT' + Location]
The system processes the MAB action code for log entry creation → The system sets the message to 'CARGO MAN ARRIVED BORDER AT' concatenated with the location code and changes the action code to 'ZZZ'
[Set CEX Message: 'CARGO EXPORTED AUTOMATICALLY AT' + Location]
The system processes the CEX action code for log entry creation → The system sets the message to 'CARGO EXPORTED AUTOMATICALLY AT' concatenated with the location code and changes the action code to 'ZZZ'
[Set MEX Message: 'CARGO EXPORTED MANUALLY AT' + Location]
The system processes the MEX action code for log entry creation → The system sets the message to 'CARGO EXPORTED MANUALLY AT' concatenated with the location code and changes the action code to 'ZZZ'
[Set DIV Message: 'CARGO DIVERSION REQUEST FROM' + Origin + 'TO' + Destination + 'SENT']
The system processes the DIV action code for log entry creation → The system constructs a message with 'CARGO DIVERSION REQUEST FROM ' concatenated with the origin location, ' TO ' concatenated with the destination location, and ' SENT', then changes the action code to 'ZZZ'
[Prepare GCT1051E Message Structure]
The system needs to prepare the message for transmission → The system moves the formatted message input to the GCT1051E message structure
[Write Message to Log]
The system needs to write the message to the log → The system calls the message logging service to write the message with the specified message code, content, length, and module name
[Generate CAA Message 'CARGO ARRIVAL AUTOMATICALLY AT']
The system processes the automatic arrival action → A log message 'CARGO ARRIVAL AUTOMATICALLY AT [LOCATION]' is generated with the specific location code and the action code is changed to 'ZZZ' for further processing
[Generate MAA Message 'CARGO ARRIVAL MANUALLY AT']
The system processes the manual arrival action → A log message 'CARGO ARRIVAL MANUALLY AT [LOCATION]' is generated with the specific location code and the action code is changed to 'ZZZ' for further processing
[Generate MUA Message 'CARGO ARRIVAL CANCELED AT']
The system processes the arrival cancellation action → A log message 'CARGO ARRIVAL CANCELED AT [LOCATION]' is generated with the specific location code and the action code is changed to 'ZZZ' for further processing
[Generate MUE Message 'CARGO EXPORT CANCELED AT']
The system processes the export cancellation action → A log message 'CARGO EXPORT CANCELED AT [LOCATION]' is generated with the specific location code and the action code is changed to 'ZZZ' for further processing
[Generate CAB Message 'CARGO AUTO ARRIVED BORDER AT']
The system processes the automatic border arrival action → A log message 'CARGO AUTO ARRIVED BORDER AT [LOCATION]' is generated with the specific location code and the action code is changed to 'ZZZ' for further processing
[Generate MAB Message 'CARGO MAN ARRIVED BORDER AT']
The system processes the manual border arrival action → A log message 'CARGO MAN ARRIVED BORDER AT [LOCATION]' is generated with the specific location code and the action code is changed to 'ZZZ' for further processing
[Generate CEX Message 'CARGO EXPORTED AUTOMATICALLY AT']
The system processes the automatic export action → A log message 'CARGO EXPORTED AUTOMATICALLY AT [LOCATION]' is generated with the specific location code and the action code is changed to 'ZZZ' for further processing
[Generate MEX Message 'CARGO EXPORTED MANUALLY AT']
The system processes the manual export action → A log message 'CARGO EXPORTED MANUALLY AT [LOCATION]' is generated with the specific location code and the action code is changed to 'ZZZ' for further processing
[Generate DIV Message 'CARGO DIVERSION REQUEST FROM']
The system processes the diversion request action → A log message 'CARGO DIVERSION REQUEST FROM [ORIGIN] TO [DESTINATION] SENT' is generated with the origin location from cargo data and destination location from current processing location, and the action code is changed to 'ZZZ' for further processing
[Create GCT1051E Transaction]
The system needs to record the transaction in the audit trail → A GCT1051E transaction is created with the generated message content and transaction details
[Prepare GCT1091E Message Input]
The system initializes the GCX109 input message structure → The message input structure should be cleared and ready for data population
[Set Transmission Number from Processing]
The system prepares the EDI transmission message → The transmission number should be assigned to the GCX109 transmission number field
[Call Message Writer for GCT1091E]
The system needs to create the EDI transmission record → The X200-SPAWN-GCT1091E procedure should be executed to process the transmission
[Prepare GCT1091E Message]
The system processes the EDI transmission finalization → The GCX109 input data is moved to the GCT1091E message structure
[Set Transmission Number]
The system sets up the EDI transmission → The transmission number is assigned to the GCX109 transmission number field
[Change to Alternative PCB]
The system needs to process the EDI message through the queue → The system changes to the alternative PCB and clears the accept status
[Write Message to Queue]
The system processes the message transmission → The system writes the message using WRITMSGL with the message code, content, length and module name
[Purge Alternative PCB]
The system finalizes the EDI transmission process → The system purges the alternative PCB to complete the transmission
[Set Flight/Voyage Number to Julian Date]
The system assigns the flight voyage number → The Julian date in YYDDD format should be moved to the M10 segment flight voyage number field
[Create Diversion Log Message]
A log message needs to be created → The system should format a message containing 'CARGO DIVERSION REQUEST FROM', the original location, 'TO', the destination location, and 'SENT'
[Set Export by Bond Notification]
The system processes the CAB action code → An additional M15 EDI segment is created with Export by Bond notification qualifier and the entry number as reference
[Set Export by Equipment Notification]
The system processes the CAB action code → An additional M15 EDI segment is created with Export by Equipment notification qualifier and the car ID as reference
[Set Export by Bond Notification]
The system processes the AIA action code → An M15 EDI segment is created with Export by Bond notification qualifier, entry number as reference, and special condition flag set to Y
[Set Export by Equipment Notification]
The system processes the AIA action code → An M15 EDI segment is created with Export by Equipment notification qualifier, car ID as reference, and special condition flag set to Y
[Add to Transmission Queue]
The segment needs to be transmitted → The M15 segment is added to the transmission queue with sequence number 00004
[Set Firms Code to Location ID Field]
The notification entity qualifier is ARRIVAL-BY-BOND or ARRIVAL-BY-BILL or ARRIVAL-BY-EQUIPMENT → The system sets the firms code from cargo record to the M15 location ID field (M15-17-LOC-ID)
[Set Firms Code to P4 ID Code Field]
The in-bond type code is 'TE' (Temporary Export) → The system sets the firms code from cargo record to the P4 segment ID code field (P4-04-ID-CODE)
[Set Reference Number Qualifier to 'IB']
The reference number is being assigned to the transmission segment → The reference number qualifier should be set to 'IB' to indicate in-bond processing
[TER - Set Export Enroute Message]
The cargo meets export conditions and action is TER → The system should set the notification entity qualifier to EXP-ENROUTE-MESSAGE
[Action Code Check]
The action code is TER, TAR, or CAB → The system routes to the corresponding action-specific processing logic
[Export Type Classification]
The cargo is classified as export cargo, US-Canada-US transit, multi-transit, or other types → The system applies the corresponding message processing rules for each cargo type
[Set Export Enroute Message Type]
The action code is TER (Train Enroute) → The system sets the notify entity qualifier to EXP-ENROUTE-MESSAGE
[Set Arrival by Equipment Message]
The cargo requires message processing → The system sets the notify entity qualifier to ARRIVAL-BY-EQUIPMENT
[Configure Message Parameters]
Message parameters need to be set → The system sets car ID as reference number, current date and time, location code, and export condition flag to Yes
[Action Code for Export]
The action code is TER (Train Enroute) → The system sets Export Enroute Message notification type
[Configure M15 Segment Data]
The system configures the M15 segment → The car ID is set as reference number, current date and time are recorded, location code is set as qualifier, and condition flag is set to 'Y' for export processing
[Set Transaction Set to 353]
The transaction set type needs to be specified → The transaction set is set to '353' for customs manifest data
[Generate Transmission Number]
A unique transmission identifier is required → The transmission number is generated using prefix 112 concatenated with current machine time
[Set Initial Status to II]
The initial processing status needs to be set → The status is set to 'II' to indicate insertion in progress
[Create M10 Segment]
The manifest header segment needs to be added → The M10 segment is created as a dependent segment with sequence number '00001'
[Create P4 Segment]
Port information needs to be added to the transmission → The P4 segment is created as a dependent segment with sequence number '00002'
[Create M15 Segment]
Notification information needs to be added to the transmission → The M15 segment is created as a dependent segment with sequence number '00003'
[Additional M15 Segments Required?]
The in-bond type code is not 'TR' and not 'MT' → An additional M15 segment is created with sequence number '00004' for export notification
[Additional M15 Segments Required?]
An arrival in advance notification is required → An additional M15 segment is created with sequence number '00004' and yes-no condition set to 'Y'
[Create 'CARGO ARRIVAL AUTOMATICALLY' Message]
The system processes the cargo arrival automatic action → A log message 'CARGO ARRIVAL AUTOMATICALLY AT [location]' is created and the action code is changed to 'ZZZ'
[Create 'CARGO ARRIVAL MANUALLY' Message]
The system processes the cargo arrival manual action → A log message 'CARGO ARRIVAL MANUALLY AT [location]' is created and the action code is changed to 'ZZZ'
[Create 'CARGO ARRIVAL CANCELED' Message]
The system processes the cargo arrival cancellation action → A log message 'CARGO ARRIVAL CANCELED AT [location]' is created and the action code is changed to 'ZZZ'
[Create 'CARGO EXPORT CANCELED' Message]
The system processes the cargo export cancellation action → A log message 'CARGO EXPORT CANCELED AT [location]' is created and the action code is changed to 'ZZZ'
[Create 'CARGO AUTO ARRIVED BORDER' Message]
The system processes the cargo automatic border arrival action → A log message 'CARGO AUTO ARRIVED BORDER AT [location]' is created and the action code is changed to 'ZZZ'
[Create 'CARGO MAN ARRIVED BORDER' Message]
The system processes the cargo manual border arrival action → A log message 'CARGO MAN ARRIVED BORDER AT [location]' is created and the action code is changed to 'ZZZ'
[Create 'CARGO EXPORTED AUTOMATICALLY' Message]
The system processes the cargo automatic export action → A log message 'CARGO EXPORTED AUTOMATICALLY AT [location]' is created and the action code is changed to 'ZZZ'
[Create 'CARGO EXPORTED MANUALLY' Message]
The system processes the cargo manual export action → A log message 'CARGO EXPORTED MANUALLY AT [location]' is created and the action code is changed to 'ZZZ'
[Create 'CARGO DIVERSION REQUEST' Message]
The system processes the cargo diversion request action → A log message 'CARGO DIVERSION REQUEST FROM [origin] TO [destination] SENT' is created and the action code is changed to 'ZZZ'

Structural Validations

[Generate Invalid Record Type Error]
The record type is neither US Train nor US Cargo (both GCX112-US-TRAIN and GCX112-US-CARGO conditions are false) → The system sets an error message 'INVALID INPUT CODE SHOWN IN CC-PROG', moves the record type code to CC-PROG, and calls the error handling routine
[Get Train From Station Code]
The train from-station code is retrieved → If the from-station code is blank, display a blank station code message, otherwise proceed with validation
[Get Cargo Location ID]
The cargo location ID is retrieved → If the location ID is blank, display a blank location ID message, otherwise proceed with validation
[Is SCAC Code = CPRS?]
The cargo record has SCAC code equal to CPRS AND the train ID is either blank spaces or contains the literal value 'TRAIN' → The system should skip all further processing for this cargo record and exit the routine immediately
[Send Email via EMCSEND3]
The system checks the email service return status → The system continues processing if successful, otherwise sets error message and abends
[Internet Usage Flag = 'Y'?]
The system checks the internet usage flag in BK segment → The system proceeds with email address processing only if the internet usage flag equals 'Y'
[Email Configuration Found?]
The system checks the return status → If return flag is not '0', the BK segment is initialized and EOF flag is set to true, otherwise processing continues
[Internet Address Available?]
The system checks the return status → If return flag is not '0', the B1 segment is initialized and EOF flag is set to true, otherwise processing continues
[Report Send Successful?]
The transmission response is received → If the return status indicates failure, an error should be handled and the program should terminate abnormally
[Email Send Successful?]
The email service returns a status indicator → The system checks if the return status indicates successful transmission
[Log Blank Station Code Warning]
The US from station code field is blank or contains only spaces → The system displays a warning message indicating that the US from station code is blank
[Log Blank Station Code Warning]
The location ID field is blank or contains only spaces → The system displays a warning message indicating that the location ID is blank
[Are Event Date and Time Numeric?]
The system checks if both GCX112-EVENT-TIME and GCX112-EVENT-DATE contain numeric values → The system proceeds with date conversion if both fields are numeric, otherwise skips date conversion processing
[Root Creation Successful?]
The transmission number already exists in the system → The transmission number is incremented by 1 and creation is retried until successful

Module: GCCADDCD 1 Consolidated Epic Story

Epic: GCCADDCD Complete EDI Specification Extracted from Legacy

Contains 225 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCADDCD EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Root Segment]
Root segment structure needs initialization → The EMTZ-ROOT-SEGMENT should be initialized to default state
[Initialize FWCARGET Parameters]
The system initializes FWCARGET parameters → All search criteria are set to include all waybill types except 98-99, all status types, exclude EDI incomplete records, include temporary waybills, exclude corrector waybills, return lead waybills, and use latest waybill date
[Initialize GCSCCRT Segment]
The retrieve next cargo process begins → The GCSCCRT cargo record segment is initialized to clear any previous data
[Initialize GCX101 Input Structure]
The message structure is being set up → The GCX101 input structure for the current index must be initialized to clear any previous data
[Initialize GCX101 Input Structure]
Message preparation begins → The GCX101 input structure for the current index is initialized to clear any existing data
[Initialize Message Input Structure]
The system initializes the message input structure → The system clears all fields in the message input structure for the current message index
[Initialize GCX101 Input Structure]
The message structure needs to be prepared → The GCX101 input structure for the current index is initialized to clear any existing data
[Initialize GCX101 Input Structure]
The system prepares the message structure → The GCX101 input structure is initialized to clear any previous data
[Call CIMS to Initialize Message]
The system needs to establish communication with customs → The system calls CIMS with CHNG function and ALT-PCB to initialize the message channel
[Initialize Message Structure]
The message processing system has been initialized → The WRITMSGL utility must be called with the message code, message content, message length, and module name to transmit the message to external customs systems
[Initialize Return Status Flag]
The system prepares for MERLIN communication → The EMI return status flag is initialized to clear any previous status

Core Acceptance Criteria

[8:Build Report Detail Lines]
Waybill is not found:
no cargo is found
detour manifest is required but not found
→ Build report with appropriate detail and message lines
[19:Retrieve Container from Flat Car]
Container is not found → Use root key to retrieve flat car container relationship, then retrieve container equipment, otherwise retrieve container equipment directly. If flat car relationship exists without container equipment, generate system error. If no flat car relationship exists, set message eleven and increment report index
[21:Finalize Report Processing]
No errors exist in report AND spawn processing is required → Process all pre-spawn entries and set error count to spawn count, otherwise when errors exist AND spawn processing is required, convert message twenty-eight to message nineteen and increment error count
[22:Spawn Customs Messages]
Spawn processing is executed → Move input record to customs message, call customs interface system, write message to customs queue, and purge customs interface
[24:Send Report to Customs]
Report transmission is initiated → Set customs user codes, set destination filename to 'REQUEST', populate subject with user ID and train information and timestamp, call email send service with report table, and purge interface system
[25:Determine Return Status]
Information message count is greater than zero → Set status to no waybill, otherwise when error message count is greater than zero, set status to errors and send report to customs, otherwise set status to OK and return report table
[Call FWCARGET Module for Car Data]
The system invokes FWCARGET module with parameters set to include all types except 98-99, all statuses, exclude EDI incomplete, include temporary waybills, exclude corrector waybills, return lead waybills, and get latest waybill date → The module returns waybill information in SHIPROOT segment for the specified car
[Retrieve Waybill by Root Key]
The system calls FWCWBIO service with SHIPROOT segment type, equal operator, and container equipment key → The waybill information is retrieved and stored in SHIPROOT segment
[Check for Multiple Waybill Versions]
The system checks if there are multiple waybill versions by evaluating haulage right carrier, EDI completion status, and feedback key → Continue processing until a valid waybill is found or no more versions exist
[More Waybill Versions?]
If CARGET-ERROR or CARGET-NOT-FOUND is true, or if HAULAGE-RIGHT-CARRIER is spaces, or if EDI-COMP-418-RELEASE equals 'Y', or if CARGET-FWBX-KEY-FEEDBACK matches previous feedback key → Stop processing if any termination condition is met, otherwise continue with previous status waybill date and update feedback key
[Select Latest Valid Waybill]
The system processes each version and finds one with valid haulage right carrier, completed EDI release, and unique feedback key → Set the processing flag to previous status waybill date and store the feedback key for comparison
[Set Previous Status Date]
The system prepares for the next search iteration → Previous status waybill date flag is set and the current FWBX key feedback is stored for duplicate detection
[Set Search Parameters for All Waybill Types]
The system initializes waybill search parameters → Search parameters are set to include all waybill types except 98-99, exclude EDI incomplete waybills, include temporary waybills, exclude corrector waybills, include returned lead waybills, and search for latest waybill date
[Same as Previous Version?]
The system compares the current waybill feedback key with the previous version → If the feedback keys match, mark as not found and stop processing, otherwise continue to search previous versions
[Set to Search Previous Version]
The system needs to search for previous waybill versions → Search parameters are updated to previous status waybill date and feedback key is stored for comparison
[Accept Current Waybill Version]
The system completes waybill validation → The current waybill version is accepted and version checking process ends
[Call Z320-GN-CCRT-SEG to Get Next Cargo Record]
The system needs to get the next cargo record → The Z320-GN-CCRT-SEG routine is called to retrieve the next cargo record from the Canadian Customs Cargo Records database
[Generate Message 27: Detour Manifest Missing]
If error message generation conditions → Generate message 27 indicating detour manifest is missing AND include the detour CCN key in the error message
[Generate Message 28: Transit Code Mismatch - Return]
If Canadian border crossing transit code conditions → Generate message 28 indicating transit code mismatch AND prepare GCT1011E change message for border crossing processing
[Generate Message 28: Transit Code Mismatch - Outbound]
If Canadian border crossing transit code conditions → Generate message 28 indicating transit code mismatch AND prepare GCT1011E diversion message for border crossing processing
[Prepare GCT1011E Change Message]
The system prepares border crossing messages → Set spawn flag to true AND increment pre-spawn index AND initialize GCX101 input structure AND set security byte to high values AND move cargo CCN key to message AND set Canadian flag to true AND set change flag to true AND move train crossing name and port to message
[Prepare GCT1011E Diversion Message]
The system prepares border crossing messages → Set spawn flag to true AND increment pre-spawn index AND initialize GCX101 input structure AND set security byte to high values AND move cargo CCN key to message AND set Canadian flag to true AND set diversion flag to true AND move train crossing name and port to message
[Prepare GCT1011E Change Message for Customs]
Error message 28 is set for the mismatch → Prepare GCT1011E message with change flag, Canadian flag, CCN key, border name, and border code for customs processing
[Prepare GCT1011E Diversion Message for Customs]
Error message 28 is set for the mismatch → Prepare GCT1011E message with diversion flag, Canadian flag, CCN key, border name, and border code for customs processing
[Set GCX101 Spawned Flag to True]
The system begins preparing the GCT1011E change message → The GCX101 spawned flag must be set to true to enable message generation
[Increment Pre-Spawn Index Counter]
The message preparation process begins → The pre-spawn index counter must be incremented by 1 to track this message
[Set Security Byte to High Values]
Security settings are being configured → The security byte must be set to high values to indicate maximum security level
[Move CCN Key to Message]
The change message is being populated → The cargo's CCN key must be moved to the message CCN field
[Set Canadian Flag to True]
Message classification is being set → The Canadian flag must be set to true to identify this as a Canadian border crossing message
[Set Change Message Type Flag]
Message type classification is being set → The change flag must be set to true to identify this as a change message type
[Move Train Crossing Name to Border Name]
Location details are being populated → The train crossing name must be moved to the border name field in the message
[Move Train Crossing Port to Border Code]
Port identification is being populated → The train crossing port code must be moved to the border code field in the message
[Set GCX101 Spawned Flag to True]
The diversion message preparation process begins → The GCX101 spawned flag is set to true to indicate message processing has started
[Increment Pre-Spawn Index Counter]
The message preparation process starts → The pre-spawn index counter is incremented by 1 to track the new message
[Set Security Byte to High Values]
Security settings are configured → The security byte in the GCX101 input structure is set to high values for maximum security clearance
[Move CCN Key to Message]
The diversion message is being populated → The CCN key from the cargo record is moved to the GCX101 CCN field in the message
[Set Canadian Flag to True]
Message routing flags are set → The Canadian flag in the GCX101 input structure is set to true
[Set Diversion Flag to True]
Message type classification is performed → The diversion flag in the GCX101 input structure is set to true
[Move Train Crossing Name to Border Name]
Border location information is populated in the message → The train crossing name is moved to the border name field in the GCX101 input structure
[Move Train Crossing Port to Border Code]
Border processing information is populated in the message → The train crossing port code is moved to the border code field in the GCX101 input structure
[Waybill Found?]
System checks the waybill indicator status → If waybill found, set waybill found status, otherwise proceed to generate no waybill messages
[Equipment is Container?]
System checks if the equipment is a container → If container, generate container-specific message, otherwise generate car-specific message
[Generate Message: No Waybill for Container]
System generates error messages for missing waybill → System sets message type 10 indicating no waybill found for container
[Generate Message: No Waybill for Car]
System generates error messages for missing waybill → System sets message type 12 indicating no waybill found for car
[Generate Message: No Cargo Found for Loaded Equipment]
System validates cargo consistency for loaded equipment → System sets message type 15 with waybill root key and date information
[Set Message Seventeen - Cargo Already Attached]
The system processes the train attachment validation → Set message seventeen flag to true for the current report index to indicate cargo is already attached to another train
[Prepare GCT1011E Change Message]
Error message 28 is triggered → Prepare GCT1011E message with change type, Canadian flag, CCN, border name and port for customs processing
[Prepare GCT1011E Diversion Message]
Error message 28 is triggered → Prepare GCT1011E message with diversion type, Canadian flag, CCN, border name and port for customs processing
[Manifest TO Transit Code ≠ Train Crossing Port?]
The system compares the manifest TO transit code with the train crossing port code → The system prepares a change message if the codes are different, otherwise checks outbound manifest codes
[Manifest FROM Transit Code ≠ Train Crossing Port?]
The system compares the manifest FROM transit code with the train crossing port code → The system prepares a diversion message if the codes are different, otherwise completes processing without border crossing messages
[Build Change Message for GCT1011E]
The system builds a GCT1011E change message → The system sets spawned flag, increments counter, initializes message structure, sets security level, copies CCN key, sets Canadian flag, sets change message type, and copies border crossing details
[Build Diversion Message for GCT1011E]
The system builds a GCT1011E diversion message → The system sets spawned flag, increments counter, initializes message structure, sets security level, copies CCN key, sets Canadian flag, sets diversion message type, and copies border crossing details
[Set Message as Spawned]
The system begins message preparation → The system sets the spawned status flag to indicate messages are being prepared
[Set Security Level to High Values]
The system sets the security level for the message → The system assigns high values to the security byte field to indicate maximum security clearance required
[Copy CCN Key to Message]
The system copies cargo identification data → The system moves the CCN key from the cargo record to the message CCN field
[Set Canadian Flag]
The system sets processing flags for the message → The system sets the Canadian flag to indicate this message requires Canadian customs processing
[Set Change Message Type]
The system sets the message type for change processing → The system sets the change flag to indicate this is a destination change message
[Set Diversion Message Type]
The system sets the message type for diversion processing → The system sets the diversion flag to indicate this is an origin diversion message
[Copy Border Crossing Name]
The system copies border crossing identification data → The system moves the train crossing name to the message border name field
[Copy Border Crossing Port Code]
The system completes location identification data → The system moves the train crossing port code to the message border code field
[Increment Message Counter]
The system finalizes message preparation → The system increments the pre-spawn message counter by 1 to track the total number of messages prepared
[Set GCX101 Spawned Flag to True]
The system begins building the change message → The GCX101 spawned flag is set to true to indicate message processing is active
[Increment Pre-Spawn Index Counter]
The message building process starts → The pre-spawn index counter is incremented by 1 to track the new message
[Set Security Byte to High Values]
Security level needs to be assigned to the message → The security byte is set to high values to indicate maximum security level
[Move CCN Key to Message]
The cargo identification needs to be included in the message → The CCN key from the cargo record is moved to the GCX101 message structure
[Set Canadian Flag to True]
The message destination needs to be specified → The Canadian flag in the message is set to true
[Set Change Message Type Flag]
The message type needs to be specified → The change flag in the GCX101 message is set to true
[Move Train Crossing Name to Border Name]
Location identification needs to be included in the message → The train crossing name is moved to the border name field in the message
[Move Train Crossing Port to Border Code]
Port identification needs to be included in the message → The train crossing port code is moved to the border code field in the message
[Set GCX101 Spawned Flag to True]
The system begins building a diversion message → The GCX101 spawned flag is set to true to indicate message processing is active
[Increment Pre-Spawn Index Counter]
The system needs to track multiple diversion messages → The pre-spawn index counter is incremented by 1
[Set Security Byte to High Values]
Security level needs to be assigned to the message → The security byte is set to high values to ensure maximum security clearance
[Move CCN Key to Message]
The diversion message is being populated with cargo information → The CCN key is moved to the diversion message structure
[Set Message Type to Canadian]
The message type needs to be specified → The message type is set to Canadian to indicate Canadian border processing
[Set Message Type to Diversion]
The specific message category is being assigned → The message type is set to diversion to indicate route change processing
[Move Train Crossing Name to Border Name]
The border name field needs to be populated → The train crossing name is moved to the border name field in the message
[Move Train Crossing Port to Border Code]
The border code field needs to be populated → The train crossing port code is moved to the border code field in the message
[Retrieve FWSWRWR Segment]
The system queries the FWSWRWR database segment → Retrieve the waybill relationship record that links flat cars to containers
[Get FWSWREQ Segment for Container Details]
The system queries the FWSWREQ database segment → Retrieve the container equipment record containing detailed container information
[Set Container Not Found Message]
No container relationship is found for the given root key → Set message eleven indicating container relationship not found and add to report
[Is this a Message Line?]
The system checks if the line contains a message → The system identifies whether this is a message line requiring categorization
[Type 28 Message?]
The message type indicator equals 28 → The system routes this message for pre-spawn count processing instead of regular error count
[Add 1 to Pre-Spawn Count]
The system processes the special message type → The pre-spawn count is incremented by 1
[Warning Message?]
The system checks the message warning indicator → The system determines if this is a warning message requiring warning processing
[Informational Message?]
The system checks the message informational indicator → The system determines if this is an informational message requiring info processing
[Add 1 to Info Count]
The system processes the informational message → The information count is incremented by 1
[Request Message?]
The system checks if the message has a request indicator → The system determines if this message requires request error count processing
[Increment Report Index]
The system advances to the next report line → The report index is incremented by 1
[Set Maximum Reached Message]
The system needs to indicate capacity exceeded → Message type 9 is set for the current report line
[Any Messages to Spawn?]
The system checks for messages requiring spawn processing → If pre-spawn messages exist, process each spawn message, otherwise complete report processing
[Process Each Spawn Message]
The system processes spawn messages → Each pre-spawn input is moved to the processing structure and spawn processing is performed
[Send GCT1011E Message to Customs]
The system processes the spawn message → The GCT1011E message is sent to customs via CIMS and WRITMSGL calls
[Any Messages to Spawn?]
The system checks for spawn processing requirements → If pre-spawn messages exist, review each report line for message type conversion, otherwise complete report processing
[Review Each Report Line]
The system reviews report lines → Each report line from 1 to last line is examined for message type indicators
[Is Message Type 28?]
The system checks the message type indicator → If message type is 28, convert to message type 19 and increment error count, otherwise continue to next line
[Convert to Message Type 19]
The system processes the message conversion → Message type 28 is converted to message type 19
[Check Report Status]
The system checks if there are any errors in the report → The system determines whether to proceed with spawning customs messages or convert error messages
[Pre-spawn Messages Exist?]
The system checks if PRE-NO-SPAWN condition is false → If pre-spawn messages exist, process them for customs notification, otherwise complete spawn process
[Loop Through Pre-spawn Messages]
The system processes messages from index 1 to PRE-IDX → Each message in the queue is processed sequentially for customs notification
[Prepare GCT1011E Message Structure]
The system moves WS-GCX101-INPUT data to GCX101-INPUT structure → The message structure is prepared for customs system processing
[Send Message to Customs via CIMS]
The system calls CIMS with CHNG function and ALT-PCB → The message is sent to the customs system for processing
[Write Message Log Entry]
The system calls WRITMSGL with message details → The message transmission is logged with message code, content, length and module name
[Purge Message Queue]
The system calls CIMS with PURG function → The message queue is purged to prepare for next message
[More Messages to Send?]
The system checks if SPN-IDX is less than or equal to PRE-IDX → If more messages exist, continue processing, otherwise proceed to update error count
[Prepare GCT1011E Message Structure]
The system needs to send a message to customs → The system moves the prepared input data to the GCT1011E message structure
[Clear Accept Status]
The system prepares to initialize communication → The system clears the accept status to ensure clean communication channel
[Call WRITMSGL to Write Message]
The system needs to transmit the message to customs → The system calls WRITMSGL with message code, content, length and module name to write the message to customs queue
[Call CIMS to Purge Message Queue]
The message transmission is complete → The system calls CIMS with PURG function to purge the communication channel and clean up resources
[Move GCX101 Input Data to GCT1011E Message]
The system needs to notify customs of cargo status changes → The GCX101 input data must be moved to the GCT1011E message structure to prepare for customs transmission
[Clear Accept Status]
The message initialization process begins → The accept status field must be cleared to spaces to indicate a fresh transaction state
[Call CIMS with CHNG Function]
The message has been prepared and status cleared → The CIMS system must be called with CHNG function, communication control block, and alternate PCB to initiate message processing
[Message Ready for Processing]
The message transmission is complete → The CIMS system must be called with PURG function and alternate PCB to purge the message transaction and release system resources
[Move GCX101-INPUT to GCT1011E-MSG]
The system needs to format the message for transmission → The GCX101 input data should be moved to the GCT1011E message structure
[Clear Accept Status]
The system prepares to send the message → The accept status should be cleared to spaces to initialize communication state
[Call CIMS with CHNG Function]
The system initiates message processing → A CIMS change transaction should be started using the alternate PCB
[Call WRITMSGL to Write Message]
The system needs to transmit the message to customs → The WRITMSGL service should be called with message code, message text, message length, and module name
[Call CIMS with PURG Function]
The message processing is complete → A CIMS purge transaction should be executed to commit the message
[Are there messages to spawn?]
The system checks for available pre-spawn messages → The system determines whether to proceed with message conversion logic based on spawn message availability
[Loop through all report lines]
The system processes each report line sequentially → Each report line is evaluated for message type conversion requirements
[Convert message type 28 to message type 19 Warning]
The system performs error message conversion during error handling → The message type 28 is converted to message type 19 warning status
[Set MERLIN Message Parameters]
The system prepares MERLIN message parameters → The from user code is set to OM01247, to user code is set to OM01247, and destination filename is set to REQUEST
[Build Message Subject with Train and Timestamp]
The system builds the message subject → The subject includes ACF2 user ID, train number, year, month, day, hour, and minute from system timestamp
[Call MERLIN Messaging System]
The system establishes MERLIN connection → CCISCOM utility is called with CCCOM and ISCOM parameters to establish messaging connection
[Send Report Table via EMCSEND2]
The system transmits the report → EMCSEND2 utility is called with from user code, destination filename, to user code, copy user code, subject, keywords, report table, return status flag, segment numbers, and item type parameters
[Purge Message Queue]
The system completes MERLIN communication → ISCCCOM utility is called with ISCOM and CCCOM parameters, accept status is initialized, and CIMS is called with PURG function to purge the alternate PCB message queue
[System Abend - Send Failed]
The system detects transmission failure → The abend message is set to 'SEND TO MERLIN FAILED' and system abend procedure is performed
[Get Current User ID from System]
The system processes the message subject creation → The current ACF2 user ID is extracted from the system control block and assigned to the message subject
[Extract Train Number from Input]
The system builds the message subject → The train number is extracted from the input parameters and assigned to the message subject
[Extract Year Component]
The system processes the date components → The current year is extracted from the system control block and assigned to the message subject
[Extract Month Component]
The system processes the date components → The current month is extracted from the system control block and assigned to the message subject
[Extract Day Component]
The system processes the date components → The current day is extracted from the system control block and assigned to the message subject
[Extract Hour Component]
The system processes the time components → The current hour is extracted from the system control block and assigned to the message subject
[Extract Minute Component]
The system processes the time components → The current minute is extracted from the system control block and assigned to the message subject
[Combine Train and Timestamp into Subject]
The system creates the final message subject → All components are combined into the MERLIN-SUBJECT field for the customs notification message
[Extract Year from System Date]
Preparing to send a report to customs system → The year component from machine date is extracted and stored for message subject formatting
[Extract Month from System Date]
Preparing to send a report to customs system → The month component from machine date is extracted and stored for message subject formatting
[Extract Day from System Date]
Preparing to send a report to customs system → The day component from machine date is extracted and stored for message subject formatting
[Extract Hour from System Time]
Preparing to send a report to customs system → The hour component from machine time is extracted and stored for message subject formatting
[Extract Minutes from System Time]
Preparing to send a report to customs system → The minutes component from machine time is extracted and stored for message subject formatting
[Format Time Components for Message Subject]
Creating the complete message subject for customs notification → All components are formatted into the MERLIN-SUBJECT field for transmission to customs system
[Check Information Message Count]
The system checks if any informational messages were generated during processing → If informational message count is greater than zero, set return status to NO-WAYBILL and terminate processing
[Set Return Status to OK]
The system determines that processing completed without issues → Set return status to OK indicating successful processing

Structural Validations

[3:Retrieve Waybill Information]
Car ID formatting is successful → Use formatted car ID to retrieve shiproot car waybill, otherwise generate invalid car ID error message
[11:Generate Error Messages]
Detour manifest is required AND detour manifest is not found → Set message twenty-seven with detour CCN information
[11:Generate Error Messages]
Waybill is not found AND container is found → Set message ten, otherwise when waybill is not found AND container is not found, set message twelve
[11:Generate Error Messages]
Waybill is found AND no cargo is found AND container is not found AND equipment is not conveying car → Set message fifteen with root key and waybill date
[11:Generate Error Messages]
Cargo status is pending:
error
reject
deleted
→ Set message sixteen, otherwise when user security level is not 'S' AND cargo status is blank OR reject OR error, set message sixteen, otherwise when cargo is linehaul AND status is manual, set message sixteen
[11:Generate Error Messages]
Canadian customs north train ID is not spaces → Set message seventeen
[11:Generate Error Messages]
Cargo is in return transit status AND CCN key starts with '6105E' AND manifest to transport code does not equal train crossing port → Set message twenty-eight and Execute pre-spawn processing for change, otherwise when cargo is not in return transit status AND CCN key starts with '6105E' AND manifest from transport code does not equal train crossing port, set message twenty-eight and Execute pre-spawn processing for diversion
[11:Generate Error Messages]
Pre-spawn processing is initiated → Set spawn status to true, increment pre-index, initialize input record, set security byte to high values, populate CCN key, set Canadian flag, set diversion flag, and populate border name and code from train crossing information
[11:Generate Error Messages]
Pre-spawn processing is initiated → Set spawn status to true, increment pre-index, initialize input record, set security byte to high values, populate CCN key, set Canadian flag, set change flag, and populate border name and code from train crossing information
[23:Handle Error Conditions]
Spawn processing is required → For each report line with message type twenty-eight, convert to message nineteen and increment error count
[Retrieve Waybill for Current Equipment]
Car ID formatting is successful → Use formatted car ID for shiproot car retrieval, otherwise generate invalid car ID error message
[Generate Invalid Car ID Error Message]
The system needs to handle the validation failure → The system moves the error message 'ERR>>>> INVALID CAR ID' to the report line and performs report index addition
[Generate Invalid Car ID Error]
GCCARFM-RC-SUCCESS is not true → Generate error message 'ERR>>>> INVALID CAR ID' in the report line and increment report index
[Handle FWCARGET Error]
FWCARGET returns an error status → The system creates an error message containing FWCARGET parameters and terminates processing
[Check Haulage Right Carrier]
The system checks the haulage right carrier field → If haulage right carrier is empty (spaces), the waybill is accepted; otherwise, additional EDI validation is required
[Check EDI Completion Status]
The system checks the EDI completion status → If EDI completion release flag is 'Y', the waybill is accepted; otherwise, duplicate key validation is performed
[Check for Duplicate Key]
The system compares the current FWBX key feedback with the previously processed key → If the keys match, set waybill as not found to terminate processing; otherwise, continue with previous status date processing
[Exclude EDI Incomplete Records]
The system sets the EDI completeness criteria → Car search excludes records with incomplete EDI data
[EDI Complete Release = 'Y'?]
The system checks the EDI completion release flag → If EDI completion release equals 'Y', the waybill is accepted, otherwise version checking continues
[Generate Invalid Car ID Error Message]
The formatting operation does not return a success status → An error message 'ERR>>>> INVALID CAR ID' is generated and added to the report
[Handle Equipment Classification Error]
The system receives an unsuccessful response from the equipment classification service → The system should create an error message containing the service name and parameters, then Execute system termination procedures
[Generate GCCCARTP Failure Error]
The system processes the failure condition → An error message is constructed with failure details and interface parameters, and system termination is performed
[Generate Message 10: Container Without Waybill]
If waybill validation conditions → Generate message 10 indicating container exists without proper waybill documentation
[Generate Message 12: Car Without Waybill]
If waybill validation conditions → Generate message 12 indicating car exists without proper waybill documentation
[Generate Message 15: No Cargo for Loaded Equipment]
If cargo validation conditions → Generate message 15 indicating no cargo found for loaded equipment AND include the root key and waybill date in the error message
[Generate Message 16: Invalid Cargo Status]
If cargo status validation conditions → Generate message 16 indicating invalid cargo status prevents processing
[Generate Message 17: Cargo Already on Train]
If cargo train assignment conditions → Generate message 17 indicating cargo is already assigned to another train
[Check Status: Pending]
The cargo status is PENDING → Generate message sixteen indicating invalid cargo status
[Check Status: Error]
The cargo status is ERROR → Generate message sixteen indicating invalid cargo status
[Check Status: Reject]
The cargo status is REJECT → Generate message sixteen indicating invalid cargo status
[Check Status: Deleted]
The cargo status is DELETED → Generate message sixteen indicating invalid cargo status
[Check User Security Level]
The cargo status is BLANK or REJECT or ERROR → Generate message sixteen indicating invalid cargo status due to security restrictions
[Check Additional Status Conditions]
The cargo status is MANUAL → Generate message sixteen indicating invalid cargo status
[User Security Level = 'S'?]
The cargo status is BLANK, REJECT, or ERROR → The system should set error message MSG-SIXTEEN to deny access
[Is Cargo Already Attached to Another Train?]
The cargo has a Canadian Customs North Train ID that is not empty spaces → Set Message 17 indicating the cargo is already attached to another train
[Is Cargo Linehaul Type? AND Is Cargo Status Manual?]
The cargo is linehaul type AND the cargo status is manual → Set Message 16 indicating linehaul manual status error
[Manifest TO Transit Code ≠ Train Crossing Port?]
The system compares manifest TO transit code with train crossing port → If manifest TO transit code does not equal train crossing port, set error message 28 and prepare change message for customs
[Manifest FROM Transit Code ≠ Train Crossing Port?]
The system compares manifest FROM transit code with train crossing port → If manifest FROM transit code does not equal train crossing port, set error message 28 and prepare diversion message for customs
[Set Error Message 28 - Transit Code Mismatch]
Either manifest TO or FROM transit code does not match train crossing port → Set message type 28 indicating transit code mismatch error
[Equipment has Cargo Records?]
System checks for associated cargo records → If no cargo records found, generate no cargo message, otherwise continue processing
[Generate Error: Invalid Car ID Format]
System processes the formatting failure → System generates error message 'ERR>>>> INVALID CAR ID' and adds to report
[Status = Pending?]
The cargo status is checked and found to be pending → The system sets error message MSG-SIXTEEN to indicate invalid cargo status
[Status = Error?]
The cargo status is checked and found to be error → The system sets error message MSG-SIXTEEN to indicate invalid cargo status
[Status = Reject?]
The cargo status is checked and found to be reject → The system sets error message MSG-SIXTEEN to indicate invalid cargo status
[Status = Deleted?]
The cargo status is checked and found to be deleted → The system sets error message MSG-SIXTEEN to indicate invalid cargo status
[User Security Level ≠ 'S'?]
The cargo status is blank, reject, or error → The system sets error message MSG-SIXTEEN to indicate invalid cargo status for the user's security level
[Cargo Status Valid - Continue Processing]
The cargo status is manual → The system sets error message MSG-SIXTEEN to indicate invalid cargo status
[Check CDN CUS North Train ID Field]
The system checks the Canadian Customs North Train ID field in the cargo record → If the field is not empty (contains spaces), set message seventeen indicating the cargo is already attached to another train
[Check for linehaul manual manifest status and generate errors if found]
The cargo is found AND the shipment is classified as linehaul type AND the cargo status is set to manual → The system generates error message MSG-SIXTEEN and sets an error flag to indicate the shipment requires manual intervention
[Check Return Status Transit Code]
The manifest TO transit code is compared with the train crossing port → If codes do not match, trigger error message 28 and prepare change message; if codes match, continue normal processing
[Check Non-Return Status Transit Code]
The manifest FROM transit code is compared with the train crossing port → If codes do not match, trigger error message 28 and prepare diversion message; if codes match, continue normal processing
[Check Cargo Status]
The system checks if cargo data has been found and loaded → The system proceeds to transit status validation only if cargo is found, otherwise skips border crossing message preparation
[CCN Key = '6105E'?]
The system checks if the CCN key starts with '6105E' → The system proceeds with Canadian border crossing validation if CCN starts with '6105E', otherwise skips border crossing message preparation
[Container Relationship Found?]
The system checks the query results → If container relationship is found, proceed to retrieve container equipment data, otherwise set container not found message
[Generate Missing Container Relation Error]
No container relation record is found in FWSWRWR database → Set message eleven error flag and add to report index
[Generate System Error - Missing Equipment]
Container equipment details are not found in FWSWREQ database → Generate abend message indicating FWSWRWR segment exists without FWSWREQ segment and Execute system abend
[Error Message?]
The system checks the message error indicator → The system determines if this is an error message requiring error processing
[Add 1 to Error Count]
The system processes the regular error message → The error count is incremented by 1
[Add 1 to Error Count]
The system processes the warning message → The error count is incremented by 1
[Add 1 to Request Error Count]
The system processes the request message → The request error count is incremented by 1
[Add 1 to Request Error Count]
The system processes the capacity exceeded condition → The request error count is incremented by 1
[Any Errors in Report?]
The system checks for errors in the report → If no errors exist, proceed to spawn message processing, otherwise proceed to error handling path
[Set Error Count from Spawn Count]
All spawn messages are completed → The pre-spawn count is moved to the report error count
[Increment Error Count]
The conversion is completed → The report error count is incremented by 1
[Any Errors Found?]
If RPT-NO-ERROR condition is true → If no errors exist, proceed with customs message spawning, otherwise convert error messages to warnings
[Update Error Count with Spawn Count]
The system completes the spawn processing loop → The PRE-SPAWN-CNT is moved to RPT-ERROR-CNT to reflect spawned message count
[Convert Error Messages to Warnings]
The system finds message type 28 in the report lines → Message type 28 is converted to message type 19 and error count is incremented
[Is message type 28 Transit Code Error?]
If the message type indicator for the current report line → The system determines if the message is type 28 requiring conversion to a warning message
[Increment error count by 1]
The system updates error tracking counters → The total error count is incremented by one to reflect the converted message
[Message Send Successful?]
The system checks transmission status → If EMI return status is not successful, the system prepares for abend with 'SEND TO MERLIN FAILED' message
[Check Error Message Count]
The system checks if any error messages were generated during processing → If error message count is greater than zero, set return status to ERRORS, otherwise proceed to success processing
[Set Return Status to ERRORS]
The system determines that errors occurred during processing → Set return status to ERRORS and invoke customs reporting process to send error details to external customs system

Module: GCCADDT 1 Consolidated Epic Story

Epic: GCCADDT Complete EDI Specification Extracted from Legacy

Contains 196 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCADDT EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Database Segments]
Database segment areas need initialization → The EMTZ-ROOT-SEGMENT should be initialized to prepare for database operations
[Initialize Cargo Segment]
The system prepares to query for cargo records → The cargo segment structure is initialized to empty/default values
[Initialize Cargo Segment Structure]
The system needs to retrieve the next cargo record → The cargo segment structure must be initialized to clear any previous data
[Initialize IMS Transaction]
The system needs to send the message to export queue → IMS transaction is initialized with CHNG function and export PCB

Core Acceptance Criteria

[12:Check Bond Requirements]
Bond requirements are checked → Generate message twenty-three AND create IT export special manifest
[13:Validate Waybill Existence]
Waybill validation is performed → Generate message twenty-three AND create US-US detour special manifest
[14:Validate Cargo Export Status]
Export status is validated → Generate message twelve error
[16:Validate Port Codes]
Port codes are validated → Generate message twenty AND create change port special manifest
[18:Process Diversion Cases]
Diversion processing is initiated → Generate message twenty AND create diversion special manifest
[24:Finalize Report Processing]
Report finalization is performed → Set last report line index AND count error messages AND count warning messages AND count information messages AND process any special manifests if no errors exist
[25:Send Report to Customs]
Report transmission is initiated → Set customs user code AND set destination filename to REQUEST AND populate subject with user ID, train, and timestamp AND call EMCSEND2 to transmit report AND generate system error IF transmission fails
[26:Spawn GCX101 Processing]
Manifest spawning is performed → For each special manifest: copy manifest data to message format AND call CIMS to change to export PCB AND call WRITMSGL to write message AND call CIMS to purge export PCB
[27:Return Processing Results]
Results are returned → Return report table and CCN key array IF processing successful OR return error status IF errors occurred OR return no waybill status IF information messages exist
[Call Database Function to Get Next Cargo Record]
The system executes the next cargo retrieval operation → The database function GCCUSIO must be called with GN (Get Next) function to retrieve the next cargo record
[Set TE Bond Found Flag]
The transport record created for immediate transport flag != 'Y' → Set the TE (Transport Export) found flag to true
[Set TR Bond Found Flag]
The transport record created for immediate transport flag != 'Y' → Set the TR (Transport) found flag to true
[Bond Type = 'TR' and Status = 'EXPORT'?, Bond Type = 'TR'? AND Cargo Status = 'EXPORT'? AND Bill as CPRS? AND User Security Level NOT 'S'?]
User security level is not 'S' → Generate export security error message (MSG-TWELVE)
[Transport Export without TR Created?]
Cargo location does not match train crossing port → Generate port change message (MSG-TWENTY) and create CHG-PORT special manifest
[US-CAN-US with Master In-Bond?]
Train crossing port does not match cargo location → Generate port change message (MSG-TWENTY) and create DIVERSION special manifest
[User Security Level = S?]
User security level is not 'S' (supervisor level) → Generate export restriction error message (MSG-TWELVE)
[Determine Bond Type Required]
The cargo has transport code M1201-IMM-TRANSP → Set TR-REQ-FOR-IT flag to indicate transport bond is required for immediate transport
[Determine Bond Type Required]
The cargo has transport code M1201-TRANSP-EXPORT → Set TE-REQ-FOR-TE flag to indicate transport export bond is required
[Determine Bond Type Required]
The cargo has transport code M1109-DEFAULT → Set TR-REQ-FOR-00 flag to indicate transport bond is required for default cargo
[Determine Bond Type Required]
The cargo has transport code M1109-EXPORT → Set TE-REQ-FOR-88 flag to indicate transport export bond is required for export cargo
[Determine Bond Type Required]
The cargo has transport code M1201-US-CAN-US → Set TR-REQ-FOR-TR flag to indicate transport bond is required for US-Canada-US movement
[Generate Message 22: Missing TR Bond for IT Export]
TR bond requirement is set for IT export AND TR bond is not found → Add saved IT line to report AND set message twenty-two flag AND increment report index
[Generate Message 30: Missing TE Bond for TE Export]
TE bond requirement is set for TE export AND TE bond is not found → Add saved IT line to report AND set message thirty flag AND increment report index
[Generate Message 31: Missing TR Bond for Default]
TR bond requirement is set for default processing AND TR bond is not found → Add saved IT line to report AND set message thirty-one flag AND increment report index
[Generate Message 32: Missing TR Bond for TR Type]
TR bond requirement is set for TR type AND TR bond is not found → Add saved IT line to report AND set message thirty-two flag AND increment report index
[Generate Message 33: Missing TE Bond for 88 Export]
TE bond requirement is set for 88 export AND TE bond is not found → Add saved IT line to report AND set message thirty-three flag AND increment report index
[Generate IT Export Message]
The system processes error messages → Set MSG-TWENTY-THREE flag to TRUE AND increment report index AND set WS-GCX101-IT-EXPORT flag to TRUE
[Generate IT Export Message, Generate IT Export Message for IMM-TRANSP, Generate IT Export Message for Default]
The system processes the cargo validation → The system sets MSG-TWENTY-THREE message flag to TRUE and increments report index and sets WS-GCX101-IT-EXPORT flag to TRUE
[Generate Message 23: US-US Detour Required]
The origin country is US AND the destination country is US → Generate message MSG-TWENTY-THREE and create a US-US-DETOUR special manifest
[Generate Message 23: US-US Detour Required]
No cargo is found for the waybill → Set WS-GCX101-US-US-DETOUR flag and Execute special manifest creation with empty CCN, equipment ID, waybill root, and waybill date
[Is User Security Level NOT 'S'?]
User security level is not 'S' (supervisor level) → Generate export status error message (MSG-TWELVE)
[Does Cargo Port NOT Match Train Port?]
Cargo location port does not match train crossing port → Generate diversion message (MSG-TWENTY) AND create special manifest for port change (CHG-PORT)
[US-CAN-US Transit with Release Status?, Immediate Transit without TR?, Default Bond with Release Status?]
System processes the cargo for manifest validation → System sets message twenty-three flag AND adds report index AND sets IT export flag for GCX101 AND creates special manifest
[Transport Export with Port Mismatch?]
System processes the cargo for manifest validation → System sets message twenty flag AND adds report index AND sets port change flag for GCX101 AND creates special manifest
[US-CAN-US with Port Mismatch?]
System processes the cargo for manifest validation → System performs diversion process which sets message twenty flag AND adds report index AND sets diversion flag for GCX101 AND creates special manifest
[Set Diversion Message]
The system processes the diversion requirement → Message type MSG-TWENTY is set for the report indicating port diversion is needed
[Add Message to Report]
The system updates the processing report → The report index is incremented to include the diversion message in the output report
[Set Diversion Message]
The system processes the diversion condition → Set message twenty (MSG-TWENTY) to indicate diversion requirement
[Add Report Line]
The system updates the report → Add report index to include the diversion message in the output report
[Set GCX101 Diversion Flag]
The system prepares for manifest creation → Set WS-GCX101-DIVERSION flag to true to indicate diversion manifest type
[Generate US-to-US Detour Message]
System processes US domestic detour requirement → System sets message twenty-three flag to indicate US-to-US detour situation
[Add Message to Report]
System adds message to report → System increments report index to include the detour message in the output report
[Set US-US-Detour Flag]
System sets processing flags for special manifest creation → System sets US-US-detour flag to true to trigger appropriate manifest generation
[Generate Missing Cargo Message]
Origin country is not 'US':
destination country is not 'US'
→ System sets message fifteen flag to indicate missing cargo situation
[Add Waybill Root Key and Date to Message]
System adds waybill details to the message → System includes waybill root key and waybill date in the message fifteen content for identification purposes
[Set IT Export Type]
The manifest type is being determined as IT export → The system sets GCX101 IT export flag to true, populates equipment ID, waybill number, waybill date, and CCN from cargo
[Execute GCX101 Spawn Process]
The spawn processing is executed for each queued request → The system retrieves each spawn table entry, moves it to message format, and calls CIMS to change to export PCB
[Send Message to Export Queue]
The message is being sent to the export queue → The system calls WRITMSGL to write the message with code, content, length and module name to the export PCB
[Purge Message Queue]
The message processing is complete → The system calls CIMS with purge function to clear the export PCB queue
[Generate Message 23: IT Export Required]
The system processes the cargo validation → Set MSG-TWENTY-THREE message flag AND create IT-EXPORT special manifest request
[Generate Message 23: US-US Detour Required]
The system determines routing requirements for domestic movement → Set MSG-TWENTY-THREE message flag AND create US-US-DETOUR special manifest request
[Generate Message 20: Diversion Required]
The system processes port change requirements → Set MSG-TWENTY message flag AND create CHG-PORT special manifest request
[Generate Message 20: Diversion Required]
The system processes diversion requirements for master in-bond cargo → Execute diversion process to generate MSG-TWENTY and create DIVERSION manifest request
[Cargo Found with TR Created for IT?]
If the cargo movement type codes → Set the appropriate transport requirement flag: IT for immediate transport (M1201-IMM-TRANSP), TE for transport export (M1201-TRANSP-EXPORT), 00 for default (M1109-DEFAULT), 88 for export (M1109-EXPORT), or TR for US-Canada-US (M1201-US-CAN-US)
[US-CAN-US Cargo Released?, Immediate Transport Not Created?, Default Cargo Released?]
The system processes the cargo validation → Generate message twenty-three (IT Export Required) AND create IT export special manifest
[US-to-US Movement?]
The system determines movement is domestic US routing → Generate message twenty-three (US-US Detour) AND create US-US detour special manifest
[Export Cargo Security Issue?]
The system validates user access to export cargo → Generate message twelve (Security Level Error)
[Transport Export Port Change?]
The system validates transport export cargo routing → Generate message twenty (Port Change Required) AND create port change special manifest
[Diversion Required?]
The system validates US-Canada-US cargo routing → Generate message twenty (Diversion Required) AND create diversion special manifest
[Categorize Message Type]
The system categorizes the message type → If message is error type, increment error count OR if message is warning type, increment warning count OR if message is information type, increment information count
[US-CAN-US Cargo with Release Status?, Immediate Transport Cargo?, Default Cargo with Release Status?]
The system processes the cargo for manifest requirements → The system should set message twenty-three, increment report index, set IT export flag, and create special manifest
[Is Cargo US-CAN-US Type?, Is Cargo Default Type?]
The cargo transport record creation flag is not 'Y' AND the cargo status description is 'RELEASE' → Set message twenty-three indicator to true AND create special manifest for IT export processing
[Is Cargo Immediate Transport Type?]
The cargo transport record creation flag is not 'Y' → Set message twenty-three indicator to true AND create special manifest for IT export processing
[Set IT Export Flag to True]
Creating a special manifest → The IT export flag is set to true to classify the manifest type
[Set US-US Detour Message]
The system confirms both origin and destination are within the US → Message twenty-three should be set in the report and the report index should be incremented
[Generate Message 23: US-US Detour Required AND Set GCX101 US-US Detour Flag AND Create Special Manifest for US-US Detour]
The system processes the detour requirement → The system should generate message 23 indicating US-US detour required AND set the GCX101 US-US detour flag AND create a special manifest for US-US detour processing
[Generate Message 15: No Cargo Found for Waybill AND Include Root Key and Waybill Date in Message]
The system processes the no-cargo condition → The system should generate message 15 indicating no cargo found for the waybill AND include the root key and waybill date in the error message
[Set US-US Detour Message]
The system processes the US-US detour scenario → Message twenty-three is set in the report for the current report index
[Set Origin Country to Spaces - Not Found]
Both the origin country and destination country are determined to be 'US' → The system generates message twenty-three, creates a US-US-DETOUR special manifest, and adds it to the report
[Is Spawn Message?]
The message is identified as a spawn message → Skip updating any message type counters and proceed to increment report index
[Warning Message?]
The message is classified as a warning message type → Add 1 to the warning counter
[Information Message?]
The message is classified as an information message type → Add 1 to the information counter
[Increment Report Index]
Message type categorization is complete → Add 1 to the report index
[Set IT Export Flag]
Processing cargo for manifest requirements → Set IT export flag to true AND create IT export manifest
[Set IT Export Flag]
Processing cargo for manifest requirements → Set message twenty-three AND increment report index AND set IT export flag to true AND create IT export manifest
[Set Diversion Flag]
Processing cargo for manifest requirements → Set message twenty AND increment report index AND set diversion flag to true AND create diversion manifest
[Set Port Change Flag]
Processing cargo for manifest requirements → Set message twenty AND increment report index AND set port change flag to true AND create port change manifest
[Set US-US Detour Flag]
Processing cargo for manifest requirements → Set message twenty-three AND increment report index AND set US-US detour flag to true AND create US-US detour manifest
[Process Spawn Messages]
The system processes spawn messages → Execute spawn processing for each request from index 1 to spawn count
[Convert to Port Change Message]
A message line contains a diversion spawn message → Set message nineteen flag and populate station field with train crossing port
[Convert to IT Export Message]
A message line contains an IT export spawn message → Set message eighteen flag for the report line
[Any Info Messages?]
The system checks for informational messages → Return true if info count is greater than zero, otherwise return false
[Set Report Status to NO-WAYBILL]
The system assigns final status → Set report status to NO-WAYBILL
[Set Report Status to OK]
The system assigns final status → Set report status to OK
[Set Email Parameters]
The system prepares email parameters for transmission → The sender code is set to OM01247, recipient code is set to OM01247, destination filename is set to REQUEST, and keywords and copy user code are cleared
[Prepare Message for GCX101]
The message needs to be prepared for transmission → The input data is moved to the GCT1011E message structure
[Write Message to Export Queue]
The message needs to be sent to external system → The message is written to the export queue using WRITMSGL
[Commit IMS Transaction]
The transaction needs to be finalized → IMS transaction is committed using PURG function
[Update Message Types for Failed Spawns]
Spawn processing cannot proceed normally due to errors → The system updates message types for failed spawn processes
[Diversion Message?]
The message is identified as a diversion spawn message → The system sets the appropriate diversion error message type
[IT Export Message?]
The message is identified as an IT export spawn message → The system sets the appropriate IT export error message type
[Generate Train Arrival Warning Message]
The train has arrived AND the first report line contains no US-CCN data → Generate message twenty-six warning and add it to the report
[Count Report Statistics]
The system needs to finalize report statistics → Set the last report line index and process report wrap-up including spawn message handling
[Set Success Return Code]
The processing is successful → Set the return status to OK

Structural Validations

[11:Validate Cargo Status]
Cargo type is immediate transport → Set TR required for IT flag to true
[13:Validate Waybill Existence]
Waybill is not found → Generate message ten error
[13:Validate Waybill Existence]
Waybill validation is performed → Generate message fifteen with waybill root key and date
[14:Validate Cargo Export Status]
Export status is validated → Generate message seventeen error
[14:Validate Cargo Export Status]
Export status is validated → Generate message sixteen error
[15:Validate Train Attachment]
Train attachment is validated → Generate message twenty-five error
[22:Validate Train Arrival Status]
Train arrival status is validated → Generate message twenty-six error
[23:Generate Error Messages]
Error message generation is performed → Generate message twenty-two IF TR required for IT but not found OR generate message thirty IF TE required for TE but not found OR generate message thirty-one IF TR required for default but not found OR generate message thirty-two IF TR required for TR but not found OR generate message thirty-three IF TE required for 88 but not found
[Errors Found?]
Final result is determined → Set no waybill status IF information messages exist OR set error status and send to customs IF error messages exist OR set OK status and return report data IF no errors exist
[Generate TR Bond Missing Error]
TR bond is required for IT but TR is not found → Message twenty-two error is generated and TR requirement flag is set
[Generate TE Bond Missing Error]
TE bond is required for TE but TE is not found → Message thirty error is generated and TE requirement flag is set
[Generate Bond Requirement Errors]
TR bond is required for default transport but TR is not found → Message thirty-one error is generated
[Generate Bond Requirement Errors]
TR bond is required for US-Canada-US transport but TR is not found → Message thirty-two error is generated
[Generate Bond Requirement Errors]
TE bond is required for export transport but TE is not found → Message thirty-three error is generated
[Generate Invalid Car ID Error]
The system detects the formatting failure → An 'INVALID CAR ID' error message is generated and added to the report
[Process Error - Service Failed]
Service failure needs to be handled → Error message is constructed with service parameters and error processing is initiated to terminate the operation
[Bond Type = 'TE' and Vessel Name starts with 'T'?]
Cargo has bond type 'TE' and vessel name starts with 'T' → Generate bond vessel error message (MSG-SEVENTEEN)
[Bond Type ≠ 'TE' or 'MT' and Vessel ≠ 'TRAIN'?]
Cargo bond type is not 'TE' and not 'MT' and vessel name is not 'TRAIN' → Generate bond type error message (MSG-SEVENTEEN)
[Cargo Status = Pending/Deleted/Error?]
Cargo status is pending, deleted, or error → Generate cargo status error message (MSG-SIXTEEN)
[Bond Type = 'MT' and Vessel ≠ 'TRAIN'?]
Vessel name is not 'TRAIN' and not spaces and train crossing port does not match cargo location → Generate port mismatch error message (MSG-TWENTY-FIVE)
[Check if bond type matches vessel requirements and generate appropriate error messages]
The 23rd character of the vessel name is 'T' → Generate message seventeen indicating invalid vessel for TE bond type
[Check if bond type matches vessel requirements and generate appropriate error messages]
The vessel name != 'TRAIN' → Generate message seventeen indicating invalid vessel for bond type
[Check if bond type matches vessel requirements and generate appropriate error messages]
The train crossing port does not equal the cargo location ID → Generate message twenty-five indicating port mismatch for MT bond
[Is Bond Type = 'TE'? and Does Vessel Name Start with 'T'?]
Vessel name starts with 'T' (23rd character position) → Set message 17 flag to indicate invalid vessel configuration for TE bond
[Is Bond Type NOT 'TE' or 'MT'? and Is Vessel Name NOT 'TRAIN'?]
Vessel name != 'TRAIN' → Set message 17 flag to indicate invalid vessel name for the bond type
[Cargo Status = Pending?]
Cargo status is pending (RT10-CPCARGO-PENDING condition is true) → Generate cargo status error message (MSG-SIXTEEN)
[Cargo Status = Deleted?]
Cargo status is deleted (RT10-CPCARGO-DELETED condition is true) → Generate cargo status error message (MSG-SIXTEEN)
[Cargo Status = Error?]
Cargo status is error (RT10-CPCARGO-ERROR condition is true) → Generate cargo status error message (MSG-SIXTEEN)
[Cargo Found?]
Cargo status validation is required → The system should verify that cargo data exists before proceeding with status checks
[Status = Pending?]
The cargo status is checked against pending state → The system should identify cargo with pending status for error message generation
[Status = Deleted?]
The cargo status is checked against deleted state → The system should identify cargo with deleted status for error message generation
[Status = Error?]
The cargo status is checked against error state → The system should identify cargo with error status for error message generation
[Set Message Sixteen - Status Error]
An invalid cargo status condition is detected → The system should set message sixteen to indicate the cargo status error
[Bond Type = MT?]
Vessel name is not TRAIN and not SPACES and train crossing port does not match cargo location ID → Generate port mismatch error message (MSG-TWENTY-FIVE)
[Bond Type = TE and Transport Export?]
Cargo location does not match train crossing port → Generate diversion message (MSG-TWENTY) and create change port manifest
[Bond Type = 'TE'? AND Vessel Name Contains 'T'?]
The vessel name contains 'T' in position 23 → Generate bond type error message (MSG-SEVENTEEN)
[Bond Type NOT 'TE' or 'MT'? AND Vessel Name NOT 'TRAIN'?]
The vessel name != 'TRAIN' → Generate bond type error message (MSG-SEVENTEEN)
[Bond Type = 'MT'? AND Vessel Name NOT 'TRAIN' or SPACES? AND Train Port ≠ Cargo Port?]
Train crossing port does not equal cargo location port → Generate port mismatch error message (MSG-TWENTY-FIVE)
[TR Required but Not Found? - Generate Missing TR Bond Error]
Processing bond requirements validation → Add saved IT line to report and generate MSG-TWENTY-TWO error message
[TE Required but Not Found? - Generate Missing TE Bond Error]
Processing bond requirements validation → Add saved IT line to report and generate MSG-THIRTY error message
[TR Required but Not Found? - Generate Missing TR Bond Error]
Processing bond requirements validation → Add saved IT line to report and generate MSG-THIRTY-ONE error message
[TR Required but Not Found? - Generate Missing TR Bond Error]
Processing bond requirements validation → Add saved IT line to report and generate MSG-THIRTY-TWO error message
[TE Required but Not Found? - Generate Missing TE Bond Error]
Processing bond requirements validation → Add saved IT line to report and generate MSG-THIRTY-THREE error message
[Generate Bond Vessel Error]
The vessel name starts with 'T' (GCUSRT-M1005-VESSEL-NAME (23:1) = 'T') → The system generates message seventeen error (MSG-SEVENTEEN)
[Generate Bond Vessel Error]
The vessel name != 'TRAIN' (GCUSRT-M1005-VESSEL-NAME NOT = 'TRAIN') → The system generates message seventeen error (MSG-SEVENTEEN)
[Generate TR Bond Export Error]
The user security level is not 'S' (GCLADDIF-USER-SECURITY-LEVEL NOT = 'S') → The system generates message twelve error (MSG-TWELVE)
[Generate MT Bond Port Error]
The train crossing port does not match the cargo location (GCLADDIF-TRAIN-CROSSING-PORT NOT = GCUSRT-P401-LOCATION-ID) → The system generates message twenty-five error (MSG-TWENTY-FIVE)
[Set Bond Vessel Error Message]
The 23rd character of vessel name is 'T' → Set bond vessel error message (MSG-SEVENTEEN)
[Set Bond Vessel Error Message]
Vessel name != 'TRAIN' → Set bond vessel error message (MSG-SEVENTEEN)
[Generate MSG-TWENTY-TWO Error]
Transport bond was not found (TR-NOT-FOUND is true) → Generate MSG-TWENTY-TWO error message and add saved line to report
[Generate MSG-THIRTY Error]
Transport export bond was not found (TE-NOT-FOUND is true) → Generate MSG-THIRTY error message and add saved line to report
[Generate MSG-THIRTY-ONE Error]
Transport bond was not found (TR-NOT-FOUND is true) → Generate MSG-THIRTY-ONE error message and add saved line to report
[Generate MSG-THIRTY-TWO Error]
Transport bond was not found (TR-NOT-FOUND is true) → Generate MSG-THIRTY-TWO error message and add saved line to report
[Generate MSG-THIRTY-THREE Error]
Transport export bond was not found (TE-NOT-FOUND is true) → Generate MSG-THIRTY-THREE error message and add saved line to report
[Generate Message 10: Container without Waybill]
The waybill is not found AND the container is found → Generate message MSG-TEN indicating container exists without waybill
[Generate Message 15: No Cargo Found for Waybill]
The movement is not US to US domestic (origin country is not US:
destination country is not US)
→ Generate message MSG-FIFTEEN with waybill root key and date
[Generate Message 15: Idler Car with No Cargo]
The idler indicator is not spaces (indicating an idler car) → Generate message MSG-FIFTEEN with waybill root key and date
[Does Train Port NOT Match Cargo Port?]
Train crossing port does not match cargo location port → Generate port mismatch error message (MSG-TWENTY-FIVE)
[Does Train Crossing Port NOT Match Cargo Location?]
The train crossing port does not match the cargo's P401 location ID → Generate port mismatch error message (MSG-TWENTY-FIVE)
[Check if train has arrived and US-CCN is required for additions]
The train has arrived AND the first US-CCN entry in the report is empty (spaces) → Generate error message MSG-TWENTY-SIX indicating train arrived but no US-CCN available for additions AND add the error to the report
[Generate Message 10: Container Waybill Missing]
The system validates waybill and container relationship → Set MSG-TEN message flag to indicate container waybill is missing
[Generate Message 15: No Cargo Found]
The system validates cargo existence for the waybill → Set MSG-FIFTEEN message flag AND populate message with ROOT-KEY and WB-DATE
[Generate Message 17: Invalid Bond Type]
The system validates transport bond type compatibility → Set MSG-SEVENTEEN message flag to indicate invalid bond type for train transport
[Generate Message 16: Cargo Status Error]
The system validates cargo processing status → Set MSG-SIXTEEN message flag to indicate cargo status error
[Generate Message 12: Security Level Error]
The system validates user authorization for export cargo processing → Set MSG-TWELVE message flag to indicate insufficient security level
[Generate Message 25: Port Mismatch]
The system validates port location for MT transport → Set MSG-TWENTY-FIVE message flag to indicate port mismatch
[Generate Message 1: No Waybill Found]
The system searches for waybill and container information → Set MSG-ONE message flag to indicate no waybill found for the equipment
[No Waybill for Container?]
The system validates waybill and container relationship → Generate message ten (Container Waybill Missing)
[No Cargo for Loaded Equipment?]
The system processes cargo validation for loaded equipment → Generate message fifteen (No Cargo Found) with waybill root key and date
[Invalid Bond Type for Vessel?]
The system validates bond type and vessel name combination → Generate message seventeen (Invalid Bond/Vessel)
[Cargo Status Error?]
The system validates cargo processing status → Generate message sixteen (Cargo Status Error)
[Port Mismatch for MT Bond?]
The system validates MT bond cargo routing → Generate message twenty-five (Port Mismatch)
[Set Origin Country to Spaces - Not Found]
Either the origin country or destination country is not 'US' → The system generates message fifteen with the waybill root key and date in the report
[Error Message?]
The message is classified as an error message type → Add 1 to the error counter
[Report Maximum Reached?]
The report index reaches the maximum allowed report lines → Set message nine indicating maximum report capacity reached
[Train Arrived and No US-CCN Found?]
Train arrival flag is set to true AND the first report line US-CCN field is empty → Add message twenty-six warning to the report and increment report index
[Email Send Successful?]
If the email return status → If transmission failed, the system processes an email send error, otherwise continues with normal processing
[Set Diversion Error Message]
The message type needs to be updated → The system sets MSG-NINETEEN with the train crossing port information
[Set IT Export Error Message]
The message type needs to be updated → The system sets MSG-EIGHTEEN for the IT export error condition
[Set Error Return Code]
The report error count is greater than zero → Set the return status to ERRORS AND send the report to customs identification

Module: GCCCCARR 1 Consolidated Epic Story

Epic: GCCCCARR Complete EDI Specification Extracted from Legacy

Contains 24 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCCARR EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Arrival Message Structure]
The system begins preparing the arrival message → The GCX148 input structure is initialized to clear any previous data

Core Acceptance Criteria

[7:Send Arrival Message]
The system sends the arrival message → The system should clear acceptance status, call CIMS to send the message, write message log entry, and purge the message from CIMS queue
[Set Security Parameters]
Security parameters need to be established → The security byte is set to HIGH-VALUE to indicate maximum security level
[Populate CCN Key]
The arrival message is being populated with identification data → The CCN key is moved to the train or US CCN field in the message structure
[Populate CCN Key]
Cargo type classification is required → The cargo type indicator is set to CA-CARGO to designate Canadian cargo
[Populate Action Code]
The arrival message requires action specification → The action code is moved from input to the message action code field
[Populate Port Code]
The arrival message requires location specification → The port code is moved from input to the message port code field
[Populate Date/Time]
The arrival message requires timestamp information → The date and time is moved from input to the message date-time field
[Prepare Message for Transmission]
The message needs to be prepared for external system transmission → The input structure is moved to the GCT1481E message field for transmission
[Copy Arrival Data to Message Format]
The system prepares the arrival message for processing → The message structure is initialized with high security level, cargo type set to Canadian cargo, and all arrival data is copied to appropriate message fields
[Send Message to GCX148 System]
The system sends the message to the cargo management system → The message is submitted to CIMS using the alternative PCB communication path with cleared acceptance status
[Write Message Log Entry]
The system processes the message submission → A log entry is written containing the message code, message content, message length, and module name
[Purge IMS Communication]
The system completes message processing → The IMS communication is purged using the alternative PCB to release system resources

Structural Validations

[2:Validate CCN Key]
The CCN key field is blank or contains only spaces → The system should Throw error: 'GCWCCAR-CCN-KEY IS BLANK' and invoke error handling
[3:Validate Action Code]
The action code field is blank or contains only spaces → The system should Throw error: 'GCWCCAR-ACTION-CODE IS BLANK' and invoke error handling
[4:Validate Port Code]
The port code field is blank or contains only spaces → The system should Throw error: 'GCWCCAR-PORT-CODE IS BLANK' and invoke error handling
[Check if Canada Customs Number key is provided and not blank]
The CCN key field is blank or contains only spaces → The system should Throw error: indicating the CCN key is blank and invoke error handling
[Set Error Message: 'GCWCCAR-CCN-KEY IS BLANK']
The validation check detects the missing CCN key → The system should set the error message to 'GCWCCAR-CCN-KEY IS BLANK'
[Call Error Handler]
The error condition needs to be processed → The system should call the error handler routine to manage the validation failure
[Check if action code is provided and not blank]
The action code field is blank or contains only spaces → The system should set an error message indicating the action code is blank and invoke error handling
[Set Error Message: 'Action Code is Blank']
The validation check fails → The system should set the error message to 'GCWCCAR-ACTION-CODE IS BLANK'
[Call Error Handler]
The error condition is detected → The system should call the error handling routine 'CERR' with the common communication area
[Check if port code is provided and not blank]
The port code field is blank or contains only spaces → The system should set an error message 'GCWCCAR-PORT-CODE IS BLANK' and invoke error handling
[Call Error Handler]
The error message has been set for the port code validation failure → The system should call the error handling routine 'CERR' with the common communication area

Module: GCCINARR 1 Consolidated Epic Story

Epic: GCCINARR Complete EDI Specification Extracted from Legacy

Contains 223 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCINARR EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Communication Areas]
The initialization process begins → All communication areas (ISCOM, GCSCCRT, GCSTBRT segments) and working storage areas are cleared to spaces or initial values
[Initialize Search Parameters]
The system prepares to search the CM table → All search parameters, table keys, flags, and segment areas are cleared and initialized to empty values
[Initialize GCX148 Input Parameters]
The system prepares to send the transaction message → All GCX148 input parameters are initialized to blank values
[Initialize Database Search Parameters]
The system prepares for database search → Clear all search keys, flags, and segment areas to ensure clean search parameters
[Initialize Email Parameters]
The email report generation process starts → All email parameters are initialized to spaces or zero values including sender, recipients, subject, text, keywords, and message counters
[Initialize Email Parameters]
Email setup process begins → All email parameters including sender, recipients, subject, text, and message counters are cleared to spaces or zero
[Initialize Email Parameters]
The report generation process starts → All email parameters are initialized to spaces or zero and message counter is reset
[Initialize Container Exception Message]
Exception message storage needs to be initialized → The container exception message field is set to spaces in the arrival report array
[Initialize Database Status and Segment]
The system prepares for database access → The system initializes the database status code and relationship segment variables to clear any previous values
[Initialize Email Parameters]
Email distribution setup begins → All email parameters are cleared and set to default values including sender, recipients, subject, and message content
[Initialize Email Parameters]
Email parameter initialization is triggered → All email fields are cleared including sender, recipients, copy recipients, subject, keywords, text content, item sequences, item type, and message counter is reset to zero

Core Acceptance Criteria

[28:CLV Report Generation]
Report generation is initiated → Create report with header information, process results for each equipment item, include container details, and handle access/validation error messages
[29:AEI Email Report Generation]
Email report generation is initiated → Create email with exception details, send to up to 5 Merlin email addresses, include equipment and container information with exception messages, and send to backup address if primary distribution fails
[Retrieve User Permission Segment]
The system needs to access the user's permission details → The system moves the retrieved table segment data to the user security segment structure for permission evaluation
[User has Cargo Arrival Access?]
The system checks the user's cargo arrival access level → If the user has super user access or standard user access for cargo arrival, set user has access flag, otherwise set no user access flag
[Set No User Access Flag - No Record]
The system handles the missing user record condition → The system clears the user security segment and sets the no user access flag to true
[Terminal Record Found?]
The database operation completes successfully and returns terminal data → The terminal segment information is stored and the terminal found status is maintained
[Set Terminal Not Found Status]
The database operation fails to find a matching terminal record → The terminal segment is cleared and terminal not found status is set
[Extract Sub-location Code from MC Record]
The system processes the MC table record data → The sub-location code is extracted from the MC segment and the Canadian customs code (positions 2-4) is extracted as the port code for GCX148 processing
[Set MC Table Match Flag to FALSE]
No matching MC table entry is found → MC table match flag is set to FALSE, don't process for CLV flag is set to TRUE, and MC segment data is cleared to spaces
[Mark Cargo as Found and Eligible for Arrival]
The system determines cargo processing eligibility → The cargo is marked as found, the cargo report segment is saved as previous, the waybill date index is saved, and the cargo is marked as eligible for arrival processing
[Save Cargo Record as Latest Candidate]
The system identifies this as the most recent cargo record → The entire cargo record segment should be saved as the previous cargo record for potential arrival processing
[34:Container Information Parsing - Parse container IDs and waybill info]
The system processes each container's information → The system stores container initial, number, and waybill information in the container table, replacing spaces with zeroes in waybill fields, and increments the container counter
[Search First Cargo Record by Waybill]
The system searches for the first cargo record by waybill index → If a cargo record is found, it is loaded into the cargo report segment, otherwise the no more cargo flag is set
[Search Next Cargo Record by Waybill]
The system searches for the next cargo record by waybill index → If another cargo record is found, it is loaded into the cargo report segment, otherwise the no more cargo flag is set
[All Ports Processing?]
The cargo is evaluated for arrival processing and the cargo is not customer bonded → The system sets the cargo as needing arrival processing without checking sub-location matching rules
[Retrieve MC Sub-location Code from Station Validation]
The system needs to validate cargo location eligibility → Retrieve the MC sub-location code from the GCSTBRT MC segment for comparison with cargo sub-location
[Skip Cargo - CSA/Transit/Return/Export Rules]
The cargo in-transit status is 'Return':
the cargo in-transit status is 'Transit'
→ The system skips cargo arrival processing and displays appropriate message
[Skip Cargo - CSA/Transit/Return/Export Rules]
The cargo is identified as US-Canada export cargo → The system skips cargo arrival processing and displays appropriate message
[Skip Cargo - CSA/Transit/Return/Export Rules]
The cargo in-transit status is 'Empty' AND the cargo origin country != 'CA' → The system skips cargo arrival processing and displays appropriate message
[Skip Cargo - Bonded at FPOA]
The CSA indicator is ON → The system skips cargo arrival processing and displays message 'CARGO BONDED AT FPOA'
[Skip Cargo - Already Arrived]
The manifest from-station name equals the manifest to-station name AND the manifest to-station name != 'IIS-A6' → The system skips cargo arrival processing and displays message 'CARGO ALREADY ARRIVED'
[Skip Arrival - Return Cargo]
The cargo in-transit status is 'RETURN' → The system skips arrival processing and displays 'CSA CARGO, DO NOT ARRIVE' message
[Skip Arrival - Transit Cargo]
The cargo in-transit status is 'TRANSIT' → The system skips arrival processing and displays 'CSA CARGO, DO NOT ARRIVE' message
[Skip Arrival - Transit Cargo]
The cargo is marked as US-CA export cargo → The system skips arrival processing and displays 'CSA CARGO, DO NOT ARRIVE' message
[Skip Arrival - Empty Non-CA Origin]
The cargo in-transit status is 'EMPTY' AND the origin country != 'CA' → The system skips arrival processing and displays 'CSA CARGO, DO NOT ARRIVE' message
[Check Return Status]
The cargo has in-transit status of 'Return' → The cargo is marked as CSA cargo and excluded from arrival processing with appropriate message displayed
[Check Transit Status]
The cargo has in-transit status of 'Transit' → The cargo is marked as CSA cargo and excluded from arrival processing with appropriate message displayed
[Check US-CA Export Flag]
The cargo is flagged as US-CA export cargo → The cargo is marked as CSA cargo and excluded from arrival processing with appropriate message displayed
[Check Empty Status and Origin Country]
The cargo has in-transit status of 'Empty' AND the origin country != 'CA' → The cargo is marked as CSA cargo and excluded from arrival processing with appropriate message displayed
[Display CSA Cargo Message]
The system processes the CSA cargo determination → An informational message 'CSA CARGO, DO NOT ARRIVE' is displayed to indicate the cargo exclusion reason
[Retrieve destination station from CM table]
The destination station lookup is performed in the CM table → Extract the port code from the CM segment for the destination station
[Retrieve manifest station from MC table]
The manifest to-station lookup is performed in the MC table → Extract the Canadian customs code (positions 2-4) from the MC segment as the port code
[Extract Station Segment Data]
Processing the retrieved station information → The system should move the complete table segment data to the CM station segment structure for access to station details
[Assign CM Port Code to Arrival Transaction]
Finalizing the port code for the arrival transaction → The system should move the CM station port code to the arrival transaction port code field
[Retrieve Station Segment Data]
The system processes the query result → The station segment data is moved from the database result to the CM segment structure
[Extract Port Code from Station Record]
The system extracts port information from the station record → The port code is obtained from the CM station segment for further processing
[Extract Station Segment Data]
The system processes the retrieved station record → The complete station segment data is extracted and moved to the MC segment working area
[Extract Canadian Customs Code from Position 2-4]
The system processes the Canadian customs code field → Characters in positions 2 through 4 of the Canadian customs code are extracted and assigned as the port code
[Retrieve MC Station Segment Data]
A matching MC station record is found → The system retrieves and stores the complete MC station segment data from the database result
[Extract Canadian Customs Code]
Canadian customs code extraction is performed → The system extracts characters 2 through 5 from the MC station Canadian customs code field and stores it as the port code
[Clear Station Segment Data]
No matching MC station record is found → The system clears the MC station segment data to ensure no invalid data remains
[Set Table Match Flag to False]
Table match status is updated → The system sets the MC table match flag to false to indicate lookup failure
[Set NOT-ARRIVED-BORDER status]
The border arrival date validation fails → Set the cargo status to NOT-ARRIVED-BORDER and assign exception message REP-MSG-5
[Set NOT-ACK-AT-BORDER status]
The border acknowledgment validation fails → Set the cargo status to NOT-ACK-AT-BORDER and assign exception message REP-MSG-9
[Master Manifest CCN Retrieval]
The system needs to process the master manifest → The system should retrieve the master CCN record from GCCC database using the master manifest CCN key, and if successful load the master cargo segment, otherwise set ignore cargo flag
[Has border arrival date?]
The system checks if the border arrival date is SPACES (empty) → The system should set NOT-ARRIVED-BORDER status and generate border arrival exception message if date is empty, otherwise proceed to border acknowledgment validation
[Is border arrival acknowledged?]
The system checks if the border arrival acknowledgment flag is not set → The system should set NOT-ACK-AT-BORDER status and generate border acknowledgment exception message if not acknowledged, otherwise continue with normal cargo processing
[Generate border arrival exception message]
The system sets NOT-ARRIVED-BORDER status → The system should generate and store the appropriate border arrival exception message for reporting
[Generate border acknowledgment exception message]
The system sets NOT-ACK-AT-BORDER status → The system should generate and store the appropriate border acknowledgment exception message for reporting
[Calculate Port Code from Destination Station]
The system needs to determine the port code for arrival processing → The system should look up the cargo destination station number in the CM table and extract the port code from the CM segment
[Send Transaction to Message Queue]
The system executes the cargo arrival transaction → The system should call CIMS to change message status, call WRITMSGL to write the transaction message, and call CIMS to purge the message queue
[Prepare Transaction Message]
Message preparation is required → Transaction input parameters are formatted into the message structure for queue transmission
[Send Transaction to Message Queue]
Transaction needs to be submitted for processing → Message is sent to CIMS processing queue, written to message log, and queue is purged
[CM Station Table Lookup - Retrieve destination station details from CM table and extract port code for cargo arrival processing]
The system performs CM station table lookup using the cargo destination station number → The system retrieves the CM station segment and extracts the port code from the CM record for assignment to the cargo arrival transaction
[Retrieve CM Station Segment]
The system processes the successful lookup result → The system retrieves and stores the complete CM station segment data from the found record
[Extract Port Code from CM Record]
The system processes the CM station segment data → The system extracts the port code field from the CM station record for use in cargo arrival processing
[Retrieve CM Segment Data]
The system processes the query results → The CM table segment data is retrieved and stored for further processing
[Extract Port Code from CM Table]
The system processes the CM segment information → The port code value is extracted from the CM table segment for assignment to the transaction
[Execute Database Query - Perform CM table lookup with station key and handle success/failure conditions]
The system performs a CM table lookup using the cargo destination station number as the key → If the lookup is successful, the system extracts the port code from the CM segment and assigns it to the arrival transaction, otherwise the system continues processing without a port code
[Retrieve MC Segment Data]
The system retrieves the record data → The complete MC segment data is extracted and made available for port code processing
[Extract Canadian Customs Code from Position 2-4]
The system extracts the customs code → Characters from position 2 through 5 of the Canadian customs code field are extracted as the port code
[Store MC Segment Data]
The system processes the query response → The returned MC segment data is stored in the MC segment area
[Extract Port Code from MC Record]
The system processes the MC table information → The Canadian customs code characters 2 through 4 are extracted and stored as the temporary port code
[Clear MC Segment Data]
The system processes the failed query response → The MC segment data area is cleared to empty values
[Extract Sub-location Code]
The system extracts configuration data from the MC table segment → The sub-location code is retrieved from the MC segment for subsequent location validation processing
[Extract Port Code for Processing]
The system extracts port code information → The Canadian customs code characters 2 through 4 are extracted and stored as the port code for processing
[Clear MC Segment Data]
The system handles the lookup failure → The MC segment data area is cleared with spaces to prevent processing with invalid station information
[Set Processing Flag to Stop]
The system determines processing authorization → The CLV processing flag is set to stop preventing cargo arrival processing from proceeding
[Prepare Message for Queue]
The message needs to be prepared for queue submission → The GCX148 input structure is moved to the message area for queue processing
[Call CIMS to Change Message Queue Status]
The message queue needs to be prepared for transmission → The CIMS program is called with CHNG function to change the queue status using the alternate PCB
[Write Message to Queue via WRITMSGL]
The transaction message needs to be transmitted → The WRITMSGL program is called to write the message with its code, content, length and module name to the queue using alternate PCB
[Purge Message Queue via CIMS]
Queue cleanup is required → The CIMS program is called with PURG function to purge the queue using the alternate PCB
[Look up Destination Station in CM Table]
The system performs a lookup in the CM table using the destination station number → The system attempts to retrieve the corresponding port code from the CM table segment
[Look up Manifest Station in MC Table]
The system performs a lookup in the MC table using the manifest destination station name → The system attempts to retrieve the corresponding port information from the MC table segment
[Extract Canadian Customs Code]
The system processes the Canadian customs code from the MC table segment → The system extracts characters 2 through 4 from the Canadian customs code field
[Retrieve CM Segment Data]
The system processes the table response → The CM segment data is moved from the table response to the working storage area
[Extract Port Code from CM Segment]
The system processes the segment data → The port code is extracted from the CM segment port code field
[Assign Port Code to Transaction]
The system completes the port code assignment process → The port code is assigned to the transaction's port code field
[Retrieve MC Segment Data]
The system processes the successful lookup result → The complete MC segment data is retrieved and stored from the table lookup result
[Extract Canadian Customs Code from Position 2-4]
The system processes the customs code information → Characters 2 through 5 are extracted from the Canadian customs code field in the MC segment
[Assign Port Code to GCX148 Transaction]
The system prepares the arrival transaction data → The extracted customs code is assigned to the port code field in the GCX148 transaction
[Set Lifted Early Flag]
The system processes the lifted early exception → The system sets AEI report as required and assigns lifted early exception message
[Set Not Lifted Flag]
The system processes the not lifted exception → The system sets AEI report as required and assigns not lifted exception message
[Set Not Set Out Flag]
The system processes the not set out exception → The system sets AEI report as required and assigns not set out exception message
[Set Not On 9PLAN Flag]
The system processes the not on 9PLAN exception → The system sets AEI report as required and assigns not on 9PLAN exception message
[Set Container Exception Message]
The system assigns exception messages for containers → The system places the appropriate exception message in the container exception message field based on the exception type
[Set Equipment Exception Message]
The system assigns exception messages for equipment → The system places the appropriate exception message in the equipment exception message field based on the exception type
[Set AEI Report Required]
The system processes border arrival exceptions → The system sets AEI report as required and assigns appropriate border-related exception messages
[Set AEI Report Required]
The system processes cargo error exceptions → The system sets AEI report as required and assigns cargo error exception message
[Set AEI Report Required]
The system processes master arrived follower exceptions → The system sets AEI report as required and assigns master arrived exception message
[Check access conditions]
If access control conditions → If SCAC access is invalid, display SCAC invalid message with carrier code; if user has no access rights, display user access denied message; if MC table entry is not found, display no MC table entry message with manifest location; otherwise proceed with normal equipment processing
[Process equipment detail lines]
The system processes equipment entries up to 999 items → For each non-empty equipment entry, format equipment number and exception message, assign sequence number from array index, create equipment detail line with type space, and send to terminal
[Has containers?]
The system checks for container information up to 30 containers per equipment → For each non-empty container entry, format container number and exception message, assign sequence number from container index, create container detail line with type 'C', and send to terminal
[Send equipment detail line]
The system sends the report line → Call GCSTONLY service with destination terminal, common communication area, alternate PCB, call letters, and formatted line content
[Check User Access Status]
The system checks user access status and finds the user has no access permissions → The system should generate a user no access message and send the user access error to the terminal
[Display SCAC Invalid Message]
CLV report is being created → The system displays the SCAC invalid access message in the report output
[Display User Has No Access Message]
The system generates the CLV report → The system displays a 'user has no access' message in the report instead of processing cargo arrival data
[Check CCF Arrive Permission Level]
The CCF arrive permission equals super user access or user access → The system grants user access, otherwise denies access
[User Record Found?]
The user record is not found in the table → The system clears user security segment and sets no user access flag
[Table Record Retrieved Successfully]
The GCWTBIO-SUCCESSFULL flag indicates success → The returned table segment data is moved from GCWTBIO-GCTAB-SEGMENT to the appropriate target segment area for further processing
[Table Record Not Found]
The GCWTBIO-SUCCESSFULL flag indicates the record was not found → Target segment areas are cleared to spaces and appropriate not-found flags are set to indicate the unsuccessful search result
[Extract Sub-location Code]
The system processes the MC table segment data → The system extracts the sub-location code and port code from positions 2-4 of the Canadian customs code field
[Extract MC Segment Data]
Processing the found MC table entry → The system extracts the MC segment data from the lookup result
[Extract Port Code from Customs Code]
Processing the MC segment information → The system extracts characters 2 through 4 from the Canadian customs code as the port code
[Clear MC Segment Data]
Handling the failed lookup result → The system clears the MC segment data to spaces
[MC Table Record Found]
A matching MC table record is found for the manifest station → Set MC table match flag to TRUE, enable CLV processing, store MC segment data, and extract port code from Canadian customs code
[MC Table Record Not Found]
No matching MC table record is found for the manifest station → Set MC table match flag to FALSE, disable CLV processing, and clear MC segment data
[Move Equipment Number to Detail Line]
The system formats the equipment detail line → Move equipment number, exception message, and formatted sequence number to the detail line structure
[Move Container Number to Detail Line]
The system formats the container detail line → Move container number, container exception message, and formatted container sequence number to the detail line structure
[Move Exception Message to Detail Line]
Formatting the equipment detail line → The exception message should be moved to the detail line message field
[Format Complete Detail Line Structure]
Creating the final detail line for output → The complete CLV report detail line structure should be assembled and ready for output
[Retrieve Container Exception Message]
The system formats container details for reporting → The exception message must be retrieved from WS-ARR-CONT-EXCP-MESSAGE array using the current equipment count and container sub-index
[Format Container Detail Line]
The system creates a container detail line for the report → All container information must be formatted into the standard CLV report detail line structure (WS-CLV-REPORT-DET-LINE)
[Format Equipment Number and Message]
Formatting the equipment exception details → The equipment type is set to spaces, equipment number and exception message are populated, sequence number is derived from the last 3 digits of the equipment index, and the formatted line is added to the report
[Format Container Number and Message]
Formatting the container exception details → The container type is set to 'C', sequence number is derived from the last 3 digits of the container index, container number and exception message are populated, and the formatted line is added to the report
[Add Equipment Detail Line]
Adding equipment detail to report → Equipment line includes blank type indicator, equipment number, exception message, sequence number (last 3 digits of index), and line counter is incremented
[Add Container Detail Line with Type Indicator]
Adding container detail to report → Container line includes 'C' type indicator, container number, exception message, sequence number (last 3 digits of container index), and line counter is incremented
[Move Exception Message to Report Line]
The exception message needs to be included in the report line → The exception message from the equipment array should be moved to the report detail message field
[Format Equipment Detail Line]
The equipment detail line needs to be formatted for the report → The AEI report detail line should be constructed with all equipment information
[Move Container Exception Message to Report Line]
The container exception message needs to be included in the report line → The container exception message from the container array should be moved to the report detail message field
[Format Container Detail Line]
The container detail line needs to be formatted for the report → The AEI report detail line should be constructed with all container information
[Extract Exception Message from Array]
The system formats the equipment detail line → The exception message is extracted from the arrival exception message array at the equipment index position
[Construct Standardized Equipment Detail Line]
The system formats the equipment detail line → A standardized equipment detail line is constructed using the CLV report detail line format
[Extract Container Exception Message]
The system formats the container detail line → The exception message is extracted from the arrival container exception message array using the equipment index and container sub-index
[Construct Standardized Container Detail Line]
The system formats the container detail line → A standardized container detail line is constructed using the CLV report detail line format
[Extract Exception Message from Array]
The system extracts additional equipment data → Move WS-ARR-EXCEPTION-MESSAGE at position X to WS-AEI-DET-MESSAGE field
[Format Equipment Detail Line]
The system formats the equipment detail line → Set WS-AEI-DET-TYP to SPACES and move WS-AEI-REPORT-DET-LINE to SD3-ITEM-LINES at position I
[Extract Container Exception Message]
The system extracts additional container data → Move WS-ARR-CONT-EXCP-MESSAGE at equipment position X and container sub-position to WS-AEI-DET-MESSAGE field
[Format Container Detail Line with 'C' Type]
The system formats the container detail line → Set WS-AEI-DET-TYP to 'C' and move WS-AEI-REPORT-DET-LINE to SD3-ITEM-LINES at position I
[Get Container Equipment Number, Get Container Exception Message, Move Container Data to Report Line Fields]
The container detail line is being constructed → The container equipment number must be retrieved from WS-ARR-CONT-NUMBER array and the container exception message must be retrieved from WS-ARR-CONT-EXCP-MESSAGE array using the current equipment count and container sub-index
[Construct Formatted Container Report Line, Add Container Line to Report]
The container detail line formatting is completed → The formatted container report line must be constructed and added to the report item lines array at the current report line position
[Extract Container Exception Message]
The system processes container data for reporting → The system should extract the container exception message from the array and assign it to the report detail message field
[Add Equipment Exception Details to Email]
The system builds detailed email content → For each equipment marked for AEI reporting, equipment details and exception messages are added, followed by any associated container details and their exception messages
[Call Database to Get Next Container Equipment Record]
The system requests the next container equipment record using GNP function → The system retrieves the next available container equipment segment from the database
[Read Next Container Cross-Reference Record]
The system attempts to read the next container cross-reference record from FWIQBOTL segment → The next available container cross-reference record is retrieved or no-more-containers flag is set if no records remain
[Format Equipment Detail Line]
The system processes equipment details up to 999 items → Each equipment item is formatted with equipment number, exception message, and a 3-digit sequence number derived from the array index, and the detail line is sent to output
[Format Container Detail Line]
The system processes containers for the equipment up to 30 containers per equipment → Each container is formatted with type indicator 'C', container sequence number, container number, exception message, and sent to output until all containers are processed or empty entries are encountered
[Generate Header Lines]
The system generates CLV report content and access validation failed → If SCAC access is invalid, display SCAC invalid message; if user has no access, display no access message; if MC table match failed, display no MC table entry message with manifest location
[Format AEI Equipment Line]
The system formats the AEI equipment detail line → Equipment line is formatted with blank type indicator, equipment number, exception message, and 3-digit sequence number, then added to email content with line count tracking
[Format AEI Container Line]
The system formats AEI container detail lines → Each container line is formatted with type indicator 'C', container sequence number, container number, container exception message, and added to email content up to 30 containers per equipment or until line limit of 700 is reached
[Finalize Report]
The system sends the email report → Email is sent using EMCSEND3 service, and if return status is '2' indicating failure, a second attempt is made to backup recipient 'AEI9999OM01247', followed by message queue purge
[Finalize Report]
The system finalizes the CLV report → User function code is set to 'WRAP' and master header record is sent as final message to complete the report transmission
[Construct Report Header Line 1]
The system encounters user without access permissions → Display CLV user has no access message
[Process Equipment Detail Lines]
The system processes equipment detail lines up to 999 items → For each non-empty arrival detail area entry, initialize detail type to spaces, set equipment number from arrival area, set exception message from arrival area, calculate 3-digit sequence number from index, and construct CLV report detail line
[Process Container Detail Lines]
The system processes up to 30 containers per equipment item → For each non-empty container entry, set detail type to 'C', calculate 3-digit sequence from container index, set container number from arrival container array, set container exception message from arrival container array, and construct CLV report detail line
[Include Container Exception Message]
The system generates container report entries → The container exception message is included in the report detail line
[Store Equipment in Processing Array]
The system stores equipment for processing → Equipment number is stored in arrival equipment number array at current arrival equipment count position and exception message is initialized to spaces
[Add Equipment Detail Line to Report]
Adding equipment detail to report → Equipment line contains blank type indicator, equipment number, exception message, and sequence number derived from the last 3 digits of the equipment index
[Add Container Detail Line with Exception Message]
Adding container detail to report → Container line contains 'C' type indicator, container number, container exception message, and sequence number derived from the last 3 digits of the container index
[Add Equipment Detail Line with Number and Exception Message]
Adding equipment details to email → An equipment detail line is added containing equipment type (spaces), equipment number, exception message, and sequence number (last 3 digits of equipment index)
[Add Container Detail Line with Container Number and Exception]
Adding container details to email → A container detail line is added containing container type 'C', container number, exception message, and sequence number (last 3 digits of container sub-index)
[Complete Email Content Assembly]
Completing email assembly → The email content assembly process is marked as complete and ready for transmission
[Format Equipment Detail Line]
Creating equipment detail line for email content → The system should set type indicator to blank, extract equipment number, extract exception message, generate sequence number from equipment array position, and format complete detail line
[Extract Exception Message]
Populating exception information → The exception message should be extracted from the arrival exception message array at the current equipment position
[Format Container Detail Line]
Creating container detail line for email content → The system should set type indicator to 'C', extract container number, extract container exception message, generate container sequence number, and format complete container detail line
[Extract Container Exception Message]
Populating container exception information → The exception message should be extracted from the arrival container exception message array at the current equipment and container position
[Complete Detail Assembly]
Completing the detail assembly process → The email content should contain all formatted equipment and container detail lines ready for transmission
[Extract Exception Message from Array]
Processing equipment for report detail line formatting → The exception message at the current index position is extracted and assigned to the detail line message field
[Format CLV Report Detail Line]
Processing a CLV report request → The CLV report detail line record is constructed and moved to the output line for report generation
[Format AEI Report Detail Line]
Processing an AEI report request → The AEI report detail line record is constructed and added to the email report item lines array
[Extract Exception Message from Array]
The system continues extracting equipment data for report formatting → The exception message should be retrieved from the arrival exception message array at position X and assigned to the AEI detail message field
[Generate Sequence Number from Counter]
The system generates a sequence number for report display → The equipment counter X should be moved to a temporary sequence field, and the last 3 characters should be extracted and assigned to the AEI detail sequence field
[Format Equipment Detail Line]
The system formats the equipment detail line → The equipment type should be set to SPACES, and the complete AEI report detail line should be formatted with all extracted equipment data
[Retrieve Container Exception Message]
The system formats the container detail line for reporting → The corresponding exception message is retrieved from the container exception message array
[Construct Container Detail Line]
The system creates a container detail line for the report → All container information is assembled into the standardized report line format
[Extract Container Exception Message]
The system extracts the exception message → Retrieve the exception message from the container exception message array using the equipment count and container sequence as indices
[Format Container Detail Line]
The system formats the container detail line → Combine all container information elements into the standard report detail line format
[Prepare Email Parameters]
The system initializes email transmission parameters → All email fields are cleared, sender is set to AEI report sender, and email configuration parameters are established
[Call EMCSEND3 to Send Email]
The system calls EMCSEND3 to transmit the email → The email transmission is attempted with all configured parameters including sender, recipients, subject, and AEI report content
[Check Return Status Flag]
The system checks the return status flag from the email service → The return status flag value is evaluated to determine transmission success or failure
[Status Flag = '2' Failed?]
The return status flag equals '2' → The system identifies this as a failed email delivery requiring fallback processing
[Set Fallback Recipient AEI9999OM01247]
The system processes the delivery failure → The recipient is changed to the fallback address 'AEI9999OM01247' for retry transmission
[Call EMCSEND3 with Fallback Recipient]
The system calls EMCSEND3 for the second transmission attempt → The email is sent to the fallback recipient with the same report content and parameters
[Log Final Email Status]
The system receives the final return status from the fallback transmission → The final email transmission status is logged for audit and monitoring purposes
[Add Equipment Detail Line]
Adding equipment details to the report → The equipment detail line should be formatted with sequence number, equipment number, and exception message and added to the report content
[Add Container Detail Line]
Adding container details to the report → The container detail line should be formatted with 'C' type indicator, container sequence number, container number, and exception message and added to the report content
[Set AEI Report Required - Assign Message: Equipment lifted early]
The system processes the lifted early exception → The system marks AEI report as required, assigns lifted early message to equipment or container exception message, and sets report flag to 'Y'
[Set AEI Report Required - Assign Message: Equipment not lifted]
The system processes the not lifted exception → The system marks AEI report as required, assigns not lifted message to equipment or container exception message, and sets report flag to 'Y'
[Set AEI Report Required - Assign Message: Equipment not set out]
The system processes the not set out exception → The system marks AEI report as required, assigns not set out message to equipment or container exception message, and sets report flag to 'Y'
[Set AEI Report Required - Assign Message: Equipment not on 9PLAN]
The system processes the not on 9PLAN exception → The system marks AEI report as required, assigns not on 9PLAN message to equipment or container exception message, and sets report flag to 'Y'
[Set AEI Report Required - Assign Border-related Messages]
The system processes the border arrival exception → The system marks AEI report as required, assigns appropriate border-related message to equipment or container exception message, and sets report flag to 'Y'
[Set AEI Report Required - Assign Message: Master manifest processed]
The system processes the master manifest exception → The system marks AEI report as required, assigns master manifest processed message to equipment or container exception message, and sets report flag to 'Y'
[Assign Message: Equipment processed successfully]
The system assigns the final processing message → The system assigns successful processing message to equipment or container exception message
[Set Lifted Early Message REP-MSG-1]
The system processes the container exception message assignment → The lifted early message (REP-MSG-1) should be assigned to the container exception message field in the container array
[Set Not Lifted Message REP-MSG-2]
The system processes the container exception message assignment → The not lifted message (REP-MSG-2) should be assigned to the container exception message field in the container array
[Set Not Set Out Message REP-MSG-3]
The system processes the container exception message assignment → The not set out message (REP-MSG-3) should be assigned to the container exception message field in the container array
[Set Not on 9PLAN Message REP-MSG-4]
The system processes the container exception message assignment → The not on 9PLAN message (REP-MSG-4) should be assigned to the container exception message field in the container array
[Set Not Arrived at Border Message REP-MSG-5]
The system processes the container exception message assignment → The not arrived at border message (REP-MSG-5) should be assigned to the container exception message field in the container array
[Set Not ACK at Border Message REP-MSG-9]
The system processes the container exception message assignment → The not ACK at border message (REP-MSG-9) should be assigned to the container exception message field in the container array
[Set Master Arrived Message REP-MSG-7]
The system processes the container exception message assignment → The master arrived message (REP-MSG-7) should be assigned to the container exception message field in the container array
[Set Default Arrived Message REP-MSG-8]
The system processes the container exception message assignment → The default arrived message (REP-MSG-8) should be assigned to the container exception message field in the container array
[Is this a container?]
The system checks the equipment type → If the equipment is identified as a container, container-specific exception message processing should be applied, otherwise standard equipment exception processing should be used
[Set AEI Report Required Flag]
The system completes container exception message assignment → The AEI report required flag should be set to true to trigger report generation
[Mark Container for AEI Reporting]
The system processes the container for reporting → The container should be marked with 'YES' flag for AEI reporting to ensure it appears in the generated report
[Set up inquiry database parameters]
The system initializes the inquiry database parameters → The segment type is set to 'FWIQROOT', user function code is set to 'GU', and accept status is set to 'GEGB'
[Prepare for container cross-reference reading]
The system prepares to read container details → Initialize status code, set segment type to 'FWIQBOTL', clear secondary key, set function code to 'GNP', and set accept status to 'GE'
[Load Cargo Record Data]
The cargo data needs to be made available for processing → The cargo report segment is moved to the GCSCCRT structure
[Load Next Cargo Record]
The cargo data needs to be loaded for evaluation → The cargo report segment is moved to the GCSCCRT structure

Structural Validations

[User Record Found?]
If the database search results → If the lookup is successful, the system retrieves the user permission segment, otherwise sets no user access flag for missing record
[Set No User Access Flag - Invalid SCAC]
The system processes the invalid SCAC access result → The system sets the no user access flag to true without proceeding to user permission table lookup
[AEI Sub-location Matches Cargo Sub-location?]
The system loops through up to 10 AEI sub-locations and finds a match with the cargo sub-location code → The system sets the cargo as needing arrival processing
[MC Sub-location Matches Cargo Sub-location?]
The MC table sub-location code matches the cargo sub-location code → The system sets the cargo as needing arrival processing
[Set Report Area for Error]
The system prepares error reporting information → The report area is configured with appropriate error message and reporting flags
[Query Successful?]
If the query results → If the query returns successful status, the system proceeds to retrieve CM segment data, otherwise the lookup process terminates
[Check SCAC Access Status]
The system checks SCAC access status and finds it is invalid → The system should set the carrier SCAC code in the error message, generate SCAC invalid message, and send the error to the terminal
[Check MC Table Match Status]
The system checks MC table match status and finds no matching entry exists → The system should set the manifest station in the error message, generate MC table entry missing message, and send the MC table error to the terminal
[Include SCAC Code in Error Message]
Error message needs to be generated → The system includes the CP SCAC code in the CLV invalid access error message
[Clear Return Flags and Segments]
The system prepares for the table call → Return flags and table segment areas are initialized to prevent data contamination from previous operations
[Construct Report Header Line 1]
The system encounters invalid SCAC access → Set carrier SCAC in CLV report SCAC field and display CLV SCAC invalid message
[Construct Report Header Line 1]
The system encounters MC table match failure → Set CLV manifest upon location from input and display CLV no MC table entry message
[Set AEI Report Required - Assign Message: Cargo in error]
The system processes the cargo error exception → The system marks AEI report as required, assigns cargo error message to equipment or container exception message, and sets report flag to 'Y'
[Set Cargo in Error Message REP-MSG-6]
The system processes the container exception message assignment → The cargo in error message (REP-MSG-6) should be assigned to the container exception message field in the container array

Module: GCCTRARR 1 Consolidated Epic Story

Epic: GCCTRARR Complete EDI Specification Extracted from Legacy

Contains 10 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCTRARR EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[6:Train Arrival Log Generation]
Log generation is initiated → An arrival log should be created with train ID, 'TRAIN ARRIVED' message, action code 'ZZZ', and current transaction details
[Calculate Time Difference Between Current Date and Train EDA]
The system needs to determine how many days have passed since the train's estimated arrival → The TIMEDIFF program is called with machine date/time, train date/time parameters to calculate the difference in days
[Clear Log Input Structure]
The system begins preparing the log message → The log input structure is cleared to spaces to ensure clean data entry
[Set Security Information]
Security information needs to be set → The security byte is set to high values to indicate maximum security level
[Capture Transaction Details]
Transaction details need to be captured → The sending transaction code and ACF2 user ID are recorded from the current session
[Record Current Date and Time]
Date and time information needs to be recorded → The current machine date (century + date) and time are captured and formatted into the log message
[Set Train ID and Message Text]
Train identification and message content are being set → The Canadian customer train ID is recorded and the message text is set to 'TRAIN ARRIVED ' and the train type is marked as new CA train
[Set Action Code to 'ZZZ']
The action code needs to be assigned → The action code is set to 'ZZZ' to indicate a train arrival event
[Send Log Message via IMS]
The message needs to be transmitted → The log message is sent via the GCT1051E messaging service through IMS
[Send Transaction Message via GCT1481E]
The capacity transaction is ready to be processed → The transaction message must be sent via the GCT1481E processing module

Structural Validations

None explicitly identified in logic extraction.

Module: GCCUSCNV 1 Consolidated Epic Story

Epic: GCCUSCNV Complete EDI Specification Extracted from Legacy

Contains 44 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCUSCNV EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Loop Counter J=1]
The system begins processing P5 location search keys → The loop counter is initialized to 1 to start processing from the first occurrence

Core Acceptance Criteria

[Check Segment ID]
If the segment ID value → The system routes to P4 conversion for 'P4' segments, P5 conversion for 'P5' segments, M11 conversion for 'M11' segments, M12 conversion for 'M12' segments, Broker conversion for 'BRO' segments, or N10 conversion for 'N10' segments
[Convert to City Code]
The system performs SK table lookup with concatenated location and province data and the lookup fails → Attempt second lookup using only province/state code, and if successful use that value, otherwise set place of receipt to question marks
[Lookup MC Table]
The system performs MC table lookup using the location ID name as search key → Retrieve border port classification and US state exit code information, or return lookup failure status if location not found
[Lookup SD Table]
The system performs SD table lookup using the search key → Retrieve port code information from the table, or return lookup failure status if search key not found
[Lookup SK Table]
The system performs SK table lookup using concatenated location-province key or individual province key → Retrieve city code information from the table, or return lookup failure status if key not found
[Lookup Commodity Information]
The system calls external commodity lookup service with the commodity code ID → Retrieve commodity information and status, processing continues based on returned status code
[Lookup MC Table with Location ID Name]
MC table lookup is performed using the location ID name → Location data is retrieved from MC table if found, otherwise lookup fails
[Extract Port Code from SD Table]
The system processes the table lookup result → The port code is extracted from the SD table segment data
[Clear SK Segment Data]
The system needs to clean up associated segment data → The system clears the SK segment data by setting it to spaces
[More N10 Records to Process?]
The system processes N10 data conversion → The system iterates through each commodity record from position 1 up to the maximum number of N10 occurrences allowed by sequence
[Call CIMS to lookup commodity information]
The system calls the CIMS external system → The system uses the commodity code ID as the search key and retrieves commodity details from the COMODITY IMS segment
[Loop Through N10 Commodity Occurrences]
The system processes commodity code conversion → The system iterates through each occurrence from 1 to maximum allowed occurrences
[Retrieve Commodity Information from COMODITY Segment]
The system processes the CIMS response → Commodity information is retrieved from the COMODITY segment if the commodity code exists
[Call Table Lookup Service]
Executing the table lookup operation → The table lookup service should be called with all required parameters to retrieve SK table segment data
[Retrieve SK Table Segment]
Processing the lookup results → The returned table segment should be moved to the SK segment work area for further processing
[Extract City Code from Segment]
Extracting city code data → The city code should be extracted from the SK segment and made available for use
[Retrieve MC Table Segment]
The table data is processed → The MC table segment containing location information is loaded for further processing
[Clear MC Segment Data]
The location data is processed → The MC table segment data is cleared and location ID is set to indicate invalid status
[Loop Through N10 Commodity Entries]
The system processes N10 commodity data conversion → The system iterates through each commodity entry from position 1 up to the maximum occurrence limit
[Retrieve Commodity Details from COMODITY Segment]
The system processes the CIMS response → The system retrieves commodity details from the COMODITY segment data structure
[MC Table Lookup Failed]
The MC table lookup fails to find matching location data → Clear the MC segment data and set the location ID to question marks to indicate unknown location
[SD Table Lookup Failed]
The SD table lookup fails to find matching port data → Clear the SD segment data and set the port code to question marks to indicate unknown port
[SK Table Lookup Failed]
The SK table lookup fails to find matching city/location data → Clear the SK segment data and set the place of receipt or location ID to question marks to indicate unknown location
[BK Table Lookup Failed]
The BK table lookup fails to find matching broker data → Clear the BK segment data and set district code, office code, and filer code to question marks to indicate unknown broker information
[Skip P4 Processing - No Field Changes]
The location ID name field is empty or contains only spaces → The system skips all P4 location conversion processing and makes no changes to the location ID field
[Skip P5 Processing - No Field Changes]
A specific location search key occurrence is empty or contains only spaces → The system skips processing for that occurrence and makes no changes to the corresponding port code field
[Skip M11 Processing - No Field Changes]
Both the location ID name field and province/state code field are empty or contain only spaces → The system skips all M11 location conversion processing and makes no changes to place of receipt and location ID fields
[Skip M12 ID1 Processing - No Field Changes]
The location ID1 name field is empty or contains only spaces → The system skips location ID1 conversion processing and makes no changes to the location ID1 field
[Skip M12 ID2 Processing - No Field Changes]
The location ID2 name field is empty or contains only spaces → The system skips location ID2 conversion processing and makes no changes to the location ID2 field
[Continue Broker Processing]
The broker short name field is empty or contains only spaces → The system continues broker processing without performing any actions but allows other broker rules to be evaluated
[Skip N10 Processing - No Field Changes]
A specific commodity code ID occurrence is empty or contains only spaces → The system skips processing for that occurrence and makes no changes to the commodity fields

Structural Validations

[Location ID Name exists?]
The system checks the location ID name field → Processing continues to MC table lookup if location ID name is not empty, otherwise no conversion is performed
[Search Key exists?]
The system iterates through each location search key position → For each non-empty search key, Execute SD table lookup to convert to port code, otherwise skip processing for that occurrence
[Location or Province exists?]
The system checks if either location ID name or province/state code is present → If either field contains data, proceed with SK table lookup using concatenated values, otherwise skip conversion processing
[Broker Name exists?]
If the broker short name field → If broker name is empty, skip processing; if broker is marked as unknown or not required, clear broker code; if broker name exists, proceed with BK table lookup
[Commodity Code exists?]
The system checks each commodity code ID and harmonized commodity code pair → Process commodity lookup only if commodity code ID is not empty AND harmonized commodity code is empty, otherwise skip that occurrence
[Is Location ID Name not empty?]
The location ID name field is checked for content → Processing continues only if location ID name is not empty, otherwise conversion is skipped
[Place of Receipt: Location Name or Province/State exists?]
The system checks if either location name (RT051) or province/state code (RT052) contains non-space values → Processing continues to place of receipt conversion if either field has data, otherwise skips to location ID processing
[Location ID: Location Name or Province/State exists?]
The system checks if either location name (RT321) or province/state code (RT322) contains non-space values → Processing continues to location ID conversion if either field has data, otherwise processing ends
[Location ID1 Name exists?]
The system checks Location ID1 name field → If Location ID1 name is not empty, proceed with SD table lookup, otherwise skip Location ID1 processing
[Location ID2 Name exists?]
The system checks Location ID2 name field → If Location ID2 name is not empty, proceed with SK table lookup, otherwise complete M12 processing
[Commodity Code ID exists?]
The system checks the commodity code ID field → Processing continues only if the commodity code ID is not empty or spaces
[Commodity Code ID exists?]
The system checks the commodity code ID field → The system continues processing only if the commodity code ID is not empty spaces

Module: GCX111E 1 Consolidated Epic Story

Epic: GCX111E Complete EDI Specification Extracted from Legacy

Contains 7 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX111E EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[11:Handle Manual Arrival Status]
The train has arrived automatically and the arrival message has been sent or acknowledged → The system returns 'ARRIVED' as the train status
[11:Handle Manual Arrival Status]
The train has arrived manually and the arrival message has been sent or acknowledged → The system returns 'MNL-ARR' as the train status
[Set Status to 'ARRIVED']
The train has arrived (GCWTL-ARRIVED-YES is true) AND the train message has been sent:
acknowledged
→ The train status should be overridden to 'ARRIVED'
[Set Status to 'MNL-ARR']
The train has been manually marked as arrived (GCWTL-ARRIVED-MANUAL is true) AND the train message has been sent:
acknowledged
→ The train status should be set to 'MNL-ARR'
[Process Found Train Status]
The train is found in the database → The train status should be set to the current operational status from the train record, with special status 'ARRIVED' if train has arrived and message was sent or acknowledged, or 'MNL-ARR' if train arrived manually and message was sent or acknowledged

Structural Validations

[Invalid Parameters Error]
The database response indicates invalid parameters were provided → The system should display an error message about invalid parameters and terminate processing
[Too Many Equipment Error]
The database response indicates the train has too many equipment items → The system should display an error message about train capacity exceeded and terminate processing

Module: GCX996I 1 Consolidated Epic Story

Epic: GCX996I Complete EDI Specification Extracted from Legacy

Contains 200 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX996I EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Call MQ Open Function]
The system needs to open the MQ queue for EDI message processing → The system must call MQOPEN with connection handle, queue descriptor, options, and response parameters
[MQ Open Successful?]
The system checks the completion status of the queue open operation → If MQ-COMPCODE equals MQCC-OK then the queue is ready for message processing, otherwise error handling is required
[Initialize BGF Segment Structure]
System prepares to parse BGF segment data → The system clears BGF-SEGMENT structure by moving spaces
[Initialize FWCARGET Parameters]
Lead car search is initiated → FWCARGET parameters are initialized with all car types except 98-99, all status types, and include incomplete EDI, temporary waybill, corrector waybill, returned lead waybill, and latest waybill date options
[Initialize Car Search Parameters]
The system initializes car search parameters → All car types except 98 and 99 are included, all status types are allowed, EDI incomplete records are included, temporary waybills are included, corrector waybills are included, and latest waybill date is returned
[Initialize Equipment Request Segment]
Equipment request processing begins → The multi-shipment found flag is set to false and the request indicator is cleared to prepare for equipment matching
[Initialize New N9 Pedimento Entry]
The system initializes the new entry → The FEN qualifier is set and the pedimento number is assigned to the identified slot
[Initialize New N9 Information]
The system initializes the new N9 entry with pedimento data → Set the reference number qualifier to FEN and assign the pedimento number to the reference number field
[Initialize Loop Counter to 1]
The N9 space search process begins → The loop counter is initialized to 1 to start checking from the first N9 entry
[Initialize New N9 Pedimento Information]
System initializes new N9 information for the identified slot → System sets FEN qualifier in reference number qualifier field and pedimento number in reference number field for the specific N9 entry index
[Initialize Length and Position Variables]
The parse message segment process is initiated → All length, position, and segment ID length variables are set to zero
[Initialize Equipment Request Segment]
Preparing the data structure for new data → The system initializes the equipment request segment to clear any previous data
[Initialize Car Search Parameters]
Initiating lead car search in SHIPROOT → Car search parameters are initialized with equipment ID and search criteria are set for all car types except specific exclusions, all status types, incomplete EDI included, temporary waybill included, corrector waybill included, returned lead waybill enabled, and latest waybill date enabled

Core Acceptance Criteria

[Transaction Already Started?]
The transaction ID indicates the transaction has already been started (GCW180-STARTED-TRANSID is true) → The system skips all MQ message processing and proceeds directly to termination
[Extract Equipment Information]
The K3-01-FIXED-FORMAT-INFO is parsed using file info delimiter → The system extracts K3-01-EQUIP-INIT, K3-02-EQUIP-NUM, K3-04-WYBL-NUM, K3-05-WYBL-DATE, and K3-06-ACTION-CDE
[Extract Pedimento Information]
The K3-01-FIXED-FORMAT-INFO is parsed using file info delimiter → The system extracts K3-07-PEDIMENTO, K3-08-PEDIMENTO-TYPE, and K3-09-PEDIMENTO-RCV-TMSTMP
[Append Pedimento to Existing A2RT]
An available N9 data slot is found (empty or contains spaces/low-values) or FEN qualifier slot exists → The system updates the N9 segment with WS-FEN-QUAL as reference qualifier and K3-07-PEDIMENTO as reference number
[Insert New A2RT Segment]
The system attempts to store pedimento information → The system creates a new A2RT N9 segment with index 1, WS-FEN-QUAL as reference qualifier, and K3-07-PEDIMENTO as reference number
[Update GCUSRT with Pedimento Data]
The GCUSRT record is retrieved using the US CCN key → The system updates GCUSRT-PEDIMENTO-TYPE with K3-08-PEDIMENTO-TYPE and GCUSRT-PEDIMENTO-RCV-TMSTMP with K3-09-PEDIMENTO-RCV-TMSTMP
[Call Event Logging Service]
The system has completed GCCDSPIO processing → The system calls GCX151AR program with equipment details, waybill information, and pedimento data for event logging
[Set Queue Object Type to Queue]
The queue configuration is being set up → The queue object type must be set to MQOT-Q to indicate it is a standard message queue
[Set Queue Name for EDI Messages]
The queue name needs to be specified → The queue object name must be set to MQTMC-QNAME to identify the EDI message queue
[Set Queue Options for Input Operations]
Queue access options need to be configured for message retrieval → The queue options must be set to MQOO-INPUT-AS-Q-DEF to enable input operations as defined by the queue
[Queue Ready for Reading EDI Messages]
The system has established connection to the EDI message queue → The queue is ready for reading EDI messages and message processing can proceed
[Set Message Not Available]
The MQ completion code is not OK AND the reason code indicates no message is available → Set the message status to not available
[Set Message Skip Flag]
The MQ completion code is OK AND the message backout count is not zero → Set the message status to skip processing
[Set Message Good Flag]
The MQ completion code is OK AND the message backout count is zero AND the message length meets minimum requirements → Set the message status to good for processing
[Set End of File Flag]
The MQ response does not match any specific error conditions → Set end of file flag to terminate message processing AND set MQ get error status
[Message Available?]
The MQ reason code equals MQRC-NO-MSG-AVAILABLE → Set the message not available flag to true
[Set Message Good Flag]
The message data length is greater than or equal to the minimum required MQ length → Set the message good flag to true to proceed with business processing
[Set MQ EOF Flag]
The MQ completion code equals MQCC-FAILED and reason code equals MQRC-NO-MSG-AVAILABLE → Set MQ error text and Execute MQ error handling procedure
[Set BGF Segment Identifier]
BGF segment processing is initiated → The system sets WS-SEGMENT-ID to BGF segment identifier
[Parse MQ Message for BGF Segment]
System performs MQ message parsing for BGF segment → The system calls XA000-PARSE-MQ-MSG-GET-SEGMENT to locate BGF segment and determine its length
[Extract BGF Data Elements]
System extracts BGF data elements → The system uses UNSTRING to parse MQ-MESSAGE from position WS-POSN-START for length WS-LENGTH, delimited by WS-DATA-ELEMENT-DELIMITER, into BGF identifier, transaction set ID code, reference ID code, and reference ID fields
[Locate K3 Segment in EDI Message]
The system searches for K3 segment in the message → The system identifies the segment position and length for data extraction
[K3 Segment Found?]
The segment length is greater than zero → The system proceeds to extract file information data elements, otherwise skips K3 processing
[Extract K3 Basic Data Elements]
The system parses the segment using data element delimiter → The system extracts K3 identifier, fixed format info, record format code, and unit/basis measure code into respective fields
[Extract Equipment Initial]
The system parses the field using file info delimiter → The system extracts equipment initial, equipment number, load/empty status code, waybill number, waybill date, action code, pedimento number, pedimento type, and pedimento received timestamp into respective fields
[Parse K3-01-FIXED-FORMAT-INFO using File Info Delimiter]
The system processes the K3-01-FIXED-FORMAT-INFO field → The field is parsed using the file information delimiter to separate individual data elements
[Extract Equipment Initial K3-01-EQUIP-INIT]
The system extracts equipment information → The equipment initial is captured from the first data element position (K3-01-EQUIP-INIT)
[Extract Equipment Number K3-02-EQUIP-NUM]
The system extracts equipment information → The equipment number is captured from the second data element position (K3-02-EQUIP-NUM)
[Extract Load/Empty Status Code K3-03-LOAD-EMPTY-STATUS-CDE]
The system extracts equipment status information → The load/empty status code is captured from the third data element position (K3-03-LOAD-EMPTY-STATUS-CDE)
[Extract Waybill Number K3-04-WYBL-NUM]
The system extracts waybill information → The waybill number is captured from the fourth data element position (K3-04-WYBL-NUM)
[Extract Waybill Date K3-05-WYBL-DATE]
The system extracts waybill information → The waybill date is captured from the fifth data element position (K3-05-WYBL-DATE)
[Extract Action Code K3-06-ACTION-CDE]
The system extracts action information → The action code is captured from the sixth data element position (K3-06-ACTION-CDE)
[Extract Pedimento Number K3-07-PEDIMENTO]
The system extracts customs information → The pedimento number is captured from the seventh data element position (K3-07-PEDIMENTO)
[Extract Pedimento Type K3-08-PEDIMENTO-TYPE]
The system extracts customs information → The pedimento type is captured from the eighth data element position (K3-08-PEDIMENTO-TYPE)
[Extract Pedimento Received Timestamp K3-09-PEDIMENTO-RCV-TMSTMP]
The system extracts customs timing information → The pedimento received timestamp is captured from the ninth data element position (K3-09-PEDIMENTO-RCV-TMSTMP)
[Parse K3-01-FIXED-FORMAT-INFO using File Info Delimiter]
The system parses the fixed format information using the file info delimiter → The system extracts equipment initial, equipment number, load/empty status code, waybill number, waybill date, action code, pedimento number, pedimento type, and pedimento received timestamp into separate fields
[Extract K3-04-WYBL-NUM - Waybill Number]
The system processes the fourth delimited field from the parsed data → The system stores the value in K3-04-WYBL-NUM as the waybill number
[Extract K3-05-WYBL-DATE - Waybill Date]
The system processes the fifth delimited field from the parsed data → The system stores the value in K3-05-WYBL-DATE as the waybill date
[Store Waybill Number in Working Storage]
The system prepares for manifest lookup operations → The system moves the waybill number to WS-WAYBILL-NUMBER working storage field for use in equipment and manifest searches
[Store Waybill Date in Working Storage]
The system creates or updates GCCDSPIO records → The system uses characters 3 through 8 of the waybill date (K3-05-WYBL-DATE(3:6)) and stores it in GCWDSPIO-WAYBILL-DTE field
[Extract Pedimento Number]
The system unstrings the fixed format info using the file info delimiter → The system assigns the seventh delimited field to K3-07-PEDIMENTO
[Extract Pedimento Type]
The system unstrings the fixed format info using the file info delimiter → The system assigns the eighth delimited field to K3-08-PEDIMENTO-TYPE
[Extract Pedimento Received Timestamp]
The system unstrings the fixed format info using the file info delimiter → The system assigns the ninth delimited field to K3-09-PEDIMENTO-RCV-TMSTMP
[Extract Equipment Initial and Number from K3 Segment]
The system processes the file information segment → Equipment initial is extracted to K3-01-EQUIP-INIT and equipment number is extracted to K3-02-EQUIP-NUM
[Format Equipment ID using Standard Format]
The system needs to create a standardized equipment ID → Equipment initial and number are combined and formatted using GCCCARFM program to create WS-EQUIP-ID
[Is Container Equipment?]
The system checks equipment type → Equipment is considered container if the fourth character of equipment initial equals WS-CONTAINER value
[Search Multi-Shipment Records]
The system searches multi-shipment records → The system queries FWSWRWR and FWSWREQ segments to find equipment in multi-car shipments
[Extract Multi-Shipment Waybill Data]
The system extracts waybill data → Road numbers, station numbers, and waybill numbers are extracted from FWEQ record for both WR and EQP segments
[Format Equipment ID]
The system needs to search for cargo manifest records → Equipment initial and number are concatenated and formatted into a standardized equipment ID
[Multi-Shipment Found?]
If the multi-shipment search results → If equipment ID matches and either waybill record waybill number or equipment waybill number matches the message waybill number, then multi-shipment is found, otherwise the search is unsuccessful
[Waybill Number Matches?]
System compares message waybill number with SHIPROOT waybill number and original waybill number → System marks waybill as found if message waybill matches current waybill (when origin road not 000) or matches original waybill (when origin road is 990)
[Check EDI Completion Status]
FWBX key feedback matches previously processed key → Set CARGET not found status and mark search as complete to prevent infinite loop
[Same Equipment Key?]
The system compares the current equipment key with the previous search key → If the equipment keys are the same, mark as not found and stop searching, otherwise set previous status waybill date flag and continue searching
[Get Next Equipment Request Record]
System performs get next parent operation on equipment request segment → The next equipment request record is retrieved with acceptable status codes for continuation or completion
[Equipment Request Found?]
System evaluates the operation status → If status is successful (spaces), continue with equipment matching; otherwise mark request processing as complete
[Display Invalid Check Digit Message]
The program name is not GCX903R or GCX905R and check digit is not allowed → Display invalid container equipment error message with equipment details
[Format Equipment ID from K3 Segment]
The system processes the equipment information → Equipment initial and number are combined and formatted into a standardized equipment ID
[Append to Existing A2RT Segment]
The system needs to store pedimento information → The system routes to append the pedimento to the existing segment
[Insert New A2RT Segment]
The system needs to store pedimento information → The system routes to create and insert a new A2RT segment
[Find Available N9 Entry Slot]
The system searches for an available slot or existing FEN qualifier entry → The system identifies the first empty slot or existing FEN entry up to the maximum allowed entries
[Update A2RT Segment with New Entry]
The system performs the update operation → The A2RT segment is replaced in the database with the new N9 entry data
[Create New A2RT Segment]
The system creates a new segment → A new A2RT segment is initialized with the first N9 entry set to index 1
[Insert A2RT Segment to Database]
The system performs the insert operation → The new A2RT segment is inserted into the database
[Update GCUSRT with Pedimento Type]
The system updates the GCUSRT record → The pedimento type field is set with the value from K3-08-PEDIMENTO-TYPE
[Update GCUSRT with Received Timestamp]
The system updates the GCUSRT record → The pedimento received timestamp field is set with the value from K3-09-PEDIMENTO-RCV-TMSTMP
[Replace GCUSRT Record]
The system performs the replace operation → The GCUSRT record is updated in the database with the new pedimento information
[Send Email - No Space Available]
The system encounters this error condition → An error email is sent with details about the A2RT no space available condition
[A2RT Segment Exists?]
The system attempts to retrieve the A2RT N9 segment for pedimento storage → If the segment exists with valid status, proceed to append pedimento data, otherwise create a new segment
[Replace A2RT N9 Segment]
New pedimento information needs to be stored in the segment → Replace the existing segment with updated N9 entry containing FEN qualifier and pedimento number
[Insert New A2RT N9 Segment]
Pedimento information needs to be stored for the cargo manifest → Create a new A2RT N9 segment with the first entry containing FEN qualifier and pedimento number
[FEN Qualifier Match Found?]
The N9 entry reference number qualifier equals the FEN qualifier → The entry is identified as a matching location for updating existing pedimento information
[Available Space Found]
Available space is identified in the N9 segments → The system proceeds to store or update pedimento information in the identified N9 entry position
[Set Valid Return Code for Get Operation]
Preparing to access the A2RT N9 segment database → The system sets the acceptance status to valid return code for get-equal operations to properly handle both found and not-found scenarios
[Access A2RT N9 Segment Database]
The system executes a database get operation on the A2RT N9 segment → The system attempts to retrieve the segment and returns a status indicating success or failure of the operation
[A2RT Segment Found?]
If the returned status code from the database operation → If the status code is spaces (successful), the segment exists; if the status code is not spaces (error/not found), the segment does not exist
[Search for Available N9 Entry Slot]
System searches for available N9 entry slot by iterating through entries from 1 to maximum limit → System stops searching when it finds an entry that is either empty (spaces or low-values) or already contains FEN qualifier, or when maximum entries exceeded
[Found Available Slot?]
System evaluates if the current index is within maximum N9 entries limit → System proceeds with pedimento storage if index is within limit, otherwise triggers no-space-available error handling
[Get Current A2RT N9 Segment]
System calls database function to get hold and update A2RT N9 segment using US CCN key → System retrieves current A2RT N9 segment data for modification
[Replace A2RT N9 Segment with Updated Data]
System calls database function to replace A2RT N9 segment → System updates the A2RT segment in database with the modified N9 data containing new pedimento information
[Insert New A2RT Segment - Create new A2RT segment with pedimento information if none exists]
The system needs to store new pedimento information received from KCSM customs system → A new A2RT N9 segment is created with index position 1, FEN qualifier code is set as the reference number qualifier, the pedimento number is stored as the reference number, and the segment is inserted into the database
[N9 Space Available - Proceed with Update]
The position is either empty or contains FEN qualifier data → The system proceeds with updating the N9 segment with new pedimento information
[No N9 Space Available]
No available space is found and the maximum limit is reached → The system identifies that no space is available for storing additional pedimento information
[Retrieve US Cargo Manifest Record by CCN Key]
The system needs to update the US cargo manifest with pedimento information → The system retrieves the US cargo manifest record using the CCN key
[Store Pedimento Type from K3 Segment]
The system updates the manifest with pedimento information → The pedimento type from K3-08-PEDIMENTO-TYPE is stored in GCUSRT-PEDIMENTO-TYPE field
[Store Pedimento Received Timestamp from K3 Segment]
The system updates the manifest with pedimento information → The pedimento received timestamp from K3-09-PEDIMENTO-RCV-TMSTMP is stored in GCUSRT-PEDIMENTO-RCV-TMSTMP field
[Replace Updated US Cargo Manifest Record]
The system completes the update process → The updated US cargo manifest record is replaced in the database
[Prepare Update Operation]
The record needs to be modified with new pedimento information → The system sets the function to UPDATE mode
[Populate Pedimento Details]
Pedimento information needs to be stored → The system sets pedimento number, pedimento type, action code, received timestamp, and update user ID from the K3 segment data
[Use Existing CCN from Manifest]
The US cargo manifest is found for the equipment ID and waybill number → The existing US CCN from the manifest record should be used for pedimento storage
[Keep Existing CCN]
The GCCDSPIO record exists and contains a non-blank US CCN value → The existing CCN value in the hold table should be preserved and not overwritten
[Generate Dummy CCN]
The system needs to create a new CCN for tracking purposes → A dummy CCN should be generated by concatenating the current system date and system time into a single identifier
[Store Dummy CCN in Hold Table]
The pedimento information needs to be stored in the hold table → The CCN should be stored in the GCWDSPIO-US-CCN field of the GCCDSPIO record
[Use Existing CCN from Manifest]
The US cargo manifest is found for the equipment ID and waybill number → The existing US CCN key from the manifest record should be used for pedimento storage
[Generate Dummy CCN using Date/Time]
The system is inserting a new record → A dummy CCN should be generated using current system date and time and assigned to the US CCN field
[Set Action Code to Input Message]
Creating a log entry for the processing activity → The action code is set to indicate input message processing
[Set US Cargo Control Number from Manifest]
Creating a log entry for KCSM pedimento processing → The log entry is associated with the US cargo control number from the manifest record
[Format Pedimento Number for Log Message]
Preparing the log message content → The pedimento number is formatted and included in the log message text
[Format Pedimento Type for Log Message]
Preparing the log message content → The pedimento type is formatted and included in the log message text
[Create Log Message Text for KCSM EDI996 Receipt]
Creating the complete log message → The log message is set to indicate KCSM EDI 996 message receipt with pedimento details
[Start Transaction GCT1051E for Logging]
Ready to record the log entry → The GCT1051E transaction is started to persist the log information
[Call Email Service EMCSEND3]
The system calls the external email service → The system invokes EMCSEND3 service with all email parameters to send the notification
[Set Equipment Initial and Number]
Setting up parameters for event logging service → Equipment initial is moved to GCX151AR equipment initial parameter and equipment number is moved to GCX151AR equipment number parameter
[Format Pedimento Information]
Formatting event description for logging service → Pedimento number is moved to log message FEN field and pedimento type is moved to log message TYP field
[Set Event Description Message]
Setting the event description parameter for logging service → Event description is set to the standardized KCSM EDI996 received message format
[Call MQ Close Function]
The system initiates the MQ queue close operation → The system calls the MQCLOSE function to close the queue connection
[Map Reason Code to Text Message]
The system needs to provide a descriptive error message → The system initializes output message text AND calls GCCMQERR service with MQ reason code AND receives corresponding descriptive text message
[Get Segment ID Length]
The segment ID length calculation is performed → The length counter tallies all characters before the first space character in the segment identifier
[Find Segment Start Position in Message]
The segment start position search is executed → The position counter tallies all characters before the segment identifier match in the message
[Segment Found?]
The segment existence is evaluated → Processing continues to segment length calculation if position is greater than zero, otherwise parsing ends
[Extract Segment Delimiter]
Segment length calculation begins → The character at the start position is moved to the segment delimiter variable
[Move to Next Character Position]
Position advancement is performed → The start position is incremented by one to point to the actual segment data
[Count Characters Until Next Delimiter]
Segment length calculation is performed → The length counter tallies all characters from the current position until the next delimiter occurrence
[32:Extract Original Waybill Data]
The system processes the equipment information for waybill search → Equipment initial is moved to working storage, equipment number is moved to working storage, waybill number is moved to working storage, program name is set to 'GCX996I', message name is set to '{KCSM->iEDI996->L-CP Customs}', check digit is cleared, and equipment ID formatting is performed
[39:Search Lead Car in SHIPROOT]
The system searches for lead car using equipment ID → Car search is performed with all status types included, incomplete EDI included, temporary waybill included, corrector waybill included, returned lead waybill flag set, latest waybill date flag set, and search continues until valid lead car is found or search is exhausted
[Execute SHIPROOT Database Call]
Executing the database search → Call FWCWBIO with SHIPROOT segment type and configured search parameters
[Call IMS to Get Next Equipment Request Record]
Executing the database call to get next equipment request record → The system calls IMS using GN function with equipment request segment and qualified search argument
[Set search parameters with Equipment ID]
Setting up search parameters → Equipment ID is assigned to the search key field and segment type is set to SHIPROOT
[Set segment type to 'SHIPROOT', Set equipment ID as search key, Set operator to '>' for next record, Set browse flag to 'Y']
Configuring the database search parameters → The system should set segment type to 'SHIPROOT', use the equipment ID as the search key, set the operator to '>' to get records after the current position, and enable browse mode with flag 'Y'
[Car Search Complete?]
Determining if search should continue → Search is complete if car search error occurred, car not found, haulage right carrier is empty, EDI complete release is 'Y', or duplicate car key detected, otherwise continue search loop
[Set Waybill Parameters from Car Details]
The system prepares for waybill inquiry → Road number, station number, and waybill number are extracted from car details and set in the freight inquiry structure with segment type FWIQROOT
[Get Root Key from SHIPROOT]
The system needs to search for multi-shipment waybill records → The root key is extracted from SHIPROOT and used as the search key for FWSWRWR segment
[Search FWSWRWR Segment]
The system searches the FWSWRWR segment using the root key → The system retrieves the multi-shipment waybill record if it exists and sets the multi-shipment status indicator
[Multi-Shipment Record Found?]
The system checks the search results → If multi-shipment records are found, proceed to equipment request search; otherwise, complete the search with no records found
[Get Next Equipment Request Record]
The system retrieves the next equipment request record using GNP function → The next FWSWREQ segment is retrieved if available, or the search is marked as complete
[Get Next Equipment Request Record]
A request is made to get the next equipment request record → The system performs a database call to retrieve the next equipment request segment using the search qualifier
[Set Waybill Key as Search Key]
Setting up search parameters for cargo manifest → Waybill key is constructed from waybill number for database search

Structural Validations

[Message Available?]
The message status is WS-MQ-MSG-GOOD (completion code OK and backout count zero) → The system proceeds to parse BGF segment, K3 segment, and process KCSM pedimento data
[Get EDI 996 Message]
The message backout count != zero → The system sets WS-MQ-MSG-SKIP to true and continues to get the next message
[Get EDI 996 Message]
The message data length is less than WS-MIN-MQ-LENGTH → The system sets error message WS-MQ-ERROR-IEDI996-TOO-SHORT and abends the program
[Validate N9 Space Available?]
The system searches for available N9 slots and the index exceeds WS-MAX-N9 → The system sets error reason WS-EMAIL-ERROR-A2RT-NO-SPACE and sends error email notification
[Send Error Email Notification]
The system completes manifest search procedures without finding a match → The system sends email notification with WS-EMAIL-ERROR-MANIFEST-NOTFND reason including equipment ID, CCN, pedimento number, and waybill details
[Set MQ Connection Error Message]
Error message preparation occurs → The program error text must be set to MQ connection error message
[Terminate Process with Error]
Error termination is required → The system must call the MQ error handling routine to terminate processing
[Set Message Too Short Error]
The MQ completion code is OK AND the message data length is less than the minimum required length → Set error message indicating message is too short AND trigger system termination
[Set MQ Get Error]
The MQ completion code is FAILED AND the reason code indicates no message is available → Set MQ get error status AND process the MQ error condition
[Check MQ Completion Code]
The MQ completion code != MQCC-OK → Set the MQ EOF flag to indicate end of processing and trigger MQ error handling
[Check Backout Count]
The message backout count != zero → Set the message skip flag to true to bypass processing
[Validate Message Length]
The message data length is less than the minimum required MQ length → Set error message indicating message is too short and Execute system abort
[Set MQ Error Flag]
The MQ completion code or reason code indicates an error condition not specifically handled → Set the MQ EOF flag to true, set MQ error text, and Execute MQ error handling procedure
[BGF Segment Found?]
System checks if BGF segment was located → If WS-LENGTH is greater than zero, BGF segment is found and processing continues, otherwise processing ends
[Waybill Matches?]
The system validates waybill matching → Waybill matches if GCUSRT-RT073-WB-INDEX equals K3-04-WYBL-NUM
[Is Container Equipment?]
The system checks the fourth character of the equipment initial → If the fourth character equals the container indicator, the equipment is classified as container type, otherwise it is classified as non-container equipment
[Waybill Found in SHIPROOT?]
If the SHIPROOT search results → If waybill number from SHIPROOT matches the waybill number from the message and origin road number is not 000, or if original waybill number matches and origin road number is 990, then waybill is considered found
[Validate Equipment and Waybill Match]
The system compares the lead car equipment ID with the search equipment ID and validates waybill numbers → If car ID from SHIPROOT equals the equipment ID and either waybill number or original waybill number matches the message waybill number, then the match is valid
[Set Check Digit Invalid Flag]
The system encounters an invalid check digit condition → Set check digit invalid flag and display appropriate error message for invalid container or check digit calculation
[Valid Check Digit?]
The check digit format is invalid or unrecognized → Set check digit invalid flag and display error message with equipment details
[Check EDI Completion Status]
Checking EDI completion status → If EDI completion 418 release flag is 'Y', mark search as complete, otherwise continue with previous status check
[Has Haulage Right Carrier?]
The system checks the haulage right carrier field → If haulage right carrier is spaces (empty), the lead car validation is complete and successful, otherwise continue to EDI completion check
[EDI Complete Release = 'Y'?]
The system checks the EDI completion release flag → If EDI completion release equals 'Y', the lead car validation is complete and successful, otherwise continue to equipment key validation
[Waybill Matches?]
The system compares the message waybill number with the cargo manifest waybill index → Waybill is considered matched if the waybill number from message equals the waybill index in the cargo record
[Waybill Matches in SHIPROOT?]
The system compares waybill numbers and waybill number from message equals current waybill number in SHIPROOT and origin road number is not 000, or waybill number from message equals original waybill number in SHIPROOT and origin road number is 990 → Waybill is considered matched
[Lead Car Waybill Matches?]
The system validates equipment ID matches car ID in SHIPROOT and waybill number from message equals current waybill number or original waybill number in SHIPROOT → Lead car waybill is considered matched
[Multi-Shipment Found?]
If records and equipment ID matches equipment ID in multi-shipment record and waybill number from message equals waybill reference number or equipment waybill number in multi-shipment record → Multi-shipment is considered found
[Check if A2RT N9 Segment Exists]
The system attempts to retrieve the A2RT N9 segment using the US CCN key → The system determines if the segment exists based on the retrieval status
[Space Available in N9?]
The system searches through N9 entries up to the maximum allowed entries → If an entry position is empty (spaces or low-values) or contains FEN qualifier, mark as available space, otherwise continue searching until maximum entries reached
[Send No Space Available Error Email]
The system cannot find available space to store new pedimento information → Send an error email notification indicating no space available in A2RT segments
[N9 Entry Empty or Low-Values?]
The N9 entry contains spaces or low-values → The entry is identified as available space for storing pedimento information
[Loop Counter Exceeds Maximum?]
The loop counter exceeds the maximum allowed N9 entries limit → The search process determines that no space is available for storing pedimento information
[No Space Available - Send Error Email]
The loop counter exceeds the maximum N9 entries limit → An error email notification is sent indicating that no space is available for storing pedimento information
[Check A2RT Segment Exists - Determine if A2RT segment already exists for the manifest]
The system attempts to retrieve the A2RT N9 segment using the US CCN key with valid return code acceptance criteria → The system determines segment existence status - if no error status is returned then segment exists, otherwise segment does not exist
[Check if Entry is Empty or Low-Values]
System checks if current N9 entry data is empty → System identifies the entry as available for new pedimento information if it contains spaces or low-values
[Check if Entry has FEN Qualifier]
System checks if the reference number qualifier in the N9 entry equals FEN qualifier → System identifies this entry as available for pedimento information if it already has FEN qualifier
[Send Error Email - No Space Available]
System determines no space is available for new pedimento information → System sets error reason to A2RT no space available and sends error email notification for KCSM manifest processing
[Is N9 Entry FEN Qualifier?]
The reference number qualifier is evaluated → If the qualifier equals FEN qualifier, the position is identified as already containing pedimento data
[Send Email Error Notification]
The system cannot proceed with manifest update → An error email notification is sent indicating A2RT segment has no available space
[Add Error Reason to Email Body, Add US CCN Key to Email Body, Add Equipment ID to Email Body, Add KCSM Pedimento to Email Body, Add Waybill Number to Email Body]
The system builds the email message body → The system adds the specific error reason as the first line, adds the US CCN key information as the second line, adds the equipment ID details as the third line, adds the KCSM pedimento number as the fourth line, and adds the waybill number as the fifth line
[Email Send Successful?, Set Error Message, Abort Program]
The email service response indicates delivery failure → The system sets an error message indicating email send failure and aborts the program execution
[Set MQ Error Message]
The system prepares error handling for the close failure → The system sets the program error text to the MQ open error message and prepares for error processing
[Terminate Program with Error]
The system processes the MQ close error → The system calls the MQ error handling routine which terminates the program with an error condition
[Set MQ Error Message]
System needs to set error context for program termination → System moves MQ connect error message to program error text field
[Terminate Program with Error]
System cannot successfully disconnect from MQ manager → System performs MQ error processing which includes mapping reason code to text message and terminating program with abend
[Display Error Message with Timestamp]
The system detects the connection failure → The system displays current system date and time AND displays program identifier 'GCX996I.ZB000-MQ-CONNECT' AND displays process description '{KCSM->iEDI996->L-CPKC Customs} Start' AND displays MQ queue name AND displays MQ completion code AND displays MQ reason code
[Display Error Message with Timestamp]
The system detects the open failure → The system displays current system date and time AND displays program identifier 'GCX996I.ZB000-MQ-OPEN' AND displays process description '{KCSM->iEDI996->L-CPKC Customs} Start' AND displays MQ queue name AND displays MQ completion code AND displays MQ reason code
[Display Error Message with Timestamp]
The system completes the get operation → The system displays current system date and time AND displays program identifier 'GCX996I.ZB000-MQ-GET' AND displays process description '{KCSM->iEDI996->L-CPKC Customs} Start' AND displays MQ queue name AND displays MQ completion code AND displays MQ reason code AND displays MQ data length AND displays first 600 characters of MQ message content
[Display Error Message with Timestamp]
The system detects the close failure → The system displays current system date and time AND displays program identifier 'GCX996I.ZB000-MQ-CLOSE' AND displays process description '{KCSM->iEDI996->L-CPKC Customs} Start' AND displays MQ queue name AND displays MQ completion code AND displays MQ reason code
[Display Error Message with Timestamp]
The system detects the disconnect failure → The system displays current system date and time AND displays program identifier 'GCX996I.ZB000-MQ-DISCONNECT' AND displays process description '{KCSM->iEDI996->L-CPKC Customs} Start' AND displays MQ queue name AND displays MQ completion code AND displays MQ reason code
[Set Error Message in Common Area]
The system prepares for abnormal termination → The system moves mapped error text to MQ error text field AND moves transaction set identifier to MQ transaction set field AND moves error message to common communication area error message field
[Mark Check Digit as Invalid]
Equipment number first two digits are not '00' or check digit calculation returns invalid result → Set check digit status as invalid and display error message for invalid container format
[39:Search Lead Car in SHIPROOT]
The system validates lead car search results → Search is considered complete if haulage right carrier is blank OR if EDI completion 418 release is 'Y', otherwise search continues with previous status waybill date until valid result is found
[Equipment ID Matches?]
The system compares the equipment ID from the message with the car ID in the SHIPROOT record → If the equipment IDs match, proceed to waybill validation, otherwise mark as no multi-shipment match found
[Waybill Number Matches?]
The system compares the waybill number from the message with both WB-NUM and ORIGINAL-WB-NUM in SHIPROOT → If waybill number matches either current or original waybill, extract waybill information, otherwise proceed to multi-shipment root processing
[Waybill Number Matches Request?]
The system compares the message waybill number with both FWEQ-WR-WB-NUM and FWEQ-EQP-WB-NUM → If waybill number matches either waybill root or equipment waybill, extract multi-shipment data, otherwise continue searching for next equipment request
[Set Check Digit as Invalid]
The service returns an invalid result or error status → Set check digit status as invalid and display error message for invalid check digit
[Set Check Digit Not Allowed]
The first two digits of equipment number are not '00' → Set check digit as not allowed and display error message for invalid container format
[Haulage Right Carrier Available?]
Checking haulage right carrier field → If haulage right carrier is spaces or empty, then search is marked as complete, otherwise continue with EDI release check
[EDI Complete Release Available?]
Checking EDI complete release status → If EDI complete 418 release equals 'Y', then search is marked as complete, otherwise continue with car key validation

Module: GCCCARID 1 Consolidated Epic Story

Epic: GCCCARID Complete EDI Specification Extracted from Legacy

Contains 7 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCARID EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Start from position after leading spaces]
The system begins extracting alphabetic characters → The extraction starts from the position immediately after all leading spaces
[Is current character a space?]
The current character at position I1 is evaluated → If the character is a space, numeric portion processing must stop immediately
[Start scanning from position after initials and spaces]
The system needs to count numeric characters → Scanning starts from the position immediately after the initials and spaces (position I2)
[Move numeric characters to output format right-justified]
The numeric portion needs to be formatted in the output car ID structure → Each numeric character should be moved to the numeric field starting from the rightmost position (position 7) and filling leftward, maintaining the original sequence of digits

Structural Validations

[Character Type Check - Is character non-alphabetic?]
A non-alphabetic character is encountered at the current position → The initial extraction process should terminate immediately
[Letter Count Check - Have 5 letters been extracted?]
The counter for extracted initials reaches 5 characters → The initial extraction process should terminate to prevent exceeding the maximum allowed initials
[Position Boundary Check - Is I1 > 12?]
The system needs to extract a character from the car ID at the current position → The system must verify that the position I1 is not greater than 12 (the maximum field length) before proceeding with character extraction

Module: GCCCCIO 1 Consolidated Epic Story

Epic: GCCCCIO Complete EDI Specification Extracted from Legacy

Contains 34 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCCIO EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Is Creation Timestamp Empty?]
The creation timestamp field is empty (spaces) → The system should proceed to set new creation information including date, time, terminal and user
[Use Secondary Index Search]
The secondary index option is selected → The system builds secondary index SSA using the secondary key and executes database call to retrieve the record
[Use Primary Key Search]
The primary key option is selected and secondary key is valid → The system builds primary key SSA using GCSCCS00-KEY and executes database call to retrieve the record
[Attempt to Retrieve Existing Record]
The system attempts to retrieve the existing record using GHU function → The system determines if the record exists based on the database response status
[Attempt to Retrieve Existing GCSCCS00 Record]
The system needs to check if a GCSCCS00 record already exists → The system performs a Get Hold Unique operation to retrieve the existing record and sets the status code accordingly
[Delete Request for GCSCCS00 Record]
The system processes the delete operation → The system should save current record data and set up for record retrieval to validate existence before deletion
[Skip Insert Operation]
The cargo data field contains all spaces, all low-values, or all underscore characters → The insert operation should be skipped and no database call should be made
[Delete Existing Record]
The cargo data field contains all spaces, all low-values, or all underscore characters → The existing record should be deleted from the database
[Continue with Insert]
The cargo data field contains values other than all spaces, all low-values, or all underscore characters → The insert operation should proceed normally and the record should be added to the database
[Continue with Update]
The cargo data field contains values other than all spaces, all low-values, or all underscore characters → The replace operation should proceed normally and the record should be updated in the database
[Process Normal Update]
The cargo data field contains values other than all spaces, all low-values, or all underscore characters → The operation should be converted to an insert and the new record should be added to the database
[Database Segment Type?]
The segment type is GCSCCRT → The system routes to primary database function processing
[Database Segment Type?]
The segment type is GCSA2RT → The system routes to secondary database function processing
[Primary Function Code?]
The function code is ISRT (Insert) → The system routes to insert processing for primary segment
[Primary Function Code?]
The function code is REPL (Replace) → The system routes to replace processing for primary segment
[Primary Function Code?]
The function code is DLET (Delete) → The system routes to delete processing for primary segment
[Index Usage?]
The index usage indicator is NOT-USED → The system routes to primary key retrieval processing
[Index Usage?]
The index usage indicator is not NOT-USED → The system routes to secondary index retrieval processing
[Secondary Function Code?]
The function code is ISRT (Insert) → The system routes to insert processing for secondary segment
[Secondary Function Code?]
The function code is REPL (Replace) → The system routes to replace/update processing for secondary segment
[Secondary Function Code?]
The function code is DLET (Delete) → The system routes to delete processing for secondary segment
[Index Type?]
The index usage indicator is SECN-KEY → The system routes to secondary key retrieval processing
[Index Type?]
The index usage indicator is not SECN-KEY → The system routes to primary key retrieval processing

Structural Validations

[1:Parameter Validation]
The segment name is not GCSCCRT (primary segment) and not GCSA2RT (secondary segment) → The system marks parameters as invalid and sets error message to 'SEGMENT NAME INVALID'
[1:Parameter Validation]
The function code is not GU (Get Unique) and not GN (Get Next) and not ISRT (Insert) and not REPL (Replace) and not DLET (Delete) → The system marks parameters as invalid and sets error message to 'FUNCTION CODE INVALID'
[1:Parameter Validation]
The index usage indicator is not NOT-USED and not WAYBILL and not CAR-ID and not DESTINATION and not ERROR and not PRINT and not LEAD-CCN and not SECN-KEY → The system marks parameters as invalid and sets error message to 'INDEX USAGE INDICATOR INVALID'
[2:Primary Database Record Retrieval]
The CCN key is empty spaces → The system marks parameters as invalid and sets error message to 'GCCC-CCN-KEY EQUAL SPACES'
[6:Secondary Database Record Retrieval]
The secondary key is empty spaces → The system marks parameters as invalid and sets error message to 'SECN-KEY EQUAL SPACES'
[Segment Name Valid?]
The segment name is not GCSCCRT (primary segment) and not GCSA2RT (secondary segment) → The system sets parameter invalid flag and displays error message 'SEGMENT NAME INVALID'
[Function Code Valid?]
The function code is not GU (Get Unique) and not GN (Get Next) and not ISRT (Insert) and not REPL (Replace) and not DLET (Delete) → The system sets parameter invalid flag and displays error message 'FUNCTION CODE INVALID'
[Index Usage Indicator Valid?]
The index usage indicator is not NOT-USED and not WAYBILL and not CAR-ID and not DESTINATION and not ERROR and not PRINT and not LEAD-CCN and not SECN-KEY → The system sets parameter invalid flag and displays error message 'INDEX USAGE INDICATOR INVALID'
[Build Primary Key SSA]
The CCN key is empty spaces → The system sets parameter invalid status AND sets error message 'GCCC-CCN-KEY EQUAL SPACES'
[Secondary Key Empty?]
The secondary key (GCSCCS00-KEY) is empty → The system sets parameter invalid status and returns error message 'SECN-KEY EQUAL SPACES'
[Compare Primary Key with Retrieved Key]
The system compares the retrieved CCN key with the original key value used for the search → The system sets the data-in-range flag to true if keys match, otherwise sets data-not-in-range flag to true

Module: GCCCCIO2 1 Consolidated Epic Story

Epic: GCCCCIO2 Complete EDI Specification Extracted from Legacy

Contains 182 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCCIO2 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program Parameters]
Function code is GU (Get Unique) → Clear all cargo segment data areas (52, 53, 54, 55, 56) and working storage arrays
[Initialize Secondary Segment Structure]
The fetch process begins → The secondary segment data structure (GCSCCS00) should be cleared to spaces
[Initialize Segment Type 52 Processing]
The segment 52 processing routine is invoked → The system clears the communication areas and working storage for segment processing
[Initialize Segment Type 53 Processing]
The segment 53 processing routine is initiated → The communication areas are cleared and record type is set to '53'
[Initialize Segment 54 Processing]
The segment 54 processing routine is initiated → The communication areas are cleared and the record type is set to '54'
[Initialize Segment Type 55 Processing]
The segment 55 processing routine is initiated → The system clears the communication work area and segment data area, and sets the record type to '55'
[Initialize Segment Type 56 Processing]
The segment type 56 processing is initiated → The system clears the working communication area and segment data area, and sets the record type to '56'
[Initialize Secondary Segment Key]
The system initializes the navigation parameters → The secondary segment structure is cleared and the CCN key is set from the cargo root key

Core Acceptance Criteria

[Process All Segments?]
First segment name is set to ALL → Process cargo root segment first, then process all secondary segments if root processing succeeds
[Fetch All Segments?]
First segment name is set to FETCH ALL → Process cargo root segment first, then fetch all secondary segments if root processing succeeds
[4:Fetch All Secondary Segments]
Fetching all secondary segments for the CCN key → Retrieve each segment, validate sequence numbers, and route data to appropriate segment type arrays (52, 53, 54, 55, 56) based on record type
[3:Process All CA Cargo Segments]
Function code is GU (Get Unique) → Fetch all secondary segments, otherwise process each segment type individually (52, 53, 54, 56, 55)
[5:Process Selected Segments]
Processing selected segments from the segment names array → For each requested segment (up to 10), process the corresponding segment type (root, 52, 53, 54, 55, 56) based on segment name and function code
[7:Process Cargo Segment Type 52]
Processing each sequence up to maximum allowed for segment 52 → Skip empty keys for update/delete operations, set sequence numbers, use existing data for update/delete or retrieve and store data for get operations
[8:Process Cargo Segment Type 53]
Processing each sequence up to maximum allowed for segment 53 → Skip empty keys for update/delete operations, set sequence numbers, use existing data for update/delete or retrieve and store data for get operations
[9:Process Cargo Segment Type 54]
Processing each sequence up to maximum allowed for segment 54 → Skip empty keys for update/delete operations, set sequence numbers, use existing data for update/delete or retrieve and store data for get operations
[10:Process Cargo Segment Type 55]
Processing sequences and encountering empty keys with update/delete operations → If return status is OK Execute delete operation, if return status is not OK Execute replace operation, otherwise process normally with sequence handling
[11:Process Cargo Segment Type 56]
Processing each sequence up to maximum allowed for segment 56 → Skip empty keys for update/delete operations, set sequence numbers, use existing data for update/delete or retrieve and store data for get operations
[Function Code is GET?]
The function code is GET (GU) → All cargo segment data areas must be cleared for fresh data retrieval
[Clear Root Segment Data]
Preparing for fresh cargo data retrieval → The root cargo segment data area is cleared to spaces
[Clear Type 52 Segment Data]
Preparing Type 52 cargo segment for data retrieval → The Type 52 segment data area is cleared to spaces
[Clear Type 53 Segment Data]
Preparing Type 53 cargo segment for data retrieval → The Type 53 segment data area is cleared to spaces
[Clear Type 54 Segment Data]
Preparing Type 54 cargo segment for data retrieval → The Type 54 segment data area is cleared to spaces
[Clear Type 55 Segment Data]
Preparing Type 55 cargo segment for data retrieval → The Type 55 segment data area is cleared to spaces
[Clear Type 56 Segment Data]
Preparing Type 56 cargo segment for data retrieval → The Type 56 segment data area is cleared to spaces
[Clear Working Arrays]
Finalizing data area preparation for GET operations → All working storage arrays for cargo segments are cleared to spaces
[Input Parameters Valid]
CCN key is provided AND segment names are specified → Allow the system to continue to main cargo data processing
[Function Code = GU?]
The function code is GU (Get Unique) → The system should fetch all secondary segments instead of processing individual segment types
[Fetch All Secondary Segments]
The system retrieves secondary segments for the CCN key → Each segment should be routed to the appropriate data array based on its record type (52, 53, 54, 55, or 56)
[Process Cargo Segment Type 52]
The system processes cargo segments → Each segment type (52, 53, 54, 55, 56) should be processed individually in sequential order
[Fetch All Secondary Segments]
The record type is '52', '53', '54', '55', or '56' → The segment data should be moved to the corresponding data array for that record type
[Fetch All Secondary Segments]
The return status is not OK, end of file is reached, or the CCN key changes → The system should stop processing segments
[Set CCN Key for Search]
Preparing to search for secondary cargo segments → The CCN key should be set in the secondary segment search structure
[Get First Secondary Cargo Segment]
Starting the fetch process for secondary cargo segments → The system should retrieve the first secondary cargo segment record
[More Segments Available?]
Checking if more segments are available for processing → Continue processing if return status is OK and not end-of-file, otherwise terminate the fetch process
[Segment Type = '52'?]
Determining the segment type for proper storage → Route to type 52 storage if the record type is '52', otherwise check for type 53
[Segment Type = '53'?]
Continuing to determine the segment type for proper storage → Route to type 53 storage if the record type is '53', otherwise check for type 54
[Segment Type = '54'?]
Continuing to determine the segment type for proper storage → Route to type 54 storage if the record type is '54', otherwise check for type 55
[Segment Type = '55'?]
Continuing to determine the segment type for proper storage → Route to type 55 storage if the record type is '55', otherwise check for type 56
[Segment Type = '56'?]
Determining the final segment type for proper storage → Route to type 56 storage if the record type is '56', otherwise proceed to get next segment
[Store in Type 52 Array]
Storing the segment data for later use → The segment data should be stored in the type 52 data array at the sequence number position
[Store in Type 53 Array]
Storing the segment data for later use → The segment data should be stored in the type 53 data array at the sequence number position
[Store in Type 54 Array]
Storing the segment data for later use → The segment data should be stored in the type 54 data array at the sequence number position
[Store in Type 55 Array]
Storing the segment data for later use → The segment data should be stored in the type 55 data array at the sequence number position
[Store in Type 56 Array]
Storing the segment data for later use → The segment data should be stored in the type 56 data array at the sequence number position
[Get Next Secondary Segment]
Continuing the fetch process for remaining segments → The system should retrieve the next secondary cargo segment record
[End Fetch Process]
The fetch loop determines no more processing is needed → The fetch process should terminate and return control to the calling process
[Store in Type 52 Array]
The system processes the segment for storage → The segment data is stored in the Type 52 array at the position corresponding to the sequence number
[Store in Type 53 Array]
The system processes the segment for storage → The segment data is stored in the Type 53 array at the position corresponding to the sequence number
[Store in Type 54 Array]
The system processes the segment for storage → The segment data is stored in the Type 54 array at the position corresponding to the sequence number
[Store in Type 55 Array]
The system processes the segment for storage → The segment data is stored in the Type 55 array at the position corresponding to the sequence number
[Store in Type 56 Array]
The system processes the segment for storage → The segment data is stored in the Type 56 array at the position corresponding to the sequence number
[Process CA Cargo Root Segment for Update/Delete]
If the segment type in the selection array → The system processes the cargo root segment
[Process Cargo Segment Type 52]
If the segment type in the selection array → The system processes cargo segment type 52
[Process Cargo Segment Type 53]
If the segment type in the selection array → The system processes cargo segment type 53
[Process Cargo Segment Type 54]
If the segment type in the selection array → The system processes cargo segment type 54
[Process Cargo Segment Type 55]
If the segment type in the selection array → The system processes cargo segment type 55
[Process Cargo Segment Type 56]
If the segment type in the selection array → The system processes cargo segment type 56
[Move to Next Segment Selection]
The system processes selected segments → The system iterates from position 1 by 1 until position 10 or until segment name is empty
[Root Segment Selected?]
If the segment type at array position I → The system processes the root cargo segment
[Type 52 Segment Selected?]
If the segment type at array position I → The system processes the type 52 cargo segment
[Type 53 Segment Selected?]
If the segment type at array position I → The system processes the type 53 cargo segment
[Type 54 Segment Selected?]
If the segment type at array position I → The system processes the type 54 cargo segment
[Type 55 Segment Selected?]
If the segment type at array position I → The system processes the type 55 cargo segment
[Type 56 Segment Selected?]
If the segment type at array position I → The system processes the type 56 cargo segment
[Process Root Segment]
The system determines root segment processing is required → The system calls the root cargo processing function
[Process Type 52 Segment]
The system determines type 52 segment processing is required → The system calls the type 52 cargo processing function
[Process Type 53 Segment]
The system determines type 53 segment processing is required → The system calls the type 53 cargo processing function
[Process Type 54 Segment]
The system determines type 54 segment processing is required → The system calls the type 54 cargo processing function
[Process Type 55 Segment]
The system determines type 55 segment processing is required → The system calls the type 55 cargo processing function
[Process Type 56 Segment]
The system determines type 56 segment processing is required → The system calls the type 56 cargo processing function
[Move to Next Array Position]
The system completes processing for the current segment → The system increments the array position counter to move to the next segment
[Skip Processing Flag Set?]
The skip processing flag (88-RETURN-SKIP-PRCS) is set to true → The system should exit processing without performing any cargo operations
[Save Current Root Segment Data]
Processing begins for the root segment → The system should save the current GCSCCRT data to WS-GCSCCRT-SAVE for potential restoration
[Clear Communication Area]
Preparing for database operation → The system should clear GCWCCIO communication area and restore the saved accept status
[Set Root Segment Processing Flag]
Setting up for root segment processing → The system should set GCWCCIO-SEG-GCSCCRT flag to true and copy the function code and security index from input parameters
[Set Get Function]
Setting up the database operation → The system should set GCWCCIO-FUNC-GU flag to true
[Set Update/Insert/Delete Function]
Setting up the database operation → The system should use the function code from input parameters (GCWCCIO2-FUNC-CODE)
[Call Database Operation]
Executing the root segment operation → The system should call GCCCCIO program with communication area and root segment data
[Database Operation Successful?]
The operation fails (CC-STATUS-CODE is not spaces) → The system should set data not in range flag, set return status to not OK, and clear root segment data for Get operations
[Set Record Type to '52']
The record type needs to be identified for database operations → The system sets the record type field to '52'
[J > Maximum Sequence?]
The current sequence counter J is compared against the maximum sequence limit → The system continues processing if J is within limits or terminates the loop if J exceeds the maximum sequence count
[Empty Key AND Update/Delete Function?]
The sequence has an empty key identifier → The system skips processing this sequence and continues to the next sequence
[Set Sequence Number J]
The sequence number needs to be established for the current record → The system sets the sequence number field to the current counter value J
[Load Existing Data for Sequence J]
The operation requires existing data for the current sequence → The system loads the existing data from the working storage array for the specified sequence
[Execute Database Operation for Segment 52]
A database operation needs to be executed → The system calls the database interface to Execute the requested operation on the segment record
[Store Retrieved Data to Segment 52]
Data has been retrieved from the database → The system stores the retrieved data to the cargo segment 52 structure and working storage array
[Set Record Type to '53']
The record type needs to be identified → The record type field is set to '53'
[J > Maximum Sequence?]
The current sequence number J is compared against the maximum sequence limit for segment 53 → Processing continues if J is less than or equal to maximum sequence limit, otherwise processing terminates
[Empty Key AND Update/Delete Operation?]
The segment key is empty AND the function is either update or delete operation → The current sequence is skipped and processing continues with the next sequence
[Set Sequence Number J]
The sequence number needs to be established for the current record → The sequence number is set to the current loop counter value J
[Update or Delete Operation?]
The function code indicates an update or delete operation → The existing data from working storage array is moved to the processing area before database operations
[Move Working Storage Data to Processing Area]
The working storage contains existing data for the current sequence → The data from working storage array position J is moved to the processing area
[Execute Database Operations for Segment 53]
Database operations need to be executed → The appropriate database operation is performed based on the function code
[Get Operation?]
The function code indicates a get operation → The retrieved data is stored in both the segment area and working storage array
[Move Retrieved Data to Segment 53]
The operation is a get function → The retrieved data is moved to the segment 53 output area
[Move Retrieved Data to Working Storage Array]
The operation is a get function → The retrieved data is moved to the working storage array at position J
[Increment Sequence Counter J]
The sequence processing needs to continue → The sequence counter J is incremented by 1 to process the next sequence
[Set Record Type to '54']
The record type needs to be identified → The record type field is set to '54'
[Start Sequence Loop J=1]
The processing loop is initiated → The sequence counter J starts at 1 and increments until the maximum sequence limit is reached
[Empty Key AND Update/Delete Function?]
If whether to process the record → The record is skipped and processing continues with the next sequence
[Skip This Sequence]
The skip condition is triggered → Processing moves to the next sequence without performing any operations on the current record
[Set Sequence Number]
The sequence number needs to be assigned → The current loop counter J is assigned as the sequence number for the record
[Update or Delete Function?]
The function type is evaluated → If the function is update or delete, existing data from working storage is used; otherwise, the operation proceeds without pre-loading data
[Move Working Storage Data to Processing Area]
The function is update or delete → The corresponding data from the working storage array is moved to the processing area
[Execute Database Operation for Segment 54]
The database operation is executed → The system performs the requested operation (get, update, delete, or insert) on the cargo segment 54 record
[Get Function?]
The function type is evaluated → If the function is a get operation, the retrieved data is processed and stored; otherwise, processing continues to the next sequence
[Move Retrieved Data to Segment 54]
The function is a get operation → The retrieved data is moved to the cargo segment 54 data structure
[Store Data in Working Storage Array]
The get operation is completed → The data is also stored in the corresponding working storage array position
[Increment Sequence Counter]
Processing of the current sequence is complete → The sequence counter J is incremented to process the next sequence
[Set Record Type to '55']
The record type needs to be identified → The system sets the record type field to '55'
[Start Sequence Loop J=1]
Processing begins for segment type 55 → The system starts a loop with sequence counter J beginning at 1 and continues until J exceeds the maximum sequence limit for segment 55
[Empty Key AND Update/Delete Function?]
The function is either update or delete → The system applies special deletion logic based on the current return status rather than standard processing
[Set Delete Function Parameters]
Special deletion processing is required → The system sets the function to delete, configures segment 55 parameters, sets index as not used, moves the sequence number, clears cargo data, and executes the deletion operation
[Set Replace Function Parameters]
Special replacement processing is required → The system sets all segments for processing, sets the function to replace, configures delete function flag, and sets index as not used
[Set Current Sequence Number]
The sequence number needs to be established for the record → The system moves the current J value to the working sequence field and then to the segment 55 key sequence field
[Move Working Storage Data to Processing Area]
Data needs to be prepared for the database operation → The system moves the working storage data for the current sequence from the segment 55 array to the processing area
[Execute Database Operation for Segment 55]
The database operation needs to be executed → The system calls the database processing routine with the prepared segment data
[Move Result to Segment 55 Output]
Data is successfully retrieved from the database → The system moves the retrieved data to both the segment 55 output area and the working storage array for the current sequence
[Exit Loop - Set J Beyond Maximum]
The return status indicates failure → The system forces loop termination by setting the sequence counter J to a value beyond the maximum sequence limit
[Is Return Status OK?]
The return status is checked for OK condition → If return status is OK, proceed with direct delete operation, otherwise proceed with replace operation
[Set Delete Function Parameters]
Delete operation is selected as the processing path → Clear communication area, set accept status to 'GE', set delete function flag, and configure index as not used
[Set Segment Type 55 for Delete]
Segment type needs to be specified for the delete operation → Set segment type to GCSCCS55 for targeted deletion
[Move Sequence Number to Key]
The sequence number needs to be assigned to the segment key → Move the current sequence number to the segment key sequence field
[Set Replace Function Parameters]
Replace operation is selected as the processing path → Clear communication area, set accept status to 'GE', set replace function flag, and configure index as not used
[Set All Segments for Replace]
Segment scope needs to be specified for the replace operation → Set segment processing to ALL segments mode
[Continue Processing Next Sequence]
Processing needs to continue to next sequence → Skip normal segment operation and continue with next sequence iteration
[Process Normal Segment Operation]
Normal processing path is selected → Execute standard segment processing including sequence assignment, data movement, and cargo processing call
[Empty Key AND Update/Delete Function?]
The segment key at sequence J is empty → The system skips processing for this sequence and continues to the next sequence
[Set Sequence Number J]
A valid sequence needs to be processed → The system moves the counter J to the working sequence field and assigns it to the segment key sequence
[Move Segment Data to Working Storage]
The segment data needs to be prepared for the operation → The system moves the segment data from the working array at sequence J to the segment processing area
[Execute Database Operation for Segment 56]
A database operation needs to be executed → The system calls the data access module to Execute the operation on the segment data
[Move Result to Segment 56 Structure]
The function code is get (GU) → The system moves the retrieved data to both the segment structure and the working array at sequence J
[Set Accept Status to 'GE' for Get]
The function code is GU (Get Unique) → The accept status should be set to 'GE' and the CCN key should be moved to the segment key
[Set Accept Status to 'GB' for Get Next]
The function code is GN (Get Next) → The accept status should be set to 'GB'
[Set Accept Status to 'IIGE' for Insert/Update/Delete]
The function code is neither GU nor GN (indicating insert, update, or delete operation) → The accept status should be set to 'IIGE'
[Set Segment Type to GCSA2RT]
The database interface parameters need to be set → The segment type should be set to GCSA2RT and the function code should be set from the working storage function code
[Call Database Interface GCCCCIO]
The database operation needs to be executed → The system should call program 'GCCCCIO' with the communication area, interface parameters, and segment data
[Status Code Empty?]
The database interface returns a status code → If the status code is empty (spaces), the operation is successful; otherwise, the operation failed
[Set Return Status OK]
The database status code is empty (indicating success) → The return status should be set to OK (88-RETURN-OK)
[Set Return Status Not OK]
The database status code is not empty (indicating failure) → The return status should be set to Not OK (88-RETURN-NOT-OK)
[Set Record Type to '0']
The system sets up search parameters → The record type is set to all zeros as the starting point for segment retrieval
[Set Sequence to '0']
The system sets up search parameters → The sequence number is set to all zeros as the starting point for segment retrieval
[Execute Get First Secondary Segment]
The system executes the get first secondary segment operation with greater than operator → The first secondary segment matching the criteria is retrieved or an appropriate status is returned
[First Segment Found?, Next Segment Found?]
The system checks the operation result → If the status code is spaces, the segment is found and processing continues, otherwise navigation is complete
[Store in Type 52 Array]
The system processes the segment data routing → The segment data is stored in the type 52 data array at the position indicated by the sequence number
[Store in Type 53 Array]
The system processes the segment data routing → The segment data is stored in the type 53 data array at the position indicated by the sequence number
[Store in Type 54 Array]
The system processes the segment data routing → The segment data is stored in the type 54 data array at the position indicated by the sequence number
[Store in Type 55 Array]
The system processes the segment data routing → The segment data is stored in the type 55 data array at the position indicated by the sequence number
[Store in Type 56 Array]
The system processes the segment data routing → The segment data is stored in the type 56 data array at the position indicated by the sequence number
[Execute Get Next Secondary Segment]
The system executes the get next secondary segment operation → The next secondary segment in sequence is retrieved or an appropriate status is returned
[End of File Reached?]
The system checks for end of file condition → If the status code indicates end of file (GE or GB), navigation is complete
[Store in Type 52 Array WS-GCSCCS52-DATA]
The segment record type equals '52' → Store the complete segment data in the Type 52 array at the sequence position
[Store in Type 53 Array WS-GCSCCS53-DATA]
The segment record type equals '53' → Store the complete segment data in the Type 53 array at the sequence position
[Store in Type 54 Array WS-GCSCCS54-DATA]
The segment record type equals '54' → Store the complete segment data in the Type 54 array at the sequence position
[Store in Type 55 Array WS-GCSCCS55-DATA]
The segment record type equals '55' → Store the complete segment data in the Type 55 array at the sequence position
[Store in Type 56 Array WS-GCSCCS56-DATA]
The segment record type equals '56' → Store the complete segment data in the Type 56 array at the sequence position
[Skip Processing - Continue to Next Segment]
The operation is an update or delete function → The system should skip processing this segment and continue to the next sequence number
[Process Segment Normally]
Any operation type is requested → The system should process the segment normally according to the function code
[Process Segment Normally]
The operation is not an update or delete function → The system should process the segment normally according to the function code

Structural Validations

[2:Validate Input Parameters]
Segment names parameter is empty or spaces → Set parameter segment names error and skip processing
[Root Processing OK?]
Root segment processing returns successful status → Continue with secondary segment processing based on requested operation type
[Set Root Not Found Error]
Root segment processing fails or returns not found status → Set root not found error and skip all secondary segment processing
[4:Fetch All Secondary Segments]
Segment sequence number is not numeric → Set sequence number to default value of 1
[Are Segment Names Empty?]
The segment names parameter is empty (spaces) → Set parameter segment names error flag AND set skip processing flag to prevent further processing
[Fetch All Secondary Segments]
The segment's sequence number is not numeric → The sequence number should be set to 1
[CCN Matches Current Record?]
Validating the record belongs to the correct customer → Continue processing if the segment CCN key matches the search CCN key, otherwise terminate the fetch process
[Segment Retrieved Successfully?]
Checking if the segment was successfully retrieved → Process the segment data if return status is OK and CCN keys match, otherwise get the next segment
[Sequence Number Valid?]
Processing the segment sequence number → Use the existing sequence number if it is numeric, otherwise default to sequence number 1
[Set Sequence to 1]
Processing the segment for storage → The sequence number should be set to 1
[Check Record Type]
The system validates the sequence number before storage → The sequence number is set to 1 as the default value
[More Segments to Check?]
The system completes processing a segment at position I → The system checks if I is less than or equal to 10 and if the segment name at position I is not empty to determine if more segments need processing
[CCN Key Empty?]
The CCN key (WS-CCN-KEY) is empty (spaces) → The system should exit processing without performing any cargo operations
[J > Maximum Sequence?]
The current sequence number J is compared against the maximum sequence limit → Processing continues if J is within limits, otherwise processing terminates
[J > Maximum Sequence?]
The current sequence counter J is evaluated → If J exceeds the maximum sequence limit, the system terminates processing; otherwise, it continues with the current sequence
[Check Segment 55 Empty Key]
The segment key is empty AND the function is update or delete → The system should identify this as a special case requiring deletion logic
[J > Maximum Sequence?]
The sequence counter J is compared against the maximum sequence limit for segment type 56 → If J exceeds the maximum sequence limit, the processing loop terminates
[Clear Segment Data]
The function code is GU (Get Unique) and the database operation was not successful → The segment data (GCSCCS00) should be cleared to spaces
[Sequence Not Numeric?]
The system validates the sequence number format → If the sequence number is not numeric, it is defaulted to 1, otherwise the original value is retained
[Set Sequence to 1]
The system processes the invalid sequence number → The sequence number is set to 1 as the default value
[Same CCN Key?]
The system validates the CCN key consistency → If the segment CCN key matches the original CCN key, processing continues, otherwise navigation is complete

Module: GCCCROS2 1 Consolidated Epic Story

Epic: GCCCROS2 Complete EDI Specification Extracted from Legacy

Contains 11 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCROS2 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Clear Crossing Table Segment Area]
The system continues environment initialization → All fields in the crossing table segment area are cleared to spaces
[Clear Crossing Table Segment]
The system begins building a crossing table key → The crossing table segment is cleared to spaces to remove any previous data
[Set Shipper CHOP Code in Key]
The system builds the crossing table key → The shipper CHOP code is moved to the corresponding key field in the crossing table segment
[Set Consignee CHOP Code in Key]
The system builds the crossing table key → The consignee CHOP code is moved to the corresponding key field in the crossing table segment
[Set Origin Station in Key]
The system builds the crossing table key → The origin station code is moved to the corresponding key field in the crossing table segment
[Set Destination Station in Key]
The system builds the crossing table key → The destination station code is moved to the corresponding key field in the crossing table segment
[Set Origin SPLC Code in Key]
The system builds the crossing table key → The origin SPLC code is moved to the corresponding key field in the crossing table segment
[Set Destination SPLC Code in Key]
The system builds the crossing table key → The destination SPLC code is moved to the corresponding key field in the crossing table segment
[Set Commodity Code in Key]
The system builds the crossing table key → The commodity code is moved to the STCC field in the crossing table segment
[Prepare Database Query Key]
The system needs to prepare the database query key for crossing table lookup → The system clears the crossing table segment, moves all input parameters to their corresponding key fields, and creates an indexed key for database search
[Clear Output Data Area]
The system processes the unsuccessful query result → The system moves spaces to the crossing table segment to clear any residual data

Structural Validations

None explicitly identified in logic extraction.

Module: GCCDUPCA 1 Consolidated Epic Story

Epic: GCCDUPCA Complete EDI Specification Extracted from Legacy

Contains 45 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCDUPCA EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Message Structure]
The system begins generating an alert message → All message input fields are cleared to spaces to ensure clean message structure

Core Acceptance Criteria

[Input Source Type?]
The system checks the OUTPUT-MESSAGE field → If OUTPUT-MESSAGE is empty (SPACES), process cargo report input; otherwise process message input
[3:Extract Manifest Identifiers from Cargo Report]
The system extracts manifest identifiers → CCN key, waybill key, and equipment ID are extracted from cargo report segment
[3:Extract Manifest Identifiers from Message Input]
The system extracts manifest identifiers → CCN from input field, waybill components (road, station, number, date), and car ID are extracted from message data
[4:Search for Duplicate Manifests by Car ID]
The system searches for records with the same car ID → Database is queried using car ID as search key and cargo report segment is retrieved
[7:Generate Duplicate Manifest Alert Message]
The system generates alert message → Alert message is created with action code 'ZZZ', message 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID', CCN key, transaction details, user ID, and timestamp
[8:Log Duplicate Manifest Event]
The system logs the duplicate event → Alert message is sent to message queue and written to audit log with message details
[10:Restore Original Cargo Data]
The system restores original data → Original cargo report segment is restored from saved copy
[Input Source Type?]
The system checks the OUTPUT-MESSAGE field → If OUTPUT-MESSAGE is empty (SPACES), process cargo report data; otherwise process message input data
[Destination NOT IIS-A6?]
The system checks the GCM24-MANIFEST-TO field → If destination is not 'IIS-A6', continue validation; otherwise skip duplicate checking
[Valid Haulage Rights?]
If GCM24-HAULAGE-SCAC and GCMSG-INPUT-FIELD → If NOT (SCAC is empty AND input field does not start with '6105E'), proceed with duplicate checking; otherwise skip duplicate checking
[Extract from Cargo Report Segment]
The system needs to extract manifest identifiers for duplicate checking → The system captures CCN key from cargo report CCN key field, waybill ID from cargo report waybill key field, and car ID from cargo report equipment ID field
[Extract from Message Input]
The system needs to extract manifest identifiers for duplicate checking → The system captures CCN key from message input field, waybill road from GCM24 waybill road, waybill station from GCM24 waybill station, waybill number from GCM24 waybill number, waybill date from GCM24 date, and car ID from GCM24 car ID
[Input Source Type?]
The system checks the OUTPUT-MESSAGE field → If OUTPUT-MESSAGE equals spaces then process cargo report segment data, otherwise process message input data
[Clear Cargo Report Segment]
The system begins database query preparation → The cargo report segment is cleared to spaces to ensure no residual data affects the query
[Clear Cargo Record Buffer]
The system prepares to get the next record with the same car ID → The cargo report segment buffer is cleared to spaces to prevent data contamination
[Prepare CCN Key for Record Lookup]
The system needs to retrieve a specific cargo record → The CCN key must be extracted from the cargo report segment and prepared for database lookup
[Generate Alert Message with Browse Instruction]
An alert message needs to be created → The system must generate a message with action code 'ZZZ', message text 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID', include the CCN key, set security and cargo flags, and populate transaction details including user ID, date, and time
[Send Message to System Queue]
The message needs to be queued for processing → The system must send the message to the alternate PCB queue using CIMS with CHNG operation
[Write Audit Log Entry]
Audit logging is required → The system must call WRITMSGL to write an audit log entry with message code, message content, message length, and module name, followed by a purge operation
[Record Successfully Updated]
The update operation completes successfully → The system generates an audit message 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID' with the CCN key, timestamp, and user information for logging and notification
[Set Action Code to 'ZZZ']
The system sets the message action code → The action code is set to 'ZZZ' to identify this as a duplicate manifest alert
[Set Alert Message Text: 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID']
The system sets the alert message text → The message text is set to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID' to inform users and provide resolution guidance
[Add CCN Key to Message]
The system adds identification information to the message → The CCN key from the cargo report segment is included in the train or US CCN field of the alert message
[Set Security Level]
The system sets the security level for the message → The security byte is set to high-value to establish maximum security level for the alert
[Set Message Category to Cargo]
The system sets the message category → The message category is set to cargo to ensure proper classification and routing
[Add Transaction Information]
The system adds transaction tracking information → The transaction code from the communication control block is included as the sending transaction in the alert message
[Add User ID Information]
The system adds user identification information → The ACF2 user ID from the communication control block is included in the alert message
[Add Current Date to Message]
The system adds the current date to the message → The machine century and machine date are concatenated together to form the complete date in the alert message
[Add Current Time to Message]
The system adds the current time to the message → The machine time from the communication control block is included in the alert message
[Prepare Message for Queue]
The system prepares the message for queue processing → The complete alert message input is moved to the message queue structure for transmission
[Send Alert Message to System Queue]
The system sends the message to the queue → The alert message is transmitted to the system queue using the alternate PCB and message logging service
[Duplicate Manifest Alert Message Created]
The system needs to create an alert message → The system creates a message with action code 'ZZZ', sets the message content to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID', includes the CCN key as train/CCN identifier, sets security level to high value, and marks it as cargo-related
[Set Message Code]
The system prepares the audit log parameters → The system sets the message code to 'ZZZ' to identify this as a duplicate manifest alert
[Set Message Content]
The system creates the alert message content → The system sets the message to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID' to inform users about the duplicate condition and recommended action
[Set Message Content]
The system needs to identify the specific manifest → The system sets the CCN key as the train or CCN identifier in the alert message
[Set Message Content]
The system sets security parameters → The system sets the security byte to high value to ensure appropriate access control for the alert
[Set Message Content]
The system categorizes the alert type → The system marks the alert as cargo-related to ensure proper routing and handling
[Write Audit Log Entry to System]
The system needs to log the alert → The system writes the message to the audit log using the message logging service with message code, content, length, and module name
[Save Original Cargo Report Segment to Working Storage]
The duplicate manifest checking process is initiated → The original cargo report segment data is saved to working storage for later restoration
[Restore Original Cargo Report Segment from Working Storage]
The duplicate checking operations are finished → The original cargo report segment data is restored from working storage back to the cargo report segment

Structural Validations

[Cargo Report Input Conditions Met?]
If cargo report processing conditions → Process for duplicates if train ID is empty AND destination station is not 'IIS-A6' AND it's not a haulage rights exception (where SCAC is empty and CCN does not start with '6105E')
[Message Input Conditions Met?]
If message input processing conditions → Process for duplicates if train ID is empty AND destination is not 'IIS-A6' AND it's not a haulage rights exception (where SCAC is empty and input field does not start with '6105E')
[Train ID Empty?]
If the GCM24-TRAIN-ID field → If train ID is empty (SPACES), continue validation; otherwise skip duplicate checking
[Mark Current Record as Duplicate Error]
Error code 6200 has been set for duplicate detection → The system marks the current cargo report record as having duplicate error status

Module: GCCROUTE 1 Consolidated Epic Story

Epic: GCCROUTE Complete EDI Specification Extracted from Legacy

Contains 22 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCROUTE EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[5:Process Route Carriers]
System processes each route segment that has a carrier code but no junction data → Assign the carrier code as destination carrier and copy destination code and qualifier to the route segment
[7:Lookup Schedule D Codes]
System performs Schedule D lookup using junction location as key → If found, assign Schedule D port code to junction code and set qualifier to Schedule D type
[Retrieve Canadian Customs Code]
System processes the lookup result → System retrieves Canadian customs code from table segment and assigns it as origin code with 9-character format
[Loop Through Route Index 1-10]
Junction point processing is initiated → System loops through route index from 1 to 10 to process each potential junction point
[Junction Point Found with Schedule D Code]
The system performs a reverse lookup using the Schedule D port code → The corresponding location name is retrieved and stored in the route data for that junction point
[Store Location Name in Route Data]
The system updates the route data → The location name is stored in the appropriate route segment field
[Junction Point Found with Schedule K Code]
The system performs a reverse lookup using the Schedule K city code → The corresponding location name is retrieved and stored in the route data for that junction point
[Retrieve Port Location Name]
Location name data is available in the lookup result → The system retrieves the port location name from the table segment
[Extract City Code from Schedule K Record]
The system processes the record data → The system extracts the city code from the Schedule K record segment
[Store City Code as Junction Point Code]
The system assigns the junction point code → The system stores the city code as the junction point code in the route segment
[Extract Location Name from Record]
The system processes the record data → The system extracts the location name from the Schedule K record segment
[Store Location Name as Junction City/State]
The system assigns the junction city/state information → The system stores the location name as the city/state for the junction point in the route segment
[Set Schedule K Reverse Lookup Flag]
The system needs to retrieve the location name corresponding to the Schedule K city code → The system sets the Schedule K reverse lookup flag to prepare for the reverse table lookup
[Extract Port Code from Schedule D Record]
The port code needs to be extracted from the record → The port code field from the Schedule D record segment is moved to the appropriate destination code field
[Extract City Code from Schedule K Segment]
Processing the retrieved Schedule K data → The city code should be extracted from the Schedule K segment and assigned as the location code

Structural Validations

[2:Validate Input Data - GCSUSS13 Empty?]
The system checks if GCSUSS13 route data is empty or contains only spaces → If route data is empty, set empty flag to true and record error message 'NO DATA IN GCSUSS13', otherwise proceed with route processing
[6:Process Junction Points]
System examines each route segment for junction data → If junction data is not empty, proceed with junction processing, otherwise skip to next segment
[Clear Error Message Field]
The system performs error message initialization → The error message field is cleared of any previous content
[Check if GCSUSS13 route data is provided and not empty]
The system checks if GCSUSS13 contains only spaces or is empty → The system sets empty flag to true and records error message 'NO DATA IN GCSUSS13' in the field-in-error
[Junction Point R260 Not Empty?]
System checks for junction point data → Processing continues only if the R260 junction code is not empty or spaces
[Route Data Not Empty?]
The system validates the current route data (GCSUSS13) → The system should confirm route data is not empty before proceeding with change comparison

Module: GCCSCAC 1 Consolidated Epic Story

Epic: GCCSCAC Complete EDI Specification Extracted from Legacy

Contains 2 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCSCAC EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Load User Security Configuration]
The security record is successfully found and retrieved → The table segment data is moved to the user security segment structure
[Load User Security Data]
The lookup operation returns a successful status → The retrieved table segment data is moved to the user security segment structure

Structural Validations

None explicitly identified in logic extraction.

Module: GCCTIB 1 Consolidated Epic Story

Epic: GCCTIB Complete EDI Specification Extracted from Legacy

Contains 5 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCTIB EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Retrieve Car ID Configuration]
Configuration lookup is performed using table ID 'ID' and the carrier ID as sequence key → If lookup succeeds, carrier configuration segment is loaded, otherwise configuration is initialized as empty
[Execute Database Lookup]
The database lookup operation is executed → The system attempts to retrieve the corresponding table segment data
[Configuration Found?]
The lookup return status is evaluated → If successful, load the retrieved table segment data, otherwise initialize empty configuration
[Load Car Configuration Data]
Loading the configuration data → The table segment data is moved to the car ID configuration segment
[Set Empty Configuration]
No configuration data is found for the car ID → The car ID configuration segment is initialized to empty values

Structural Validations

None explicitly identified in logic extraction.

Module: GCCUTRIO 1 Consolidated Epic Story

Epic: GCCUTRIO Complete EDI Specification Extracted from Legacy

Contains 88 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCUTRIO EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Equipment Segments]
The system performs final cleanup of equipment-related data → All equipment segment data structures are initialized to clear any remaining equipment information
[Initialize Segment and Equipment Counters]
The system begins equipment segment processing → Segment quantity counter and equipment quantity counter are initialized to zero AND all empty car indicators are cleared
[Initialize Segment and Equipment Counters]
The system begins equipment calculation → Both segment quantity counter and equipment quantity counter are set to zero
[Initialize Indicator Set Counter Set to 1]
The system starts processing indicator sets → The indicator set counter is initialized to 1 to begin processing from the first set
[Initialize Indicator Set Counter = 1]
The system processes empty car indicators → The system loops through exactly 3 indicator sets, incrementing the counter from 1 until it exceeds 3

Core Acceptance Criteria

[2:Get Train Root Record Only]
Retrieving train information → The system fetches only the train root segment and populates the train header data
[3:Get Complete Train List]
Retrieving complete train information → The system first retrieves the train root segment, and if successful, proceeds to retrieve equipment segments
[5:Insert New Train with Equipment]
Creating a new train record → The system inserts the train root segment first, and if successful, proceeds to insert equipment segments
[10:Extract Empty Car Indicators]
Processing equipment information → The system extracts empty car indicators from each segment, validates numeric values, and maps them to the appropriate car positions
[11:Build Train Root Segment]
Building the root segment for database storage → The system moves train header data to the root segment structure, sets timestamps, and builds secondary indexes
[12:Process Equipment Segments for Insert]
Inserting equipment information → The system divides equipment into segments of 50 items each, fills remaining positions with spaces, and inserts each segment with sequential key numbers
[13:Pack Empty Car Indicators]
Storing equipment segment data → The system packs indicators into 3 sets of 18 indicators per segment, validates numeric values, and stores zero for non-numeric indicators
[Move Train Header Data to Output Structure]
The system processes the retrieval results → The complete train header segment data is moved to the output train list structure and the operation return code is set to indicate success
[Read First Equipment Segment]
The system reads the first equipment segment → Equipment data is retrieved from the equipment database if available
[Store Equipment Data in Train List]
The system processes the equipment data → Equipment information is stored in the corresponding train list segment position
[Extract Empty Car Indicators from Segment]
The system processes empty car indicators from the segment → Empty car indicator flags are extracted and prepared for unpacking
[Unpack Empty Car Indicator Flags]
The system unpacks the indicator flags across 3 indicator sets with 18 positions each → Individual car empty status flags are stored in the train list for cars 1 through 50 of the current segment
[Read Next Equipment Segment]
The system attempts to read the next equipment segment → Next equipment segment data is retrieved if available
[Calculate Total Equipment Count]
The system calculates the total equipment count → Total equipment count is computed as (number of complete segments × 50) plus remaining equipment in partial segment
[Clear Unused Segment Areas]
The system processes unused segment areas → All unused equipment positions and empty car indicators beyond the actual count are cleared to spaces and low-values respectively
[Calculate Starting Car Position and Calculate Last Car Position]
The system needs to determine the car position range for that segment → The starting car position is calculated as 50 times (segment index minus 1) and the last car position is calculated as starting position plus 50
[Indicator Set <= 3?]
The system processes empty car indicators for the segment → The system iterates through exactly 3 indicator sets, processing each set sequentially
[Indicator <= 18 AND Car < Last Car Position?]
The system processes individual indicators within the set → The system processes indicators while the indicator counter is 18 or less AND the current car position is less than the last car position for the segment
[Increment Car Position and Map Indicator Value to Car Position]
Each indicator is mapped to a car position → The car position is incremented by 1 for each indicator processed, and the indicator value is assigned to the corresponding car position
[Equipment Count Valid 1-2500 Range]
The equipment quantity is between 1 and 2500 inclusive → Proceed with inserting the train root record followed by inserting the equipment data if root insert is successful
[Equipment Count Valid 1-2500 Range]
The equipment quantity is between 1 and 2500 inclusive → Delete the existing train record, then insert new train root record followed by inserting the equipment data if both delete and root insert are successful
[Build Train Root Segment]
The equipment quantity validation passes → The system copies the train header data to the root segment structure
[Set Creation Timestamp]
The train root segment is built → The system sets creation timestamp with current date, time, terminal, user ID, and module name
[Insert Train Header to Database]
The insert operation is executed → The system calls the database insert function to store the train header record
[Calculate Equipment Segments Needed]
Processing equipment for storage → The system divides the equipment quantity by 50 to get the number of full segments and calculates remainder for partial segment
[Divide Equipment into 50-item Segments]
There is a remainder from the division by 50 → The system adds 1 to the segment count, fills remaining positions in the partial segment with spaces, and prepares each segment with up to 50 equipment items
[Process Each Equipment Segment]
Processing each segment sequentially → The system copies the segment data to the equipment structure and sets the segment key number
[Pack Empty Car Indicators]
Empty car indicators need to be stored → The system calculates car positions based on segment index, processes 3 sets of 18 indicators each, validates numeric indicators and defaults non-numeric to 0, and packs the indicators into the equipment segment structure
[Insert Equipment Segment to Database]
The segment is ready for storage → The system calls the database insert function to store the equipment segment
[Divide Total Equipment Count by 50]
The system needs to determine how many full segments are required for storage → The system divides the total equipment count by 50 to get the number of full segments and calculates any remainder equipment
[Add 1 to Segment Count for Partial Segment]
The remainder equipment count is greater than zero → The system adds 1 to the total segment count to accommodate the partial segment and calculates the starting position for padding empty spaces
[Pad Remaining Positions with Spaces]
The system processes equipment positions from the remainder position plus 1 through position 50 → The system fills each unused position with spaces to complete the segment structure
[Insert Equipment Segments]
Inserting equipment segments → Divide equipment into segments of 50 items, insert each segment with sequential numbering, and handle partial segments appropriately
[Pack Empty Car Indicators]
Processing empty car indicators → Extract and pack empty car indicator data from the equipment segments into the appropriate storage format
[Read First Equipment Segment from GCSUTDP]
The system performs the first equipment segment read operation → The system reads the next equipment segment from GCSUTDP database
[Store Equipment Data in Segment Array]
The system processes the segment data → Equipment data is moved to the segment array at current segment index AND empty car indicators are extracted and stored for the current segment
[Read Next Equipment Segment]
The system needs to read the next equipment segment → The system performs next equipment segment read operation from GCSUTDP
[Calculate Final Segment Count]
The system finalizes equipment counting → Final segment count is calculated by subtracting 1 from current segment index AND equipment count in last segment is determined by counting non-space equipment entries up to position 50
[Clear Remaining Segment Slots]
The system needs to clean up unused segment slots → All segment slots from current segment index to 50 are cleared to spaces AND corresponding empty car indicators are set to low-values
[Calculate Total Equipment Count]
The system calculates total equipment → Total equipment count equals (segment count multiplied by 50) plus equipment count in last segment
[Set Equipment Count in Train List]
The system finalizes equipment processing → Total equipment count is moved to the train list equipment quantity field
[Read Equipment Segments from Database]
The system needs to retrieve equipment segments → The system performs a database read operation to get the next equipment segment
[Process Current Segment]
The segment data is available for processing → The system moves the equipment data to the working segment area and processes empty car indicators for the segment
[Count Equipment in Last Segment]
The system needs to determine the exact equipment count → The system iterates through positions 1 to 50 in the final segment and counts non-empty equipment positions
[Calculate Total Equipment Count]
The system needs to determine total equipment count → The system multiplies complete segments by 50 and adds the equipment count from the final segment
[Clear Unused Segment Areas]
The system needs to clean up unused storage areas → The system initializes unused segment areas to spaces and sets empty car indicators to low values
[Calculate Starting Car Position Based on Segment Index, Calculate Starting Car Position, Calculate Car Position Range]
The system needs to determine the car position range for that segment → The starting car position is calculated as 50 times (segment index minus 1) and the ending car position is calculated as starting position plus 50
[Calculate Starting Car Position]
The system needs to determine the car position range for the segment → The starting car position is calculated as 50 times (segment index minus 1) and the ending car position is calculated as starting position plus 50
[Copy Train Header Data to Root Segment]
The system needs to build a train root segment → The train header data is copied to the root segment structure (GCUTR-TRAIN-ROOT-SEGMENT)
[Calculate Number of Segments Needed]
The system calculates storage requirements → The equipment quantity is divided by 50 to determine the number of full segments needed, with any remainder indicating additional equipment requiring one more segment
[Add One More Segment]
The remainder of equipment items is greater than zero → One additional segment is allocated to accommodate the remaining equipment items
[Fill Remaining Positions with Spaces]
There are unused positions in the segment after placing all remaining equipment → All unused positions from the next available position through position 50 are filled with spaces
[More Segments to Process?]
The system processes segments sequentially starting from segment 1 → Each segment is processed in order until the segment counter exceeds the total number of segments required
[Move Equipment Data to Current Segment]
The segment is being prepared for insertion into the database → The equipment data from the working segment is moved to the database segment structure
[Set Segment Number]
The segment requires a unique identifier → The current segment index is assigned as the segment key number
[Pack Empty Car Indicators for Segment]
The segment is being prepared for database insertion → The empty car indicators are packed from the expanded 150-position format into the compressed 3-group format for the segment
[Insert Equipment Segment to Database]
The segment is ready for permanent storage → The segment data is inserted into the GCSUTDP database table
[Divide Total Equipment Count by 50]
The system processes equipment for storage in segments → The total equipment count is divided by 50 to determine complete segments and any remainder equipment count
[Add 1 to Segment Count for Partial Segment]
The remainder count is greater than zero → One additional segment is added to the total segment count and the remainder position is incremented by 1
[Fill Remaining Positions with Spaces]
Equipment positions from the remainder position to position 50 need to be processed → All unused equipment positions in the segment are filled with spaces
[Move Equipment Data to Segment Structure]
Each segment is being prepared for insertion → The equipment data from the train list segment is moved to the database equipment structure
[Set Segment Number]
The segment data structure is being prepared → The current segment index is assigned as the segment key number
[Pack Empty Car Indicators for Segment]
The segment is being prepared for database storage → Empty car indicators are packed from the train list format into the database segment format across multiple indicator sets
[Insert Equipment Segment to Database]
The segment is ready for database storage → The equipment segment is inserted into the database using the equipment insertion process
[Individual Indicator <= 18 AND Car < Last Car?]
The system processes individual indicators within the set → The system continues processing while the individual indicator counter is 18 or less AND the current car position is less than the last car position for the segment
[Move Compressed Indicators to Database Segment]
All indicators in the current set are processed → The compressed indicator values are moved from working storage to the corresponding database segment field
[Process Next Indicator Set?]
The system begins indicator processing → The system processes exactly 3 indicator sets, iterating from set 1 to set 3
[Save Indicator Set to Database]
The indicator set processing is complete → The complete indicator set from working storage is moved to the database segment structure
[Move New Header Data to Train Record]
The system prepares to update the train record → The new train header data is moved from the input structure to the train root segment

Structural Validations

[9:Retrieve Equipment Segments]
Retrieving equipment information → The system reads equipment segments sequentially until end of data or maximum of 50 segments is reached, setting too-many-equipment flag if limit exceeded
[Equipment Segment Found?]
The system checks if equipment segment data was found → Processing continues with equipment data storage if found, otherwise proceeds to calculate totals
[More Segments Available?]
The system checks for more available segments → Processing continues if under 50 segments and more data exists, stops if no more data, or returns error if 50 segment limit reached
[Is Indicator Set Numeric?]
The system checks the indicator set format → If the indicator set is numeric, use the actual value; otherwise set the indicator set to zero
[Header Creation Successful?]
The header creation operation completes → If successful, proceed to insert equipment segments; if failed, terminate the replace operation
[More Segments Available AND Segment Count < 50?]
The system checks whether to continue reading more segments → Loop continues IF segment was found successfully AND segment index is less than 50, OTHERWISE loop terminates
[Set Too Many Equipment Status]
The system found more segments available after reading 50 segments → System sets too many equipment status flag to true
[Reached Maximum 50 Segments?]
The segment index reaches 50 → The system stops processing additional segments to enforce the maximum limit
[Total > Maximum Limit?]
Additional equipment segments are found beyond the 50 segment limit → The system sets the too many equipment flag to indicate equipment exceeds maximum allowed
[Check if Database Indicator is Numeric]
The system needs to process this indicator value → The system checks if the indicator value is numeric before using it
[Indicator <= 18 AND Car < Last Car?]
If whether to continue processing the next indicator → Processing continues only if the indicator counter is 18 or less AND the current car position is less than the last car position for the segment
[Car Position Within Range?]
The system checks if the car position is valid → The car position must be less than the last car position for the segment range

Module: GCX904 1 Consolidated Epic Story

Epic: GCX904 Complete EDI Specification Extracted from Legacy

Contains 52 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX904 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Report Line Counter]
The system begins processing report message lines → The mail subscription counter is initialized to 1 to track the current position in the message line array
[File Opening Successful?]
The file opening status is not successful (not equal to '00') → An error message is displayed to indicate the file opening failure

Core Acceptance Criteria

[4:Process Report Data Lines]
The line is identified as a message line AND the PDF length equals 132 → The system skips processing this line and continues to the next line, otherwise processes the line normally
[5:Filter Message Lines]
Processing the message line for JCL output → The system increments sequence number, splits the 132-character line into two 66-character segments, assigns sequence numbers (positions 1-4) and group numbers (positions 71-72) to each segment, and increments group number by 50 for each segment
[Set Message Class Parameters]
Setting up message class parameters → The system moves the appropriate job configuration flag to the spool user ID field
[Is Message Line AND PDF Length = 132?]
If whether to process the line → The line should be skipped and processing should continue to the next line without creating JCL segments
[Assign Sequence Number and Group Number]
The system creates a line segment → A sequence number should be incremented and assigned to positions 1-4 of the JCL line, and a group number should be assigned to positions 71-72
[Create First Segment: Characters 1-66]
The system processes the first segment → Characters 1-66 from the message line should be moved to positions 5-70 of the JCL line
[Create Second Segment: Characters 67-132]
The system processes the second segment → Characters 67-132 from the message line should be moved to positions 5-70 of the next JCL line
[Assign Sequence Number and Group Number]
The system completes processing of each segment → The group number should be incremented by 50 to prepare for the next segment
[Store First Segment and Store Second Segment]
The system completes storing the segment → The line counter should be incremented by 1 to point to the next available JCL array position
[Is Message Line AND PDF Length = 132?]
The PDF length is set to 132 characters → Skip processing this line and continue to the next report line without creating any segments
[Create First Segment - Characters 1-66]
The line is ready for segment creation → Create the first segment using characters 1 through 66 of the original report line
[Create Second Segment - Characters 67-132]
Processing continues for the same report line → Create the second segment using characters 67 through 132 of the original report line
[Assign Sequence Number and Group Number]
The segment is ready for numbering → Increment the sequence number by 1 and assign it to positions 1-4 of the JCL line, and assign the current group number to positions 71-72
[Assign Same Sequence Number and Updated Group Number]
Processing continues to the next segment or operation → Increase the group number by 50 for subsequent use
[Increment Sequence Number]
The system begins creating a new segment from the report line → The sequence number must be incremented by 1 to ensure unique identification of each JCL line
[Move Sequence Number to Position 1-4]
The system constructs the JCL line structure → The sequence number must be moved to character positions 1-4 of the JCL line
[Extract Characters 1-66 from Report Line]
The system creates the first segment of the report line → Characters 1 through 66 from the original message line must be extracted for the first segment
[Move First 66 Characters to Position 5-66]
The system constructs the JCL line with the first segment content → The 66 characters must be moved to positions 5-66 of the JCL line, immediately following the sequence number
[Add Group Number to Position 71-72]
The system completes the JCL line structure for a segment → The current group number must be moved to positions 71-72 of the JCL line
[Increment Group Number by 50]
The system completes processing of the current segment → The group number must be incremented by 50 to prepare for the next segment
[Move to Next JCL Line]
The system finishes processing the current segment → The line pointer must be incremented by 1 to position for the next JCL line in the output array
[Add 50 to Group Number]
The system begins creating the second segment of the report line → The group number is increased by 50 from its current value
[Move Sequence Number to Position 1-4]
The system formats the second segment structure → The current sequence number is placed in character positions 1 through 4 of the output line
[Extract Characters 67-132 from Report Line]
The system creates the second segment → Characters 67 through 132 from the original report line are extracted for processing
[Move Characters 67-132 to Position 5-66]
The system formats the second segment output line → The extracted 66 characters are placed in positions 5 through 66 of the output line
[Move Group Number to Position 71-72]
The system completes the second segment structure → The group number is placed in character positions 71 through 72 of the output line
[Add 50 to Group Number for Next Processing]
The system prepares for processing the next report line → The group number is increased by an additional 50 to maintain sequential numbering
[Increment Line Counter]
The system completes the second segment creation → The output line counter is incremented by 1 to point to the next available output position
[Is Line a Message Line?]
The system moves the report line to the message line field and evaluates if it is a message line → The system identifies whether the line qualifies as a message line for further processing
[Is PDF Length = 132?]
The PDF length is set to 132 characters → The system skips the message line and continues to the next line without further processing
[Process Line - Split into Two 66-Character Segments]
The line needs to be processed for JCL output → The system splits the line into two 66-character segments, assigns sequence numbers, adds group numbers, and increments the group number by 50 for each segment
[Check Line Content Type]
If the line content to determine if it contains message data → The system identifies the line as either a message line or non-message line for further processing decisions
[Is Message Line?]
The system processes the report content → The system skips the message line and continues to the next report line without adding it to the JCL output
[Process Line Normally]
The system processes the report content → The system processes the line normally by adding sequence numbers, splitting into segments, adding group numbers, and including it in the JCL output
[More Report Lines to Process?]
The system checks if more lines need processing → Processing continues if the current line counter is less than the total number of lines AND the counter is 1981 or less, otherwise processing stops
[Get Next Report Line]
The system needs to process the next message line → The message line at the current counter position is moved to the working storage message line field
[Is Message Line AND PDF Length = 132?]
The line is identified as a message line type AND the PDF length is set to 132 characters → The line is skipped and processing continues with the next line without any JCL generation
[Increment Sequence Number]
The line is not skipped due to format restrictions → The sequence number counter is incremented by 1 to provide unique identification for the line segment
[Create First 66-Character Segment]
The first segment is being created → Characters 1 through 66 of the message line are extracted and prepared for JCL formatting
[Add Sequence Number and Group Number]
The JCL line is being formatted → The sequence number is placed in positions 1-4, the message segment in positions 5-70, and the group number in positions 71-72 of the JCL line
[Write First Segment to JCL Array]
The line needs to be stored for output → The formatted line is moved to the current position in the JCL output array
[Create Second 66-Character Segment]
The second segment is being created → Characters 67 through 132 of the message line are extracted and prepared for JCL formatting
[Add Sequence Number and Updated Group Number]
The second JCL line is being formatted → The incremented sequence number is placed in positions 1-4, the second message segment in positions 5-70, and the updated group number in positions 71-72 of the JCL line
[Write Second Segment to JCL Array]
The line needs to be stored for output → The formatted line is moved to the next position in the JCL output array
[Update Group Number Counter]
The group numbering needs to be updated for the next message line → The group number counter is increased by 50 to maintain proper grouping sequence
[Close Spool File]
The system initiates the file closure process → The system closes the spool file and displays an error message if the closure operation fails
[Display Completion Message]
The system completes the spool closure process → The system displays a message containing current date, time, process identifier, job file name, and script name to system error output

Structural Validations

[Check if File Exists]
The operation type is 'WRITE' → The system checks if the target spool file exists before proceeding with write operation
[Check if File Exists for Closing]
The operation type is 'CLOSE' → The system checks if the spool file exists before proceeding with close and job submission operations
[Check if File Exists for Closing]
The operation type is 'CLOSE' → Check if the target file exists before proceeding with closure and submission

Module: GCCB4RIO 1 Consolidated Epic Story

Epic: GCCB4RIO Complete EDI Specification Extracted from Legacy

Contains 50 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCB4RIO EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Segment and Equipment Counters, Initialize Segment Counter and Equipment Counter]
The system begins equipment retrieval → Both segment quantity counter and equipment quantity counter are set to zero

Core Acceptance Criteria

[Train List Replacement]
The equipment quantity is not zero and not exceeding 2500 → The system deletes existing root record, inserts new root record, and then inserts equipment data if successful
[Equipment Segmentation]
The equipment quantity is divided by 50 → The system creates the required number of segments and pads the last segment with spaces if there's a remainder
[Route to DELETE TRAIN-LIST Operation]
The system processes the request → The system performs D100-DLET-ROOT and if successful sets DELETE-PENDING and DELETED-CONFIRM flags, performs B100-ISRT-ROOT, and if successful sets equipment quantity to zero and initializes equipment segments
[Execute Database Query for Train Root Segment]
The system executes the database query for train root segment → The system performs a database get operation on the GCSB4RT segment using the configured parameters
[Copy Train Header Data to Output Structure]
The system copies train header data to output structure → The train root segment data from the database is moved to the train header field in the train list structure
[Get Next Equipment Segment from Database]
The system requests the next equipment segment → Database operation is performed to get next parent equipment segment
[Store Equipment Segment Data]
The segment data is available → The equipment segment data is moved to the corresponding position in the train list equipment segments array
[Calculate Equipment Count in Last Segment]
The system needs to determine total equipment count → The system counts non-space equipment entries in the last segment up to position 50
[Clear Unused Segment Slots]
There are unused segment positions beyond the last retrieved segment → All unused segment positions are cleared with spaces
[Calculate Total Equipment Count]
Total equipment calculation is required → Total equipment equals (number of segments multiplied by 50) plus the count of items in the final segment
[Calculate Equipment Count in Last Segment]
The system needs to determine the actual count of equipment in the last segment → The system iterates through equipment positions starting from position 1, increments counter for each non-empty position, stops when an empty position is found or maximum 50 positions is reached, and returns the actual equipment count by subtracting 1 from the final counter value
[Total Count = 0?]
The calculated total equipment count (segments × 50 + remaining equipment) equals zero → Set NO-EQP status to indicate no equipment is present
[Read First Equipment Segment]
The system needs to read equipment segments → Equipment segment data is retrieved from the database
[Store Equipment Segment Data]
The segment data needs to be processed → The equipment segment data is stored in the train list structure
[Read Next Equipment Segment]
More segments need to be processed → The system reads the next equipment segment from database
[Increment Segment Counter]
The segment counter needs to be updated → The segment counter is incremented by one
[Count Equipment in Last Segment]
Equipment count in the final segment needs to be determined → The system counts non-empty equipment positions in the last segment
[Calculate Total Equipment Count]
Total equipment count needs to be determined → Total equipment count equals (number of segments × 50) + remaining equipment count
[Copy Train Header Data to Database Segment]
The system prepares to insert the train header record → The train header data from the working list is copied to the database segment structure
[Copy Updated Record Back to Train List]
The system processes the insertion result → The database segment data is copied back to the train header working area
[Calculate Number of Segments Needed]
The system processes equipment for insertion → The system divides the total equipment quantity by 50 to determine the number of segments needed and calculates any remainder
[Equipment Count Divides Evenly by 50?]
There is a remainder greater than zero → The system adds one more segment to accommodate the remaining equipment items
[Add One More Segment for Remainder]
The system processes the remainder → The system increments the segment count by 1 and increments the equipment position by 1
[Fill Remaining Slots with Spaces]
The system processes equipment positions from the last equipment position to position 50 → The system fills all remaining positions in the segment with spaces
[Process Each Equipment Segment]
The system processes equipment segments → The system iterates through each segment from 1 to the total segment count
[Move Equipment Data to Segment]
The system processes a specific segment → The system moves the equipment data from the train list segment to the database equipment structure
[Set Segment Number]
The system prepares the segment for database insertion → The system assigns the current segment index as the segment key number
[Insert Equipment Segment to Database]
The system executes the database insertion → The system calls the database insert function for the equipment segment
[Train Record Deleted Successfully]
The system processes the successful deletion → Set delete pending and confirmed flags to true, reinsert the train record, reset equipment quantity to zero, and initialize equipment segments to spaces
[Clear Equipment Segments]
The system finalizes the logical deletion process → All equipment segment data must be initialized to empty values
[Calculate Number of Segments Needed]
System needs to determine storage segments required → System divides equipment quantity by 50 to get number of segments and remainder items
[Equipment Count Divisible by 50?]
There is a remainder greater than zero → System adds one additional segment to accommodate remaining equipment
[Add One Additional Segment]
System processes the remainder calculation → System adds 1 to the segment quantity
[Calculate Remainder Equipment in Last Segment]
System needs to pad remaining positions → System adds 1 to remainder quantity to get starting position for space padding
[Fill Empty Positions with Spaces]
System processes the segment for storage → System fills remaining positions from remainder position plus 1 through position 50 with spaces
[Process Each Segment]
System processes segments for database insertion → System iterates through segments from 1 to total segment quantity
[Set Segment Number]
System prepares segment for database storage → System assigns current segment index as the segment key number
[Store Equipment Segment to Database]
System executes database storage operation → System inserts the equipment segment into the database
[More Segments to Process?]
System checks for remaining segments → System continues processing if current segment index is less than or equal to total segment quantity, otherwise completes processing

Structural Validations

[Equipment Segmentation]
The number of equipment segments reaches 50 → The system stops processing additional segments and sets 'Too Many Equipment' status
[Train Record Found?]
The system checks if the train record was found → If the database operation was successful, the train record is considered found, otherwise the train record is considered not found
[Reached 50 Segments Limit?]
The segment index reaches 50 → The system stops retrieving additional segments to enforce the maximum limit
[Set Error: Too Many Equipment]
More than 50 equipment segments were found in the database → The system sets the 'too many equipment' error flag
[Equipment Position Empty?]
The system checks if the equipment position contains data → The system determines the position is empty if it contains spaces, otherwise it contains valid equipment data
[Retrieved All Segments Successfully?]
Equipment retrieval reaches the maximum of 50 segments and more segments still exist in the database → Set TO-MANY-EQP status to indicate equipment count exceeds processing limit
[Reached 50 Segments Limit?]
The segment index reaches 50 → The system stops processing additional segments
[Equipment Position Empty?]
An equipment position is examined → The system determines if the position contains equipment data or is empty (spaces)
[Set Too Many Equipment Flag]
More than 50 equipment segments are found in the database → The system sets the too many equipment flag to indicate excessive equipment data

Module: GCCSNOT3 1 Consolidated Epic Story

Epic: GCCSNOT3 Complete EDI Specification Extracted from Legacy

Contains 17 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCSNOT3 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Email Message Structure]
The system begins email message preparation → The communication structure is initialized, email text is cleared, car ID is stored in error context, and standard error message lines 1, 2, 4, and 5 are populated
[Initialize EMI-TEXT Array to Spaces]
The email message is being prepared → The car ID is stored in the error context field for reference

Core Acceptance Criteria

[5:Handle Configuration Lookup Failure]
The table lookup returns a non-zero status indicating failure → System clears the configuration segment and sets default notification recipient to 'OM01247'
[4:Retrieve Notification Configuration]
The table lookup returns zero status indicating success → System uses the retrieved table segment data for notification configuration
[8:Send Email Notification]
The system initiates email sending process → System calls email service to send the notification and receives a status flag indicating success or failure
[Email Structure Ready for Use]
Error message content needs to be loaded → Five predefined error message lines are loaded into the email text array
[Load Configuration Data from T3 Table]
The lookup returns successful status (return flag equals '0') → The retrieved table segment data is loaded into the notification configuration structure
[Use Retrieved Configuration Data]
The lookup operation returns successfully with return flag equal to '0' → The system uses the retrieved table segment data as the notification configuration
[Clear Configuration Segment]
The lookup operation fails with return flag not equal to '0' → The system clears the configuration segment by setting it to spaces
[Set Email Recipients - Assign notification user codes from configuration table to email recipient list]
The system needs to populate the email recipient list for duplicate manifest billing notification → The system assigns the first notification user code to recipient position 1, the second notification user code to recipient position 2, the third notification user code to recipient position 3, the fourth notification user code to recipient position 4, and the fifth notification user code to recipient position 5
[Execute Email Send Operation]
The email send operation is executed → The system dispatches the duplicate billing notification email to the configured recipients with the prepared subject and message content

Structural Validations

[3:Determine Country-Specific Error Message]
The system determines the error message content for line 3 → If country is CA, Canadian-specific error message is used; otherwise US-specific error message is used
[Set Car ID in Error Message]
The system builds an error message → The car ID must be included in the error message structure
[Add Standard Error Line 1, Add Standard Error Line 2, Add Standard Error Line 4, Add Standard Error Line 5]
The system adds standard error content → Standard error lines 1, 2, 4, and 5 must be populated with their respective predefined content
[Check Country Type, Add Canadian-Specific Error Line 3, Add US-Specific Error Line 3]
The system determines the content for error message line 3 → If the country code is 'CA', then Canadian-specific error line 3 content must be used, otherwise US-specific error line 3 content must be used
[Determine Country-Specific Error Message - Select appropriate error message text based on whether the car is Canadian (CA) or US]
The country code is 'CA' → The system selects the Canadian-specific error message text for line 3 of the notification
[Determine Country-Specific Error Message - Select appropriate error message text based on whether the car is Canadian (CA) or US]
The country code is not 'CA' → The system selects the US-specific error message text for line 3 of the notification

Module: GCX101 1 Consolidated Epic Story

Epic: GCX101 Complete EDI Specification Extracted from Legacy

Contains 403 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX101 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize New US Manifest Structure]
Preparing to create new manifest record → The system should initialize all manifest segments and clear status fields to prepare for new data
[Initialize GCX111 Message Fields]
The system begins detour processing → The system clears the GCX111 message fields, sets high-values to filler, sets DOM-DETOUR action flag, and sets BACKGROUND environment flag
[Initialize Audit Message]
The system needs to create an audit trail for the invalid broker condition → The system initializes the audit message structure (GCX105-INPUT) to prepare for error logging
[Initialize Empty Broker Segment]
No broker information is found in the broker table → The system initializes empty broker and B1 segments to prevent processing errors
[Initialize GCX108 Input for Next Use]
The message processing is complete → The GCX108 input structure is initialized to clear previous data for next use
[Initialize Queue Status]
Queue status is being initialized → The accept status is set to spaces to clear any previous status
[Initialize GCX108 Input Structure]
The message preparation process begins → The GCX108 input structure should be initialized to clear any previous data
[Initialize Queue Management]
Queue management initialization is requested → Accept status is set to blank spaces to clear any previous status
[Initialize SCAC Codes Across Segments]
Setting up carrier identification → The CPRS SCAC code is assigned to SCAC-1, main SCAC code, and customs SCAC code fields, bill/waybill number is set from CCN ID number, and transport type is set to train with preliminary status
[Initialize First S07 Segment]
Preparing for final S07 processing steps → Move the first S07 segment data from array to working segment
[7150: Initialize M13 Record Structure]
The system initializes the M13 record structure → Initialize the GCSUSS01 segment, set the US CCN key, record type to '01', and sequence to '0001'
[Initialize Secondary Communication]
The system needs to use secondary communication for audit logging → Secondary communication is initialized and configured for detour audit message processing
[Initialize Broker Segment - Invalid Broker]
System cannot find valid broker configuration in broker table → System initializes empty broker segments, performs invalid broker processing, sets cargo status to reject, and creates error notification message
[Initialize Empty Broker Segment]
Both port-specific and default port broker lookups fail → Initialize empty broker segment and B1 segment data structures
[Initialize In-House Message Structure]
The system begins in-house notification processing → The system initializes the in-house message structure and sets the cargo type to Canadian cargo
[Initialize Empty SK Segment]
The system needs to assign city code values → The system initializes empty SK segment with default values
[Initialize Empty Broker Segment]
No broker information is found in the BK table → The system should initialize empty BK-SEGMENT and B1-SEGMENT and exit broker lookup process
[Initialize Empty Broker Segment]
No valid broker information can be retrieved → The system should Execute broker invalid error processing
[Initialize Broker Segment if Not Found]
The system performs a second lookup using the same broker name and Canadian flag with default port '000' → The system retrieves broker information if found with default port, or initializes empty broker segment if both lookups fail
[Initialize SCAC Codes]
SCAC codes are being set in the manifest structure → CPRS SCAC code is assigned to M1112-SCAC-1, M1001-SCAC-CDE, M1301-SCAC-CDE1, and M1309-SCAC-CDE2 fields
[Initialize Segment Fields to Spaces]
The segment initialization process begins → All segment index fields, creation fields, modification fields, waybill keys, bond indexes, destination indexes, and flag indicators are cleared to spaces
[Initialize M13 Segment Structure]
The system initializes the M13 segment structure → The M13 record is set with cargo CCN as key, record type '01', and sequence number '0001'

Core Acceptance Criteria

[Cargo Data Copying]
A segment is not empty → The system should update the segment CCN key to the new work CCN key
[Country Type Check]
If the cargo country type → The cargo is classified as either Canadian, US, or invalid for further processing routing
[Create Audit Message for Border Change]
The system creates an audit trail → An audit message should be generated with action code 'ZZZ' and message text 'AUTO CHG BORD FROM [old_port_name] TO [new_border_name]' for the Canadian cargo
[Set New CCN Key in All Segments]
Copying new Canadian key data → The work CCN key is assigned to GCCC-CCN-KEY, GCSCCS52-KEY-CCN, and NEW-CDN-CCN
[Update All Segment Arrays with New CCN]
Inserting new Canadian cargo → For each non-empty segment in the array, the CCN key is updated to the new value, record type is set to '53', and sequence number is assigned
[Replace Canadian Cargo in Database]
Performing database insert operation → GCCCCIO2 is called with REPL function to insert all segments, and first segment data is moved back to working storage
[Create Audit Trail Message]
Creating audit trail → GCX105 input is initialized with new CCN, cargo type is set to Canadian, action code is set to 'ZZZ', and message is set to 'SPECIAL MANIFEST AUTOMATICALLY CREATED'
[Lookup Border Table MC]
Looking up border information for Canadian manifest → The system performs a table lookup using function code 'GU', table ID 'MC', and the border name as sequence ID to retrieve border segment data
[Set US Port Exit Code]
Processing valid border information → The table segment is moved to GCSTBRT-MC-SEGMENT and the US exit code (GCSTBRT-MC-US-STAT-EXIT-CD) is assigned to GCCC-US-PORT-OF-EXIT-CODE
[Create Audit Log Message]
The system creates the audit trail → An audit message is constructed with the format 'AUTO CHG DEST FROM [old port name] TO [new manifest-to station name]' and the action code is set to 'ZZZ'
[Spawn Audit Transaction GCT1051E]
The system finalizes the audit process → A GCT1051E audit transaction is spawned with the port change details for system logging
[Set Diverted Flag]
The system processes the diversion request → Set the cargo status to diverted
[Lookup Broker at New Border]
The system looks up broker information using broker short name and new border code → Retrieve broker segment data from the broker table
[Create Invalid Broker Message]
The system creates audit messages → Generate message 'DIVERTED TO INVALID BROKER AT [border-name]' with action code ZZZ
[Create Audit Log Message]
The system creates audit documentation → Generate audit message 'AUTO DIVERTED FROM [old-port-name] TO [new-border-name]' with action code ZZZ
[Broker Found at Border?]
If the lookup results → If broker is not found, cargo error status is set and invalid broker message is created, otherwise broker segment data is retrieved
[Create Invalid Broker Message]
The system creates audit trail messages → An audit message is created stating 'DIVERTED TO INVALID BROKER AT [border-name]'
[Get Broker Segment Data]
The system processes valid broker information → The broker segment data is retrieved and stored for further processing
[Office Code = '00'?]
The system processes broker office code information → If broker office code is '00', the office code is cleared to spaces, otherwise the broker office code is assigned to the cargo
[C220: Read All US Cargo Data]
Creating new bill from existing manifest → The system should read all US cargo segments (S01-S15) and populate working arrays
[Set Equipment ID & Waybill Data]
Building new US manifest structure → The system should format car ID using ISCCARID program and set waybill numbers and dates in appropriate segments
[Propagate New CCN to All Segments]
Finalizing new manifest structure → The system should update all non-empty segments (S01-S15) with the new CCN number
[Propagate New CCN to All Segments]
Processing segment data → The system should clear line release numbers and quantities for the first two entries
[8530: Insert New US Cargo Record]
Inserting new cargo record → The system should insert all segments (S00-S15) as a complete new US cargo record
[7310: Create Audit Log Entry]
Completing the new bill creation process → The system should create audit log entry with message 'SPECIAL MANIFEST AUTOMATICALLY CREATED' and new CCN information
[Access Counter Table CW]
The system accesses the counter table using table ID 'CW' → The counter table segment is retrieved successfully or an error is returned
[Set New US CCN Key to All Segments]
The manifest data structure is being initialized → The new US CCN key is assigned to car ID index, waybill index, car-waybill index, and the main US CCN key field
[Update Each S07 Segment with New CCN]
Each S07 segment is processed up to the maximum sequence → For each non-empty S07 segment, the new US CCN key is assigned to the segment key field and the segment is updated in the working array
[Clear Line Release Data]
S07 segment data is being processed → Line release numbers for positions 1 and 2 are cleared to spaces and quantity fields for positions 1 and 2 are cleared to spaces
[Set Default Quantity Values]
Default quantity values need to be set → The manifest quantity field value is assigned to the first position quantity field in the S07 segment
[Process S08 Segments]
Each S08 segment is processed up to maximum sequence → For each non-empty S08 segment, the new US CCN key is assigned to the segment key field and the segment is updated in the working array
[Process S03 Segments]
Each S03 segment is processed up to maximum sequence → For each non-empty S03 segment, the new US CCN key is assigned to the segment key field and the segment is updated in the working array
[Process S06 Segments]
Each S06 segment is processed up to maximum sequence → For each non-empty S06 segment, the new US CCN key is assigned to the segment key field and the segment is updated in the working array
[Update S10-S14 Segments]
Each S12 segment is processed up to maximum sequence → For each non-empty S12 segment, the new US CCN key is assigned to the segment key field and the segment is updated in the working array
[Lookup Tax Table 'TX']
The tax table lookup is performed using table ID 'TX' → The system retrieves the CPRS tax number from the tax table segment
[Lookup City Code from SK Table]
The system looks up the border name in the SK table → If found, the city code is retrieved from the SK segment, otherwise the SK segment is initialized as empty
[Create Audit Log Message]
Creating audit documentation → An audit message is created with format 'AUTO DIV BOND DEST FROM [old port name] TO [new border name]' and action code 'ZZZ'
[Lookup Border Name in SK Table]
The system looks up the border name in the SK table using the determined border name as the search key → If the SK table entry is found successfully, the system should load the SK segment data, otherwise initialize an empty SK segment
[Update M1204 Location with City Code]
The SK segment contains valid city code information → The system should update M1204-LOCATION-ID2 with the city code from SK table and M1204-LOC-ID2-NAME with the border name
[Generate Audit Message]
The system needs to create an audit trail of the changes made → The system should generate an audit message with action code 'ZZZ' containing the text 'AUTO DIV BOND DEST FROM [old-port-name] TO [new-border-name]' and spawn the audit transaction
[C220: Read All US Cargo Data]
The system needs to copy cargo data to new manifest → All cargo segments should be retrieved and bill type, bond type, and bond number should be saved for reference
[C450: Set Up TE Bond Data for Mexico]
The system sets up TE bond data → Set transport export flag to true, determine re-entry point, set Mexico destination codes (MX/20100 or CA/88888), clear N10 segments except first, and ensure harmonized commodity code is not empty or 999999
[Clear Line Release Numbers]
The system processes export line release data → Clear line release numbers and quantities in positions 1 and 2 of the N1009 and N1001 segments
[Copy Cargo Data to New Manifest]
The system copies cargo data to new manifest → Update all segment CCN keys with new US CCN, copy equipment and waybill information, set creation timestamps, and maintain all cargo detail segments with new CCN references
[8530: Insert New US Cargo Record]
The system inserts the new cargo record → Insert all cargo segments into database and handle any insertion errors with appropriate error messages
[Generate Audit Messages]
The system generates audit messages → Create audit message for new manifest indicating bill type and creation purpose, create audit message for original manifest indicating new bill creation, and send GCT011 message for bond movement tracking
[Lookup SK Table for Re-Entry Port Details]
The system looks up the port in the SK table using the re-entry port name → The system retrieves the complete port segment data including city codes and location details
[Clear N10 Segment Data]
The system prepares to process N10 segment data → All N10 segment arrays are cleared and the first segment data is moved to working storage
[Process N10 Segment with GCCUSCN2]
The commodity code identifier is not spaces or low-values → The system calls GCCUSCN2 to process the N10 segment with segment ID 'N10' and record type '07'
[Update Segment Arrays]
The system finalizes transportation export data configuration → The processed segment data is moved back to the first position of the working storage segment array
[Search Junction Table for Mexico Routing]
The system searches for junction matches in the routing table → If a matching junction code is found in the Rule 260 table, the junction and rail information are captured for further processing
[Lookup Junction in SD Table]
The system looks up the junction in the SD table using table ID 'SD' → Station destination segment data is retrieved if the junction exists in the SD table
[Get Port Code from SD Table]
The system extracts port information from the SD segment → The SD port code is assigned to the cargo location and re-entry code fields
[Lookup Port in DS Table]
The system looks up the port code in the DS table using table ID 'DS' → Destination station segment data is retrieved if the port code exists in the DS table
[Set Mexico Destination Port Name]
The system extracts port name information from the DS segment → The DS port name is assigned to the cargo location name and re-entry name fields
[Log Junction Not Found on SD Table]
The SD table lookup fails for the junction → An error message is logged indicating the junction was not found on SD table and processing continues to next junction
[Log Port Not Found on DS Table]
The DS table lookup fails for the port code → An error message is logged indicating the port was not found on DS table and processing continues to next junction
[Call GCCCROS2 crossing table lookup]
Performing crossing table lookup for SNP data → Call GCCCROS2 program with crossing table parameters and crossing table segment to retrieve SNP information
[7350: Spawn GCT1113E Canadian Manifest]
The system creates the Canadian manifest notification → The system sets the border name and re-entry name in the GCM111 message and spawns the GCT1113E transaction
[US-US or CA-CA Detour Decision]
The system prepares the US manifest message → For US-US detours, the system sets the US action code, and for CA-CA detours, the system sets the RT action code
[7340: Spawn GCT0111E US Manifest]
The system creates the US manifest notification → The system sets the manifest from/to border names, waybill number and date, and car ID in the GCX011 message and spawns the GCT0111E transaction
[Set Action Code to DOM-DETOUR]
The system creates a GCM111 domestic detour message → The system should set the action code to DOM-DETOUR to identify the message type
[Set Environment to Background]
The system sets up the processing environment → The system should configure the environment for background processing
[Populate Waybill and Car ID]
The system populates the message fields → The system should include the waybill key and car ID from the original detour request
[Set Border and Re-Entry Names]
The system populates the GCM111 message location fields → The system should set the border name as RT04 location and re-entry name as M1203 location
[Spawn GCT1113E Transaction]
The system needs to notify about the domestic detour → The system should spawn a GCT1113E transaction with the prepared message
[Set US Action Code]
The detour type is US-to-US detour → The system should set the US action code in the manifest message
[Set RT Action Code]
The detour type is Canada-to-Canada detour → The system should set the RT action code in the manifest message
[Set Border as Manifest From]
The system populates the routing information → The system should set the border name as the manifest from location
[Set Re-Entry as Manifest To]
The system populates the routing information → The system should set the re-entry name as the manifest to location
[Populate Waybill Details]
The system populates the waybill details → The system should include waybill number, waybill date, and car ID in the message
[Spawn GCT0111E Transaction]
The system needs to track the manifest movement → The system should spawn a GCT0111E transaction with the prepared manifest message
[Get B1 Table Segment]
The system retrieves additional broker configuration → The system looks up the B1 table segment for internet address information, initializing empty segment if not found
[Send X12 EDI Notification]
The broker's X12 usage flag is set to 'Y' → The system sends X12 EDI notification using the broker's X12 header and the cargo CCN key
[Send Internet Notification]
The broker's internet usage flag is set to 'Y' → The system creates a print job using the internet address from B1 segment and the cargo CCN with high-value security byte
[X12 EDI Enabled?]
The broker's X12 usage flag is set to 'Y' → The system sends X12 EDI notification using the broker's X12 header information and the cargo CCN key through the GCCS309C program
[Internet Enabled?]
The broker's internet usage flag is set to 'Y' → The system sends internet notification using the B1 segment's internet address and cargo CCN through the 7320-SPAWN-GCT0191E-PRINT procedure
[Set CCN for Audit Trail]
The audit message is being prepared → The system sets the cargo control number (GCX101-CCN) as the train or US CCN identifier (GCX105-TRAIN-OR-US-CCN) in the audit message
[Set Cargo Type as Canadian]
The audit message cargo type needs to be specified → The system sets the cargo type indicator to Canadian cargo (GCX105-CA-CARGO) in the audit message
[Set Action Code to ZZZ]
The audit message action code needs to be assigned → The system sets the action code to 'ZZZ' (GCX105-ACTION-CODE) to indicate an error condition
[Create Audit Log Entry]
The audit log entry needs to be created → The system calls the audit logging function (7310-SPAWN-GCT1051E) to create the permanent audit record
[Port Change Message]
The border change operation is completed successfully → The system constructs message 'AUTO CHG BORD FROM [old-port-name] TO [new-border-name]' AND creates audit trail with action code 'ZZZ'
[Port Change Message]
The destination port change is completed → The system constructs message 'AUTO CHG DEST FROM [old-port-name] TO [new-destination-name]' AND creates audit trail with action code 'ZZZ'
[Cargo Diversion Message]
The diversion operation completes successfully → The system constructs message 'AUTO DIVERTED FROM [old-port-name] TO [new-border-name]' AND creates audit trail with action code 'ZZZ'
[Port Change Message]
The bond destination change is completed → The system constructs message 'AUTO DIV BOND DEST FROM [old-port-name] TO [new-border-name]' AND creates audit trail with action code 'ZZZ'
[Bond Creation Message]
The new bond bill is created and notifications are sent → The system creates first message '[bond-type] BILL CREATED FOR [original-bond-type] BILL [original-ccn]' for new CCN AND creates second message '[bond-type] BILL [new-ccn] CREATED FOR [original-bond-type] BILL' for original CCN
[Get Border Crossing Name]
The system needs to format location details in messages → The system looks up the Canadian border name using the border code from the ports table AND uses the retrieved name in message construction
[Construct Multi-part Message]
The system constructs the final message string → The system concatenates message parts using STRING operations with 'DELIMITED BY SIZE' AND ensures proper message structure and completeness
[Combine Components with Delimiters]
The system constructs the final message string → The system uses STRING operation to combine components with 'AUTO CHG BORD FROM', 'AUTO CHG DEST FROM', 'TO', and other descriptive text delimited by SIZE into the target message field
[Format Message Components]
The system processes each character position in the CCN → The system copies non-space and non-zero characters to destination, processes numeric sequences when found, and maintains proper positioning for compressed CCN format
[STRING 'AUTO CHG BORD FROM ' + OLD-PORT-NAME + ' TO ' + BORDER-NAME]
The system needs to create an audit trail message for the border change → Construct a message by concatenating 'AUTO CHG BORD FROM ' + old port name + ' TO ' + new border name and store it in the message field
[STRING 'AUTO CHG DEST FROM ' + OLD-PORT-NAME + ' TO ' + DEST-NAME]
The system needs to create an audit trail message for the destination change → Construct a message by concatenating 'AUTO CHG DEST FROM ' + old port name + ' TO ' + new destination station name and store it in the message field
[STRING 'AUTO DIVERTED FROM ' + OLD-PORT-NAME + ' TO ' + BORDER-NAME]
The system successfully processes the diversion → Construct a message by concatenating 'AUTO DIVERTED FROM ' + old port name + ' TO ' + new border name and store it in the message field
[STRING 'AUTO DIV BOND DEST FROM ' + OLD-PORT-NAME + ' TO ' + BORDER-NAME]
The system processes a bond destination change → Construct a message by concatenating 'AUTO DIV BOND DEST FROM ' + old port name + ' TO ' + new border name and store it in the message field
[STRING BOND-TYPE + ' BILL CREATED FOR ' + SAVE-BOND-TYPE + ' BILL ' + CCN]
The system creates a new bond bill from an existing bond → Construct a message by concatenating the new bond type + ' BILL CREATED FOR ' + original bond type + ' BILL ' + original CCN and store it in the message field
[STRING BOND-TYPE + ' BILL ' + NEW-CCN + ' CREATED FOR ' + SAVE-BOND-TYPE + ' BILL']
The system creates a new bond bill and needs to update the original bill with audit information → Construct a message by concatenating the new bond type + ' BILL ' + new CCN + ' CREATED FOR ' + original bond type + ' BILL' and store it in the message field
[MOVE 'SPECIAL MANIFEST AUTOMATICALLY CREATED' TO MESSAGE]
The system needs to create an audit message for the automatically created manifest → Set the message field to 'SPECIAL MANIFEST AUTOMATICALLY CREATED'
[Prepare GCT0191E Message]
The system prepares the GCT0191E message for Merlin notification → The system transfers the GCX019 input data to the GCT0191E message structure
[Clear Accept Status]
The system initializes the message queue processing → The system sets the accept status to spaces to clear any previous status
[Change Message Queue Status]
The system prepares to send the Merlin notification → The system calls CIMS with CHNG function to change the alternate PCB queue status for GCT0191E message type
[Write Message to Queue]
The system delivers the Merlin notification → The system calls WRITMSGL to write the message with message code, content, length and module name to the alternate PCB queue
[Purge Message Queue]
The system completes the message delivery process → The system calls CIMS with PURG function to purge the alternate PCB queue
[Send X12 EDI Notification]
The broker's USE-X12 flag is set to 'Y' → Send X12 EDI notification using the broker's X12 header and cargo control number
[Get Broker Delivery Schedule]
The system needs to validate delivery schedule requirements → The system extracts the broker delivery schedule value from the broker segment
[Validation Passed - Continue Processing]
The delivery schedule is either DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → The system continues with broker notification processing
[Validation Failed - Skip Broker Notification]
The delivery schedule is neither DEFAULT-DELIVERY nor IMMEDIATE-DELIVERY → The system skips broker notification and exits the validation process
[Check Broker at Border Location]
The system searches the BK broker table using concatenated broker short name and border code → The system should retrieve broker segment data if found in the table
[Broker Valid at Border?]
The broker table search fails to find matching broker at border location → The system should set CPCARGO error status and create diverted to invalid broker audit message
[Call GCCS309C - Send to CCRA]
The system executes the CCRA notification → The GCCS309C interface is called to transmit the notification to CCRA
[Prepare Audit Message]
An audit trail needs to be created → The system prepares audit message parameters for logging
[Set CCN for Audit Trail]
The audit trail needs cargo identification → The CCN is assigned to the audit trail record
[Set Cargo Type as Canadian]
The cargo type needs to be specified in the audit trail → The cargo type is set as Canadian cargo
[Search Routing Junctions for Mexico-bound Cargo]
The system iterates through up to 10 routing junction entries in the routing table → The system searches each junction entry against the Rule 260 table to find a matching routing path
[Search GCSPORTS-PORTS Table]
The system searches for a matching port entry → The system finds a match when the border code equals either the US port code or the Canadian port code in any table entry, and extracts the corresponding Canadian and US port names from that matched entry
[Set Transmission Prefix to '98']
The transaction type has been determined → The transmission prefix should be set to '98'
[Get US CCN Key]
The transmission parameters are being set → The US CCN key from the cargo record should be assigned to the customs message
[Call GCCS309E for Export Processing]
The border port is classified as an export port → The GCCS309E export processing service should be called with the customs message parameters
[Call GCCS309 for Standard Processing]
The border port is NOT classified as an export port → The GCCS309 standard processing service should be called with the customs message parameters
[Is Export Manifest?]
The port location is found in the SE table AND the cargo is an export manifest → The system uses the special CBP export service GCCS309E, otherwise uses standard customs service GCCS309
[Use Special CBP Export Service GCCS309E]
The system determines special CBP export processing is required → The system calls the GCCS309E service for specialized export manifest processing
[Use Standard Customs Service GCCS309]
The system determines standard customs processing is required → The system calls the GCCS309 service for standard customs manifest processing
[Lookup B1 Table for Additional Info]
The system looks up additional information in B1 table → Load B1 segment if found, otherwise initialize empty B1 segment
[Set US CCN Key in Message]
The system prepares the notification message → The US CCN key from the cargo record is assigned to the message CCN field
[Set Security Byte to High Value]
Security authorization needs to be established → The security byte is set to high value to grant full access privileges
[Change Message Queue to GCT1081E]
The message queue is being configured → The system changes the message queue to use GCT1081E transaction type
[Write Message to Queue with: - Message Code - Message Content - Message Length - Module Name]
The system writes the message to the queue → The message is transmitted with message code, content, length, and module name included
[Purge Message Queue]
The transmission process is complete → The system purges the message queue to clear processed messages
[Prepare Message Components]
The system prepares message components → Message code, content, length, and module name are set appropriately for the specific message type
[Set Message Code]
The message code is being set → The message code is set to GCT1051E-MSG-CODE
[Set Message Code]
The message code is being set → The message code is set to GCT0191E-MSG-CODE
[Set Message Code]
The message code is being set → The message code is set to GCT1081E-MSG-CODE
[Set Message Code]
The message code is being set → The message code is set to GCT0111E-MSG-CODE
[Set Message Code]
The message code is being set → The message code is set to GCT1113E-MSG-CODE
[Set Message Content]
The message content is being set → The message content includes sending transaction, ACF2 user ID, security byte, date, time, CCN, cargo type, and action code
[Set Message Content]
The message content is being set → The message content includes CCN, security byte, and delivery method (Merlin ID, Internet address, or FAX number)
[Set Message Content]
The message content is being set → The message content includes US CCN, security byte, and delivery method details (Merlin ID, Internet address, or FAX number)
[Set Message Content]
The message content is being set → The message content includes action code, CP number, origin station, waybill number, waybill date, manifest from/to locations, old CDN CCN, and car ID
[Set Message Content]
The message content is being set → The message content includes action code, environment setting, waybill key, car ID, location names, and routing details
[Set Message Length]
The message length is being calculated → The message length is set to the predefined length constant for the specific message type (GCT1051E-MSG-LGTH, GCT0191E-MSG-LGTH, GCT1081E-MSG-LGTH, GCT0111E-MSG-LGTH, or GCT1113E-MSG-LGTH)
[Set Module Name]
The module name is being set → The module name is set to the predefined module name constant for the specific message type (GCT1051E-MOD-NAME, GCT0191E-MOD-NAME, GCT1081E-MOD-NAME, GCT0111E-MOD-NAME, or GCT1113E-MOD-NAME)
[Call CIMS for Queue Management]
Queue management is invoked → CIMS is called with CHNG operation and appropriate PCB for the message type to prepare the queue
[Call WRITMSGL for Message Write]
Message write operation is executed → WRITMSGL is called with message code, message content, message length, and module name to write the message to the queue
[Purge Queue Buffer]
Queue cleanup is performed → CIMS is called with PURG operation and appropriate PCB to purge the queue buffer
[Set Security Byte to High-Value]
Security parameters need to be established → The security byte should be set to high-value to authorize transmission
[Assign US CCN Key to Message]
The message structure needs cargo identification → The US CCN key should be assigned to the message US CCN field
[Set Merlin ID Parameters]
Message communication parameters are being configured → Merlin ID should be populated and Internet and Fax fields should be cleared
[Set Internet Address Parameters]
Message communication parameters are being configured → Internet address should be populated and Merlin ID and Fax fields should be cleared
[Set Fax Number Parameters]
Message communication parameters are being configured → Fax number should be populated and Merlin ID and Internet fields should be cleared
[Set Diversion Information]
Broker notification message is being prepared → The diversion flag should be set to true in the message
[Set Diversion Port Code and Name]
Diversion port data needs to be included → The original port code and port name should be populated in the diversion port fields
[Set Previous Border Port Name]
Previous border port data needs to be recorded → The new border name should be set as the previous border port name
[Purge Existing Queue Messages]
PURG command is executed on the queue → All existing messages in the specified queue are removed
[Change Queue Status/Connection]
CHNG command is executed on the queue → Queue status is changed and connection is established for message processing
[Write Message to Queue Buffer]
WRITMSGL is called with message code, message content, message length and module name → Message is written to the queue buffer for transmission
[Clean Up Queue Resources]
Final PURG command is executed on the queue → Queue resources are cleaned up and freed for subsequent operations
[Access Counter Table CW]
The system accesses the counter table with table ID 'CW' → The counter table segment is retrieved containing the next available CPRS and bond numbers
[Process Segment Arrays S03-S14]
The system processes each segment in the S53 array up to the maximum sequence → For each non-empty segment (not spaces, low-values, or underscores), the new CCN key is assigned, record type '53' is set, and the sequence number is updated, while empty segments are cleared to spaces
[Update Segment with New CCN Key]
The segment data is not spaces, low-values, or all underscores → The segment CCN key is updated to the new CCN, the record type is set to '53', and the sequence number is assigned from the array index
[Complete Data Structure Setup]
Processing segments S01, S02, S04, S05, S06, S07, S08, S10, S11, S12, S13, and S14 → For each non-empty segment, the CCN key is updated to the new work US CCN key, and for equipment segments, the car initial and number are set from the formatted car ID
[Process Equipment ID with Compression]
Setting up equipment information for the new cargo record → The car ID is processed through ISCCARID compression with size 12, and the compressed output is stored in car ID number indexes and equipment car field
[Set Waybill Information in Indexes]
Setting up waybill tracking for the new cargo record → The waybill number is stored in waybill number indexes, the first 15 characters proceed to the root key, car sequence is set to '01', and waybill date is stored in the waybill date field
[Set Border Crossing Location Data]
Setting up location information for the new cargo record → The Canadian border name is determined from the border code, stored in the location ID name field, and the border code is stored in the location ID field and customs location ID field
[Process S07 Segment Array]
Processing segment arrays for the new cargo record → For each non-empty S07 segment entry up to maximum sequence, if the segment is not empty, the new US CCN key is assigned to the segment key field
[Propagate CCN Keys to All Segment Arrays]
Updating segment keys for the new cargo record → If S01 segment is not empty, the new US CCN key is assigned to S01 key field; if S02 segment is not empty, the new US CCN key is assigned to S02 key field
[Set Equipment Data in S05 Segment]
Setting up equipment information in segments → If S05 segment is not empty, the new US CCN key is assigned to S05 key field, equipment initialization is set from compressed car ID, and equipment number is set from compressed car ID number
[Process S08 Segment Array with CCN Keys]
Processing S08 segment array for CCN key updates → For each S08 segment entry up to maximum sequence, if the entry is not empty or low-values, and the segment is not empty, the new US CCN key is assigned to the S08 segment key field
[Process S03 Segment Array with CCN Keys]
Processing S03 segment array for CCN key updates → For each S03 segment entry up to maximum sequence, if the entry is not empty or low-values, and the segment is not empty, the new US CCN key is assigned to the S03 segment key field
[Process S06 Segment Array with CCN Keys]
Processing S06 segment array for CCN key updates → For each S06 segment entry up to maximum sequence, if the entry is not empty or low-values, and the segment is not empty, the new US CCN key is assigned to the S06 segment key field
[Process S12 Segment Array with CCN Keys]
Processing S12 segment array for CCN key updates → For each S12 segment entry up to maximum sequence, if the entry is not empty or low-values, and the segment is not empty, the new US CCN key is assigned to the S12 segment key field
[Set Final Segment Keys S10, S11, S13, S14]
Completing the CCN key propagation process → If S10 segment is not empty, assign new US CCN key to S10; if S11 segment is not empty, assign new US CCN key to S11; if S13 segment is not empty, assign new US CCN key to S13; if S14 segment is not empty, assign new US CCN key to S14
[More S07 Segments to Process?]
Processing S07 segments in sequence → Continue processing while index is within maximum sequence limit and segment contains data
[Update S07 with New US CCN Key]
Processing the segment for CCN key updates → Update the S07 segment CCN key with the new work US CCN key
[Clear Line Release Numbers and Quantities]
The operation type is IT Export or Export Transit → Clear line release numbers for positions 1 and 2 and clear quantities for positions 1 and 2
[Store Updated S07 Back to Array]
Completing processing for the current segment → Store the updated S07 segment back to its position in the array
[Update S07 CCN Key]
Processing the S07 segment array for new US cargo creation → The S07 segment CCN key is updated with the new work US CCN key
[Clear Line Release Data for Export Operations]
Processing S07 segment data during new US cargo creation → Clear line release numbers for positions 1 and 2 and clear quantities for positions 1 and 2
[Update S08 CCN Key]
Processing the S08 segment array for new US cargo creation → The S08 segment CCN key is updated with the new work US CCN key
[Update S03 CCN Key]
Processing the S03 segment array for new US cargo creation → The S03 segment CCN key is updated with the new work US CCN key
[Update S06 CCN Key]
Processing the S06 segment array for new US cargo creation → The S06 segment CCN key is updated with the new work US CCN key
[Update S12 CCN Key]
Processing the S12 segment array for new US cargo creation → The S12 segment CCN key is updated with the new work US CCN key
[Update Single Segments S10/S11/S13/S14]
Processing single segments during new US cargo creation → Update the respective segment CCN key with the new work US CCN key
[Clear Line Release Data for Export Operations]
Processing quantity data during S07 segment updates → Transfer the master quantity picture 9 value to the commodity quantity picture 9 field for position 1
[Set SCAC Code to 'CPRS']
The system sets the SCAC code fields → Set both M1301 SCAC code 1 and M1309 SCAC code 2 to 'CPRS'
[Get Port Code from GCSTBRT-SD-PORT-CODE]
The system extracts port routing information → The port code is retrieved from GCSTBRT-SD-PORT-CODE field in the SD table segment
[Get Port Name from GCSTBRT-DS-NAME]
The system extracts port name information → The port name is retrieved from GCSTBRT-DS-NAME field in the DS table segment
[Extract Port Code from SD Table]
The system processes the SD table segment data → The port code is extracted and assigned to the cargo location and re-entry code fields
[Set Mexico Destination Port and Name]
The system processes the DS table segment data → The port name is assigned to the cargo location name and re-entry name fields
[Log Junction Not Found in SD Table]
No valid port code mapping is found for the junction → The SD table segment is initialized to default values and processing continues with default settings
[Get Port Code from SD Entry]
Port information is extracted → The port code is retrieved from the SD segment and stored for DS table lookup
[Display Port Not Found Message]
Port lookup fails → Display error message indicating port not found on DS table with the port code
[Display Junction Not Found Message]
Junction lookup fails → Display error message indicating junction not found on SD table with the junction value
[Lookup Junction in SD Table]
The system performs an SD table lookup using the junction value → If the SD table entry is found successfully, extract the port code from the SD segment and update the manifest location ID
[Extract Port Name from DS]
The system searches the DS table using the port code → If the DS table entry is found, extract the port name from the DS segment and update both the manifest location name and re-entry name fields
[Restore Primary Communication]
The system finishes writing detour audit messages → Primary communication channel is restored for normal processing operations
[Purge Message Queue]
The system prepares to write audit trail entries → The message queue is purged to ensure clean audit message delivery
[Change Message Destination]
The system needs to route the audit message to the correct destination → Message destination is configured based on the audit type and routing requirements
[Write Message to Log]
The system executes the audit logging operation → The audit message is written to the designated audit log with proper formatting and message length
[Complete Audit Entry]
The system completes the audit logging process → Final cleanup operations are performed and the audit entry is marked as complete
[Delivery Schedule Valid?]
The system checks the broker's delivery schedule preference → Notification proceeds only if delivery schedule is 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY', otherwise notification is skipped
[Get B1 Table Data]
The system retrieves B1 table data for the broker → B1 segment data is loaded if found, otherwise B1 segment is initialized to spaces
[X12 EDI Enabled?]
The broker's X12 EDI usage flag is set to 'Y' → The system calls GCCS309C with notify-broker flag and broker's X12 header information
[Broker Table Lookup - BK]
The system searches the broker table (BK) with the specific port code → If broker is found at specific port, load broker segment data, otherwise attempt lookup with default port '000'
[Try Default Port 000]
The system searches the broker table (BK) using default port '000' → If broker is found at default port, load broker segment data, otherwise initialize empty broker segment
[Broker Details Table - B1]
The system searches the B1 table for additional broker details → If B1 record is found, load B1 segment data, otherwise initialize empty B1 segment
[Border/Port Table - MC]
The system searches the MC table using the border name as key → If border is found, load border segment data and set US port exit code, otherwise return border not found error
[Station Table - SK]
The system searches the SK table using the border name as key → If station is found, load station segment data and set city code, otherwise initialize empty station segment
[Call GCCTBIO with Parameters: - Function Code - Table ID - Sequence ID - Key Values]
The system calls the table lookup service with the provided parameters → The system executes the table lookup operation and returns the appropriate data segment or error status
[Load Table Segment Data into Working Storage]
The lookup returns valid table segment data → The system loads the retrieved table segment data into working storage variables for application use
[Try Default Port 000 Lookup]
The system performs a secondary lookup using port code '000' as fallback → If fallback lookup succeeds, use the default broker configuration; if it fails, initialize empty broker segment and continue processing
[Include CCN and Context Details]
The system detects the failure condition → Format error message including the CCN being processed and specific error context, then call error handler CERR
[Send X12 EDI Notification to Secondary Broker]
The broker configuration has USE-X12 set to 'Y' → Send X12 EDI notification using the broker's X12 header information and the cargo CCN key
[Broker Validation Required?]
Broker validation is required and no valid broker was found → Execute invalid broker handling process
[Handle Invalid Broker]
Broker validation fails → Create audit message 'DIVERTED TO INVALID BROKER AT [border-name]', set cargo status to reject, and update cargo record
[Proceed with Broker Notification]
Broker notification is required → Process notifications via X12 EDI, Merlin system, Internet, FAX, or paper based on broker's communication preferences and update batch print call letters if paper notification is used
[Copy CCN Status to Message]
The system populates the message with cargo information → The system copies the current cargo status to the CCN status field in the message
[Copy Equipment ID to Message]
The system continues populating the message with cargo details → The system copies the equipment ID from the cargo record to the car ID field in the message
[Copy Waybill Number to Message]
The system continues populating the message with cargo details → The system copies the first 15 characters of the waybill key to the waybill field in the message
[Copy CCN Key to Message]
The system continues populating the message with cargo identifiers → The system copies the complete CCN key to the CCN field in the message
[Search for CN Reference Number]
The system needs to find the shipment ID from reference numbers → The system initializes a counter to zero and begins iterating through up to 10 reference number entries
[Copy Reference Number as Shipment ID]
The system identifies this as the Canadian shipment reference → The system copies the reference number value to the shipment ID field in the in-house message
[Call GCCIH Program for In-House Processing]
The system completes message preparation → The system calls the GCCIH program to process the in-house notification with the cargo message
[Generate Invalid Broker Message]
The system generates audit messages → An audit message is created stating 'DIVERTED TO INVALID BROKER AT [border-name]'
[Lookup Border Name in SK Table]
The system looks up the border name in the SK (Station/City) table → The system attempts to retrieve the corresponding city code segment from the reference table
[Assign City Code to M1204-LOCATION-ID2]
The system assigns location identifiers for transport export cargo → The city code from the SK segment is assigned to the cargo's M1204-LOCATION-ID2 field
[Call SNP Lookup Service]
Calling the SNP lookup service → Execute GCCCROS2 program with SNP parameters and crossing table segment to retrieve notify party information
[Extract Waybill Number and Date from Input]
The system needs to search for existing Canadian manifests → The waybill number and waybill date are extracted from the input and stored in working storage variables for search operations
[Format Waybill Key for Search]
The system prepares to search the Canadian manifest database → The waybill number and date are combined into a formatted search key that matches the database index structure
[Search Routing Junctions for Mexico-bound Cargo]
The system processes Mexico destination routing and searches through GCSUSS13 routing segments for Rule 260 junction matches → The system iterates through up to 10 routing segments and identifies matching junctions in the Rule 260 table
[Lookup Junction in SD Table]
The system performs a lookup in the SD table using the junction as the search key → The system retrieves the SD segment containing port code information for the junction
[Extract Port Code from SD Segment]
The system processes the SD segment data → The system extracts the port code from the SD segment and assigns it to the manifest location and re-entry code fields
[Lookup Port Details in DS Table]
The system performs a lookup in the DS table using the port code as the search key → The system attempts to retrieve detailed port information from the DS table
[Assign Mexico Port Name and Code to Manifest]
The system processes the DS segment containing port name information → The system assigns the port name to the manifest location name field and updates the re-entry name
[Call GCCCROS2 for SNP crossing table lookup]
System needs to retrieve notify party SCAC codes → Call GCCCROS2 program with SNP parameters and crossing table segment to get notify party data
[Fallback to Default Port 000]
Looking up broker in BK table with broker name, Canadian flag 'C', and default port '000' → Return broker configuration if found, otherwise initialize empty broker segments
[X12 EDI Enabled?]
The broker X12 usage flag is 'Y' → Send X12 EDI notification using GCCS309C with broker X12 header and CCN key
[Lookup Broker in BK Table by Port]
The system looks up the broker in the BK table using broker name, Canadian flag 'C', and the specific port code from positions 2-3 of the manifest-to-trans-code → The system attempts to retrieve the broker configuration segment from the table
[Lookup Broker at Default Port 000]
The system performs a second lookup using the same broker name and Canadian flag 'C' but with default port '000' → The system attempts to retrieve the broker configuration segment using the default port settings
[Lookup B1 Table for Additional Info]
The system looks up the B1 table using table ID 'B1' → The system retrieves additional broker configuration information if available, or initializes empty B1 segment if not found
[X12 EDI Method Enabled?]
The system processes X12 EDI notifications → The system sets notify-broker flag, assigns the broker's X12 header information, sets the CCN key, and calls GCCS309C for X12 EDI transmission
[Internet Method Enabled?]
The system processes Internet notifications → The system initializes GCX019 input, sets the CCN, security byte to high-values, assigns the Internet address from B1 segment, and calls 7320-SPAWN-GCT0191E-PRINT
[Broker Uses X12 EDI?]
The system checks broker communication preferences for X12 EDI → The system should proceed with X12 EDI notification if the broker uses X12 EDI, otherwise skip to next notification method
[Set Notification Type to Broker]
The system prepares X12 EDI notification parameters → The system should set the notification type to broker notification mode
[Validate Broker X12 Header]
The system prepares X12 EDI notification → The system should assign the broker's X12 header to the EDI message parameters
[Set CCN Key for Message]
The system prepares X12 EDI notification parameters → The system should assign the cargo control number to the EDI message key
[Set Action Code from Spawn Action]
The system prepares X12 EDI notification parameters → The system should assign the spawn action code to the EDI message action code field
[Call GCCS309C for X12 Transmission]
The system initiates X12 EDI transmission → The system should call the GCCS309C program to transmit the X12 EDI message to the broker
[Broker Uses X12?]
The system checks if the broker uses X12 EDI transmission → The system should proceed with X12 notification if broker X12 usage is set to 'Y', otherwise skip X12 processing
[Set Notification Parameters]
The system prepares X12 notification parameters → The system should set the notification type to broker notification mode
[Move Broker X12 Header to Parameters]
The system prepares X12 transmission parameters → The system should copy the broker's X12 header to the transmission parameter structure
[Move CCN Key to Parameters]
The system prepares X12 transmission parameters → The system should copy the CCN key to the transmission parameter structure
[Call GCCS309C for X12 Transmission]
The system initiates X12 EDI transmission → The system should call the GCCS309C program to send the X12 EDI message to the broker
[Prepare GCX019 Input Message]
The system begins preparing the notification message → The GCX019 input message structure is initialized to clear any previous data
[Move CCN to Message]
The system processes the notification for the cargo → The CCN from the cargo record is copied to the GCX019-CCN field in the notification message
[Set Security Byte to High-Value]
The system configures security settings for the message → The security byte is set to high-values to grant full authorization privileges
[Copy Input to GCT0191E Message]
The system prepares to send the notification → The complete GCX019-INPUT content is copied to the GCT0191E-MSG field
[Clear Accept Status]
The system prepares the message queue for transmission → The CC-ACCEPT-STATUS is set to spaces to clear any previous status
[Call CIMS - Change PCB]
The system needs to configure the message queue for transmission → The CIMS service is called with CHNG parameter to modify the ALT-PCB queue configuration
[Call WRITMSGL - Send Message]
The system transmits the notification message → The WRITMSGL service is called with the ALT-PCB queue, message code, message content, message length, and module name to send the GCT0191E notification
[Call CIMS - Purge PCB]
The system completes the message transmission process → The CIMS service is called with PURG parameter to purge the ALT-PCB queue and clean up resources
[Get B1 Table for Additional Info]
The system looks up additional information in B1 table → If B1 table information is found, load it into broker segment; otherwise initialize B1 segment to spaces
[Broker Found in BK Table?]
The system searches the BK table for broker information → If broker is not found (return flag not equal to '0'), initialize empty broker segment and exit, otherwise proceed with found broker data
[Get B1 Table for Additional Info]
The system needs extended broker information for notification methods → Lookup B1 table for additional broker configuration, if found use the data otherwise initialize empty B1 segment
[Lookup B1 Table for Extended Info]
The system looks up extended information in B1 table → Load B1 segment if found, otherwise initialize empty B1 segment
[Use Merlin = Y?]
The system processes communication preferences → Prepare Merlin message with broker Merlin ID and send via GCT1081E
[Use Internet = Y?]
The system processes communication preferences → Set Internet address from B1 segment and send via GCT1081E
[Clear Message Fields]
The system completes the notification → Clear all message input fields to prepare for next processing
[Lookup Additional Broker Info from B1 Table]
The system queries B1 table using table ID 'B1' → The system should retrieve additional broker details and populate B1-SEGMENT if found, otherwise initialize empty B1-SEGMENT
[Retrieve Broker Information from BK Table]
The system looks up broker information in the BK table using broker name, Canadian flag 'C', and port code from manifest-to-trans-code positions 2-3 → The system retrieves the broker segment if found, or attempts lookup with default port '000' if initial lookup fails
[Broker Validation Required?]
The system cannot find a valid broker and broker validation is required → The system marks the broker as invalid, sets cargo status to reject, and creates an error message for invalid broker at the specified border
[Send X12 EDI Notification via GCCS309C]
The broker X12 usage flag is set to 'Y' → Send X12 EDI notification using GCCS309C with broker X12 header and CCN key
[Lookup US Broker in BK Table]
Looking up broker in BK table using broker short name and destination location ID if available, otherwise origin location ID → Retrieve broker configuration details or initialize empty broker segment if not found
[Get B1 Table Information]
The system needs additional broker configuration → The system should retrieve B1 table information for the broker, initializing empty B1 segment if not found
[Send X12 EDI Notification via GCCS309C]
The system processes broker notifications → The system should send X12 EDI notification using GCCS309C with broker's X12 header and CCN key
[Retrieve Current Bond Number Counter]
The system needs the current bond number for assignment → The system should move the next bond number from the CW segment to the working storage bond number variable
[Increment Bond Number Counter]
The system needs to prepare for the next bond number assignment → The system should add 1 to the next bond number field in the CW segment
[Update Counter Table with New Value]
The system needs to persist the updated counter value → The system should replace the CW counter table record with the updated segment containing the new bond number counter
[Process Manifest Segments S07]
Processing segments from index 1 to maximum S07 sequence number → For each non-empty S07 segment, the new US CCN key is assigned to the segment's CCN field, and the updated segment is stored back in the array
[Update All Segment Arrays]
Segment array processing is performed for S01, S02, S03, S04, S05, S06, S08, S10, S11, S12, S13, and S14 segments → For each non-empty segment in each array type, the new US CCN key is assigned to the segment's CCN field, and equipment initialization and compression data are set for S05 segments
[Set New US CCN Key in Primary Segments]
Primary segment keys need to be updated → The new US CCN key is assigned to RT071, RT072, RT073 index segments and the main US CCN key field
[Set Waybill Information in Segments]
Waybill data needs to be propagated to segments → The waybill number is assigned to RT072 and RT073 waybill index fields, the first 15 characters are assigned to RT082 root key, car sequence is set to '01', and waybill date is assigned to RT082 waybill date field
[Process Segment Arrays S03, S06, S07, S08, S12]
Each segment array is processed for CCN key updates → For each non-empty segment (not spaces or low-values), if the segment is not marked as empty, the new US CCN key is assigned to the segment's CCN key field
[Process Individual Segments S01, S02, S04, S05, S10, S11, S13, S14]
Each individual segment is checked for activity → For each segment that is not marked as empty, the new US CCN key is assigned to the segment's CCN key field
[Set Equipment Data in S05 Segment]
Equipment information needs to be set in the S05 segment → Car ID initialization code is assigned to VID02 equipment init field and car ID number is assigned to VID03 equipment number field
[Process Broker Notifications - X12 EDI]
The broker's use-X12 flag is set to 'Y' → Set notify-broker flag, populate X12 broker header information, and call GCCS309C with the CCN key
[Process Broker Notifications - Internet]
The broker's use-Internet flag is set to 'Y' → Initialize GCX019 input with CCN, security byte, and internet address from B1 table, then spawn GCT0191E print process
[Set Default SCAC Codes]
SCAC codes are being set → CPRS SCAC code is assigned to M1112 SCAC-1, M1001 SCAC code, M1301 SCAC code 1, and M1309 SCAC code 2 fields
[Process Segment Arrays]
Segment array processing occurs → For each non-empty segment in arrays S03, S06, S07, S08, S09, S12, the new US CCN key is assigned to the segment's CCN key field, and for border/export bill types with IT export or export transit, line release numbers and quantities are cleared
[Propagate CCN Keys]
CCN key propagation occurs → For all non-empty segments (S01, S02, S04, S05, S10, S11, S13, S14), the new US CCN key is assigned to the segment's CCN key field, and for S05 segments, compressed equipment initial and number are also assigned
[Assign Tax Number to US Manifest M1209 Field]
Tax number assignment is performed → The CPRS tax number from TX table segment is moved to M1209-REF-NUM field
[Set SCAC Code to CPRS]
The system sets the SCAC code values → Both M1301 SCAC Code 1 and M1309 SCAC Code 2 fields are set to 'CPRS'
[Loop Through Routing Junctions GCSUSS13-RT-INDEX 1 to 10]
Junction analysis is performed for Mexico destinations → System loops through junction entries from index 1 to 10 or until a valid junction is found
[Lookup SD Table with Junction Code]
SD table lookup is performed using table ID 'SD' and junction code as sequence ID → System retrieves SD table segment if junction code exists in the table
[Extract Port Code from SD Segment]
Port information is extracted → Port code is extracted from SD segment port code field for DS table lookup
[Update M1203 Location ID and Re-entry Code]
Cargo manifest location data is updated → M1203 location ID field and working re-entry code are set to the extracted port code
[Lookup DS Table with Port Code]
DS table lookup is performed using table ID 'DS' and port code as sequence ID → System retrieves DS table segment if port code exists in the table
[Extract Port Name from DS Segment]
Port name information is extracted → Port name is extracted from DS segment name field
[Update M1203 Location Name and Re-entry Name]
Cargo manifest location name data is updated → M1203 location name field and working re-entry name are set to the extracted port name
[Process S07 Segment Array]
Processing S07 segments and the segment data is not empty or low-values → Update the CCN key in each S07 segment and clear line release numbers and quantities for border export or export transit operations
[Process S08 Segment Array]
Processing S08 segments and the segment data is not empty or low-values → Update the CCN key in each S08 segment
[Process S03 Segment Array]
Processing S03 segments and the segment data is not empty or low-values → Update the CCN key in each S03 segment
[Process S06 Segment Array]
Processing S06 segments and the segment data is not empty or low-values → Update the CCN key in each S06 segment
[Process S12 Segment Array]
Processing S12 segments and the segment data is not empty or low-values → Update the CCN key in each S12 segment
[Update Single Segments S01, S02, S04, S05, S10, S11, S13, S14]
Processing individual segments and the segment data is not empty → Update the CCN key in each individual segment including equipment initialization and number for S05 segment
[Clear Line Release for Export Operations]
The bill type is border export with IT export flag or export bill type with export transit flag → Clear the line release numbers and quantities in the N1009 and N1001 segments

Structural Validations

[Canadian New Bill Creation]
The sequence counter is less than 50 → The system should set error message to 'CAN NOT CREATE NEW CCN' and call error handling
[US Cargo Diversion]
The SCAC code is not CPRS or EDI is not sent electronically or broker is unknown/not required or diversion location already exists → The system should skip diversion processing and continue to location update
[US Cargo Diversion]
The system looks up broker information using broker short name and border code → If broker is not found, the system should set cargo error status and create invalid broker message, otherwise update broker office code information
[Canadian Broker Notification]
The broker delivery schedule is not default delivery or immediate delivery → The system should skip broker notification processing
[Invalid Input Error]
The cargo is neither Canadian nor US type, or the operation type is not recognized for the cargo type → An error message 'GCX101 INVALID INPUT' is set and error handling is invoked
[Error: Cannot Create New CCN]
The sequence counter becomes less than 50 → The system sets error message 'CAN NOT CREATE NEW CCN' and calls error handler CERR
[Lookup Border Table for US Port Code]
Looking up border information in MC table → If border is found, US port of exit code is set from table; if not found, error message 'BORDER NOT FOUND' is set and CERR is called
[Error: Cannot Create New CCN]
The sequence counter falls below 50 → Terminate CCN creation process and generate error message 'CAN NOT CREATE NEW CCN'
[Error: Border Not Found]
Border information is required but not found → An error message 'BORDER NOT FOUND' is set in CC-ERROR-MESSAGE and the error handling routine CERR is called
[Is EDI Sent Electronically?]
The system checks if EDI has been sent electronically → If EDI has not been sent electronically, skip diversion processing and proceed to border name determination
[Is Broker Known and Required?]
The system checks the broker status → If broker is unknown or not required, skip diversion processing and proceed to border name determination
[Has Location ID?]
The system checks for existing diversion location → If diversion location already exists, skip diversion processing and proceed to border name determination
[Is EDI Sent Electronically?]
The system checks if EDI has been sent electronically → Processing continues only if EDI was sent electronically, otherwise diversion processing is skipped
[Is Broker Known and Required?]
The system checks broker status → Processing continues only if broker is not unknown and not marked as not required, otherwise diversion processing is skipped
[Is M1203 Location Empty?]
The system checks the M1203 location field → Processing continues only if M1203 location is empty, otherwise diversion processing is skipped
[Generate New CPRS CCN Number]
Attempting to generate new US CCN → The system should generate error message 'NEW CPRS NUMBER CREATION FAILED' and terminate processing
[C220: Read All US Cargo Data]
Attempting to read cargo data for copying → The system should Throw error: with the CCN and terminate processing
[Assign Default Quantity & Weight Values]
Setting up new manifest data → The system should set default weight to '00001000' in both detail and manifest segments
[7142: Set Up Bonding Data for IT-EXPORT]
Looking up CPRS tax number → The system should generate error message 'TX TABLE RECORD NOT FOUND' and terminate processing
[8530: Insert New US Cargo Record]
Attempting to create new US cargo record → The system should generate error message with return code and error details, then terminate processing
[Counter Table Found?]
The counter table access fails (return flag is not '0') → An error message 'NEW CPRS NUMBER CREATION FAILED' is set and the error handling routine is called
[Counter Update Successful?]
The system checks the update result → If the update failed, an error message 'NEW CPRS NUMBER CREATION FAILED' is set and error handling is invoked
[Update All Segment Arrays with New CCN]
Segment arrays are being updated with new CCN → The new US CCN key is assigned to the S01 segment key field
[Update All Segment Arrays with New CCN]
Segment arrays are being updated with new CCN → The new US CCN key is assigned to the S02 segment key field
[Update All Segment Arrays with New CCN]
Segment arrays are being updated with new CCN → The new US CCN key is assigned to the S04 segment key field
[Set Equipment Information in S05]
Equipment information is being set in S05 segment → The new US CCN key is assigned to S05 segment key, car ID initial portion is assigned to equipment initial field, and car ID number portion is assigned to equipment number field
[Update S10-S14 Segments]
These segments are being updated with new CCN → For each non-empty segment among S10, S11, S13, and S14, the new US CCN key is assigned to the respective segment key field
[Error: Tax Table Not Found]
The tax table lookup fails to return successful results → The system generates error message 'TX TABLE RECORD NOT FOUND' and calls error handling
[Weight is Numeric?]
The system attempts to calculate value from weight → The system should verify that the weight field contains numeric data before proceeding with calculation
[Re-Entry Port Found?]
The port information is not found in the SK table → The system initializes an empty SK segment with default values
[Skip - Invalid Broker]
The system cannot locate the broker in either specific port or default port lookup → The system creates an invalid broker error message, sets cargo status to reject, and updates the cargo record
[Delivery Schedule Valid?]
The broker's delivery schedule is checked → The system only proceeds with notification if the delivery schedule is 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY'
[Secondary Schedule Valid?]
The secondary broker's delivery schedule is checked → The system only proceeds with secondary notification if the delivery schedule is 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY'
[Delivery Schedule Valid?]
The broker's delivery schedule is checked → The system only continues processing if the delivery schedule is set to DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise it exits the procedure
[Build Error Message]
An error message needs to be constructed for the audit trail → The system concatenates 'DIVERTED TO INVALID BROKER AT ' with the border crossing name (GCX101-BORDER-NAME) and stores it in the audit message (GCX105-MESSAGE)
[Invalid Broker at Border]
The system needs to create an error message for invalid broker → The system constructs a message 'DIVERTED TO INVALID BROKER AT [border-name]' AND sets the cargo status to error AND spawns an audit trail message
[Format Message Components]
The system builds audit or error messages → The system formats CCN information, location names, and action codes according to standard message templates AND ensures proper spacing and delimiters
[Parse CCN Structure]
The system processes CCN structure for compression and validation → The system moves CCN type to work area, moves carrier code to work area, moves equipment indicator to work area, assigns equipment ID and waybill date to work areas, and sets sequence counter for processing
[Border Code Available?]
The system needs to resolve location names → The system checks if border code is not spaces or low-values before proceeding with table lookup operations
[STRING 'DIVERTED TO INVALID BROKER AT ' + BORDER-NAME]
The system cannot find valid broker information for the diversion location → Construct an error message by concatenating 'DIVERTED TO INVALID BROKER AT ' + border name and store it in the message field
[Delivery Schedule Valid?]
The broker's delivery schedule is either DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → Continue with notification processing, otherwise exit without sending notifications
[Broker Found?]
The system checks if broker information was found → If broker information is not found, the system initializes an empty broker segment and skips broker notification
[Schedule = DEFAULT-DELIVERY or IMMEDIATE-DELIVERY?]
The system validates the delivery schedule → If the delivery schedule equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, validation passes and broker notification continues, otherwise validation fails and broker notification is skipped
[Create Error Message for Canada]
No valid broker configuration is found for the cargo → The system should create diverted to invalid broker audit message and set cargo status to reject
[Broker Found?]
The system checks if broker information was found → If broker not found, initialize empty broker segment and exit processing
[Error: CCN Creation Failed]
CCN generation fails due to table access issues → An error message 'NEW CPRS NUMBER CREATION FAILED' is set and error handling is invoked
[Error: Counter Creation Failed]
The error condition is detected → An error message 'NEW CPRS NUMBER CREATION FAILED' is set and error handling is invoked to terminate the process
[Copy Border Crossing Data]
The system looks up the border name in the MC table → If the border is found in the table, the US port exit code is copied from the MC segment, otherwise an error 'BORDER NOT FOUND' is generated
[S07 Segment Empty or Low-Values?]
The segment data equals spaces or low-values → Skip processing this segment and move to next segment
[Error: TX Table Not Found]
The TX table record is not found → An error message 'TX TABLE RECORD NOT FOUND' should be generated and error handling should be invoked
[Broker Validation Result?]
The broker lookup fails for the combination of broker name and border code in the broker table → The cargo status is set to reject AND an invalid broker error message is created
[Load Broker Segment Data]
The system checks the broker delivery schedule → Continue processing only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise exit
[Invalid Broker at Border Crossing]
The broker table lookup returns a not found status for the broker-border combination → Set cargo status to CPCARGO-ERROR, generate error message indicating invalid broker at border location, and spawn audit log entry
[Sequence Counter Exhausted]
The sequence counter decrements below 50 without successfully creating a unique CCN → Return error message 'CAN NOT CREATE NEW CCN' and terminate the creation process
[CCN Not Found Error]
The database lookup returns a status indicating the CCN was not found → Generate error message 'CCN NOT FOUND' and call error handler to terminate processing
[Insert/Update Operation Failed]
The operation returns an error status with error number and message → Format comprehensive error message including operation type, error code, and error description, then call error handler
[Delivery Schedule Allows Default/Immediate?]
The broker delivery schedule is not DEFAULT-DELIVERY and not IMMEDIATE-DELIVERY → Skip secondary broker notification processing and continue to completion
[Delivery Schedule = DEFAULT or IMMEDIATE?]
System checks broker delivery schedule setting → Broker notification proceeds only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise notification is skipped
[Schedule Allows Default or Immediate Delivery?]
The broker delivery schedule is either 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY' → Proceed with broker notification process
[Is EDI Sent Electronically?]
The system checks the EDI transmission status → Processing continues only if EDI has been sent electronically, otherwise normal processing continues
[Is Broker Unknown or Not Required?]
The system checks the broker status → Processing continues only if broker is not unknown and is required, otherwise normal processing continues
[Is M1203 Location Empty?]
The system checks for existing diversion location in M1203 field → Diversion processing continues only if M1203 location is empty, otherwise normal processing continues
[Junction Found in Routing Table?]
A junction from GCSUSS13 routing segment matches a value in the Rule 260 table → The system sets the junction found flag to true and captures the junction and rail information
[SD Table Entry Found?]
The table lookup operation completes → The system checks if the return flag indicates successful retrieval of SD segment data
[DS Table Entry Found?]
The table lookup operation completes → The system checks if the return flag indicates successful retrieval and logs appropriate messages for found or not found conditions
[Delivery Schedule Valid?]
The broker delivery schedule is 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY' → Continue with notification processing, otherwise skip broker notifications
[Delivery Schedule Valid?]
The broker's delivery schedule is either 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY' → The system continues with the notification process, otherwise it exits without sending notifications
[Broker Found in BK Table?]
The system checks if broker information was found → If broker not found, initialize empty broker segment and exit; otherwise load broker configuration
[Schedule Allows Default or Immediate?]
The broker delivery schedule is checked → The system should only proceed with notification processing if delivery schedule equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise exit broker processing
[Schedule = DEFAULT-DELIVERY or IMMEDIATE-DELIVERY?]
The system checks the broker delivery schedule value → The system allows broker notification to continue if schedule equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise skips broker notification
[Delivery Schedule Valid?]
The broker delivery schedule is 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY' → Continue with notification processing, otherwise skip notifications
[Delivery Schedule Valid?]
The system checks the broker's delivery schedule → The system should only proceed with notifications if the delivery schedule is 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY', otherwise exit notification processing
[Error: Counter Table Access Failed]
The table access return flag is not '0' → The system should set error message 'NEW CPRS NUMBER CREATION FAILED' and call error handling
[Schedule Allows Default or Immediate Delivery?]
The broker's delivery schedule is not 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY' → Skip broker notification processing and proceed to secondary broker check
[Set Default Harmonized Code to '999999']
The harmonized commodity code field is spaces, low-values, or contains the value '999999' → The system sets the harmonized commodity code to '999999' as the default value
[Is Quantity Missing or Zero?]
The quantity field (GCUS-N1001-QUANTITY) is either spaces or all zeroes → The system sets the quantity to default value '000000000000001' in the N1001 segment and '000001' in the M1103 segment
[Error: TX Table Record Not Found]
TX table record is not found (return flag is not SUCCESSFUL) → System sets error message 'TX TABLE RECORD NOT FOUND' and calls error handler

Module: GCCADD 1 Consolidated Epic Story

Epic: GCCADD Complete EDI Specification Extracted from Legacy

Contains 234 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCADD EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Working Storage Variables]
Variable initialization is performed → All working storage variable groups including WS-VARIABLES, WS-STATUS, RPT-CONTROL-VARIABLE, RPT-WS-VARIABLES, EMTZ-ROOT-SEGMENT, WS-AELGCWS, and WS-CONTR-TABLE must be initialized to their default values
[Initialize Bond Processing Flags]
The system begins processing equipment → All TR (Transportation Request) flags are set to not-found state AND all TE (Transportation Export) flags are set to not-found state AND all requirement flags are set to not-required state AND detour message storage is cleared
[Initialize SHIPROOT Segment]
The system prepares for database access → The SHIPROOT segment and FWWWBIO parameter structure are initialized to clear any previous data
[Initialize GCSUSRT Segment]
The system begins cargo retrieval process → The GCSUSRT segment structure is initialized to empty state
[Initialize GCT1011E Parameters]
The system prepares to spawn a GCT1011E transaction → The pre-spawn index should be incremented and GCT1011E input parameters should be initialized
[Initialize Electronic Message Interface]
The system prepares to send the electronic message → The EMI return status flag is initialized to clear any previous status
[Initialize Car Retrieval Parameters]
The system initializes car retrieval parameters → All waybill types except 98-99 are included, all statuses are searched, EDI incomplete records are excluded, temporary waybills are included, corrector waybills are excluded, returned lead waybills are included, and latest waybill date is prioritized

Core Acceptance Criteria

[31:Final Report Status Setting]
Info message count is greater than 0 → Set status to NO-WAYBILL, when error message count is greater than 0 set status to ERRORS and trigger customs notification, otherwise set status to OK and return report data
[31:Final Report Status Setting]
TR is required for IT but not found → Generate message type 28, when TR required for TR but not found generate message type 34, when TR required for 00 but not found generate message type 35, when TE required for TE but not found generate message type 36, when TE required for 88 but not found generate message type 37
[Build Report for Current Cargo]
Report building is initiated for current cargo → Equipment information is populated in report AND cargo details are added to report AND appropriate message lines are generated based on cargo status
[Set Search Parameters]
The system configures parameters for container waybill database search → The segment type is set to 'SHIPROOT', operator is set to ' =', key field is set to the container key from the current index, function code is set to 'GU', and accept status is set to 'GE'
[Call FWCWBIO Database Service]
The system executes the database search operation → The CCISCOM service is called to establish communication context, FWCWBIO is called with the parameter structure and SHIPROOT segment, and ISCCCOM is called to restore communication context
[Set Car Retrieval Parameters]
The system prepares to retrieve waybill information → The system sets parameters to include all waybill types except 98-99, exclude EDI incomplete waybills, include temporary waybills, exclude corrector waybills, return lead waybills, and get latest waybill date
[EDI-418 Release Valid?]
The system checks the EDI completion 418 release status → If EDI-418 release equals 'Y', the waybill is accepted, otherwise the system continues searching for previous waybills
[Check Haulage Right Carrier]
The haulage right carrier field is evaluated → If haulage right carrier is spaces (empty), accept the waybill; otherwise proceed to EDI completion check
[EDI-418 Release Complete?]
The EDI completion 418 release status is evaluated → If EDI completion 418 release equals 'Y', accept the waybill; otherwise get the previous waybill with earlier status date
[Get Previous Waybill]
The waybill key feedback matches the previously processed key feedback → Set the waybill status to not found and stop processing to avoid infinite loop
[Process Current Cargo Record]
The system processes the current cargo record → The system should build report entries, validate TIB information, create detail lines, generate appropriate message lines, and increment report index if not a spacer line
[Set TR-REQ-FOR-IT Flag]
Bond type is Immediate Transport (M1201-IMM-TRANSP) → Set TR-REQ-FOR-IT flag to true
[Save Current Detail Line]
Bond type is Default, Export, Immediate Transport, Transport Export, or US-CAN-US → Save current report line to detour line and clear current report line
[Generate MSG-THIRTY-ONE - TIB Required for Empty Equipment]
TIB flag reset is completed → Generate message type 31 indicating TIB requirement for empty equipment and increment report index
[Generate MSG-TWENTY-SEVEN - TIB Required]
TIB flag reset is completed → Generate message type 27 indicating TIB requirement and increment report index
[Trigger Z121 New Bill Creation Spawn]
TIB processing determines new bill creation is needed → Execute Z121 pre-spawn process to prepare new bill creation parameters for customs processing
[Save Detour Line for Later Processing]
Processing cargo with TR created status → Save current report line as detour line and clear current report line
[MSG-TWENTY-SEVEN: Canadian domestic]
Both origin country and destination country are 'CA' (Canada) → Generate message type 27 (MSG-TWENTY-SEVEN) and Execute pre-spawn GCT1011E processing
[MSG-THIRTY: Export manifest required]
The waybill is found AND cargo is found AND cargo has transport export type AND cargo status description is 'EXPORT' → Generate message type 30 (MSG-THIRTY) and Execute pre-spawn GCT1011E processing
[MSG-THIRTY: Export manifest required]
The waybill is found AND cargo is found AND cargo has export type AND cargo status description is 'ARRIVED' → Generate message type 30 (MSG-THIRTY) and Execute pre-spawn GCT1011E processing
[MSG-THIRTY-EIGHT: Master in-bond required]
Cargo is found AND has US-CAN-US type AND has master in-bond type AND TR is not created for IT AND cargo status is not 'EXPORT' → Generate message type 38 (MSG-THIRTY-EIGHT) indicating master in-bond requirement
[MSG-THIRTY: Port diversion required]
Cargo is found AND bond type is not 'TR' AND BOL type is not '15' AND train crossing port does not match cargo location → Generate message type 30 (MSG-THIRTY) and Execute pre-spawn GCT1011E processing
[MSG-THIRTY: Port change required]
Waybill is found AND cargo is found AND cargo has US-CAN-US type AND cargo is billed as CPRS AND train crossing port does not match cargo location → Generate message type 30 (MSG-THIRTY) and Execute pre-spawn GCT1011E processing
[Count Message Types]
The message is classified as error type (including spawn types 27 or 30) → Increment the appropriate counter (error count, warning count, or info count) and request error count if applicable
[Generate MSG-TWENTY-SEVEN: Canadian domestic traffic]
Both origin province/state code and destination province/state code resolve to country 'CA' (Canada) → Generate message type 27 for Canadian domestic traffic and Execute pre-spawn processing for GCT1011E
[Generate MSG-THIRTY-EIGHT: Master in-bond validation]
Transportation request is not created for IT (GCUSRT-TR-CREATED-FOR-IT NOT = 'Y') and cargo status is not 'EXPORT' → Generate message type 38 for master in-bond validation failure
[Generate MSG-TWENTY-FIVE: MT bond crossing validation]
Vessel name is not 'TRAIN' and not spaces, and train crossing port equals cargo location ID → Generate message type 25 for MT bond crossing validation
[Generate MSG-SEVENTEEN: BOL type validation]
Vessel name is not 'TRAIN' and does not start with 'T' in position 23 → Generate message type 17 for BOL type validation failure
[Generate MSG-SEVENTEEN: Vessel name validation]
In-bond type code is not 'MT' and vessel name is not 'TRAIN' → Generate message type 17 for vessel name validation failure
[Generate MSG-THIRTY: Border crossing mismatch]
Train crossing port does not equal cargo location ID (GCUSRT-P401-LOCATION-ID) → Generate message type 30 for border crossing mismatch and Execute pre-spawn processing for GCT1011E
[Generate MSG-THIRTY: Export manifest required]
Cargo status description is 'EXPORT' (GCUSRT-RT21-USCARGO-STAT-DESC = 'EXPORT ') → Generate message type 30 for export manifest requirement and Execute pre-spawn processing for GCT1011E
[Generate MSG-THIRTY: Export manifest required]
Cargo status description is 'ARRIVED' (GCUSRT-RT21-USCARGO-STAT-DESC = 'ARRIVED') → Generate message type 30 for export manifest requirement and Execute pre-spawn processing for GCT1011E
[Generate MSG-THIRTY: Border crossing mismatch]
Train crossing port does not equal cargo location ID (GCUSRT-M1203-LOCATION-ID1) → Generate message type 30 for border crossing mismatch and Execute pre-spawn processing for GCT1011E
[Set MSG-TEN Message Flag]
The waybill is not found AND a container is found → Set message type TEN flag to indicate container exists without waybill
[Set MSG-FIFTEEN Message]
The system processes the waybill and cargo validation → The system generates message type fifteen indicating waybill without cargo and includes the waybill root key and waybill date in the message
[Continue Processing]
The system processes the waybill and cargo validation → The system continues processing without generating any error message
[Set MSG-TWENTY-SEVEN Message]
The system validates the geographic routing → The system generates message type twenty-seven and performs the Z125-PRE-SPAWN-GCT1011E process to create a transportation export transaction
[Set MSG-FIFTEEN Message with ROOT-KEY and WB-DATE]
The system validates the geographic routing → The system generates message type fifteen with the waybill root key and waybill date included in the message
[Both Countries = 'CA'?]
Both origin country and destination country equal 'CA' → Generate message type 27 for Canadian domestic traffic and Execute pre-spawn processing for GCT1011E transaction
[Continue with Other Processing]
Either origin country or destination country is not 'CA' → Generate message type 15 with waybill root key and date for standard international processing
[Both Countries = 'CA'?]
Both the origin country and destination country equal 'CA' → The system sets message type twenty-seven and performs pre-spawn processing for GCT1011E
[Set Standard No-Cargo Message]
Either the origin country or destination country is not 'CA' → The system sets message type fifteen with the waybill root key and date
[Both Origin and Destination = 'CA'?]
Both the origin country and destination country equal 'CA' → The shipment is classified as Canadian domestic traffic and message twenty-seven is set, followed by TE creation processing
[Set Message Fifteen - No Waybill Found]
Either the origin country or destination country is not 'CA' → Message fifteen is set with the waybill root key and waybill date populated in the message
[Both Countries = 'CA'?]
Both origin country equals 'CA' AND destination country equals 'CA' → Classify the shipment as Canadian domestic traffic and set message type twenty-seven
[Set Standard No-Cargo Message]
Origin country is NOT 'CA':
destination country is NOT 'CA'
→ Set message type fifteen with root key and waybill date
[Both Countries = 'CA'?]
Both the origin country code and destination country code equal 'CA' → Set message type twenty-seven and Execute pre-spawn GCT1011E processing
[Set Standard No-Cargo Message]
The origin and destination country combination is not both 'CA' → Set message type fifteen with the waybill root key and waybill date
[Generate MSG-TWENTY-SEVEN: Canadian Domestic Traffic]
The system processes the message generation logic → Generate message type twenty-seven indicating Canadian domestic traffic
[Prepare TE Creation for Canadian Cargo Spawn]
The system processes the spawn preparation logic → Execute the pre-spawn procedure Z125-PRE-SPAWN-GCT1011E to prepare TE creation with train crossing details, equipment ID, waybill information, and waybill date
[Generate MSG-FIFTEEN: No Cargo Found]
The system processes the message generation logic → Generate message type fifteen indicating no cargo found and include the waybill root key and waybill date in the message
[Both Countries = 'CA'?]
Both origin country equals 'CA' AND destination country equals 'CA' → Classify the shipment as Canadian domestic and set message type 27 for TE creation processing
[Set Standard No-Cargo Message]
Either origin country is not 'CA':
destination country is not 'CA'
→ Set message type 15 with waybill root key and date for standard no-cargo processing
[Set Canadian Domestic Message]
Both the origin country and destination country are determined to be Canada ('CA') → Set message type twenty-seven and Execute pre-spawn GCT1011E processing
[Set Standard No-Cargo Message]
The origin and destination countries are not both Canada → Set message type fifteen with the waybill root key and date
[Master In-Bond US-CAN-US?]
Cargo bond type is US-CAN-US (88-GCUSRT-M1201-US-CAN-US) AND cargo is Master In-Bond (88-GCUSRT-M1109-MASTER-IN-BOND) AND TR created for IT != 'Y' AND cargo status description != 'EXPORT ' → Generate message type thirty-eight (MSG-THIRTY-EIGHT) indicating Master In-Bond TR requirement violation
[Set Message Sixteen - Cargo in Bad State]
The cargo status validation is performed → The system sets message type sixteen to indicate cargo is in an invalid state for processing
[Continue Processing - Cargo State Valid]
The cargo status is not PENDING, ERROR, or DELETED → The system continues with normal cargo processing without generating error messages
[Set Location Mismatch Message]
The system validates location requirements → Generate message type 30 and trigger diversion processing via GCT1011E spawn
[Set Port Diversion Message]
The system validates port requirements for CPRS billing → Generate message type 30 and trigger port diversion processing via GCT1011E spawn
[Read Container Equipment Record]
The system retrieves the next container equipment record → The container equipment segment is populated with container data
[Current container order > Next container order?]
The current container's order value is greater than the next container's order value → The containers are identified as needing to be swapped to maintain proper sequence
[First Report Line Has US CCN?]
The first report line US CCN field contains only spaces (RPT-US-CCN (1) = SPACES) → The system should set message type 26 indicating missing CCN error and add it to the report index
[Generate Message 31 - Empty Equipment]
The equipment loaded/empty indicator shows 'E' for empty → Message type 31 is generated indicating empty equipment without waybill
[Generate Message 27 - TIB Required]
The equipment is not empty or has other TIB validation failures → Message type 27 is generated and the GCT1011E bill creation process is spawned
[Reset TIB Processing Variables]
Messages have been generated and any required processes spawned → The TIB CCN flag is reset to spaces, the current equipment ID becomes the TIB car ID, and the equipment loaded/empty indicator is updated
[Execute GCT1011E Transaction]
The system executes all queued transactions → For each queued transaction, move input parameters to GCT1011E message, call CIMS to change status, call WRITMSGL to send message, and call CIMS to purge transaction
[Train Crossing Port ≠ Cargo Location?]
The train crossing port does not equal the cargo location ID → The system should trigger diversion processing by setting message type 30 and spawning GCT1011E transaction
[Set Message Type 30 Port Diversion Required]
The system processes the diversion requirement → Message type 30 should be set for the current report index to indicate port diversion is required
[Transport Export with EXPORT Status?]
The cargo has manifest type M1201 transport export AND the cargo status description equals 'EXPORT ' → Set message type 30 and trigger TE Canadian return manifest spawning process
[Export Manifest with ARRIVED Status?]
The cargo has manifest type M1109 export AND the cargo status description equals 'ARRIVED' → Set message type 30 and trigger TE Canadian return manifest spawning process
[Set Message Type 30]
The cargo meets the criteria for TE Canadian return manifest processing → Set message type thirty for the current report index
[Set Message Type 27 - Canadian Domestic TE Creation Required]
The system generates status messages → The system sets message type 27 indicating Canadian domestic TE creation requirement
[Pre-Spawn Required?]
If pre-spawn requirements → The system should determine if message conversion should proceed based on pre-spawn status
[Convert to Message Type 32]
The system processes the message conversion → The message type should be changed from 27 to 32 (message type thirty-two)
[Convert to Message Type 29]
The system processes the message conversion → The message type should be changed from 30 to 29 (message type twenty-nine)
[Loop Through Report Lines]
The system processes message conversion → The system should examine each report line from 1 to the last line number for message type conversion
[Info Messages > 0?]
The information message count is greater than zero → Set the final processing status to NO-WAYBILL
[Set Status: OK]
Both information and error message counts are zero → Set the final processing status to OK and copy report data and CCN keys to output
[Copy Report Data to Output]
No errors or informational messages are present → Copy the report table to output report parameter AND copy the CCN key array to output CCN key array parameter
[Set Car Retrieval Parameters]
Setting up car retrieval parameters → All car types except 98 and 99 should be included, all statuses should be included, EDI incomplete records should be excluded, temporary waybills should be included, corrector waybills should be excluded, returned lead waybills should be included, and latest waybill date should be used
[Accept Current Waybill]
Processing the waybill acceptance → The current waybill should be marked as done and processing should continue
[Get Previous Waybill Date]
Setting up for previous waybill retrieval → The system should set previous status waybill date flag and store current waybill key for comparison
[Set Waybill Status]
Setting the final waybill status → If an error occurred during retrieval, an error message should be generated, otherwise the return flag should be assigned to the waybill indicator
[Train Crossing Port = Cargo Location?]
The train crossing port does not equal the cargo location ID → Generate border crossing mismatch message (type 30) and trigger diversion processing
[Train Crossing Port = Bill Location?]
The train crossing port does not match the cargo bill location ID → Generate port diversion message (type 30) and trigger port diversion processing
[Trigger Diversion Processing]
Message type 30 is generated for location mismatch → Execute pre-spawn processing for GCT1011E diversion transaction
[Trigger Port Diversion Processing]
Message type 30 is generated for port location mismatch → Execute pre-spawn processing for GCT1011E port change transaction
[Train Crossing Port = Cargo Location ID?]
The system compares train crossing port with cargo location ID → If train crossing port equals cargo location ID, generate MT bond crossing error message, otherwise continue processing
[Categorize Message Type]
If the message type indicator → The system increments the error count for error messages, warning count for warning messages, and info count for informational messages
[Is Request Message?]
The message is identified as a request message type → The system increments the request error count by 1
[Both Origin and Destination are Canada?]
Both the origin country code equals 'CA' and the destination country code equals 'CA' → Generate message type 27 and Execute pre-spawn GCT1011E processing for Canadian domestic traffic
[Mark as International Traffic]
Either the origin country code is not 'CA' or the destination country code is not 'CA' → Generate message type 15 with the waybill root key and date for international traffic processing
[Set Canadian Domestic Traffic Message]
The system processes the Canadian domestic traffic case → Message type 27 is set for the current report index to indicate Canadian domestic traffic requiring TE creation
[Prepare TE Creation for Canadian Cargo]
The system prepares TE creation parameters → The pre-spawn index is incremented, GCX101 input parameters are initialized, security byte is set to high values, transaction type is set to CREATE-TE, and country indicator is set to US
[Set Standard No-Cargo Message]
The system processes the non-Canadian domestic traffic case → Message type 15 is set for the current report index, the waybill root key is moved to the message root key field, and the waybill date is moved to the message waybill date field
[Is Transport Export Bond Type?]
The cargo status description equals 'EXPORT ' → Set message type 30 (export manifest required) and trigger Z124 pre-spawn for TE/Canadian return manifest creation
[Is Export Bond Type?]
The cargo status description equals 'ARRIVED' → Set message type 30 (export manifest required) and trigger Z124 pre-spawn for TE/Canadian return manifest creation
[Set Export Message Flag]
The system processes the arrived export cargo → Message type thirty flag is set to true for the current report index
[Generate Loading Status Messages]
Equipment loading status is not empty or waybill was found in previous processing → Message type twenty-seven is generated and GCT1011E transaction is spawned for TIB creation
[Trigger TE Creation for Canadian Cargo]
Both origin country and destination country are 'CA' (Canada) → Message type twenty-seven is generated and GCT1011E transaction is spawned for TE creation
[Message Type?]
The message type is evaluated and it is an error type 27 or 30 → The message is counted as a pre-spawn message by incrementing the pre-spawn counter
[Count Warning Message]
The message type is classified as a warning → The message is counted as a warning by incrementing the error counter
[Count Info Message]
The message type is classified as informational → The message is counted as informational by incrementing the info counter
[Is Request Message?]
The message is identified as a request message → The message is additionally counted as a request error by incrementing the request error counter
[Increment Report Index]
The system needs to move to the next report position → The report index is incremented by 1
[Set Overflow Message]
An overflow condition is detected → Message type 9 is set to indicate report overflow
[Convert Message Types]
Processing each report line with message type indicators → Message type 27 is converted to message type 32 AND message type 30 is converted to message type 29 AND the error count is incremented for each conversion
[Check Report Status]
The system checks the report error status → The system identifies whether the report has errors or not to determine the next processing path
[Write Message to Express PCB]
The system needs to transmit the transaction message → Write the message using WRITMSGL to the express PCB with message code, content, length and module name
[Purge Transaction]
The system completes the transaction processing → Call CIMS with purge operation to finalize the transaction
[Process Message Type Conversions]
The system processes message type conversions → Iterate through all report lines to identify and convert message types 27 and 30
[Convert to Message Type 32]
The system processes error message conversions → Convert the message type from 27 to 32 and increment the report error count by 1
[Convert to Message Type 29]
The system processes error message conversions → Convert the message type from 30 to 29 and increment the report error count by 1
[Pre-Spawn Required?]
The PRE-NO-SPAWN flag is evaluated → If PRE-NO-SPAWN is not set, the system proceeds with message type conversions, otherwise it skips the conversion process
[Convert to Message Type 32]
The system processes message type conversions for error reports → The message type is changed from 27 to 32 and the error count is incremented
[Convert to Message Type 29]
The system processes message type conversions for error reports → The message type is changed from 30 to 29 and the error count is incremented
[Loop Through Report Lines]
Message type conversion processing is initiated → The system iterates through each report line from index 1 to the last line number
[Spawn Processing Required?]
Spawn processing is not required (PRE-NO-SPAWN is true) → The system should iterate through all report lines and convert message types 27 to type 32 and message types 30 to type 29, incrementing error counts for each conversion
[Message Type = 27?]
The system processes the report line for message type conversion → The message type should be changed to 32 and the error count should be incremented by 1
[Message Type = 30?]
The system processes the report line for message type conversion → The message type should be changed to 29 and the error count should be incremented by 1
[More Report Lines to Process?]
The system checks if there are more report lines to process → Processing should continue if the current index is less than or equal to the last report line, otherwise processing should end
[Loop Through Report Lines]
The system needs to process message type conversions → The system should iterate through each report line from 1 to the last line number (RPT-LAST-LINE)
[Message Type = 27?]
The message type indicator equals 27 → The system should flag this message for conversion to error type
[Convert Message Type 27 to Message Type 32]
The message requires conversion for error reporting → The system should change the message type from 27 to 32 (MSG-THIRTY-TWO)
[Continue to Next Line]
The message requires conversion for error reporting → The system should change the message type from 30 to 29 (MSG-TWENTY-NINE) and increment the error count
[Convert to Message Type 29]
Processing each message in the report and the message type indicator equals 30 → Set the message type to 29 and add 1 to the report error count
[Continue Processing Next Message]
Processing each message in the report and the message type indicator does not equal 30 → Continue processing the next message without any conversion
[Convert to Message Type 32]
The system processes the message type conversion → The message type 27 is converted to message type 32 and the error count is incremented by 1
[Convert to Message Type 29]
The system processes the message type conversion → The message type 30 is converted to message type 29 and the error count is incremented by 1
[Process Each Report Line]
The system processes each report line sequentially → Each line from 1 to the last report line is processed for message type conversion
[Check Info Message Count]
The system checks if information message count is greater than zero → The system sets the final status to NO-WAYBILL indicating waybill-related issues were found
[Set Status to OK]
If the message counts → The system sets the final status to OK indicating successful processing
[Set Message Parameters - From: OM01247 - To: OM01247 - Destination: REQUEST]
The system initializes message parameters → The from usercode is set to 'OM01247', the to usercode is set to 'OM01247', and the destination filename is set to 'REQUEST'
[Build Message Subject - ACF2 User ID - Train Number - Current Date/Time]
The system builds the message subject → The subject includes ACF2 user ID, train number, and current machine date components (year, month, day, hour, minute)
[Call EMCSEND2 to Send Report to Customs System]
The system calls the electronic messaging service → EMCSEND2 is invoked with sender usercode, destination filename, recipient usercode, copy usercode, subject, keywords, report table, return status flag, segment numbers, and item type
[Purge Message Queue]
The system performs cleanup operations → CIMS is called with PURG function and ALT-PCB to purge the message queue
[System Abend - SEND TO MERLIN FAILED]
The EMI return status indicates transmission failure → The system sets abend message to 'SEND TO MERLIN FAILED' and performs system abend
[Same Waybill Key as Previous?]
The system compares the current waybill key with the previously processed key → If the waybill key matches the previous key, set not found status to prevent infinite processing, otherwise continue with previous waybill date search
[Set Previous Waybill Date Search]
The system sets up search for previous waybill date records → Search criteria is updated to find earlier dated waybill records and the current waybill key is saved for duplicate detection

Structural Validations

[15:Error Message Generation]
The system generates error messages → Set message type 10 to indicate container found but waybill not found
[15:Error Message Generation]
The system generates messages → Set message type 15 with waybill root key and date information
[15:Error Message Generation]
Both origin and destination countries are Canada → Set message type 27 and spawn GCT1011E transaction for TE creation, otherwise set message type 15
[15:Error Message Generation]
The system validates export status → Set message type 30 and spawn GCT1011E transaction for IT export processing
[15:Error Message Generation]
The cargo status is pending, error, or deleted → Set message type 16 to indicate CP cargo processing issue
[15:Error Message Generation]
TR is not created for IT and cargo status is not EXPORT → Set message type 38 to indicate master in-bond processing required
[15:Error Message Generation]
The system completes equipment lookup → Set message type 12 to indicate complete equipment lookup failure
[15:Error Message Generation]
The train crossing port matches the cargo location → Set message type 25 to indicate marine terminal vessel mismatch
[15:Error Message Generation]
Vessel name is not TRAIN and does not start with T → Set message type 17 to indicate invalid vessel for BOL type 15
[15:Error Message Generation]
The system validates vessel requirements → Set message type 17 to indicate vessel name violation for non-marine terminal cargo
[15:Error Message Generation]
The system detects location mismatch → Set message type 30 and spawn GCT1011E transaction for diversion processing
[15:Error Message Generation]
Train crossing port does not match the cargo location → Set message type 30 and spawn GCT1011E transaction for location change processing
[22:Train Arrival Status Validation]
The system validates arrival requirements → Set message type 26 to indicate missing customs documentation for arrived train
[Retrieve Waybill for Current Equipment]
Car ID format validation fails → Add error message 'ERR>>>> INVALID CAR ID' to report
[Add TR Bond Missing Message]
TR is required for IT transaction type AND TR was not found → Add saved detour line to report AND add message type 28 to report
[Add TE Bond Missing Message]
TE is required for TE transaction type AND TE was not found → Add saved detour line to report AND add message type 36 to report
[Generate Invalid Car ID Error]
The formatting process returns an unsuccessful status → The system generates error message 'ERR>>>> INVALID CAR ID' and adds it to the report
[Set Validation Criteria]
Setting up waybill validation criteria → The system should exclude incomplete EDI waybills, exclude corrected waybills, include temporary waybills, exclude returned lead waybills, and configure to get the latest waybill date
[System Error - GCCCARTP Failed]
The system attempts to retrieve equipment type → An error message is generated indicating the GCCCARTP service failure with parameter details
[Generate TR Missing Message]
TR-NOT-FOUND flag is true → Restore detour line to report and generate message type 28
[Generate TR Missing Message]
TR-NOT-FOUND flag is true → Restore detour line to report and generate message type 34
[Generate TR Missing Message]
TR-NOT-FOUND flag is true → Restore detour line to report and generate message type 35
[Generate TR Missing Message]
TE-NOT-FOUND flag is true → Restore detour line to report and generate message type 36
[Generate TR Missing Message]
TE-NOT-FOUND flag is true → Restore detour line to report and generate message type 37
[MSG-TEN: Container without waybill]
The waybill is not found AND the container is found → Generate message type 10 (MSG-TEN) indicating container exists without waybill
[MSG-FIFTEEN: No cargo with idler]
The waybill is found AND no cargo is found AND idler indicator is not spaces → Generate message type 15 (MSG-FIFTEEN) with root key and waybill date information
[MSG-FIFTEEN: No cargo found]
The traffic is not Canadian domestic (origin or destination country is not 'CA') → Generate message type 15 (MSG-FIFTEEN) with root key and waybill date information
[MSG-SIXTEEN: Invalid cargo state]
Cargo is found AND cargo state is pending:
error
deleted
→ Generate message type 16 (MSG-SIXTEEN) indicating invalid cargo state
[MSG-TWELVE: Neither found]
The waybill is not found AND the container is not found → Generate message type 12 (MSG-TWELVE) indicating neither waybill nor container found
[MSG-TWENTY-FIVE: MT bond crossing issue]
Cargo is found AND bond type is 'MT' AND vessel name is not 'TRAIN' and not spaces AND train crossing port matches cargo location → Generate message type 25 (MSG-TWENTY-FIVE) indicating MT bond crossing issue
[MSG-SEVENTEEN: Vessel name validation]
Cargo is found AND BOL type is '15' AND vessel name is not 'TRAIN' AND vessel name does not start with 'T' → Generate message type 17 (MSG-SEVENTEEN) indicating vessel name validation issue
[MSG-SEVENTEEN: Vessel name validation]
Cargo is found AND bond type is not 'MT' AND vessel name is not 'TRAIN' → Generate message type 17 (MSG-SEVENTEEN) indicating vessel name validation issue
[Generate MSG-TEN: Container without waybill]
The waybill lookup fails to find any associated waybill record for the container → Generate message type 10 indicating container exists without waybill
[Generate MSG-FIFTEEN: Waybill without cargo]
No cargo records are found associated with the waybill → Generate message type 15 with root key and waybill date information
[Generate MSG-FIFTEEN: Waybill without cargo]
Either origin or destination country is not 'CA' (Canada) → Generate message type 15 with root key and waybill date information
[Generate MSG-SIXTEEN: Cargo pending/error/deleted]
Cargo status indicates pending, error, or deleted state (88-GCUSRT-RT10-CPCARGO-PENDING, 88-GCUSRT-RT10-CPCARGO-ERROR, or 88-GCUSRT-RT10-CPCARGO-DELETED) → Generate message type 16 indicating cargo is in invalid state
[Generate MSG-TWELVE: No waybill no container]
Both waybill lookup fails (WS-WAYBILL-NOT-FOUND) and container lookup fails (WS-CONTAINER-NOT-FOUND) → Generate message type 12 indicating neither waybill nor container found
[Search Origin State/Country]
The system needs to determine the appropriate message type → The system searches the state-country table to find the country codes for both origin province/state and destination province/state from the shipment root record
[Cargo State Pending/Error/Deleted?]
Cargo state is CP Cargo Pending (88-GCUSRT-RT10-CPCARGO-PENDING):
CP Cargo Error (88-GCUSRT-RT10-CPCARGO-ERROR)
CP Cargo Deleted (88-GCUSRT-RT10-CPCARGO-DELETED)
→ Generate message type sixteen (MSG-SIXTEEN) indicating bad cargo state
[MT Bond Crossing Error]
Cargo bond type is 'MT' AND vessel name != 'TRAIN' and not spaces AND train crossing port equals cargo location ID (GCUSRT-P401-LOCATION-ID) → Generate message type twenty-five (MSG-TWENTY-FIVE) indicating MT bond crossing error
[Check MT Bond Type]
The system validates border crossing requirements → Generate message type 25 indicating vessel name mismatch for MT bond type cargo
[Check BOL Type = '15']
The system validates vessel name requirements → If vessel name is not 'TRAIN' and does not start with 'T', continue processing without error, otherwise generate message type 17
[Check Non-MT Bond]
The system validates vessel name requirements → Generate message type 17 indicating invalid vessel name for non-MT bond type
[Check MT Bond Type]
Processing cargo for MT bond type validation → Set message twenty-five to indicate MT bond type issue
[Train Crossing Port = Location ID?]
Comparing train crossing port with cargo location ID → Generate message twenty-five if ports match, otherwise continue normal processing
[Bond Type = 'MT'?]
Vessel name is not 'TRAIN' and not empty spaces AND train crossing port equals cargo location ID → Set message type 25 for MT bond crossing error
[Vessel Name = 'TRAIN' or starts with 'T'?]
Vessel name != 'TRAIN' AND vessel name character at position 23 is not 'T' → Set message type 17 for vessel name mismatch
[Vessel Name ≠ 'TRAIN'?]
Vessel name != 'TRAIN' → Set message type 17 for vessel name mismatch
[Train Crossing Port ≠ Location ID?]
Train crossing port does not equal cargo location ID → Set message type 30 for port mismatch AND spawn diversion processing Z122
[Train Crossing Port matches Location ID?]
Train crossing port does not equal cargo location ID1 → Set message type 30 for port mismatch AND spawn change processing Z123
[Check US-CAN-US Traffic]
The cargo is US-CAN-US traffic type AND is Master In-Bond type AND transportation request is not created for IT AND cargo status is not 'EXPORT' → Generate message 38 indicating Master In-Bond transportation request is required
[Collect Container Information]
The container count exceeds 20 containers for a single car → The system should Throw error: indicating too many containers and stop processing additional containers
[Generate Error Message - No Container Relationship]
No container relationship is found in the FWSWRWR database → The system should generate message type 11 indicating no container relationship exists
[Flat Car Found?]
The system checks the status of the flat car relationship retrieval → If flat car relationship is found, proceed with container collection, otherwise generate error message for no containers
[Index Exceeds 20?]
The system checks if the container index exceeds the maximum allowed limit → If index is greater than 20 containers, display error message and set container not found status, otherwise continue with container data storage
[Display Error - Too Many Containers]
The system detects too many containers for a single flat car → Display error message indicating more than 20 containers found for the car ID with the waybill root key, and set container status to not found
[Generate Error Message - No Containers]
No flat car relationship record exists for the waybill → Generate message type 11 indicating no containers found for the equipment
[System Error - Service Failed]
Service failure is detected → Generate error message containing service name and parameter details, then Execute system termination procedure
[System Error - Service Failed]
Service failure needs to be handled → Generate error message containing 'GCCCARTP FAILED PARMS=' followed by service parameters and Execute system abort
[System Error - GCCCARTP Failed]
Service failure needs to be handled → Generate error message containing 'GCCCARTP FAILED PARMS=' with service parameters and Execute system termination
[Report Has Errors?]
The system checks if the report contains any errors → The system should identify whether error message conversion is needed based on report error status
[Increment Error Count]
The message conversion is completed → The report error count should be incremented by 1
[Train Arrived AND No CCN Found?]
The train has arrived at the crossing AND the first report entry has no CCN (US CCN is spaces) → Add a train arrival error message (type 26) to the report
[Error Messages > 0?]
The error message count is greater than zero → Set the final processing status to ERRORS and prepare error report for customs notification
[Prepare Error Report for Customs]
The final status is set to ERRORS → Send the complete report table to customs via the messaging system using predefined user codes and destination
[EDI-418 Release = 'Y'?]
Checking the EDI completion 418 release status → If EDI completion 418 release equals 'Y', the waybill should be accepted, otherwise previous waybill date processing should be initiated
[Bond Type = TR?]
The cargo bond type is 'TR' → Skip border crossing validation and continue processing without generating mismatch messages
[BOL Type = 15?]
The cargo BOL type code is '15' → Skip border crossing validation and continue processing without generating mismatch messages
[Set Master In-Bond Validation Error Message]
All master in-bond validation conditions are met for error generation → Set message type thirty-eight error indicating master in-bond validation failure
[Set MSG-TWENTY-FIVE Error Message]
The validation identifies this invalid configuration → Generate message type 25 error indicating MT bond crossing violation
[Cargo State Validation - Validate cargo is not in bad state (pending/error/deleted)]
The system checks the cargo processing state and finds the cargo status is PENDING, ERROR, or DELETED → The system sets error message MSG-SIXTEEN to indicate invalid cargo state and prevents further processing
[Maximum Report Capacity Reached?]
The report index reaches or exceeds the maximum allowed report capacity → The system sets an overflow message (message type 9) and increments the request error count to indicate capacity exceeded
[Master In-Bond Status Validation - Validate master in-bond status requirements for US-Canada-US traffic]
The cargo is US-Canada-US traffic type AND has master in-bond classification AND no transportation request has been created for immediate transport AND the cargo status is not 'EXPORT' → The system should generate error message type 38 indicating master in-bond status validation failure
[Get Car Loading Status]
Car ID format validation fails → An error message 'ERR>>>> INVALID CAR ID' is generated in the report
[Generate Loading Status Messages]
Equipment loading status is empty ('E') → Message type thirty-one is generated indicating TIB issue for empty car
[Count Error Message]
The message type is an error but not type 27 or 30 → The message is counted as a standard error by incrementing the error counter
[Count Request Error for Overflow]
The overflow condition is being handled → The request error counter is incremented by 1 to account for the overflow
[Report Has Errors?]
If the report for errors → The system determines whether message type conversions should be processed
[Increment Error Count]
The conversion is completed → The report error count is incremented by 1
[Check Report Has Errors]
The report contains errors (RPT-NO-ERROR is false) and pre-spawn records exist (PRE-NO-SPAWN is false) → The system should process message type conversions for error reporting
[Increment Error Count]
The message conversion is completed → The system should add 1 to the report error count (RPT-ERROR-CNT)
[Report Has Errors?]
The system checks for errors in the report → The system identifies whether the report has errors or no errors to determine next processing steps
[Check Error Count]
The system checks if error message count is greater than zero → The system sets the final status to ERRORS and triggers customs report transmission
[Message Send Successful?]
The system checks the transmission result → If EMI return status is not successful, the system abends with 'SEND TO MERLIN FAILED' message
[Has Haulage Right Carrier?]
The system checks for haulage right carrier information → If haulage right carrier is spaces or empty, accept the waybill as valid, otherwise proceed to EDI-418 release validation
[EDI-418 Release = 'Y'?]
The system validates the EDI-418 release completion status → If EDI-418 release equals 'Y', accept the waybill as valid, otherwise check for duplicate waybill key processing
[Display Overflow Error Message]
Overflow condition is detected → Error message is displayed indicating too many containers for the car ID and waybill key

Module: GCCARRT 1 Consolidated Epic Story

Epic: GCCARRT Complete EDI Specification Extracted from Legacy

Contains 23 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCARRT EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Message Structure GCW016]
The system prepares the message structure → The GCW016 message structure is initialized to default values

Core Acceptance Criteria

[2:Prepare Train Data Message]
The system prepares the train data message structure → The GCW016 message structure is initialized, message ID is set to GCW016, and train processing flag is activated
[2:Prepare Train Data Message]
The system populates train identification data in the message structure → The train ID field is cleared with spaces, then populated with the input train ID, and the disposition code is set in the message structure
[3:Send Train Status Change Request]
The system sends train status change request → The GCW016 message is moved to GCT0161E message structure, communication status is cleared, and CIMS is called with change operation
[4:Log Train Processing Message]
The system logs the train processing message → WRITMSGL service is called with communication area, message code, message content, message length, and module name to write the log entry
[5:Purge Processing Session]
The system purges the processing session → CIMS is called with purge operation to clean up the message processing session
[Set Message ID Flag to GCW016]
The system needs to identify the message type → The message ID flag is set to indicate GCW016 message type
[Clear Train ID Field]
The system prepares to populate train identification → The train ID field is cleared of any existing values
[Clear Train ID Field]
The system prepares to populate train data → The train identifier field must be cleared with spaces
[Copy Input Train Identifier to Message]
The system processes train data preparation → The input train identifier must be copied to the message structure train ID field
[Copy Disposition Code to Message]
The system processes train data preparation → The disposition code must be copied to the message structure disposition code field
[Move Complete Message Structure for Processing]
The system completes message preparation → The complete message structure must be moved to the output message area
[Receive Train Status Change Request]
The system begins processing the request → The message structure is initialized with train processing message ID and train processing flag set to true
[Receive Train Status Change Request]
The system processes the input parameters → The train ID field is cleared and populated with the provided train ID, and the disposition code is set in the message structure
[Submit Request to CIMS System]
The system submits the request to CIMS → The message is transferred to output structure, communication status is cleared, and CIMS is called with change operation
[CIMS System Processes Train Status Change]
The system needs to output the processed message → The message is written to the output destination with all message components
[Request Processing Complete]
The processing is complete → The message is purged from CIMS system and the original program context is restored
[Write Message to System Log]
The system needs to log the train processing message for audit purposes → The message is written to the system log using the message logging service with all required parameters
[Set Message Code]
The system prepares parameters for message logging → The message code (GCT0161E-MSG-CODE) is made available as a parameter for the logging operation
[Set Message Content]
The system prepares parameters for message logging → The message content (GCT0161E-MESSAGE) is made available as a parameter for the logging operation
[Set Message Length]
The system prepares parameters for message logging → The message length (GCT0161E-MSG-LGTH) is made available as a parameter for the logging operation
[Set Module Name]
The system prepares parameters for message logging → The module name (GCT0161E-MOD-NAME) is made available as a parameter for the logging operation
[Execute CIMS Purge Function]
The system initiates cleanup procedures for the processing session → The CIMS system purges all temporary session data and cleans up system resources

Structural Validations

None explicitly identified in logic extraction.

Module: GCCCCCD 1 Consolidated Epic Story

Epic: GCCCCCD Complete EDI Specification Extracted from Legacy

Contains 13 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCCCD EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Message Queue Connection]
The system prepares to send the log message → The system calls CIMS with CHNG operation to initialize the message queue connection using ALT-PCB and GCT1051E message structure

Core Acceptance Criteria

[6:Log Cancellation Activity]
The audit logging process is initiated → Create log entry with action code 'ZZZ', message 'REMOVED FROM BONDED UPON PORT SCREEN', high security level, transaction ID 'GCT0021E', user ID, and current date/time
[7:Send Log Message to System]
The system sends the log message → Transmit the message to the messaging system using transaction GCT1051E and purge the message after successful transmission
[Setup Retrieval Parameters]
Setting up retrieval parameters → The system should clear the input/output area, set segment type to GCSCCRT, set function to Get Unique operation, and configure index as not used
[Set Message: 'REMOVED FROM BONDED UPON PORT SCREEN']
The cancellation message needs to be recorded → The message is set to 'REMOVED FROM BONDED UPON PORT SCREEN' to describe the cancellation reason
[Write Cancellation Log Message to Queue]
The message queue connection is established → The system calls WRITMSGL to write the cancellation log message using ALT-PCB, message code, message content, message length, and module name
[Purge Message Queue Connection]
The message transmission is complete → The system calls CIMS with PURG operation to purge the message queue connection using ALT-PCB

Structural Validations

[2:Validate Input Parameters]
The CCN key is blank or contains only spaces → The system displays error message 'GCWCCCD-CCN-KEY IS BLANK' and terminates processing
[3:Retrieve Canada Cargo Record]
The system attempts to retrieve the Canada cargo record → If the record is not found or not accessible, display error message 'UNABLE TO GU GCSCCRT' and terminate processing
[Is CCN Key Blank or Spaces?]
The CCN key parameter is blank or contains only spaces → The system should reject the request and display an error message indicating the CCN key is required
[Set Error Message: 'CCN Key is Blank']
The system needs to communicate the validation failure → The system should set the error message to 'GCWCCCD-CCN-KEY IS BLANK'
[Call Error Handler]
The system needs to handle the validation failure → The system should call the error handling routine to process the validation failure
[Record Found?]
Checking if the record was found successfully → If the data is not in valid range, the system should set error message 'UNABLE TO GU GCSCCRT' and call error handling routine

Module: GCCCCCP 1 Consolidated Epic Story

Epic: GCCCCCP Complete EDI Specification Extracted from Legacy

Contains 13 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCCCP EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[6:Log Cancel Place Activity]
The system creates the audit log entry → The system records action code 'ZZZ', message 'PLACED ADVISORY REMOVED', CCN key, user ID, current date and time, and transaction ID 'GCT0021E'
[7:Send Log Message]
The system submits the log message → The audit message is sent to the messaging system and purged from temporary storage
[Prepare Update Parameters]
The system prepares update parameters → The workspace is cleared and the segment type is set to Canada cargo record type
[Set Message: 'PLACED ADVISORY REMOVED']
The system sets the descriptive message for the operation → The message is set to 'PLACED ADVISORY REMOVED' to clearly describe the business action performed
[Prepare Log Message Format]
The system prepares the log entry for transmission → The GCX105-INPUT structure is moved to GCT1051E-MSG to format it for the messaging system
[Send Log to Messaging System]
The system sends the log entry to the messaging system → The CIMS program is called to insert the message and WRITMSGL is called to write the log entry to permanent storage
[Submit Message to CIMS System]
The system submits the message to CIMS messaging system using ALT-PCB connection with CHNG operation → The message is successfully submitted to CIMS for further processing
[Write Message to Log]
The system calls WRITMSGL to write the message with message code, message text, message length, and module name → The cancel place advisory removal is recorded in the audit trail log for compliance tracking
[Purge Message from System]
The system calls CIMS with PURG operation using ALT-PCB connection → The message is purged from the CIMS messaging system and the audit logging process is completed

Structural Validations

[2:CCN Key Provided?]
The CCN key is blank or contains only spaces → The system displays error message 'GCWCCCP-CCN-KEY IS BLANK' and terminates processing
[Check if CCN key is provided and not blank]
The CCN key field is empty or contains only spaces → The system should reject the request with an error message indicating the CCN key is blank
[Call Error Handler]
The error message has been set to indicate CCN key is blank → The system should call the error handler to process the validation failure
[Error: Unable to Retrieve Record]
The system determines the record is not available or accessible → An error message 'UNABLE TO GU GCSCCRT' is generated and the error handler is invoked

Module: GCCCCCS 1 Consolidated Epic Story

Epic: GCCCCCS Complete EDI Specification Extracted from Legacy

Contains 18 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCCCS EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[6:Log Cancel Suspect Activity]
The system creates the audit log entry → Log entry contains action code 'ZZZ', message 'SUSPECT ADVISORY REMOVED', transaction ID 'GCT0021E', user ID, current date and time, and the CCN key
[7:Send Log Message]
The system sends the log message → The log message is transmitted to the messaging system and the message queue is purged
[Prepare Search Parameters]
The system prepares search parameters → The input/output structure is cleared, segment type is set to Canada cargo record, function is set to get/retrieve, and index usage is disabled
[Execute Cargo Record Retrieval]
The system executes the cargo record retrieval → The cargo database interface is called with the communication area, input/output structure, and cargo record segment
[Set Database Operation Parameters]
The system prepares database operation parameters → The segment type is set to Canada Cargo (GCSCCRT) and the function is set to Replace operation
[Execute Replace Operation]
The system executes the replace operation → The Canada cargo record is updated in the database with the current segment data
[Set Message: 'SUSPECT ADVISORY REMOVED']
The system populates the audit message field → The message must be set to 'SUSPECT ADVISORY REMOVED' to clearly describe the action taken
[Format Log Message]
The system prepares to submit the log entry → The complete GCX105-INPUT structure must be moved to GCT1051E-MSG field for message formatting
[Submit Log Message to System]
The system submits the log entry → The system must call CIMS and WRITMSGL programs to process and store the audit message, then call CIMS with PURG to complete the logging transaction
[Prepare Message for Submission]
The system prepares the log message for submission → The message structure is initialized with action code 'ZZZ', message text 'SUSPECT ADVISORY REMOVED', security settings, CCN key, transaction ID 'GCT0021E', user ID, current date and time
[Submit Message to IMS System]
The system submits the message to IMS → The message is sent to IMS using CHNG function with the prepared message structure
[Write Message to Log]
The system writes the message to the log → The message is written to the system log using the message code, message text, message length and module name
[Purge Message from System]
The system purges the message from IMS → The message is purged from IMS using PURG function to free system resources

Structural Validations

[2:Validate Input Parameters]
The CCN key is blank or contains only spaces → The system displays error message 'GCWCCCS-CCN-KEY IS BLANK' and stops processing
[Is CCN Key Equal to Spaces?]
The CCN key input parameter is blank or contains only spaces → The system should reject the request and display an error message indicating that CCN key is required
[Set Error Message: 'CCN Key is Blank']
The validation check determines the CCN key is invalid → The system should set the error message to 'GCWCCCS-CCN-KEY IS BLANK' for user notification
[Call Error Handler]
The CCN key validation has failed → The system should call the error handler program to process the validation failure
[Error: Unable to Retrieve Record]
The system detects the record was not found → An error message 'UNABLE TO GU GCSCCRT' is set and the error handler is called

Module: GCCCEXP 1 Consolidated Epic Story

Epic: GCCCEXP Complete EDI Specification Extracted from Legacy

Contains 50 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCEXP EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Retrieve First Cargo Report Record]
The system attempts to retrieve the first cargo report record using GEGB status → The first cargo report segment is retrieved from the database
[4:Extract Cargo Report Data]
The system processes the cargo report data → The cargo report segment is moved to working storage
[5:Extract Cargo Control Number]
The system extracts key information → The cargo control number key is moved to working storage
[7:Update Cargo Report Record]
The system updates the database record → The cleansed cargo report segment replaces the original record in the database
[9:Perform Checkpoint Processing]
The system performs checkpoint processing → A checkpoint is executed and if shutdown is requested (status XD), the program terminates with shutdown message
[11:Reposition Database Cursor]
The system repositions the database cursor using the saved cargo control number → The database cursor is positioned at the correct cargo report record, or if repositioning fails, the program terminates with error message
[12:Retrieve Next Cargo Report Record]
The system retrieves the next cargo report record using GHN status → The next cargo report segment is retrieved from the database
[Retrieve First Cargo Report Record from Database]
The system attempts to retrieve the first cargo report record → A database call is made to get the first cargo report segment using the configured parameters
[Execute GHU Operation to Get First Cargo Report Record]
The system executes the GHU operation → The first cargo report segment should be retrieved from the database using the CIMS interface
[Extract Current Cargo Report Data]
The system begins processing the current record → The cargo report segment data is copied to working storage and the cargo control number key is extracted and saved for reference
[Update Cargo Report in Database]
The system updates the record → The modified cargo report segment is replaced in the database
[Copy Cargo Report Segment Data to Working Storage]
The system needs to process the cargo report data → The cargo report segment data is copied to working storage and the cargo control number key is extracted for processing
[Reset Extra Data Fields to Spaces]
The system processes the cargo report segment for data cleansing → The extra data fields in the cargo report segment are reset to spaces to remove any extraneous information
[Copy Cargo Report Data to Working Storage]
The system begins the update process → The cargo report segment data is copied to working storage and the cargo control number key is extracted
[Move Updated Data Back to Cargo Report Segment]
The system prepares to update the database → The cleaned cargo report data is moved back to the cargo report segment structure
[Execute Database Replace Operation]
The system executes the database update operation → A database replace operation is performed to update the cargo report segment
[Copy Cargo Report Segment to Working Storage]
The system needs to process the cargo report data → The cargo report segment data must be copied to working storage WS-CCRT to make it available for processing operations
[Copy Cargo Report Segment to Working Storage]
The system processes the cargo report data → The cargo control number key must be extracted and stored in working storage WS-CCN for identification purposes
[Extract CCN Key from Cargo Report Segment]
The system processes the cargo report record → The cargo control number key is extracted from the cargo report segment and saved to working storage for later use
[Clear Extra Data Fields - Reset extra data fields in the cargo report segment to spaces]
The system processes the cargo report segment for data cleansing → The extra data fields in the cargo report segment are reset to spaces to remove any residual data
[Clear Database Status Flags]
The system prepares to execute the database update operation → The database communication status must be cleared to spaces to ensure clean operation state
[Execute Database Update Operation]
The system executes the database update operation → The cargo report segment must be replaced in the database using REPL operation through the CIMS interface
[Prepare Modified Cargo Report Data]
The system prepares to update the database record → The processed cargo report data must be moved from working storage to the database cargo report segment area
[Increment Change Counter - Track the number of database changes made during processing]
The system begins processing a cargo report segment → The database change counter must be incremented by 1 to track the number of modifications made
[Execute Database Checkpoint]
A checkpoint operation is initiated → The system executes a database checkpoint call to preserve transaction state
[Handle Shutdown Request]
The shutdown request needs to be processed → The system displays a shutdown notification message, sets an appropriate error message, and initiates abnormal termination procedures
[Reset Change Counter to Zero]
The system attempts to reposition to the current cargo control number → The system executes a database call to retrieve the cargo report segment using the saved cargo control number key
[Execute Database Checkpoint]
A database checkpoint operation is executed → The system calls the checkpoint service to commit current transactions and maintain data integrity
[Display Shutdown Message]
The system processes the shutdown request → A shutdown notification message is displayed to the console for operator awareness
[Terminate Processing]
The system needs to terminate processing → The system calls the error handling routine to terminate processing gracefully
[Execute Database Positioning Command]
The system executes the database positioning command using GHU operation → The database attempts to position to the cargo report segment matching the specified CCN
[Execute Get Next Record Operation]
A Get Hold Next operation is executed on the cargo report database → The next cargo report segment is retrieved and made available for processing
[Check End of Database - Determine if all cargo report records have been processed]
The database operation returns a non-empty status code indicating no more records are available → The system sets the end of database flag to true to terminate further processing
[IMS Shutdown Request Received]
The system status indicates a shutdown request (status code 'XD') → Display shutdown notification message to console AND set error message to indicate shutdown request received AND invoke error handler to terminate processing
[Database Operation Failed After Checkpoint]
The database repositioning operation fails (status code is not spaces) → Set error message indicating inability to reposition after checkpoint AND invoke error handler to terminate processing
[Display Shutdown Message to Console]
The program needs to notify operators of the shutdown → Display the message 'IMS SHUTDOWN REQUEST RECEIVED BY GCCCEXP' to the system console
[Display Shutdown Message to Console]
The system needs to notify operations staff of the shutdown → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCCCEXP' is displayed on the operations console
[Terminate Processing Due to Shutdown]
The system needs to terminate cargo report processing → The standard error handling procedure is invoked to terminate the program
[Complete Program Execution - Restore original program name and terminate processing]
The system completes all database operations → The original program name is restored to maintain proper program context and execution is terminated normally

Structural Validations

[Clear Extra Data Fields]
The system prepares the record for update → All extra data fields in the cargo report segment are cleared to spaces
[Reset Change Counter to Zero]
The database repositioning operation completes → If the repositioning fails (status code is not spaces), the system sets an error message about inability to reposition and initiates abnormal termination
[Set Error Message]
The system prepares for termination → The shutdown request information is recorded as an error message for proper error handling
[Handle Positioning Error]
The system is unable to reposition the database cursor to the correct Cargo Control Number record → An error message 'UNABLE TO GHU CCRT AFTER CHECKPOINT' should be set and the program should terminate abnormally
[Verify Positioning Success]
The system checks the operation status code → If the status code is not spaces, the system sets an error message about inability to position after checkpoint and performs abnormal termination
[Set Error Message: IMS Shutdown Request]
The program needs to document the shutdown reason → Set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCCCEXP'
[Set Error Message: Unable to Reposition After Checkpoint]
The repositioning operation fails → Set the error message to 'UNABLE TO GHU CCRT AFTER CHECKPOINT'
[Call Error Handler CERR]
The program needs to terminate due to the error → Call the error handler program 'CERR' to manage the termination process
[Set Error Message for Shutdown]
The system prepares to terminate processing due to shutdown → The error message 'IMS SHUTDOWN REQUEST RECEIVED BY GCCCEXP' is stored in the communication control error message field
[Set Error Message: 'UNABLE TO GHU CCRT AFTER CHECKPOINT']
The system detects the repositioning failure → The system should set the error message to 'UNABLE TO GHU CCRT AFTER CHECKPOINT'
[Terminate Processing with Error]
The system determines it cannot continue processing safely → The system should terminate processing with an error condition

Module: GCCCKTAG 1 Consolidated Epic Story

Epic: GCCCKTAG Complete EDI Specification Extracted from Legacy

Contains 6 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCKTAG EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Retrieve Initial Equipment Record]
The system searches for associated equipment records → The cargo ID is used as the key value to retrieve the first equipment record from the cargo report segment
[Get First Equipment Record]
Retrieving the first equipment record → A database call should be made to get the cargo report segment using the equipment search key
[Get Next Equipment Record]
Getting the next equipment record → A database call should be made to retrieve the next cargo report segment
[Retrieve Cargo Report Segment]
The system processes the retrieved record → The cargo report segment information is extracted and made available
[Return Equipment Record Data]
The equipment record retrieval process completes → The equipment record data is returned to the calling process
[Set Not-Released Flag to 0]
The system returns a status code of 'GE' indicating no records were found → The not-released flag should be set to 0 and processing should exit immediately

Structural Validations

None explicitly identified in logic extraction.

Module: GCCCROSS 1 Consolidated Epic Story

Epic: GCCCROSS Complete EDI Specification Extracted from Legacy

Contains 4 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCCROSS EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Reference Table Search Parameters]
The system begins the reference table search process → All table entry segments, key values, flags, and return indicators are cleared to spaces to ensure clean initialization

Core Acceptance Criteria

[19:Reference Table Lookup - Search entry table using crossing point name or US border station]
The system searches the entry table → The system should retrieve the table entry segment if successful, or handle unsuccessful lookup
[Execute database search call to crossing table]
The system executes the database search operation → A database call is made to the crossing table segment using the composite key to retrieve matching crossing records
[Extract Table Entry Data]
The system processes the retrieved table entry → The table segment is moved to the entry segment structure and crossing point implementation status is set based on the segment's implementation flag

Structural Validations

None explicitly identified in logic extraction.

Module: GCCDRIVR 1 Consolidated Epic Story

Epic: GCCDRIVR Complete EDI Specification Extracted from Legacy

Contains 106 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCDRIVR EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Input Message Area]
Input message area needs to be prepared → Input message area is initialized to spaces

Core Acceptance Criteria

[1:Message Queue Processing]
The transaction code starts with 'GCT111' → Process only one input message and stop
[1:Message Queue Processing]
The transaction code does not start with 'GCT111' → Continue processing input messages until no more messages are available
[3:Train Transaction Processing, 4:Cargo Transaction Processing]
The transaction code is either train transaction code or cargo transaction code → Reformat the message for spawn screen display
[5:Signon Transaction Processing]
The transaction code is signon transaction code → Reformat the message for clear screen display
[6:S2MR Spawn Message Processing]
The transaction code is S2MR spawn transaction code → Reformat the message for S2MR spawn processing
[7:US Cargo Transaction Processing]
The transaction code is US cargo from freight waybill or US cargo detour transaction code → Process the input message directly without additional validation
[12:User Authorization Check]
The user ID equals the original terminal ID → Generate system message 0002, set blank screen output, and mark as security error
[13:Input Message Processing]
Input message is ready for processing → Call the processing program with input message, user security segment, and receive output message and system codes
[14:Output Message Transmission]
Output select code is not empty or system message number is not empty → Send the output message with output codes and system message number
[Check Transaction Code]
The system checks the first 6 characters of the transaction code → If transaction code starts with 'GCT111', single message processing is selected, otherwise continuous message processing is selected
[Single Message Retrieval GCT111 Transaction]
Message retrieval is initiated → Only one message retrieval operation is performed without checking for additional messages
[Continuous Message Retrieval All Other Transactions]
Message retrieval is initiated → Message retrieval continues in a loop until return code indicates no more messages are available
[Call READQL to Retrieve Message from IMS Queue]
Message retrieval is requested from IMS queue → READQL service is called with communication area and message text parameters
[Process Retrieved Message]
Message processing is initiated → System clears error flags and message numbers, then invokes message processing logic
[More Messages Available?]
System evaluates if more messages should be retrieved → If return code indicates more messages available, processing loop continues, otherwise processing ends
[Route to Train/Cargo Processing]
The transaction code equals GC-TRAIN-TRANS-CODE or GC-CARGO-TRANS-CODE → The system routes the transaction to spawn screen message reformatting process
[Route to Signon Processing]
The transaction code equals GC-SIGNON-TRANS-CODE → The system routes the transaction to clear screen message reformatting process
[Route to S2MR Spawn Processing]
The transaction code equals S2MR-SPAWN-TRAN-CODE → The system routes the transaction to S2MR spawn reformatting process
[Route to US Cargo Processing]
The transaction code equals GC-US-CARGO-FROM-FW-TRANS-CODE or GC-US-CARGO-DETOUR-TRANS-CODE → The system routes the transaction directly to input message processing
[Route to Train/Cargo Processing]
The reformatting process is invoked → The system clears PF entry data, user message, SPA fields, function data, date time filler, and input field data, sets the user ID from ACF2, sets security byte to high values, and marks screen as useable
[Route to Signon Processing]
The reformatting process is invoked → The system clears the message text, sets the user ID from ACF2, sets security byte to high values, and marks screen as useable
[Route to S2MR Spawn Processing]
The reformatting process is invoked → The system moves message text to S2MR spawn structure, clears message text, sets S2MR SPA data, sets user ID from S2MR user code, sets original system to S2MR, conditionally sets security byte to high values if spawn low values equals low values, and marks screen as useable
[Clear PF Entry Data]
The system reformats the spawn screen message → The PF entry data area must be cleared to spaces
[Clear User Message Area]
The system reformats the spawn screen message → The user message area must be cleared to spaces
[Clear S2MR SPA Area]
The system reformats the spawn screen message → The S2MR SPA area must be cleared to spaces
[Clear Customs SPA Area]
The system reformats the spawn screen message → The customs SPA area must be cleared to spaces
[Clear Screen Control SPA]
The system reformats the spawn screen message → The screen control SPA area must be cleared to spaces
[Clear Function Data Area]
The system reformats the spawn screen message → The function data area must be cleared to spaces
[Clear Date Time Filler]
The system reformats the spawn screen message → The date time filler area must be cleared to spaces
[Clear Input Field Data]
The system reformats the spawn screen message → The input field data area must be cleared to spaces
[Set User ID from ACF2]
The system reformats the spawn screen message → The user ID must be set from the CC-ACF2-USERID value
[Set Security Byte to High Values]
The system reformats the spawn screen message → The security byte must be set to HIGH-VALUES
[Mark Screen as Useable]
The system reformats the spawn screen message → The useable screen indicator must be set to 'Y'
[Clear PF Entry Data]
The system begins reformatting the spawn screen message → The PF entry data area is cleared to spaces
[Clear User Message Area]
The system begins reformatting the spawn screen message → The user message area is cleared to spaces
[Clear S2MR SPA Area]
The system begins reformatting the spawn screen message → The S2MR SPA area is cleared to spaces
[Clear Customs SPA Area]
The system begins reformatting the spawn screen message → The customs SPA area is cleared to spaces
[Clear Screen Control SPA]
The system begins reformatting the spawn screen message → The screen control SPA area is cleared to spaces
[Clear Function Data]
The system begins reformatting the spawn screen message → The function data area is cleared to spaces
[Clear Date Time Filler]
The system begins reformatting the spawn screen message → The date time filler area is cleared to spaces
[Clear Input Field Data]
The system begins reformatting the spawn screen message → The input field data area is cleared to spaces
[Set User ID from ACF2]
The system begins reformatting the spawn screen message → The user ID is set from the ACF2 user ID in the communication area
[Set Security Byte to High Values]
The system begins reformatting the spawn screen message → The security byte is set to high values to indicate security validation
[Mark Screen as Useable]
The system completes reformatting the spawn screen message → The useable screen indicator is set to 'Y' to enable screen usage
[Clear Message Text Area]
The system begins reformatting the signon message → The message text area is cleared to spaces
[Set User ID from ACF2]
The system sets user identification in the message → The ACF2 user ID is copied to the message user ID field
[Set Security Byte to High Values]
The system configures security settings for the message → The security byte is set to high values to indicate authorized access
[Extract S2MR Message Content]
The system begins reformatting the S2MR spawn message → The original message text is extracted from the S2MR spawn structure and the message text area is cleared for new content
[Move S2MR SPA to Message]
The message reformatting process executes → The S2MR SPA data is moved to the customs message S2MR SPA field
[Extract User Code from S2MR]
User identification is being processed during message reformatting → The S2MR user code is extracted and assigned as the message user ID
[Set Origin System as S2MR]
The origin system identification is being set → The message origin system is set to S2MR
[S2MR Contains Low Values?]
If the S2MR spawn low values field → If the S2MR spawn low values field equals low values, the security byte is set to high values to indicate valid security
[Mark Screen as Useable]
The screen usability indicator needs to be set → The useable screen indicator is set to 'Y' to allow screen processing
[Copy Input Message to Output]
The system begins processing the transaction → The input message content is copied to the output message
[Call Customs Processing Program]
The system needs to process customs-related business logic → The system calls CSILKCRD-PROGRAM with communication area, input message, output message, user security profile, output select code, and system message number
[Is S2MR SPA Empty?]
The system checks if GCMSG-S2MR-SPA field is empty (contains spaces) → The system routes to either user ID validation or S2MR user code validation path
[User ID = Original Terminal?]
The system compares CC-ACF2-USERID with CC-ORIG-LTERM → If they match, set security error with message 0002 and blank screen, otherwise proceed with ACF2 user ID validation
[Call Security Profile Access]
The system calls the security profile access function with GU operation code and user table ID → The system attempts to retrieve the user's security profile from the database
[Profile Found Successfully?]
The security profile access returns a successful status → The retrieved profile data is moved to the user segment for further processing
[Move Retrieved Profile to User Segment]
The profile retrieval operation completes successfully → The profile data is moved from the table segment to the user segment
[Message Source?]
The system needs to identify the user for security profile retrieval → If the message has S2MR-SPA data, use the S2MR user code; otherwise use the ACF2 user ID from the message
[Use ACF2 User ID from Message]
The system performs security profile retrieval → The ACF2 user ID from the message is moved to the user ID field for profile lookup
[Use S2MR User Code from Message]
The system performs security profile retrieval → The S2MR user code from the message is moved to the user ID field for profile lookup
[Call GCCTBIO Security Access Module]
The system needs to retrieve the user security profile → The GCCTBIO module is called with communication area, control flags, function code, table literals, key values, work segment, and return flag
[Move Retrieved Profile to User Segment]
The return flag indicates successful profile retrieval → The retrieved table segment data is moved to the user security profile segment
[Set User ID for Lookup]
The system prepares the lookup key → The user ID from the message is set as the key value for table access
[Move Retrieved Segment to User Segment]
Valid security data is retrieved from the database → The retrieved table segment is moved to the user segment structure
[Handle No Data Found]
No user security profile exists in the table → System checks segment count and applies default security configuration
[Clear User Segment]
No valid security segments exist for the user → User segment is cleared and default security configuration is applied
[Execute GCCTBIO call with security table parameters and handle response]
The GCCTBIO database access call is executed with security table parameters → The system retrieves the security profile data and stores it in the user segment workspace
[Move Retrieved Data to User Segment]
The return flag indicates successful operation → The retrieved table segment data is moved to the user security segment for further processing
[Security Table Exists? and User Segment Count = Zero?]
If the security table access results → If security table access is successful, the user segment count is checked, and if count is zero or access fails, default security profile creation is initiated
[Clear User Security Segment]
The system needs to prepare for default security profile creation → User security segment is cleared by moving spaces to the user segment area
[Set User ID from Message]
The system processes the user identification from the message → The user ID from the message is assigned to the security profile user ID field
[Set User ID from Message]
The system processes default security profile creation → The user ID from the message is assigned to the security profile
[User ID matches Terminal?]
The system compares CC-ACF2-USERID with CC-ORIG-LTERM → If the user ID matches the original terminal, set security error with message 0002, blank screen output, and mark as not valid
[Access User Security Profile]
The system calls GCCTBIO to retrieve the user security profile using GU function code and USER-TABLE-LIT → If successful, move the retrieved table segment to GCSTBRT-USER-SEGMENT, otherwise proceed to get default security profile
[Use Retrieved Security Profile]
GCCTBIO-RETURN-FLAG equals SUCCESSFUL → Use the retrieved security profile data from WS-TABLE-SEGMENT for user authorization
[Get Default Security Profile]
The system calls GCCTBIO with spaces as the user ID to get default profile → If successful and segment count is not zero, use the default profile, otherwise create standard default profile
[Copy Input Message to Output Message]
The system begins processing the input message → The input message content is copied to the output message buffer
[Call Customs Processing Program CSILKCRD]
The system needs to execute customs business logic → The CSILKCRD customs processing program is called with the communication control block, input message, output message, user security profile, output selection code, and system message number parameters
[Check Output Requirements]
The system checks for output select code or system message number presence → The system should evaluate whether either output select code is not spaces or system message number is not spaces to determine if output transmission is required
[Call GCCOUT Output Handler]
The system needs to send the output message → The system should call GCCOUT program with communication control block, output message, output select code, and system message number parameters
[Set User ID from Message]
The user identity needs to be established in the profile → The user ID from the message is assigned to the security profile user ID field
[Set User Table ID and User ID]
The system cannot find an existing user profile → The user table ID is set to USER-TABLE-LIT and the user ID is set to the message user ID
[Signon Message Reformatting]
The transaction code equals GC-SIGNON-TRANS-CODE → The message text is cleared, user ID is set from ACF2 userid, security byte is set to high values, and screen is marked as useable
[S2MR Spawn Message Reformatting]
The transaction code equals S2MR-SPAWN-TRAN-CODE → The spawn data is extracted, message text is cleared, S2MR SPA data is moved, user code becomes the user ID, origin system is set to S2MR, and screen is marked as useable
[Train/Cargo Message Reformatting]
The transaction code equals GC-TRAIN-TRANS-CODE or GC-CARGO-TRANS-CODE → All message fields are cleared including PF entry data, user message, SPA fields, function data, and input field data, then user ID is set from ACF2 userid, security byte is set to high values, and screen is marked as useable
[Set Security Byte]
The S2MR spawn low values field equals LOW-VALUES → The security byte is set to HIGH-VALUES
[Message Type?]
If the transaction code → If transaction code is GC-SIGNON-TRANS-CODE then Execute signon reformatting, else if transaction code is S2MR-SPAWN-TRAN-CODE then Execute S2MR spawn reformatting, else if transaction code is GC-TRAIN-TRANS-CODE or GC-CARGO-TRANS-CODE then Execute train/cargo reformatting
[User ID vs Terminal Check]
The user's ACF2 user ID equals the original terminal ID → The system generates invalid user error message '0002', sets blank screen output, and marks the transaction as not valid
[User ID vs Terminal Check]
The user ID matches the original terminal ID → The system generates error code 0002, sets blank screen output mode, and marks the security as not valid
[S2MR SPA Present?]
No S2MR session data is present in the message → The system generates error code 0003, sets blank screen output mode, and marks the security as not valid
[S2MR SPA Present?]
S2MR session data is present in the message → The system copies input message to output, generates error code 0003, sets S2MR menu output mode, and marks the security as not valid

Structural Validations

[8:Security Validation]
The security byte is not set to high values → Generate system message 0001, set blank screen output, and mark as security error
[Message Retrieved Successfully?]
Return code from message retrieval is evaluated → If return code equals zero, message retrieval is successful and processing continues, otherwise processing stops
[Set Security Error - Invalid User]
Security validation detects this invalid condition → Set output message to spaces, system message number to 0002, output select code to blank screen, and security error flag to not valid
[Profile Count = Zero?]
The system checks the profile segment count → If the segment count is zero, the profile is considered invalid and default permissions must be created
[Check Segment Count]
System needs to validate the data completeness → The segment count is checked to determine if it contains valid security information
[Set Security Error - Invalid User]
CC-ACF2-USERID equals CC-ORIG-LTERM for non-S2MR session → Set OUTPUT-MESSAGE to spaces, SYSTEM-MSG-NUM to 0002, OUTPUT-SELECT-CODE to BLANK-SCREEN, and SECURITY-ERROR-FLAG to NOT-VALID
[Security Byte Check]
The message security byte is not set to high values → The system generates security violation error message '0001', sets blank screen output, and marks the transaction as not valid
[Set Security Error for S2MR User]
The system needs to generate an error response → The system sets security error message '0003', configures S2MR menu output, and marks the transaction as not valid
[Set Security Error for Regular User]
The system needs to generate an error response → The system sets security error message '0003', sets blank screen output, and marks the transaction as not valid
[Send Error Message via GCCOUT]
Output select code is not empty or system message number is not empty → The system calls GCCOUT to send the error message with output message, output select code, and system message number
[Security Byte Check]
The security byte in the message is not set to HIGH-VALUES → The system generates error code 0001, sets blank screen output mode, and marks the security as not valid

Module: GCCDUP 1 Consolidated Epic Story

Epic: GCCDUP Complete EDI Specification Extracted from Legacy

Contains 76 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCDUP EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Message Structure]
The system begins generating an alert message → All message input fields are cleared to spaces to ensure clean message structure
[Initialize Audit Message Structure]
The system begins the audit logging process → The audit message structure is cleared and initialized to spaces

Core Acceptance Criteria

[3:Save Current Manifest Data]
The system begins duplicate checking process → Current CCN key, waybill key, equipment ID, and complete cargo report segment are saved to working storage, duplicate status is set to not found, and CCN found flag is set to true
[4:Search for Duplicate Manifests by Car ID]
The system performs database search using the car ID → Database is queried for cargo report segments matching the equipment ID, and search results are evaluated for successful retrieval
[9:Generate Duplicate Manifest Alert Message]
The system generates notification message → Alert message is created with action code 'ZZZ', message text 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID', CCN key, security settings, cargo type flag, transaction details, user ID, current date and time
[10:Log Duplicate Manifest Event]
The system logs the duplicate event → Message is sent to alternate PCB message queue, written to message log using WRITMSGL with message code and details, and message queue is purged
[12:Restore Original Manifest Data]
The system restores original data → Saved cargo report segment is moved back to the current cargo report segment field
[Check Train ID Availability - Verify if Canadian Customer North Train ID field is empty to determine if duplicate manifest checking is needed]
The Canadian Customer North Train ID field is evaluated → If the field is empty (spaces), proceed with duplicate manifest checking; otherwise skip the duplicate manifest validation process
[Extract CCN Key from Current Cargo Report]
The system needs to save current manifest data for comparison → The CCN key from the current cargo report segment is extracted and stored in working storage for comparison purposes
[Extract Waybill ID from Current Cargo Report]
The system needs to save current manifest data for comparison → The waybill key from the current cargo report segment is extracted and stored in working storage for comparison purposes
[Extract Car/Equipment ID from Current Cargo Report]
The system needs to save current manifest data for comparison → The equipment ID from the current cargo report segment is extracted and stored in working storage for comparison purposes
[Save Complete Cargo Report Segment]
The system needs to save current manifest data before performing database searches → The complete cargo report segment is saved to working storage to preserve original data during processing
[Clear Cargo Record Buffer]
The system prepares to get the next cargo record → The cargo report segment buffer is cleared to spaces
[Prepare CCN Key for Processing]
The duplicate marking process begins → The CCN key from the cargo report segment is moved to the key value field for processing
[Execute Database Get-Hold-Unique Call]
The system needs to retrieve a cargo record for modification → A database get-hold-unique operation must be executed using the cargo report segment and qualified search criteria
[Set Action Code to 'ZZZ']
The system sets the message action code → The action code is set to 'ZZZ' to identify this as a duplicate manifest alert
[Set Alert Message Text: 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID']
The system sets the alert message text → The message text is set to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID' to inform users of the duplicate and provide guidance
[Add CCN Key to Message]
The system adds identification information to the message → The CCN key from the cargo report segment is added to the train or US CCN field in the message
[Set Security Level]
The system sets the security level for the alert → The security byte is set to high-value to indicate high security level for the alert message
[Set Message Type to Cargo]
The system sets the message category type → The message type is set to cargo to indicate this alert relates to cargo operations
[Add Transaction Code]
The system adds transaction tracking information → The transaction code from the communication control block is added to the sending transaction field
[Add User ID]
The system adds user identification information → The ACF2 user ID from the communication control block is added to the message
[Add Current Date]
The system adds date information to the alert → The machine century and machine date from the communication control block are concatenated and added to the date field
[Add Current Time]
The system adds time information to the alert → The machine time from the communication control block is added to the time field in the message
[Prepare Message for Transmission]
The system prepares the message for transmission → The complete message input structure is moved to the message transmission format and communication status is cleared
[Clear Message Input Area]
The system begins building the alert message → The message input area is cleared to spaces to ensure clean message construction
[Set Action Code to 'ZZZ']
The system sets the message action code → The action code is set to 'ZZZ' to categorize this as a duplicate manifest alert
[Set Message Text: 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID']
The alert message is being constructed → The message text is set to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID' to inform users of the issue and recommended action
[Set Train/CCN Reference Number]
The system builds the message header information → The CCN key from the cargo record is included in the train/CCN reference field for identification purposes
[Set Security Level to High Value]
The system sets the security level for the message → The security byte is set to high-value to ensure appropriate access control for this critical alert
[Set Message Type to CA-CARGO]
The system sets the message category → The message type is set to CA-CARGO to properly categorize this as a cargo operations alert
[Set Sending Transaction Code]
The system builds the message header → The transaction code from the originating transaction is recorded in the sending transaction field for audit trail purposes
[Set User ID from System]
The system builds the message audit information → The ACF2 user ID from the system context is recorded in the message for accountability tracking
[Build Date String from System Date]
The system builds the date information → The machine century and machine date are concatenated to form a complete date string for the message timestamp
[Set Time from System Time]
The system sets the time information → The machine time from the system context is recorded in the message time field for precise timing reference
[Clear Message Input Area]
The system begins preparing the alert message → The message input area is cleared to spaces to ensure clean message content
[Set Action Code to 'ZZZ']
The system sets up the alert message structure → The action code is set to 'ZZZ' to indicate a duplicate manifest alert
[Add Alert Text: 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID']
The system populates the alert message content → The message text is set to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID'
[Add CCN Key to Message]
The system adds reference information to the message → The CCN key from the duplicate cargo record is included in the message
[Set Security Level to High Value]
The system sets security parameters for the alert → The security byte is set to high-value to ensure proper access control
[Set Message Type to CA-CARGO]
The system classifies the message type → The message is marked as CA-CARGO type to indicate cargo-related alert
[Add Sending Transaction Code]
The system adds transaction tracking information → The sending transaction code from the current transaction is included in the message
[Add User ID from ACF2]
The system adds user identification to the message → The ACF2 user ID from the current session is included in the message
[Format Current Date]
The system adds timestamp information → The current machine date with century is formatted and included in the message
[Add Current Time]
The system completes timestamp information → The current machine time is included in the message
[Complete Message Assembly]
The system finalizes the message preparation → The complete message is assembled and ready for transmission to the messaging system
[Set Action Code to 'ZZZ']
The system sets the message classification → The action code is set to 'ZZZ' to indicate a duplicate manifest alert
[Set Message Text: 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID']
The system sets the alert message content → The message text is set to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID'
[Capture CCN Key for Audit Trail]
The system prepares the audit message → The CCN key is captured and stored in the train or US CCN field of the audit message
[Set Security Level to High Value]
The system sets the security classification → The security byte is set to high value to indicate high priority alert
[Capture Current Date from System]
The system captures timestamp information → The current machine date including century is captured and formatted into the audit message date field
[Capture Current Time from System]
The system captures timestamp information → The current machine time is captured and stored in the audit message time field
[Format Complete Audit Message]
The system prepares the final audit message → The complete audit input structure is moved to the message format for logging
[Write Audit Log Entry to System]
The system writes the audit entry → The audit message is written to the system log using the message logging service
[Purge Message Queue]
The system completes the logging process → The message queue is purged to clean up system resources
[Clear Input Message Structure]
The system needs to create an audit log entry for the duplicate manifest alert → The audit message input structure should be cleared to spaces to ensure clean data initialization
[Set Action Code to 'ZZZ']
The action code field needs to be populated → The action code should be set to 'ZZZ' to categorize this as a duplicate manifest notification
[Set Duplicate Manifest Message Text]
The message text field needs to be populated → The message should be set to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID' to inform users of the issue and recommended action
[Set Train/CCN Identifier]
The audit message identifier field needs to be populated → The CCN key from the duplicate manifest should be moved to the train or CCN identifier field in the audit message
[Set Security Byte to High Value]
The security level needs to be assigned → The security byte should be set to high value to ensure the message has appropriate security classification
[Set Cargo Application Type]
The application type indicator needs to be set → The cargo application flag should be set to true to identify the source system
[Set Sending Transaction Code]
The audit message needs to record the source transaction → The transaction code from the communication control block should be moved to the sending transaction field
[Set User ID from ACF2]
The audit message needs to record user accountability → The ACF2 user ID from the communication control block should be moved to the audit message user ID field
[Construct Date String from Machine Date]
The date field needs to be populated from system date components → The machine century and machine date should be concatenated together to form a complete date string
[Set Time from Machine Time]
The time field needs to be populated → The machine time from the communication control block should be moved to the audit message time field
[Clear Message Input Structure]
The system begins the alert message creation process → The message input structure is cleared to spaces to ensure clean data entry
[Set Duplicate Manifest Message Text]
The system creates an alert message → The message text is set to 'DUPLICATE MANIFEST WAS FOUND, BROWSE BY CAR ID' to provide clear instruction to users
[Set Security Level to High Value]
The system sets the security level for the message → The security byte is set to high value to ensure appropriate access control
[Set Cargo Application Flag]
The system categorizes the message by application type → The cargo application flag is set to true to identify the message source
[Capture Current Time from System]
The system captures timing information → The current machine time is recorded in the alert message
[Prepare Message for Queue]
The system prepares the message for queue submission → The complete message input is moved to the queue message structure
[Send Message to Queue]
The system sends the message to the queue → The message is submitted using CHNG operation to the alternate PCB queue
[Write Message to Audit Log]
The system creates an audit log entry → The message is written to the audit log using WRITMSGL with message code, content, length, and module name
[Purge Message Queue]
The system completes the alert processing → The message queue is purged using PURG operation to clean up resources
[Restore Original Cargo Report Segment Data]
The system needs to restore the original manifest data after all duplicate checking operations are finished → The system restores the saved cargo report segment data from working storage back to the main cargo report segment structure

Structural Validations

None explicitly identified in logic extraction.

Module: GCCIRF 1 Consolidated Epic Story

Epic: GCCIRF Complete EDI Specification Extracted from Legacy

Contains 1 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCIRF EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

None explicitly identified in logic extraction.

Structural Validations

[Database Error Set Error Message Terminate Process]
The SQL operation fails with a database error condition → An error message 'DB2 ERROR-SQL SELECT JNCTN' is set and the process is terminated

Module: GCCOUT 1 Consolidated Epic Story

Epic: GCCOUT Complete EDI Specification Extracted from Legacy

Contains 139 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCOUT EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize S2MR Menu Message]
The system begins S2MR menu setup → Clear the S2MR output message area

Core Acceptance Criteria

[2:Validate System Message Number]
The system validates the message number → The message number validation routine is executed
[3:Build Message Table Key]
The system builds the message table access key → Key values are cleared, table ID is set to message table literal, and system message number is assigned to the key
[3:Build Message Table Key]
The system determines the language key configuration → If output select code is S2MR-MENU or BLANK-SCREEN, language key is set to spaces, otherwise GCMSG-LANGUAGE is used
[4:Access Message Database]
The system accesses the message database → The message table access routine is called with the constructed key parameters
[5:Handle Message Retrieval Results]
The system processes the retrieval results → If access was successful, English text from the table is used, otherwise 'MESSAGE-NOT-FOUND' is set as the message text
[Match Found in Config Table?]
If the search results → If a match is found, message type processing continues, otherwise a no-match error is triggered
[9:Determine Message Type]
The system determines the message type → The message type from the configuration table entry is evaluated for processing routing
[10:Adjust Language Processing]
The system adjusts for language processing → If GCMSG-LANGUAGE is not spaces, the configuration table entry index is incremented by 1
[Message Type?]
If the message type for routing → If message type is SEND-SCREEN, screen processing is performed; if SPAWN-TRANSACTION, transaction processing is performed; if SEND-GENDISP-MESSAGE, generic display processing is performed; otherwise an invalid message type error is triggered
[11:Process Send Screen Request]
The system processes the screen message request → If output select code is S2MR-MENU, S2MR menu processing is performed, otherwise standard screen message processing is performed
[12:Build S2MR Menu Message]
The system builds the S2MR menu message → S2MR output message is cleared, system ID and security byte are set from GCMSG, return module is set from configuration table, and if system message number exists, system message is added to menu user message area
[13:Handle System Message Display]
The system handles system message display → For S2MR-MENU, system message is moved to S2MR output message; for other screen types, system message is moved to GCMSG user message area, and message writing routine is called
[14:Process Transaction Spawn]
The system processes the transaction spawn request → The module field from configuration table is checked for emptiness to determine spawn validity
[16:Execute Transaction Switch]
The system executes the transaction switch → Transaction change is called with transaction code from configuration table, transaction code is set in GCMSG, message writing routine is called, and transaction purge is executed
[17:Process Generic Display Message]
The system processes the generic display message → Display format is determined based on output select code for appropriate screen formatting
[18:Format Blank Screen Display]
The system formats the blank screen display → Output message is moved to LINE-1 and SCR, and if system message number exists, system message is moved to screen table position 1
[18:Format Blank Screen Display]
The system formats the standard display → Output message is moved to LINE-1 and SCR
[19:Execute Generic Screen Display]
The system executes the generic screen display → Generic display routine is called with IO-PCB, page code, line data, and screen data
[20:Restore Program Control]
The system restores program control → The saved program name is restored to the current program identifier and program execution returns to caller
[Clear Message Table Keys]
The system begins message table access preparation → All message table key values are cleared to spaces
[Set Message Table ID to MSG-TABLE-LIT]
The system prepares to access the message table → The table identifier is set to MSG-TABLE-LIT
[Set System Message Number in Key]
The system prepares message table lookup parameters → The system message number is assigned to both the table key and working storage
[Output Select Code is S2MR-MENU or BLANK-SCREEN?]
The output select code is S2MR-MENU or BLANK-SCREEN → The language code is set to spaces for language-neutral lookup
[Set Language Code to Spaces]
The system sets up message table lookup parameters → The language key is set to spaces
[Set Language Code to GCMSG-LANGUAGE]
The system sets up message table lookup parameters → The language key is set to the current message language from GCMSG-LANGUAGE
[Call Database Access Routine GCCTBIO]
The system needs to retrieve message data → The GCCTBIO database access routine is called with the prepared parameters
[Database Access Successful?]
The database access return flag indicates successful retrieval → The system uses the retrieved English text from the message segment
[Set Message Text to Retrieved Value from GCSTBRT]
The system processes the retrieved message data → The English text from GCSTBRT message segment is moved to working storage message text
[Clear Message Table Keys]
The system begins message table access preparation → All message table key value fields are cleared to spaces
[Set Message Table ID to MSG-TABLE-LIT]
The system prepares to access the message table → The table identifier is set to MSG-TABLE-LIT to specify the message table
[Set Message Number from System Input]
The system prepares message table lookup parameters → The system message number is assigned to both the message table key and working storage
[Output Select Code is S2MR-MENU or BLANK-SCREEN?]
The output select code is S2MR-MENU or BLANK-SCREEN → The language key is set to spaces, otherwise it is set to the current message language
[Call Database Access Routine]
The system needs to retrieve message data → The database access routine GCCTBIO is called with the prepared parameters
[Execute Database Call to GCCTBIO]
The system calls the database access routine GCCTBIO with GET UNIQUE operation → The database returns the requested message segment and operation status
[Clear Key Fields]
The key building process begins → All key value fields are cleared to spaces
[Set Message Table Literal]
The table identifier needs to be set → The message table literal is assigned to the key table ID field
[Set System Message Number]
Building the message table key → The system message number is copied to both the key message number field and working storage
[Output Select Code is S2MR Menu or Blank Screen?]
The output select code is S2MR-MENU or BLANK-SCREEN → The language code is set to spaces, otherwise it is set to the global message language
[Set Language Code to Spaces]
Setting the language code for message table lookup → The language code is set to spaces (default language)
[Set Language Code from Global Message Language]
Setting the language code for message table lookup → The language code is set to the global message language value
[Clear PCB Flags]
The system initiates the database access preparation process → The system clears the second PCB flag and unqualified SSA flag to ensure clean database access parameters
[Call GCCTBIO Database Access Routine]
The system needs to retrieve message text from the GCSTBRT message table → The system calls GCCTBIO routine with GET UNIQUE operation, table literal, key values, and message segment structure to retrieve the message and receive return status
[Handle Message Retrieval Results - Set message text to retrieved value or default 'MESSAGE NOT FOUND' message]
The database return flag indicates successful retrieval → The message text is set to the retrieved English text from the message table
[Handle Message Retrieval Results - Set message text to retrieved value or default 'MESSAGE NOT FOUND' message]
The database return flag indicates unsuccessful retrieval → The message text is set to the default 'MESSAGE NOT FOUND' message
[Match Found - Proceed with Message Type Check]
The match is confirmed → The system performs message type checking using the matched table entry
[Compare Output Select Code with Current Table Entry]
The output select code is compared with the table entry's output select code → If codes match, proceed to message type processing; if no match, continue to next entry
[Match Found - Proceed with Message Type Check]
The match condition is satisfied → The system performs message type checking via A300-CHECK-MESSAGE-TYPE
[Language Code Specified?]
The language code field contains a value other than spaces → The configuration table entry index is incremented by 1 to point to the language-specific entry
[Message Type = SEND-SCREEN?]
The message type equals SEND-SCREEN → The system performs send screen processing
[Message Type = SPAWN-TRANSACTION?]
The message type equals SPAWN-TRANSACTION → The system performs transaction spawn processing
[Message Type = SEND-GENDISP-MESSAGE?]
The message type equals SEND-GENDISP-MESSAGE → The system performs generic display message processing
[Language Code Specified?]
The language code (GCMSG-LANGUAGE) is not empty or spaces → The configuration table entry index (GCWOUTTB-ENTRY-IX) should be incremented by 1 to point to the language-specific entry
[Message Type = SEND-SCREEN?]
The message type in the configuration entry equals SEND-SCREEN → The system should route the request to the send screen processing function
[Message Type = SPAWN-TRANSACTION?]
The message type in the configuration entry equals SPAWN-TRANSACTION → The system should route the request to the transaction spawning processing function
[Message Type = SEND-GENDISP-MESSAGE?]
The message type in the configuration entry equals SEND-GENDISP-MESSAGE → The system should route the request to the generic display message processing function
[Process Send Screen Request]
The system needs to process the screen display request → The send screen processing function (B310-SEND-SCREEN) should be executed
[Process Transaction Spawn]
The system needs to process the transaction spawn request → The transaction spawning processing function (B320-SPAWN-TRANSACTION) should be executed
[Process Generic Display Message]
The system needs to process the generic display request → The generic display processing function (B330-SEND-GENDISP-MESSAGE) should be executed
[Increment Table Index]
A language code is specified in the message context (GCMSG-LANGUAGE is not empty) → The system increments the table entry index by 1 to access the language-specific message configuration
[Is Output Select Code S2MR-MENU?]
The output select code equals S2MR-MENU → Initialize S2MR menu message processing
[Set System ID and Security Byte]
System configuration is applied → Set system ID from GCMSG-S2MR-SYSTEM-ID and security byte from GCMSG-S2MR-SECURITY-BYTE
[System Message Number Exists?]
System message number is greater than spaces → Include system message in S2MR menu user message area
[Add System Message to S2MR Menu]
System message integration is required → Move WS-SYSTEM-MSG to S2MR-MENU-USER-MESSAGE
[Set S2MR Message as Output]
Final output assignment occurs → Move S2MR-OUTPUT-MESSAGE to OUTPUT-MESSAGE
[System Message Number Exists?]
System message number is greater than spaces → Include system message in general user message area
[Add System Message to User Message Area]
System message integration is required → Move WS-SYSTEM-MSG to GCMSG-USER-MESSAGE
[Call WRITMSGL to Display Screen]
Screen output is requested → Call WRITMSGL with message code, output message, message length, and module from GCWOUTTB table
[Clear S2MR Output Message Area]
The output select code equals S2MR-MENU → The S2MR output message area is cleared to spaces
[Set System ID from Message Control]
The S2MR output message area has been cleared → The system ID from GCMSG-S2MR-SYSTEM-ID is moved to S2MR-SYSTEM-ID
[Set Security Byte from Message Control]
Security information needs to be included in the menu → The security byte from GCMSG-S2MR-SECURITY-BYTE is moved to S2MR-SECURITY-BYTE
[System Message Number Exists?]
The system checks for additional messaging requirements → If SYSTEM-MSG-NUM is greater than spaces, system message processing is required, otherwise standard menu processing continues
[Add System Message to User Message Area]
The system message needs to be included in the S2MR menu → The system message from WS-SYSTEM-MSG is moved to S2MR-MENU-USER-MESSAGE
[Assign Complete S2MR Message to Output]
The complete S2MR menu message needs to be prepared for output → The complete S2MR-OUTPUT-MESSAGE is moved to OUTPUT-MESSAGE
[Assign S2MR Message to Output]
The standard S2MR menu message needs to be prepared for output → The standard S2MR-OUTPUT-MESSAGE is moved to OUTPUT-MESSAGE
[Add System Message to User Message Area]
The output select code is S2MR-MENU → The system message is moved to the S2MR menu user message area
[Add System Message to User Message Area]
The output select code is not S2MR-MENU → The system message is moved to the general user message area
[Clear S2MR Output Message]
The S2MR message construction process begins → The S2MR output message buffer should be cleared to spaces
[Set System ID from GCMSG]
The system ID needs to be set in the S2MR message → The S2MR system ID should be populated with the value from GCMSG-S2MR-SYSTEM-ID
[Set Security Byte from GCMSG]
The security byte needs to be set in the S2MR message → The S2MR security byte should be populated with the value from GCMSG-S2MR-SECURITY-BYTE
[Set Return Module from Configuration Table]
The return module needs to be configured in the S2MR message → The S2MR return module should be set to the module value from the current configuration table entry
[System Message Number Exists?]
The system checks for the presence of a system message number → If system message number is greater than spaces, include system message in user message area, otherwise proceed without system message
[Add System Message to User Message Area]
The S2MR menu message is being constructed with system message integration → The system message should be moved to the S2MR menu user message area
[Assign Complete S2MR Message to Output]
The complete S2MR message needs to be assigned to the output → The S2MR output message should be moved to the final output message field
[Assign S2MR Message to Output]
The S2MR message needs to be assigned to the output → The S2MR output message should be moved to the final output message field
[Add System Message to S2MR Menu User Message Area]
The system processes the screen display request → The system message should be moved to the S2MR menu user message area
[Add System Message to General User Message Area]
The system processes the screen display request → The system message should be moved to the general user message area
[Set S2MR Output Message as Final Output]
The system completes message processing for the menu → The S2MR output message should be moved to the final output message
[Set Transaction Code in Message]
The system prepares the message for transmission → Copy the transaction code from the output table entry to the message transaction code field
[Send Message to Alternate PCB]
The message transmission process is initiated → Call WRITMSGL using the alternate PCB with message code, output message, message length, and module from the output table entry
[Purge Alternate PCB]
The system completes the message transmission process → Execute CIMS call with PURG operation on the alternate PCB to clear the communication block
[Set New Transaction Code in Message]
The transaction change process is initiated → The system moves the transaction code from the output table to the message transaction code field
[Send Message to Alternate PCB]
The system needs to send the message for the spawned transaction → The system calls WRITMSGL using alternate PCB with message code, output message, message length, and module from the output table entry
[Call CIMS with PURG Function]
The transaction spawning process needs to be completed → The system calls CIMS with PURG function on the alternate PCB
[Set Transaction Code in Message]
The system processes the spawn transaction request → The transaction code from the output configuration table entry should be moved to the message transaction code field
[Call WRITMSGL to Send Message]
The system calls the message writing service → WRITMSGL should be invoked with alternate PCB, message code from configuration, output message content, message length from configuration, and module information from configuration
[Use Alternate PCB for Message Delivery]
The system sends the message for the spawned transaction → The alternate PCB should be used as the communication channel for message delivery
[Include Message Code from Configuration]
The system prepares the message parameters → The message code should be retrieved from the current output configuration table entry
[Include Output Message Content]
The system prepares the message for transmission → The complete output message content should be included in the message transmission
[Include Message Length from Configuration]
The system determines the message length parameter → The message length should be retrieved from the current output configuration table entry
[Include Module Information from Configuration]
The system prepares the module parameter for message transmission → The module information should be retrieved from the current output configuration table entry
[Module Validation Passed - Continue Transaction]
The module field validation check passes → Continue with transaction spawning process by changing to the transaction code, setting transaction code in message, writing the message, and purging the alternate PCB
[Set Transaction Code in Message]
Transaction spawning process is executing → The transaction code from the output table is assigned to the message transaction code field
[Send Message to Alternate PCB]
Transaction spawning is in progress → The system transmits the message through the alternate communication channel using the message parameters
[Purge Alternate PCB]
Transaction spawning process is completing → The system purges the alternate communication channel to clean up resources
[Set Output Message to Line-1 and SCR, Set Output Message to Line-1 and SCR for Regular Display]
The system processes the display setup → The output message is moved to both LINE-1 and SCR variables
[System Message Number Exists?]
The system checks for system message availability → If system message number is greater than spaces, include system message, otherwise continue without system message
[Add System Message to Screen Table Position 1]
The system adds the system message to the display → The system message is moved to screen table position 1
[Set Output Message to Line-1 and SCR]
The output select code is BLANK-SCREEN → The output message is moved to both LINE-1 and SCR display variables
[Set Output Message to Line-1 and SCR]
The output select code is not BLANK-SCREEN → The output message is moved to both LINE-1 and SCR display variables
[Prepare GENDISP Call Parameters]
The display preparation process is initiated → The system should set up all required parameters including page code, line data, and screen data structure for the GENDISP call
[Set Line-1 Parameter with Output Message]
The line parameter is being configured for display → The system should move the output message content to LINE-1 parameter
[Set SCR Parameter with Output Message]
The screen data parameter is being configured for display → The system should move the output message content to SCR parameter
[Format Blank Screen Display - Set up screen table with message content for blank screen output]
The output select code equals BLANK-SCREEN → The output message is moved to LINE-1 and SCR display areas
[Add System Message to Screen Table Position 1]
A system message number exists (is greater than spaces) → The system message text is moved to screen table position 1
[Continue Without System Message]
The output select code != BLANK-SCREEN → The output message is moved to LINE-1 and SCR display areas without additional screen table processing
[Restore Program Control - Reset original program name before returning to caller]
The system needs to return control to the calling program → The original program name is restored to the program control field and control is returned to the caller

Structural Validations

[System Message Number Provided?]
The system checks if a system message number is provided → If the system message number is not spaces, validation processing is triggered
[6:Validate Output Select Code]
The system validates the output select code → An error message 'NO-OUTPUT-SELECT-CODE' is set and error handling routine is called
[8:Handle No Match Found]
The system handles the no-match condition → The invalid output select code is captured and 'NO-MATCH-FOUND-ON-GCWOUTTB' error message is set and error handling routine is called
[15:Validate Module for Transaction]
The system validates the module for transaction → Error message 'INV-MOD-FOR-MSG-SWITCH' is set and error handling routine is called
[Set Message Text to 'MESSAGE NOT FOUND']
The database access return flag indicates unsuccessful retrieval → The system sets the message text to 'MESSAGE-NOT-FOUND'
[Database Access Successful?]
The database access returns a successful status → The English message text from the database is assigned to the working storage message text field
[Database Access Successful?]
The database access does not return a successful status → The working storage message text field is set to 'MESSAGE-NOT-FOUND'
[Is Output Select Code Provided?]
The output select code field is checked for presence → If the output select code is spaces or empty, the system should reject the request and set an appropriate error message
[Set Error Message: NO-OUTPUT-SELECT-CODE]
The system needs to communicate the validation failure → The error message should be set to 'NO-OUTPUT-SELECT-CODE' to indicate the specific validation failure
[Call Error Handler]
The system needs to handle the error condition → The error handler program 'CERR' should be called with the common communication area to process the error
[Current Entry Matches Output Select Code?]
The output select code is compared with the current table entry's output select code → If they match exactly, proceed with message type processing, otherwise continue searching
[No Match Found in Configuration Table]
The output select code is not found in the GCWOUTTB configuration table after searching all entries → The system copies the invalid output select code to the error field, sets the error message to 'NO MATCH FOUND ON GCWOUTTB', and generates an error report
[Set Error Message: 'NO MATCH FOUND ON GCWOUTTB']
The system needs to prepare error information → The system sets the error message to 'NO MATCH FOUND ON GCWOUTTB'
[Generate Error Report]
The system needs to report the configuration table lookup failure → The system calls the CERR error reporting program with the common communication area
[Generate Invalid Message Type Error]
The message type is not SEND-SCREEN, SPAWN-TRANSACTION, or SEND-GENDISP-MESSAGE → The system sets an invalid message type error and calls the error handler
[Set Invalid Message Type Error]
The message type is not SEND-SCREEN, SPAWN-TRANSACTION, or SEND-GENDISP-MESSAGE → The system should set an invalid message type error and call the error handling function
[Set Error: Invalid Module for Message Switch]
The module field in the output table entry is not empty (not spaces) → Set the error message to indicate invalid module for message switch and call the error handler
[Is Module Field Empty?]
The system checks if the module field contains spaces (is empty) → If the module field is not empty, set error message to 'Invalid Module for Message Switch' and call error handler to terminate processing
[Set Error Message: Invalid Module for Message Switch]
The module field validation fails → Set the error message to 'Invalid Module for Message Switch' and invoke the error handler
[Change to Specified Transaction Code]
The module field in the output table entry is not spaces (contains data) → The system sets an invalid module error message and calls error handling routine

Module: GCCSNOT 1 Consolidated Epic Story

Epic: GCCSNOT Complete EDI Specification Extracted from Legacy

Contains 57 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCSNOT EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Console Alert Message]
The system begins initialization → The console message is initialized with compilation date, alert code is set to 'CPEDIMON', system identifier is set to 'U.S. CUSTOMS', and transaction name is set to 'TRAN'

Core Acceptance Criteria

[2:Process Message Type 309 Notification Flag]
NOTIFY-309 flag equals 'Y' → Assign '309' to TS-01 if empty, otherwise assign to TS-02 if empty, otherwise assign to TS-03 if empty
[3:Process Message Type 353 Notification Flag]
NOTIFY-353 flag equals 'Y' → Assign '353' to TS-01 if empty, otherwise assign to TS-02 if empty, otherwise assign '253' to TS-03 if empty
[4:Process Message Type 358 Notification Flag]
NOTIFY-358 flag equals 'Y' → Assign '358' to TS-01 if empty, otherwise assign to TS-02 if empty, otherwise assign to TS-03 if empty
[5:Display Console Alert Message]
The system completes notification flag processing → Display the console message to the console output
[6:Prepare Email Report Header]
Email report preparation begins → Format current machine date as YY/MM/DD, format current machine time as HH:MM, populate error message lines 1-8 and line 9 with header information including system date and time
[7:Format Message Type 309 Status Information]
Formatting message type 309 status information → Extract sent date from positions 1-8 and sent time from positions 9-12 of 309-OUT data, extract acknowledgment date from positions 1-8 and acknowledgment time from positions 9-12 of 309-ACK data, and if NOTIFY-309 equals 'Y' then set error indicator to '>>>>>>>' otherwise set to spaces
[8:Format Message Type 353 Status Information]
Formatting message type 353 status information → Extract sent date from positions 1-8 and sent time from positions 9-12 of 353-OUT data, extract acknowledgment date from positions 1-8 and acknowledgment time from positions 9-12 of 353-ACK data, and if NOTIFY-353 equals 'Y' then set error indicator to '>>>>>>>' otherwise set to spaces
[9:Format Message Type 358 Status Information]
Formatting message type 358 status information → Extract sent date from positions 1-8 and sent time from positions 9-12 of 358-OUT data, extract acknowledgment date from positions 1-8 and acknowledgment time from positions 9-12 of 358-ACK data, and if NOTIFY-358 equals 'Y' then set error indicator to '>>>>>>>' otherwise set to spaces
[11:Send Email Notification]
Email notification sending is initiated → Call communication interface to initialize system communication, call email sending service with formatted message content and recipient information, and restore communication interface
[Clear Console Message Structure]
The console message initialization process begins → The console message structure is cleared and reset to initial state
[Set Alert Code to 'CPEDIMON']
The alert code needs to be assigned → The alert code is set to 'CPEDIMON' to identify this as a customs processing monitoring alert
[Set System Failure Indicator to 'U.S. CUSTOMS']
The system failure indicator needs to be set → The system failure indicator is set to 'U.S. CUSTOMS' to identify the reporting system
[Set Transaction Name to 'TRAN']
The transaction name needs to be assigned → The transaction name is set to 'TRAN' to identify the transaction category
[Check NOTIFY-309 Flag]
If the NOTIFY-309 flag → If the flag equals 'Y', the system proceeds to assign the notification to an available transaction slot, otherwise it continues to the next processing step
[TS-01 Available?]
The system checks if TS-01 contains spaces (is empty) → If TS-01 is empty, assign '309' to TS-01 slot, otherwise check the next available slot TS-02
[TS-02 Available?]
The system checks if TS-02 contains spaces (is empty) → If TS-02 is empty, assign '309' to TS-02 slot, otherwise check the next available slot TS-03
[TS-03 Available?]
The system checks if TS-03 contains spaces (is empty) → If TS-03 is empty, assign '309' to TS-03 slot, otherwise no assignment is made as all slots are full
[Check if TS-01 is Available]
The system checks for available transaction slots in priority order → Notification 309 is assigned to TS-01 if available, otherwise to TS-02 if available, otherwise to TS-03 if available
[Assign '309' to TS-01]
If slot availability → The value '309' is assigned to TS-01 slot
[Assign '309' to TS-02]
If slot availability in priority order → The value '309' is assigned to TS-02 slot
[Assign '309' to TS-03]
If slot availability in priority order → The value '309' is assigned to TS-03 slot
[Check NOTIFY-353 Flag]
If the NOTIFY-353 flag value → If NOTIFY-353 equals 'Y', the system proceeds to assign 353 to an available transaction slot, otherwise it skips 353 processing entirely
[Assign 353 to TS-01]
The system assigns the transaction type → The value '353' is moved to TS-01 transaction slot
[Assign 353 to TS-02]
The system assigns the transaction type → The value '353' is moved to TS-02 transaction slot
[Assign 353 to TS-03]
The system assigns the transaction type to the third slot → The value '253' is moved to TS-03 transaction slot instead of '353'
[Check NOTIFY-358 Flag]
The system processes notification requirements → The system evaluates whether NOTIFY-358 flag is set to 'Y' to determine if notification processing is required
[Assign 358 to TS-01]
The system assigns message type 358 to transaction slots → The system moves '358' to TS-01 transaction slot
[Assign 358 to TS-02]
The system assigns message type 358 to transaction slots → The system moves '358' to TS-02 transaction slot
[Assign 358 to TS-03]
The system assigns message type 358 to transaction slots → The system moves '358' to TS-03 transaction slot
[Output Console Message to System Console]
The system needs to output the alert message to the system console → The console message is displayed on the system console for operator visibility
[Clear Email Text Area]
The system begins email preparation process → The email text area should be cleared of any previous content
[Add Report Title Lines to Email]
The system needs to add report header content → The system should move predefined error message lines 1 and 2 to the email text lines 1 and 2, and line 2 content should also be copied to line 9
[Extract 309 Message Last Sent Date from Position 1-8]
System processes 309 message status information → System extracts date from positions 1-8 and time from positions 9-12 of the transaction output data
[Extract 309 Message Last Acknowledgment Date from Position 1-8]
System processes 309 message status information → System extracts acknowledgment date from positions 1-8 and acknowledgment time from positions 9-12 of the transaction acknowledgment data
[309 Message Notification Required?]
System evaluates if 309 message notification is required → If notification flag equals 'Y' then mark with error indicator '>>>>>>>', otherwise clear error indicator to spaces
[Format 309 Status Line for Email Report]
System prepares email notification report → System formats the 309 message status line and assigns it to the email message template
[Extract 353 Message Last Sent Date from Database, Extract 353 Message Last Sent Time from Database]
The system processes 353 message status information → The system extracts the first 8 characters as the sent date and characters 9-12 as the sent time from the 353 outbound record
[Extract 353 Message Last Acknowledgment Date from Database, Extract 353 Message Last Acknowledgment Time from Database]
The system processes 353 message acknowledgment status information → The system extracts the first 8 characters as the acknowledgment date and characters 9-12 as the acknowledgment time from the 353 acknowledgment record
[Format 353 Message Status Line for Email Report]
The system prepares the email notification report → The system formats all 353 message status information into a single report line and assigns it to the 11th line of the email text
[Extract 358 Message Last Sent Date from Position 1-8]
The system processes 358 message status information → The last sent date is extracted from positions 1-8 and last sent time is extracted from positions 9-12 of the transaction output data
[Extract 358 Message Last Acknowledgment Date from Position 1-8]
The system processes 358 message status information → The last acknowledgment date is extracted from positions 1-8 and last acknowledgment time is extracted from positions 9-12 of the transaction acknowledgment data
[358 Message Notification Required?]
The notification flag for 358 message equals 'Y' → The system marks the 358 message with error indicator '>>>>>>>', otherwise it clears the error indicator with spaces
[Format 358 Status Line for Email Report]
The system prepares the email notification report → The 358 message status line is formatted and added to line 12 of the email text
[Set Recipient 1 from NOTIFY1]
The system configures email recipients → NOTIFY1 value is assigned to the first position in the email recipients list
[Set Recipient 2 from NOTIFY2]
The system configures email recipients → NOTIFY2 value is assigned to the second position in the email recipients list
[Set Recipient 3 from NOTIFY3]
The system configures email recipients → NOTIFY3 value is assigned to the third position in the email recipients list
[Set Recipient 4 from NOTIFY4]
The system configures email recipients → NOTIFY4 value is assigned to the fourth position in the email recipients list
[Set Recipient 5 from NOTIFY5]
The system configures email recipients → NOTIFY5 value is assigned to the fifth position in the email recipients list
[Call Email Service with Report Parameters]
The system calls the email service (EMCSEND) → The email service is invoked with ISCOM communication area, sender user code, destination filename, recipient user codes, copy recipients, subject line, keywords, message text, and return status flag

Structural Validations

[TS-01 Available?]
The system checks if TS-01 contains spaces (indicating availability) → If TS-01 is empty (contains spaces), the system proceeds to assign 353 to TS-01, otherwise it checks the next available slot TS-02
[TS-02 Available?]
The system checks if TS-02 contains spaces (indicating availability) → If TS-02 is empty (contains spaces), the system proceeds to assign 353 to TS-02, otherwise it checks the next available slot TS-03
[TS-03 Available?]
The system checks if TS-03 contains spaces (indicating availability) → If TS-03 is empty (contains spaces), the system proceeds to assign to TS-03, otherwise no assignment occurs as all slots are occupied
[TS-01 Available?]
The system needs to assign message type 358 to a transaction slot → The system checks if TS-01 is empty (contains spaces) to determine availability
[TS-02 Available?]
The system needs to assign message type 358 to an alternative transaction slot → The system checks if TS-02 is empty (contains spaces) to determine availability
[TS-03 Available?]
The system needs to assign message type 358 to the final available transaction slot → The system checks if TS-03 is empty (contains spaces) to determine availability
[353 Message Notification Required?, Mark 353 Message with Error Indicator '>>>>>>>', Clear 353 Message Error Indicator]
If the 353 notification flag → If the notification flag equals 'Y', the system marks the message with error indicator '>>>>>>>', otherwise the system clears the error indicator to spaces

Module: GCCSNOT2 1 Consolidated Epic Story

Epic: GCCSNOT2 Complete EDI Specification Extracted from Legacy

Contains 61 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCSNOT2 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The system initializes → Alert code is set to 'CPEDIMON', system failure identifier is set to 'CANADA CUSTOMS', and transaction name is set to 'TRAN'
[Initialize Console Message Structure]
Console message setup is required → The console message should be initialized, alert code set to 'CPEDIMON', system failure identifier set to 'CANADA CUSTOMS', and transaction name set to 'TRAN'

Core Acceptance Criteria

[3:Determine Transaction Types for Alert]
NOTIFY-309C flag equals 'Y' → Transaction type '309' is assigned to the first notification slot (TS-01)
[7:Format Current Date and Time]
Formatting date and time for notifications → System date is formatted as YY/MM/DD and system time is formatted as HH:MM for error message line 3
[9:Extract 309 Message Timestamps]
Processing 309 message timestamps → Date sent is extracted from first 8 characters of 309-OUT, time sent from next 4 characters, date acknowledged from first 8 characters of 309-ACK, and time acknowledged from next 4 characters
[10:Format 309 Message Status Line]
NOTIFY-309C flag equals 'Y' → Error indicator is set to '>>>>>>>' for 309 transaction, otherwise it remains blank
[11:Extract 358 Message Timestamps]
Processing 358 message timestamps → Date sent is extracted from first 8 characters of 358-OUT, time sent from next 4 characters, date acknowledged from first 8 characters of 358-ACK, and time acknowledged from next 4 characters
[12:Format 358 Message Status Line]
NOTIFY-358C flag equals 'Y' → Error indicator is set to '>>>>>>>' for 358 transaction, otherwise it remains blank
[13:Extract CUSREP Message Timestamps]
Processing CUSREP message timestamps → Date sent is extracted from first 8 characters of CUSREP-OUT, time sent from next 4 characters, date acknowledged from first 8 characters of CUSRES-ACK, and time acknowledged from next 4 characters
[14:Format CUSREP Message Status Line]
NOTIFY-RNS flag equals 'Y' → Error indicator is set to '>>>>>>>' for RNS transaction, otherwise it remains blank
[17:Send Email Notification]
Sending notification email → EMCSEND program is called to deliver the notification email to all configured recipients
[Clear Console Message Structure]
The console alert message process begins → The console message structure is cleared and initialized to empty state
[Set Alert Code to 'CPEDIMON']
The alert code needs to be established → The alert code is set to 'CPEDIMON' to identify the notification source
[Set TS-01 = '309']
NOTIFY-309C flag equals 'Y' → Set TS-01 field to '309' to indicate 309 transaction type in primary slot
[Set TS-01 = '309']
NOTIFY-309C flag is set to 'Y' → The system assigns '309' to the first transaction slot (TS-01)
[Send Alert Message to System Console]
The system needs to output the alert information to the console → The console message is sent to the system console for display
[Clear Email Text Area]
The email message structure initialization is triggered → All email text areas are cleared and set to empty spaces to ensure clean message preparation
[Add Email Title Header Line]
Building the email notification content → The system should populate email lines 1-9 with predefined error message content including system date, time, and transaction information
[Add Spacing Header Line]
Completing the email content structure → The system should add transaction status lines for 309 (line 11), 358 (line 12), and RNS (line 13) to the email text
[Parse Date Components]
The system processes the date for notification display → The year component is moved to WS-YY, month component to WS-MM, and day component to WS-DD
[Assemble Formatted Date]
The system prepares date information for notification display → The components are assembled into WS-DATE for use in error message line 3
[Store Formatted Date for Email Display]
The system prepares the notification message content → The formatted date is stored in MRLN-ERROR-L3-SYS-DATE and formatted time in MRLN-ERROR-L3-SYS-TIME within error message line 3
[Parse Date Components]
Date components need to be separated for email display → The year component is moved from WS-FMT-YY to WS-YY, month component from WS-FMT-MM to WS-MM, and day component from WS-FMT-DD to WS-DD
[Format Date for Email Display]
A complete formatted date is needed for email display → The combined date components are moved to WS-DATE and then to MRLN-ERROR-L3-SYS-DATE for inclusion in the email message
[Format Time for Email Display]
A complete formatted time is needed for email display → The combined time components are moved to WS-TIME and then to MRLN-ERROR-L3-SYS-TIME for inclusion in the email message
[Add Email Header Line 1 to Email Body]
The system builds the email body content → The first error message line is added to position 1 of the email text
[Add Email Header Line 2 to Email Body]
The system continues building the email body content → The second error message line is added to position 2 of the email text
[Add Formatted Date/Time Line to Email Body]
The system continues building the email body content → The formatted date and time line is added to position 3 of the email text
[Add Warning Message Line 4 to Email Body]
The system continues building the email body content → The fourth error message line is added to position 4 of the email text
[Add Warning Message Line 5 to Email Body]
The system continues building the email body content → The fifth error message line is added to position 5 of the email text
[Add Warning Message Line 6 to Email Body]
The system continues building the email body content → The sixth error message line is added to position 6 of the email text
[Add Warning Message Line 7 to Email Body]
The system continues building the email body content → The seventh error message line is added to position 7 of the email text
[Add Warning Message Line 8 to Email Body]
The system continues building the email body content → The eighth error message line is added to position 8 of the email text
[Add Email Header Line 2 Again as Separator]
The system continues building the email body content after adding warning messages → The second error message line is added again to position 9 of the email text as a separator
[Extract Date Sent from 309 Output Record Characters 1-8]
The system processes the 309 transaction output record → The sent date is extracted from characters 1-8 of the output record and stored for reporting
[Extract Time Sent from 309 Output Record Characters 9-12]
The system processes the 309 transaction output record → The sent time is extracted from characters 9-12 of the output record and stored for reporting
[Extract Date Acknowledged from 309 Acknowledgment Record Characters 1-8]
The system processes the 309 transaction acknowledgment record → The acknowledgment date is extracted from characters 1-8 of the acknowledgment record and stored for reporting
[Extract Time Acknowledged from 309 Acknowledgment Record Characters 9-12]
The system processes the 309 transaction acknowledgment record → The acknowledgment time is extracted from characters 9-12 of the acknowledgment record and stored for reporting
[Extract Date Sent from 309 Message Data Position 1-8]
The system processes the 309 message status → The sent date is extracted from positions 1-8 and sent time is extracted from positions 9-12 of the 309 output data
[Extract Date Acknowledged from 309 Message Data Position 1-8]
The system processes the 309 message acknowledgment status → The acknowledgment date is extracted from positions 1-8 and acknowledgment time is extracted from positions 9-12 of the 309 acknowledgment data
[Is 309 Notification Required? NOTIFY-309C = 'Y']
If whether notification is required for the 309 message → If NOTIFY-309C equals 'Y', then mark the message with error prefix '>>>>>>>', otherwise leave the error field as spaces
[Add 309 Status Line to Email Position 11]
The system prepares the email notification content → The formatted 309 status line containing date sent, time sent, date acknowledged, time acknowledged, and error prefix (if applicable) is placed at position 11 in the email text
[Extract Date from 358 Outbound Message Characters 1-8]
The system processes the 358 transaction timestamp extraction → The sent date is extracted from characters 1-8 of the outbound message timestamp and stored in DATE-SENT-358
[Extract Time from 358 Outbound Message Characters 9-12]
The system processes the 358 transaction timestamp extraction → The sent time is extracted from characters 9-12 of the outbound message timestamp and stored in TIME-SENT-358
[Extract 358 Message Sent Date from Position 1-8]
System processes 358 message status information → Date is extracted from positions 1-8 and time is extracted from positions 9-12 of the outbound message data
[Extract 358 Acknowledgment Date from Position 1-8]
System processes 358 message acknowledgment information → Date is extracted from positions 1-8 and time is extracted from positions 9-12 of the acknowledgment data
[Is 358 Notification Required?]
System evaluates if 358 message notification is required → If NOTIFY-358C equals 'Y' then error indicator is set to '>>>>>>>', otherwise error indicator is set to spaces
[Add 358 Status Line to Email Body]
System prepares email notification content → 358 status line with all timing information and error indicators is added to position 12 of the email message body
[Extract CUSREP Last Sent Date from positions 1-8]
System processes CUSREP message timestamps → System extracts the last sent date from positions 1-8 of the outbound timestamp and stores it in DATE-SENT-RNS
[Extract CUSREP Last Sent Time from positions 9-12]
System processes CUSREP message timestamps → System extracts the last sent time from positions 9-12 of the outbound timestamp and stores it in TIME-SENT-RNS
[Extract CUSREP Last Acknowledgment Date from positions 1-8]
System processes CUSREP message timestamps → System extracts the last acknowledgment date from positions 1-8 of the acknowledgment timestamp and stores it in DATE-ACK-RNS
[Extract CUSREP Last Acknowledgment Time from positions 9-12]
System processes CUSREP message timestamps → System extracts the last acknowledgment time from positions 9-12 of the acknowledgment timestamp and stores it in TIME-ACK-RNS
[Extract CUSREP Message Sent Date from Position 1-8]
The system processes CUSREP message status → The sent date is extracted from positions 1-8 and stored in DATE-SENT-RNS
[Extract CUSREP Message Sent Time from Position 9-12]
The system processes CUSREP message status → The sent time is extracted from positions 9-12 and stored in TIME-SENT-RNS
[Extract CUSREP Acknowledgment Date from Position 1-8]
The system processes CUSREP message status → The acknowledgment date is extracted from positions 1-8 and stored in DATE-ACK-RNS
[Extract CUSREP Acknowledgment Time from Position 9-12]
The system processes CUSREP message status → The acknowledgment time is extracted from positions 9-12 and stored in TIME-ACK-RNS
[Add Message Status Lines to Email]
The system prepares the email notification body → The 309 message status line is added to email body line 11, the 358 message status line is added to email body line 12, and the RNS message status line is added to email body line 13
[Call Email Service with Message Details]
The system needs to deliver the notification → The system calls EMCSEND with from user code, destination filename, recipient codes, copy codes, subject, keywords, message text, and return status flag
[Call Email Service EMCSEND]
The email service is invoked → The system calls EMCSEND with from user, destination file, recipient list, copy recipients, subject, keywords, message text, and return status parameters

Structural Validations

[Add Error Prefix '>>>>>>>' to Status Line]
NOTIFY-RNS flag equals 'Y' → Error prefix '>>>>>>>' is added to ERROR-RNS field
[Leave Error Prefix Blank]
NOTIFY-RNS flag does not equal 'Y' → Error prefix is set to spaces in ERROR-RNS field

Module: GCCSTACK 1 Consolidated Epic Story

Epic: GCCSTACK Complete EDI Specification Extracted from Legacy

Contains 2 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCSTACK EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Clear Message Area]
Variable initialization occurs → The message area working variable should be cleared to spaces
[Move Input Message Area to Working Variable]
Parameter initialization occurs → The input message area should be moved to the working message area variable

Structural Validations

None explicitly identified in logic extraction.

Module: GCCTAG 1 Consolidated Epic Story

Epic: GCCTAG Complete EDI Specification Extracted from Legacy

Contains 13 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCTAG EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[7:Yard Notification Message Preparation - Prepare message structure]
The message structure needs to be prepared for transmission → The system formats the input data into the message structure and sets transmission parameters
[8:Yard Notification Transmission - Send to yard systems]
The system initiates yard notification transmission → The system sends the message through CIMS, writes the message log, and purges the message to complete the transmission cycle
[Map Action Code from input to notification message]
The system prepares notification data for yards → The action code from the input is mapped to the notification message action code field
[Map Car ID from input to notification message]
The system prepares notification data for yards → The car ID from the input is mapped to the notification message car ID field
[Map Tag from input to notification message]
The system prepares notification data for yards → The tag identifier from the input is mapped to the notification message tag field
[Map CCN from input to notification message]
The system prepares notification data for yards → The CCN from the input is mapped to the notification message CCN field
[Move prepared input data to message structure]
The system needs to format the data into a message structure for transmission → The prepared input data is moved to the message structure field
[Set accept status to spaces]
The system needs to set the initial processing status → The accept status field is set to spaces to indicate ready state
[Set message structure with prepared notification data]
The system initiates yard notification transmission → The prepared notification data is moved to the message transmission structure YYTCST01-MSG
[Set accept status to blank]
The system prepares to send the message → The accept status field is set to blank spaces
[Call CIMS with CHNG operation to initiate message transmission]
The system needs to initiate message transmission → CIMS is called with CHNG operation using CCCOM, CHNG, ALT-PCB, and YYTCST01 parameters
[Call WRITMSGL to write message to yard systems]
The system needs to write the message to yard systems → WRITMSGL is called with CCCOM, ALT-PCB, message code, message content, message length, and module name parameters
[Call CIMS with PURG operation to complete transmission]
The system needs to complete the transmission process → CIMS is called with PURG operation using CCCOM, PURG, and ALT-PCB parameters

Structural Validations

None explicitly identified in logic extraction.

Module: GCCTIBCK 1 Consolidated Epic Story

Epic: GCCTIBCK Complete EDI Specification Extracted from Legacy

Contains 5 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCTIBCK EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[7:Retrieve US Customs Record]
The system needs to retrieve customs record information → The GCCUSIO service should be invoked to fetch the GCSUSRT segment data using the US CCN key
[Configure Database Call Parameters]
The system prepares to call the database service → The accept status is set to 'GE', the segment type is set to GCSUSRT, the function is set to GU (Get Unique), and the index usage flag is set to not used
[Call Database Service GCCUSIO]
The system executes the database service call → The GCCUSIO service is invoked with the communication control block, parameter block, and GCSUSRT segment to retrieve the customs record
[Database Call Successful - Proceed with BOL Validation]
The system checks if the BOL type code equals '99' → If BOL type code is '99', set the car as found for SPLC manual processing and stop further searching

Structural Validations

[Check CC-STATUS-CODE]
The system checks the response status from the database call → If the status code is empty (successful), proceed to validate BOL type code, otherwise continue searching other equipment entries

Module: GCCTRIDX 1 Consolidated Epic Story

Epic: GCCTRIDX Complete EDI Specification Extracted from Legacy

Contains 4 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCTRIDX EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize CA Train Record Segment]
The system prepares to execute database call → The CA train root segment is cleared to spaces
[Initialize US Train Record Segment]
The system prepares the record segment for data retrieval → The US train record segment is initialized to spaces to ensure clean data retrieval

Core Acceptance Criteria

[Execute Database Call to Get First CA Train Record]
The system executes a Get Unique database operation → A database call is made using CIMS with GU operation for CA train root segment with qualified search criteria
[Execute Database Call to Get First US Train Record]
The system executes a database call to get the first US train record → A database call is made using GU (Get Unique) operation with the qualified search criteria to retrieve the first matching US train record

Structural Validations

None explicitly identified in logic extraction.

Module: GCCTSFR 1 Consolidated Epic Story

Epic: GCCTSFR Complete EDI Specification Extracted from Legacy

Contains 11 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCTSFR EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Extract Railroad Initials]
The system processes the retrieved table segment → The railroad initials are extracted from the SS segment for use in the next lookup
[5:Extract IRS Tax Number]
The system processes the retrieved company segment → The IRS number is extracted from the CC segment and moved to the output tax number field
[Store SS Table Record Data]
The system processes the lookup result → The retrieved carrier record data must be stored in the SS segment structure for further processing
[Move Retrieved Segment to SS Segment Structure]
The system processes the retrieved SS table record → The table segment data should be moved to the SS segment structure to make railroad initials accessible
[Extract Railroad Initials from SS Record]
The system needs to perform CC table lookup for company information → The railroad initials from SS segment should be moved to the CC table key sequence identifier for lookup
[Use Railroad Initials as Search Key]
The system needs to search for the corresponding carrier company information → The railroad initials from the SS segment must be used as the search key for the CC table lookup
[CC Table Record Found?]
If the lookup result status → If the return flag equals 'SUCCESSFUL', proceed to store the CC segment data, otherwise skip to completion
[Store CC Table Segment Data]
The system processes the retrieved company information → The table segment data must be moved to the CC segment structure for access to company details
[Move CC Table Data to CC Segment]
The system receives a successful return flag from the CC table lookup operation → The retrieved table segment data is moved to the CC segment structure for data extraction
[Extract IRS Tax Number from CC Record]
The system processes the CC record for tax number extraction → The IRS number field from the CC record is extracted and made available for liability transfer
[Copy IRS Tax Number to Output]
The system has retrieved a valid IRS number from the CC table segment for the railroad company → The IRS tax number is copied to the output tax number field for the carrier

Structural Validations

None explicitly identified in logic extraction.

Module: GCCUSIO2 1 Consolidated Epic Story

Epic: GCCUSIO2 Complete EDI Specification Extracted from Legacy

Contains 396 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCUSIO2 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program Parameters]
Function code is GU and move-underscore flag is YES → Initialize all cargo segment arrays (GCSUSS01 through GCSUSS15) with underscores
[1:Initialize Program Parameters]
Function code is GU and move-underscore flag is NO → Initialize all cargo segment arrays (GCSUSS01 through GCSUSS15) with spaces
[Initialize All Segment Data with Underscores]
The move underscore flag is set to YES and function is Get Unique → All cargo segment data structures (GCSUSS01 through GCSUSS15 and their arrays) are initialized with underscores
[Initialize All Segment Data with Spaces]
The move underscore flag is set to NO and function is Get Unique → All cargo segment data structures (GCSUSS01 through GCSUSS15 and their arrays) are initialized with spaces
[Initialize Generic Segment Structure]
The fetch process begins → The generic segment structure is cleared to spaces and the container number key is populated from the root cargo record
[Initialize Generic Segment Structure]
The system begins fetching all secondary segments → The generic segment structure GCSUSS00 is initialized to spaces
[Initialize Segment Type to '01']
Processing cargo segment type 01 → The record type should be set to '01' to identify this segment type
[Initialize Segment Type 02 Processing]
The processing begins → The work areas are cleared and record type is set to '02'
[Initialize Segment Type to '03']
The segment processing routine is invoked → Initialize the working segment with spaces and set the record type to '03'
[Initialize Segment Processing]
The system begins segment processing → The processing structures are cleared and record type is set to '04'
[Initialize Segment Processing]
The segment processing is initiated → The work areas are cleared and record type is set to '05'
[Initialize Segment Type 07 Processing]
Initialization is required → Clear the work areas and set the record type to '07'
[Initialize Segment Type 08 Processing]
The processing begins → The system clears the database interface work area and general segment work area, and sets the record type to '08'
[Initialize Segment Type 10 Processing]
The segment processing is initiated → The work areas are cleared and record type is set to '10'
[Initialize Segment Processing]
The segment processing is initialized → The work areas are cleared to spaces and the record type is set to '11'
[Initialize Segment Counter J=1]
The system begins processing segment type 12 records → The segment counter J is initialized to 1 to start processing from the first sequence position
[Initialize Loop Counter J=1]
The system begins processing segment type 12 records → Loop counter J is set to 1 to start processing from the first sequence position
[Initialize Segment Data Structure]
The system begins processing segment type 12 data → The system clears the communication area and segment data structure, and sets the record type identifier to '12'
[Initialize Segment Processing Areas]
The segment processing begins → The processing areas are cleared to spaces and record type is set to '13'
[Initialize Segment Processing]
The segment processing is initiated → The work areas are cleared and record type is set to '14'
[Initialize Segment Type to '15']
The system begins processing cargo segment type 15 → The record type identifier is set to '15' to identify this segment type in database operations
[Initialize All Segment Arrays with Underscores]
The system initializes cargo segment arrays during the initialization phase → All cargo segment arrays (GCSUSS01 through GCSUSS15 and their corresponding working storage arrays) are filled with underscore characters
[Initialize All Segment Arrays with Spaces]
The system initializes cargo segment arrays during the initialization phase → All cargo segment arrays (GCSUSS01 through GCSUSS15 and their corresponding working storage arrays) are filled with space characters
[Initialize Status and Parameters]
The retrieval process begins → The return status is set to OK and all status codes are cleared
[Initialize Return Status to OK]
The retrieval process begins → The return status is set to OK to indicate readiness for processing

Core Acceptance Criteria

[3:Determine Processing Mode]
The first segment name is SEG-ALL → Process US cargo root segment and if successful, process all secondary segments
[3:Determine Processing Mode]
The first segment name is FETCH-ALL → Process US cargo root segment and if successful, fetch all secondary segments
[3:Determine Processing Mode]
Specific segment names are provided (not SEG-ALL or FETCH-ALL) → Get US cargo root segment and process each selected segment up to 10 segments
[6:Fetch All Secondary Segments]
A secondary segment record is retrieved with record type '01' through '15' → Map the record to the corresponding segment array (GCSUSS01 through GCSUSS15) using the sequence number as array index
[8:Process Cargo Segment Type 01]
The segment key is empty and the function is update or delete → Skip processing for that segment sequence
[17:Process Cargo Segment Type 10]
Function is REPLACE and cargo data is empty → Temporarily change function to DELETE, process the operation, then restore function to REPLACE
[19:Process Cargo Segment Type 12]
Function is REPLACE and cargo data is empty, spaces, low-values, or underscores → Temporarily change function to DELETE, process the operation, then restore function to REPLACE
[27:Terminate Processing]
Move-underscore flag is YES and function is GU and segment data is empty or all underscores → Replace the segment data with all underscores for all segment types (S01 through S15)
[25:Retrieve First Secondary Segment]
Retrieving the first secondary segment → Use '>' operator with US-CCN key and initialize record type and sequence to '0' for range processing
[Function Code is Get/Fetch?]
The system needs to initialize cargo segment data structures → If the function code is GU (Get Unique), proceed to check underscore formatting requirements, otherwise skip data initialization
[Move Underscore Flag Set?]
The system needs to initialize cargo segment data for display → If the move underscore flag is set to YES, initialize data with underscores, otherwise initialize with spaces
[Check for Process All Segments Flag]
The first element of segment all array is set to true → Set processing mode to process all segments
[Check for Fetch All Segments Flag]
The first element of fetch all array is set to true → Set processing mode to fetch all segments
[Set Processing Mode: Process Selected Segments]
Processing mode determination reaches the default case → Set processing mode to process selected segments only
[Check if Process All Segments Requested]
The SEG-ALL flag is set in the first position of the segment array → Set processing mode to process all segments and execute root cargo processing followed by all secondary segments processing
[Check if Fetch All Segments Requested]
The FETCH-ALL flag is set in the first position of the segment array → Set processing mode to fetch all segments and execute root cargo processing followed by fetch all secondary segments
[Set Processing Mode: Process Selected Segments]
If processing mode options → Set processing mode to process selected segments and execute root cargo retrieval followed by processing each selected segment up to 10 segments or until empty segment name is encountered
[Set Processing Mode: Process All Segments]
Root cargo processing is executed → If root processing is successful, Execute all secondary segments processing, otherwise set root not found error and skip processing
[Set Processing Mode: Fetch All Segments]
Root cargo processing is executed → If root processing is successful, Execute fetch all secondary segments, otherwise set root not found error and skip processing
[Set Processing Mode: Process Selected Segments]
Root cargo retrieval is executed → If root retrieval is successful, process each selected segment from position 1 to 10 until an empty segment name is encountered, otherwise set root not found error and skip processing
[Save Current Root Segment Data]
The operation type is update or delete → The system saves the current root segment data to working storage before proceeding
[Set Database Call Parameters]
Database call parameters need to be established → The system sets segment type to GCSUSRT, copies function code from input, copies security index from input, and clears database interface area
[Replace Underscores with Spaces]
Preparing data for database operation → The system replaces all underscore characters with spaces in the root segment record
[Call Database Program GCCUSIO]
Ready to execute database operation → The system calls program GCCUSIO with communication area, database interface, and root segment record
[Restore Saved Root Data]
The operation type was update or delete → The system restores the root segment data from the saved working storage copy
[Database Operation Successful?]
Checking operation result → The system checks if the status code is spaces (indicating success) or contains an error code (indicating failure)
[Set Success Status]
The database status code is spaces → The system sets the return status flag to indicate success
[Function Code?]
The function code is GU (Get Unique) → The system executes fetch all secondary segments mode to retrieve data
[Update/Insert/Delete Mode]
All secondary segments processing is initiated → The system processes each segment type from 01 through 14 in sequential order
[Fetch All Secondary Segments Mode]
All secondary segments processing is initiated → The system calls the fetch all secondary segments routine to retrieve data
[Process Segment Type 01]
Segment type 01 processing is reached → The system executes the processing routine for cargo segment type 01
[Process Segment Type 02]
Segment type 02 processing is reached → The system executes the processing routine for cargo segment type 02
[Process Segment Type 03]
Segment type 03 processing is reached → The system executes the processing routine for cargo segment type 03
[Process Segment Type 04]
Segment type 04 processing is reached → The system executes the processing routine for cargo segment type 04
[Process Segment Type 05]
Segment type 05 processing is reached → The system executes the processing routine for cargo segment type 05
[Process Segment Type 06]
Segment type 06 processing is reached → The system executes the processing routine for cargo segment type 06
[Process Segment Type 07]
Segment type 07 processing is reached → The system executes the processing routine for cargo segment type 07
[Process Segment Type 08]
Segment type 08 processing is reached → The system executes the processing routine for cargo segment type 08
[Process Segment Type 09]
Segment type 09 processing is reached → The system executes the processing routine for cargo segment type 09
[Process Segment Type 10]
Segment type 10 processing is reached → The system executes the processing routine for cargo segment type 10
[Process Segment Type 11]
Segment type 11 processing is reached → The system executes the processing routine for cargo segment type 11
[Process Segment Type 12]
Segment type 12 processing is reached → The system executes the processing routine for cargo segment type 12
[Process Segment Type 13]
Segment type 13 processing is reached → The system executes the processing routine for cargo segment type 13
[Process Segment Type 14]
Segment type 14 processing is reached → The system executes the processing routine for cargo segment type 14
[Get First Secondary Segment]
The system needs to start fetching secondary segments → The first secondary segment record for the container number is retrieved from the database
[Record Type? and Store in Type XX Data Structure]
The record type is evaluated → The segment data is stored in the corresponding type-specific data structure array using the sequence number as the index (Type 01 through Type 15)
[Get Next Secondary Segment]
More segments may exist for the container → The next secondary segment record is retrieved to continue the sequential processing
[End Fetch Process]
No more segment records exist, an error occurs, or the container number changes → The fetch process terminates and control returns to the calling process
[Set US Container Number Key]
The system prepares to fetch secondary cargo segments → The US Container Control Number key is copied to the generic segment key field
[Get First Secondary Segment Record]
The system needs to start retrieving secondary cargo segments → The first secondary segment record is retrieved from the database using the container key
[Determine Record Type]
The system processes the segment record → The record is stored in the corresponding type-specific array based on record type values '01' through '15'
[Store in Type 01 Array through Store in Type 15 Array]
The system determines the appropriate storage location → The complete segment record is moved to the corresponding position in the type-specific working storage array using the sequence number as the array index
[Get Next Secondary Segment Record]
The system needs to continue retrieving additional segments → The next secondary segment record is retrieved from the database in sequential order
[Evaluate Record Type]
If the record type field GCSUSS00-KEY-RECTYPE → The system routes the segment data to the corresponding storage array based on record type mapping where type '01' goes to WS-GCSUSS01-DATA array, type '02' goes to WS-GCSUSS02-DATA array, and so on through type '15' to WS-GCSUSS15-DATA array
[Route to Type 01 Array WS-GCSUSS01-DATA]
The record type evaluation determines the type is '01' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS01-DATA array at the position specified by the sequence number
[Route to Type 02 Array WS-GCSUSS02-DATA]
The record type evaluation determines the type is '02' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS02-DATA array at the position specified by the sequence number
[Route to Type 03 Array WS-GCSUSS03-DATA]
The record type evaluation determines the type is '03' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS03-DATA array at the position specified by the sequence number
[Route to Type 04 Array WS-GCSUSS04-DATA]
The record type evaluation determines the type is '04' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS04-DATA array at the position specified by the sequence number
[Route to Type 05 Array WS-GCSUSS05-DATA]
The record type evaluation determines the type is '05' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS05-DATA array at the position specified by the sequence number
[Route to Type 06 Array WS-GCSUSS06-DATA]
The record type evaluation determines the type is '06' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS06-DATA array at the position specified by the sequence number
[Route to Type 07 Array WS-GCSUSS07-DATA]
The record type evaluation determines the type is '07' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS07-DATA array at the position specified by the sequence number
[Route to Type 08 Array WS-GCSUSS08-DATA]
The record type evaluation determines the type is '08' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS08-DATA array at the position specified by the sequence number
[Route to Type 09 Array WS-GCSUSS09-DATA]
The record type evaluation determines the type is '09' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS09-DATA array at the position specified by the sequence number
[Route to Type 10 Array WS-GCSUSS10-DATA]
The record type evaluation determines the type is '10' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS10-DATA array at the position specified by the sequence number
[Route to Type 11 Array WS-GCSUSS11-DATA]
The record type evaluation determines the type is '11' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS11-DATA array at the position specified by the sequence number
[Route to Type 12 Array WS-GCSUSS12-DATA]
The record type evaluation determines the type is '12' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS12-DATA array at the position specified by the sequence number
[Route to Type 13 Array WS-GCSUSS13-DATA]
The record type evaluation determines the type is '13' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS13-DATA array at the position specified by the sequence number
[Route to Type 14 Array WS-GCSUSS14-DATA]
The record type evaluation determines the type is '14' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS14-DATA array at the position specified by the sequence number
[Route to Type 15 Array WS-GCSUSS15-DATA]
The record type evaluation determines the type is '15' → The system moves the complete segment record GCSUSS00 to the WS-GCSUSS15-DATA array at the position specified by the sequence number
[Get Next Segment Name from Input Parameters]
System processes selected segments → System loops through segment names from position 1 to 10 or until empty segment name is found
[Segment Name Empty?]
Current segment name in array is empty (spaces) → System exits the segment processing loop
[Process Root Segment GCSUSRT]
System evaluates segment type → System performs root cargo processing operation
[Process Segment Type 01]
System evaluates segment type → System performs cargo segment 01 processing operation
[Process Segment Type 02]
System evaluates segment type → System performs cargo segment 02 processing operation
[Process Segment Type 03]
System evaluates segment type → System performs cargo segment 03 processing operation
[Process Segment Type 04]
System evaluates segment type → System performs cargo segment 04 processing operation
[Process Segment Type 05]
System evaluates segment type → System performs cargo segment 05 processing operation
[Process Segment Type 06]
System evaluates segment type → System performs cargo segment 06 processing operation
[Process Segment Type 07]
System evaluates segment type → System performs cargo segment 07 processing operation
[Process Segment Type 08]
System evaluates segment type → System performs cargo segment 08 processing operation
[Process Segment Type 09]
System evaluates segment type → System performs cargo segment 09 processing operation
[Process Segment Type 10]
System evaluates segment type → System performs cargo segment 10 processing operation
[Process Segment Type 11]
System evaluates segment type → System performs cargo segment 11 processing operation
[Process Segment Type 12]
System evaluates segment type → System performs cargo segment 12 processing operation
[Process Segment Type 13]
System evaluates segment type → System performs cargo segment 13 processing operation
[Process Segment Type 14]
System evaluates segment type → System performs cargo segment 14 processing operation
[Process Segment Type 15]
System evaluates segment type → System performs cargo segment 15 processing operation
[Handle specific cargo segments based on segment names provided in input parameters]
The system processes selected segments mode and iterates through the segment names array → The system should process each specified segment type until all requested segments are processed or the array is exhausted (maximum 10 segments)
[Segment Name Empty?]
A segment name at position I in the array is empty (spaces) → The system should terminate the segment processing loop and exit
[Which Segment Type?]
If the segment type (GCSUSRT, GCSUSS01 through GCSUSS15) → The system should route to the appropriate segment processing routine based on the segment type identifier
[Function is Update or Delete?]
The system checks if the function is update or delete operation → The system should process the root segment only if the function is update or delete, otherwise skip to check for more segments
[More Segments to Process?]
The system checks if there are more segments to process (I <= 10) → The system should increment the counter and continue processing if within limits, otherwise terminate processing
[Process Root Segment GCSUSRT]
The system executes root segment processing → The system should call the root segment processing routine to handle the primary cargo data
[Process Segment Type 01]
The system executes segment type 01 processing → The system should call the segment 01 processing routine to handle the specific cargo details
[Process Segment Type 02]
The system executes segment type 02 processing → The system should call the segment 02 processing routine to handle the specific cargo details
[Process Segment Type 03]
The system executes segment type 03 processing → The system should call the segment 03 processing routine to handle the specific cargo details
[Process Segment Type 04]
The system executes segment type 04 processing → The system should call the segment 04 processing routine to handle the specific cargo details
[Process Segment Type 05]
The system executes segment type 05 processing → The system should call the segment 05 processing routine to handle the specific cargo details
[Process Segment Type 06]
The system executes segment type 06 processing → The system should call the segment 06 processing routine to handle the specific cargo details
[Process Segment Type 07]
The system executes segment type 07 processing → The system should call the segment 07 processing routine to handle the specific cargo details
[Process Segment Type 08]
The system executes segment type 08 processing → The system should call the segment 08 processing routine to handle the specific cargo details
[Process Segment Type 09]
The system executes segment type 09 processing → The system should call the segment 09 processing routine to handle the specific cargo details
[Process Segment Type 10]
The system executes segment type 10 processing → The system should call the segment 10 processing routine to handle the specific cargo details
[Process Segment Type 11]
The system executes segment type 11 processing → The system should call the segment 11 processing routine to handle the specific cargo details
[Process Segment Type 12]
The system executes segment type 12 processing → The system should call the segment 12 processing routine to handle the specific cargo details
[Process Segment Type 13]
The system executes segment type 13 processing → The system should call the segment 13 processing routine to handle the specific cargo details
[Process Segment Type 14]
The system executes segment type 14 processing → The system should call the segment 14 processing routine to handle the specific cargo details
[Process Segment Type 15]
The system executes segment type 15 processing → The system should call the segment 15 processing routine to handle the specific cargo details
[GCSUSRT Root Segment Selected?]
The root segment GCSUSRT is selected in the segment name array at position I AND the function code indicates an update or delete operation → The system executes root segment processing to handle the cargo root record
[GCSUSS01 Segment Selected?]
The segment name array at position I contains GCSUSS01 segment identifier → The system executes Type 01 cargo segment processing routine
[GCSUSS02 Segment Selected?]
The segment name array at position I contains GCSUSS02 segment identifier → The system executes Type 02 cargo segment processing routine
[GCSUSS03 Segment Selected?]
The segment name array at position I contains GCSUSS03 segment identifier → The system executes Type 03 cargo segment processing routine
[GCSUSS04 Segment Selected?]
The segment name array at position I contains GCSUSS04 segment identifier → The system executes Type 04 cargo segment processing routine
[GCSUSS05 Segment Selected?]
The segment name array at position I contains GCSUSS05 segment identifier → The system executes Type 05 cargo segment processing routine
[GCSUSS06 Segment Selected?]
The segment name array at position I contains GCSUSS06 segment identifier → The system executes Type 06 cargo segment processing routine
[GCSUSS07 Segment Selected?]
The segment name array at position I contains GCSUSS07 segment identifier → The system executes Type 07 cargo segment processing routine
[GCSUSS08 Segment Selected?]
The segment name array at position I contains GCSUSS08 segment identifier → The system executes Type 08 cargo segment processing routine
[GCSUSS09 Segment Selected?]
The segment name array at position I contains GCSUSS09 segment identifier → The system executes Type 09 cargo segment processing routine
[GCSUSS10 Segment Selected?]
The segment name array at position I contains GCSUSS10 segment identifier → The system executes Type 10 cargo segment processing routine
[GCSUSS11 Segment Selected?]
The segment name array at position I contains GCSUSS11 segment identifier → The system executes Type 11 cargo segment processing routine
[GCSUSS12 Segment Selected?]
The segment name array at position I contains GCSUSS12 segment identifier → The system executes Type 12 cargo segment processing routine
[GCSUSS13 Segment Selected?]
The segment name array at position I contains GCSUSS13 segment identifier → The system executes Type 13 cargo segment processing routine
[GCSUSS14 Segment Selected?]
The segment name array at position I contains GCSUSS14 segment identifier → The system executes Type 14 cargo segment processing routine
[GCSUSS15 Segment Selected?]
The segment name array at position I contains GCSUSS15 segment identifier → The system executes Type 15 cargo segment processing routine
[More Segment Names to Process?]
The current segment processing is complete AND the loop counter I is less than or equal to 10 AND the segment name array at position I is not empty → The system increments the counter and continues processing the next segment in the array
[Set Current Sequence Number]
The sequence is not skipped due to empty key validation → The current sequence number should be set to the loop counter value and assigned to the database record key
[Copy Input Data to Database Structure]
The function is update or delete → The input data from the working storage array should be copied to the database structure
[Execute Database Operation]
A database operation needs to be executed → The system should call the database processing routine to Execute the operation
[Copy Retrieved Data to Output Structures]
The function is get (retrieve data) → The retrieved data should be copied to both the segment output structure and the working storage array
[Start Loop: Sequence 1 to Maximum]
Processing multiple sequences within the segment → The system should loop from sequence 1 to the maximum allowed sequence number for segment type 01
[Set Record Type to '02']
The record type needs to be identified → The record type is set to '02'
[Is Key Empty AND Update/Delete Operation?]
The sequence position has an empty key → Skip processing this sequence position and move to the next one
[Set Current Sequence Number]
The sequence number needs to be set → The current loop counter value is moved to the sequence number field
[Copy Input Data to Processing Area]
Input data needs to be prepared for database operation → The input data from the sequence position is copied to the processing area
[Execute Database Operation]
The database operation is executed → The operation is performed against the cargo database
[Copy Retrieved Data to Output Areas]
Data has been retrieved from the database → The retrieved data is copied to both the segment output area and working storage array
[More Sequences to Process?]
A sequence position has been processed → Continue to next sequence if within maximum limit, otherwise end processing
[Is Key Empty AND Update/Delete Operation?]
The segment key is empty AND the operation is either update or delete → Skip processing for this sequence and continue to the next sequence
[Set Current Sequence Number]
Processing a specific sequence within the segment → Set the current sequence number and prepare it for database operations
[Move Input Data to Working Segment]
The operation is either update or delete → Move the input data from working array to the segment structure for database processing
[Execute Database Operation]
A database operation needs to be executed → Call the database processing routine to Execute the operation and return the result status
[Move Retrieved Data to Output Segment]
The operation is a fetch (GU - Get Unique) → Move the retrieved data from working segment to the output segment structure
[Move Retrieved Data to Working Array]
The fetch operation completes successfully → Move the retrieved data to the corresponding position in the working array
[Terminate Loop Early - Set Sequence Beyond Max]
The database operation fails (return status is not OK) → Set the sequence counter beyond the maximum value to terminate the processing loop early
[Start Loop: Sequence 1 to Max]
Processing begins for the segment → Start a loop from sequence 1 to the maximum sequence number defined for segment type 03
[Set Record Type to '04']
The system sets up the record identification → The record type field is populated with '04'
[Is Key Empty AND Update/Delete Operation?]
The system encounters a sequence position with an empty key (88-GCSUSS04-EMPTY-KEY condition is true) → The system skips processing for that sequence position and continues to the next
[Set Current Sequence Number]
The system prepares to process the sequence → The current sequence counter J is moved to WS-SEQ and then to GCSUSS00-KEY-SEQ
[Copy Input Data to Processing Structure]
The system prepares data for the database operation → The input data from WS-GCSUSS04-DATA array at position J is moved to GCSUSS00
[Execute Database Operation]
The system executes the database operation → The X7080-PRCS-USCARGO-GCSUSS00 routine is performed to handle the database interaction
[Copy Retrieved Data to Output Structures]
Data has been retrieved from the database → The retrieved data from GCSUSS00 is moved to both GCSUSS04 and WS-GCSUSS04-DATA array at position J
[Is Segment Empty and Update/Delete Operation?]
If whether to process the segment entry → The processing is skipped and continues to the next sequence number
[Set Current Sequence Number]
The sequence number needs to be established → The current loop counter is moved to the sequence number field
[Copy Input Data to Processing Area]
The input data needs to be prepared for database operation → The segment data is copied from the working array to the processing record structure
[Execute Database Operation]
The database operation is executed → The appropriate database function is called with the segment data
[Copy Retrieved Data to Output]
Data has been retrieved from the database → The retrieved data is copied to the output segment structure and stored in the working array
[More Sequences to Process?]
A sequence number has been processed → Processing continues if the current sequence number is less than or equal to the maximum sequence number for segment type 05
[Set Record Type to '06']
The segment processing begins → Set the record type field to '06' to identify this segment type
[Set Current Sequence Number]
The sequence is not being skipped → Move the current sequence number to the working sequence field
[Move Input Data to Working Segment]
The operation is either update or delete → Move the input data from the working storage array to the processing segment structure
[Execute Database Operations for Type 06]
Database operation is requested → Call the database processing routine to execute the operation
[Move Retrieved Data to Output Segment]
The operation is a get operation → Move the retrieved data to both the output segment and working storage array
[Terminate Loop Early - Set Counter to Max]
The database operation returns an error status → Set the loop counter to maximum value to terminate the processing loop early
[More Sequences to Process?]
The current sequence number is evaluated against the maximum sequence limit → Continue to next sequence if within limits, otherwise end processing
[Set Current Sequence Number]
The sequence number needs to be set for database operations → Move the current loop counter to the sequence field in the processing record
[Move Input Data to Processing Record]
The operation is either update or delete → Move the input data from the working array to the processing record
[Execute Database Operations]
Database operations need to be executed → Call the database processing routine to Execute the requested operation
[Move Result to Output Segment]
The operation type is get (GU) → Move the retrieved data to both the output segment structure and the working storage array
[Terminate Loop Early - Set Counter to Max]
An error condition is detected → Set the loop counter to the maximum sequence value plus one to terminate the loop immediately
[More Sequences to Process?]
The current sequence number is less than or equal to the maximum allowed sequences → Continue to process the next sequence number
[Set Current Sequence Number]
Processing a specific sequence position → The system sets the current sequence number from the loop counter and assigns it to the segment key sequence field
[Copy Input Data to Working Segment]
The operation is an update or delete function → The system copies the input segment data from the working storage array to the general segment structure
[Execute Database Operations for Segment 08]
Database processing is required → The system calls the database interface module to execute the specified operation
[Copy Retrieved Data to Output Structures]
The operation is a get function → The system copies the retrieved data to both the segment output structure and the working storage array at the current sequence position
[Terminate Loop Early - Set Counter to Max]
The system detects the error condition → The system sets the loop counter to the maximum sequence value plus one to terminate the processing loop immediately
[Continue to Next Sequence]
No database errors are detected → The system continues to the next iteration of the sequence processing loop
[More Sequences to Process?]
Checking for more sequences to process → The system continues the loop if the current sequence number is less than or equal to the maximum sequence count for segment type 08, otherwise terminates the loop
[Set Current Sequence Number]
The sequence number needs to be established for database operations → Set the current loop counter value as the sequence number in the processing structure
[Move Input Data to Processing Structure]
The operation is either update or delete → Move the input data from working storage array to the processing structure
[Execute Database Operations for Type 09]
Database operations need to be performed → Execute the generic cargo segment processing routine for the prepared record
[Move Retrieved Data to Output Structure]
Data has been retrieved from the database → Move the retrieved data to both the segment output structure and the working storage array at the current sequence position
[Set Loop Counter to Exit Early]
The operation return status indicates failure → Set the loop counter to exceed the maximum sequence count to force early termination of the processing loop
[Set Record Type to '10']
The record type needs to be identified → The record type field is set to '10'
[More Sequences to Process?]
Processing sequences within the maximum allowed range → Continue processing until all sequences up to the maximum are handled
[Set Sequence Number in Key]
Preparing the record key for database access → The sequence number is moved to the key field
[Move Input Data to Working Record]
Input data needs to be prepared for database operation → Move the input data from working array to the database record structure
[Is Replace Operation and Data Empty?]
The cargo data field contains only spaces → Identify this as a condition requiring delete operation instead of replace
[Set Function to Delete]
The system detects empty cargo data → Temporarily change the function code to delete operation
[Execute Database Operation]
The database operation is ready to execute → Call the database access routine to Execute the operation
[Move Retrieved Data to Output]
Data has been retrieved from the database → Move the retrieved data to the output segment structure and working array
[Set Sequence Number in Segment Key]
The sequence is not being skipped due to empty key validation → Set the current sequence number (J) into the working sequence field and copy it to the segment key sequence field
[Is Operation Update/Delete?]
The operation is either update or delete → Copy the input data from the working storage array to the segment structure
[Is Operation Replace AND Cargo Data is Empty?]
The cargo data field is empty (spaces) → Temporarily change the operation from replace to delete
[Execute Delete Operation]
The delete operation is executed → Process the delete operation through the standard segment processing routine
[Execute Standard Operation]
The operation is not a replace with empty cargo data → Execute the standard segment processing routine for the operation
[Is Operation Get/Fetch?]
The operation is a get or fetch operation → Copy the retrieved segment data to both the output segment structure and the working storage array
[Empty Data and Delete/Update Operation?]
The segment key is empty AND the operation is update or delete → Skip processing for this sequence number and continue to the next sequence
[Set Sequence Number in Segment Key]
Processing a specific sequence within the segment → Set the current sequence number into the segment key structure and set record type to '10'
[Copy Input Data to Segment Structure]
The operation is update or delete → Copy the input data from working storage array to the segment structure
[Special Delete Logic - Empty Cargo Data?]
The operation is replace AND the cargo data is empty or spaces → Temporarily set the operation to delete, execute the delete operation, then reset the operation back to replace
[Execute Database Operation]
A database operation needs to be executed → Call the database access module to Execute the operation and return the result status
[Copy Retrieved Data to Output Structure]
The database operation returns success status → Copy the retrieved segment data to both the output segment structure and the corresponding position in the working storage array
[Set Record Type to '11']
The record type needs to be identified → The record type is set to '11' in the processing structure
[Set Current Sequence Number]
The sequence number needs to be established → The current loop counter value is moved to the sequence number field in the processing structure
[Move Input Data to Processing Structure]
The operation type is update or delete → The input data from working storage array is moved to the processing structure
[Execute Database Operation]
The database operation is executed → The GCCUSIO database access module is called to Execute the operation on the GCSUSS11 segment
[Move Retrieved Data to Output Structure]
The operation type is get or fetch → The retrieved data is moved from the processing structure to the output segment structure
[Move Retrieved Data to Working Storage]
The data needs to be preserved in working storage → The retrieved data is moved to the corresponding position in the working storage array
[More Sequences to Process?]
The system checks if more sequences need processing → Processing continues if the current sequence number is less than or equal to the maximum sequence limit for segment type 11, otherwise processing ends
[Get Segment Data from Array Position J]
The system needs to process the segment at position J → The segment data is moved from the working storage array position J to the processing structure
[Set US-CCN Key and Record Type '12']
The system prepares the record for database operations → The US-CCN key is set from the root cargo record and the record type is set to '12'
[Set Sequence Number J]
The system sets up the complete record key → The sequence number field is set to the current value of counter J
[Update Array and Generic Segment Structure]
The system prepares for database operations → The data is synchronized between the segment-specific structure, working storage array, and generic processing structure
[Function Code?]
If the function code → Processing is routed to Get/Retrieve for inquiry operations, Delete for removal operations, Insert for new record creation, or Replace/Update for modification operations
[Retrieve Existing Record]
The system processes the inquiry request → The existing record is retrieved from the database using the US-CCN key, record type '12', and sequence number
[Delete Existing Record]
The system processes the deletion request → The record is removed from the database using the US-CCN key, record type '12', and sequence number
[Cargo Data Empty?]
If the cargo data content → If cargo data is empty, spaces, low-values, or underscores, the operation is treated as a delete; otherwise, it proceeds as an update
[Clear Segment Data in Array]
The system completes the deletion process → The corresponding segment structure and working storage array position are cleared with spaces
[Store Retrieved Data in Array]
The system processes the retrieved data → The retrieved data is stored in both the segment-specific structure and the corresponding working storage array position
[Operation Successful?]
If the operation result → For successful Get operations, data is stored; for failed Get operations, processing exits early; for other operations, processing continues regardless of success or failure
[Increment Counter J]
The system prepares for the next iteration → The counter J is incremented by 1 to process the next sequence position
[J <= Maximum Sequence?]
The system checks if more records need processing → Continue processing if J is less than or equal to maximum sequence limit, otherwise end processing
[Get Segment Data from Array Position J]
The system needs to process a specific sequence record → Move segment data from working storage array position J to the processing segment structure
[Set Container Number Key]
Processing a cargo segment record → Set the segment record container number key to match the root cargo record container number key
[Set Record Type to '12']
Setting up record identification → Set record type field to '12' to identify this as a segment type 12 record
[Update Array and Generic Segment]
Ready to process the segment record → Update both the working storage array position and generic segment structure with current data
[Execute Get Operation]
System needs to retrieve existing cargo segment data → Execute database get operation using the segment keys
[Move Retrieved Data to Segment and Array]
Data needs to be made available for output → Move retrieved data to both the segment structure and working storage array at position J
[Execute Delete Operation]
System needs to remove existing cargo segment data → Execute database delete operation using the segment keys
[Clear Segment and Array Data]
System needs to clear the data structures → Move spaces to both segment structure and working storage array at position J
[Execute Insert Operation]
System needs to add new cargo segment data → Execute database insert operation using the prepared segment data
[Execute Delete Operation]
System needs to remove existing record with empty replacement data → Execute database delete operation using the segment keys
[Execute Replace Operation]
System needs to update existing cargo segment data → Execute database replace operation using the prepared segment data
[Set Container Number Key]
The system prepares to access segment type 12 records → The system copies the US container control number from the root cargo record to the segment 12 key field
[Set Record Type to '12']
The system prepares the record key for segment type 12 access → The system sets the record type field to '12' to identify this as a segment type 12 record
[Set Sequence Number]
The system prepares to access a particular segment type 12 record occurrence → The system moves the loop counter value to the working sequence field and then to the segment record key sequence field
[Call Database Get Operation]
The system executes the database get operation → The system calls the database access routine to retrieve the segment type 12 record
[Move Retrieved Data to GCSUSS12]
The system processes the retrieved segment type 12 record → The system moves the retrieved data to both the GCSUSS12 output structure and the working storage array at the current sequence position
[Terminate Loop Processing Early]
If the database operation return status → The system calculates the loop counter to exceed the maximum sequence limit plus one to terminate the processing loop early
[Skip Insert Operation]
The cargo data is empty, contains only spaces, low-values, or underscores → The insert operation is skipped and no database insert is performed
[Execute Database Insert]
The cargo data contains valid content that is not empty, not spaces, not low-values, and not underscores → The database insert operation is executed through the cargo processing routine
[Is Cargo Data Empty?]
The cargo data is empty (spaces, low-values, or underscores) → The system should identify the data as empty and proceed to delete operation path
[Execute Delete Operation]
The delete operation is executed → The cargo segment record should be processed for deletion through the standard cargo processing routine
[Execute Update Operation]
The update operation is executed → The cargo segment record should be processed through the standard cargo processing routine
[Is Cargo Data Empty - Evaluate cargo data against multiple empty conditions (spaces, low-values, underscores) to determine delete vs update operation]
The cargo data field equals spaces:
low-values
all underscores
→ The system temporarily changes the function code to DLET (Delete) to remove the empty record
[Proceed with Update Operation]
The cargo data field does not equal spaces AND does not equal low-values AND does not equal all underscores → The system proceeds with the normal replace operation without changing the function code
[Set Record Type to '13']
The record type needs to be identified → The record type field is set to '13'
[Is Key Empty AND Update/Delete Operation?]
The key is empty (88-GCSUSS13-EMPTY-KEY) and the operation is update or delete (88-FUNC-UPDT-OR-DLET) → The current sequence is skipped and processing continues to the next sequence
[Set Current Sequence Number]
The sequence number needs to be set for database operations → The sequence number J is moved to WS-SEQ and then to GCSUSS00-KEY-SEQ
[Move Input Data to Processing Area]
The operation type is update or delete (88-FUNC-UPDT-OR-DLET) → The input data from WS-GCSUSS13-DATA array at position J is moved to GCSUSS00
[Execute Database Operation]
The database operation is executed → The X7080-PRCS-USCARGO-GCSUSS00 routine is performed to handle the database interaction
[Move Retrieved Data to Output Areas]
The operation type is get (88-FUNC-GU) → The retrieved data from GCSUSS00 is moved to both GCSUSS13 and WS-GCSUSS13-DATA array at position J
[Set Record Type to '14']
The record type needs to be identified → The record type is set to '14'
[Set Sequence Number]
The sequence number needs to be established → The current iteration value is assigned as the sequence number
[Move Input Data to Processing Structure]
Input data needs to be prepared for processing → The input data is moved to the processing structure
[Execute Database Operations]
Database operation needs to be executed → The database operation is performed through the cargo processing routine
[Move Retrieved Data to Output Structure]
Retrieved data needs to be made available to the caller → The retrieved data is moved to both the output structure and working storage
[More Sequences to Process?]
A sequence has been completed → Processing continues if more sequences exist within the maximum limit, otherwise processing ends
[Start Loop: Sequence 1 to Maximum]
The system processes segment type 15 records → All sequence numbers from 1 to GCSUSS99-S15-MAX-SEQ are processed in order
[Set Current Sequence Number]
The sequence number needs to be set for database operations → The current loop counter J is moved to WS-SEQ and then to GCSUSS00-KEY-SEQ for database key identification
[Move Working Storage Data to Segment]
The operation is either update or delete → The data from WS-GCSUSS15-DATA array at the current sequence position is moved to GCSUSS00 structure
[Execute Database Operations for Segment]
Database operation is requested → The X7080-PRCS-USCARGO-GCSUSS00 routine is performed to execute the database operation
[Move Retrieved Data to Output Areas]
The function code is GU (Get Unique/Retrieve) → The retrieved data from GCSUSS00 is moved to both GCSUSS15 output structure and WS-GCSUSS15-DATA working storage array at the current sequence position
[Set Insert/Update/Delete Operation Status]
The operation type is not a get operation and not a get next operation → The system sets the database access status to 'IIGE' and replaces all underscores with spaces in the cargo segment data
[Set Container Number Key]
The operation type is a get operation (88-FUNC-GU) → The system moves the US cargo control number key to the cargo segment container number key field
[Call Database Program GCCUSIO]
The system is ready to execute the database operation → The system calls the GCCUSIO program with the communication area, working storage I/O area, and cargo segment data
[Set Operation Failure Status]
The database status code is not spaces (indicating failure) → The system sets the return status to NOT-OK (88-RETURN-NOT-OK) and if the operation was a get operation, clears the cargo segment data to spaces
[Set Get Operation Status]
The operation type is a get operation (88-FUNC-GU) → The system sets the database status to 'GE' and populates the container number key with the cargo control number
[Set Get Next Operation Status]
The operation type is a get next operation (88-FUNC-GN) → The system sets the database status to 'GB'
[Set Insert/Update/Delete Operation Status]
The operation type is not a get operation and not a get next operation → The system sets the database status to 'IIGE' and replaces all underscores in the segment data with spaces
[Call Database Program GCCUSIO]
The system needs to execute the database operation → The system calls program 'GCCUSIO' with the communication area, working storage IO area, and segment data
[Set Operation Failure Status]
The status code returned is not spaces → The system sets the return status to NOT-OK (88-RETURN-NOT-OK) and if the operation was a get operation, clears the segment data to spaces
[Prepare Database Call Parameters]
The system prepares database call parameters → The return status is set to OK and database interface parameters are cleared
[Set Segment Type and Function Code]
The system configures the operation type → The segment type is set to GCSA2RT and the function code is copied from the working storage function code
[Set Get Operation Parameters]
The system sets Get operation parameters → The database accept status is set to 'GE' and the US-CCN key is populated in the cargo segment key field
[Set Get Next Operation Parameters]
The system sets Get Next operation parameters → The database accept status is set to 'GB'
[Set Insert/Update/Delete Parameters]
The system sets Insert/Update/Delete operation parameters → The database accept status is set to 'IIGE'
[Call GCCUSIO Database Program]
The system calls the GCCUSIO database program → The database program is executed with the communication area, database interface parameters, and cargo segment data
[Set Access Status to 'GE' Get Operation]
The function code is GU (Get Unique) → The database access status is set to 'GE' and the US-CCN key is populated in the segment record
[Set Access Status to 'GB' Get Next Operation]
The function code is GN (Get Next) → The database access status is set to 'GB'
[Set Access Status to 'IIGE' Modification Operation]
The function code is not GU (Get Unique) and not GN (Get Next) → The database access status is set to 'IIGE'
[Apply Underscore to Space Replacement for Modification Operations]
The function code is not GU (Get Unique) and not GN (Get Next) → All underscore characters in the segment record are replaced with spaces before database access
[Process Segment Type 01 Arrays through Process Segment Type 15 Arrays]
The system performs underscore replacement during termination processing → The system processes all segment types from 01 through 15 (excluding segment type 12) in sequential order, applying underscore replacement logic to each segment's array elements
[Move Underscore Flag Set?]
The move underscore flag is evaluated → Underscore replacement processing is performed only if the flag is set to YES, otherwise the processing is skipped
[Data is Spaces or Underscores?]
Each data element in the segment array is evaluated → If the data element contains only spaces or underscores, it is replaced with all underscores; otherwise the original data is preserved
[Process Segment Type 01 Data Arrays through Process Segment Type 15 Data Arrays]
The system processes segment data arrays → All segment types from 01 through 15 are processed in sequence, with each segment's data array being evaluated for underscore replacement according to the defined criteria
[Move Underscore Flag Set AND Function is Get?]
The move underscore flag is set to YES AND the function code is GU (Get Unique) → The underscore replacement process is activated for all segment data arrays
[Process Segment Type 01 Array, Process Segment Type 02 Array, Process Segment Type 03 Array...]
Processing each record in the array AND the record contains only spaces:
all underscores
→ Replace the record content with all underscores to maintain consistent formatting
[Move Underscore Flag = Yes AND Function = GU?]
The move underscore flag is set to Yes AND the function code is GU (Get Unique) → Array processing is activated to handle underscore replacement for all segment types
[J <= Max Sequence for Segment Type?]
The loop counter J is less than or equal to the maximum sequence for the segment type → Continue processing the current array element, otherwise move to next segment type
[All Segment Types Processed?]
All segment types from 01 through 15 (excluding 12) have been processed in sequence → Complete the array processing operation and end the procedure
[Set US Container Number Key]
Accessing secondary segment records → The secondary segment key is populated with the US Container Number from the root record
[Set Record Type to '00']
Initializing the search criteria → The record type is set to '00' to begin sequential access
[Set Sequence Number to '00']
Initializing the search criteria → The sequence number is set to '00' to begin sequential access
[Configure Database Access Parameters]
Configuring database access parameters → The database status is set to 'GEGB', segment type is set to GCSA2RT, function is set to GU, index is set to SECN-KEY, and operator is set to '>'
[Call Database Program GCCUSIO]
Retrieving the first secondary segment record → The GCCUSIO program is called with the communication area, working storage area, and secondary segment structure
[Set Return Status to OK]
The database call returns with no status code (spaces) → The return status is set to OK
[Set Return Status to NOT-OK]
The database call returns with a non-blank status code → The return status is set to NOT-OK and the secondary segment data is cleared to spaces
[Set Database Access Mode to 'GEGB']
Database access mode is being configured → The access mode is set to 'GEGB' to enable sequential record retrieval
[Set US Container Number Key]
The database key is being configured → The US Container Number key is set to match the target container
[Configure for Generic Segment Access]
Database access parameters are being configured → The system is configured for generic segment access to handle all secondary segment types
[Set Function to Get Next]
Database function is being configured → The function is set to Get Next to retrieve the subsequent record in sequence
[Set Secondary Key Index]
Database index configuration is being set → The secondary key index is configured to enable proper record navigation
[Call Database Program GCCUSIO]
The system needs to retrieve the next secondary segment record → The GCCUSIO database program is called to execute the retrieval operation
[Skip Processing Flag Set?]
The skip processing flag (88-RETURN-SKIP-PRCS) is set to true → The system should immediately exit termination processing without performing any data cleanup or underscore replacement operations
[Underscore Replacement Requested AND Function is Get?]
The move underscore flag is set to YES AND the function code is GU (Get Unique) → The system should proceed with underscore replacement processing for all cargo segment data arrays
[Process Segment Type 01 Data Arrays]
A data entry in the segment 01 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 02 Data Arrays]
A data entry in the segment 02 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 03 Data Arrays]
A data entry in the segment 03 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 04 Data Arrays]
A data entry in the segment 04 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 05 Data Arrays]
A data entry in the segment 05 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 06 Data Arrays]
A data entry in the segment 06 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 07 Data Arrays]
A data entry in the segment 07 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 08 Data Arrays]
A data entry in the segment 08 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 09 Data Arrays]
A data entry in the segment 09 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 10 Data Arrays]
A data entry in the segment 10 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 11 Data Arrays]
A data entry in the segment 11 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 13 Data Arrays]
A data entry in the segment 13 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 14 Data Arrays]
A data entry in the segment 14 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes
[Process Segment Type 15 Data Arrays]
A data entry in the segment 15 array contains only spaces:
contains all underscores
→ The system should replace that data entry with all underscores for display purposes

Structural Validations

[3:Determine Processing Mode]
Segment names parameter is empty → Set parameter segment names error and skip processing
[4:Process US Cargo Root Segment]
Root segment processing fails → Set root not found error and skip secondary segment processing
[6:Fetch All Secondary Segments]
The sequence number is not numeric → Default the sequence number to 1
[19:Process Cargo Segment Type 12]
Function is INSERT and cargo data is not empty, spaces, low-values, or underscores → Process the insert operation
[Check Segment Names Parameter]
The segment names parameter is empty or contains only spaces → Set parameter error for empty segment names and skip processing
[Set Parameter Error - Segment Names Empty]
The segment names parameter equals spaces → Set parameter segment names error flag and set skip processing flag to true
[Skip Processing or US-CCN Empty?]
The system flag indicates processing should be skipped:
the US Cargo Control Number is empty
→ The system exits without performing any processing operations
[Set Error Status]
The database status code is not spaces → The system sets the return status flag to indicate failure
[Segment Found? and Same Container Number?]
The system checks the retrieved segment record → Processing continues only if a record exists, the operation was successful, and the container number matches the requested container
[Validate Sequence Number]
The sequence number field is checked for validity → If the sequence number is not numeric, it is defaulted to 1 to ensure valid array indexing
[Sequence Number Valid? and Set Default Sequence to 1]
The system validates the sequence number → If the sequence number is not numeric, it is defaulted to 1, otherwise the original value is retained
[Read Record Type from GCSUSS00-KEY-RECTYPE]
The system processes the record for storage routing → The system assigns sequence number 1 as the default value for array positioning
[Is Segment Key Empty AND Function is Update/Delete?]
The segment key is empty AND the function is update or delete → Skip processing this sequence and continue to the next sequence
[Check Sequence Position]
The current sequence position is evaluated → Processing continues if within maximum limit, otherwise processing ends
[Check Sequence Position]
The system checks the current sequence position J against the maximum sequence limit → Processing continues if J is less than or equal to GCSUSS99-S04-MAX-SEQ, otherwise processing ends
[Is Segment Key Empty AND Update/Delete Operation?]
The segment key is empty AND the operation is either update or delete → Skip processing this sequence and continue to the next sequence number
[Is Segment Key Empty AND Update/Delete Operation?]
The segment key is empty AND the operation is either update or delete → Skip processing for this sequence and continue to the next sequence
[Is Segment Key Empty AND Update/Delete Operation?]
The operation is an update or delete function → The system skips processing this sequence and continues to the next sequence
[Is Segment Key Empty AND Update/Delete Operation?]
The segment key is empty AND the operation is either update or delete → Skip processing this sequence number and continue to the next sequence
[Is Key Empty and Update/Delete Operation?]
A sequence entry has an empty key → Skip processing for that sequence and continue to the next one
[Is Segment Key Empty AND Operation is Update/Delete?]
The segment key is empty AND the operation is either update or delete → Skip processing this sequence and continue to the next sequence
[Is Segment Key Empty AND Operation is Update/Delete?]
The system checks if the segment key is empty and the operation is update or delete → The processing for this sequence is skipped and continues to the next sequence
[J <= Maximum Sequence?]
The system checks if more segments need processing → Processing continues if J is less than or equal to the maximum sequence count for segment type 12, otherwise processing ends
[Cargo Data Not Empty?]
The system validates the cargo data content → The insert operation proceeds only if cargo data is not empty, spaces, low-values, or underscores
[Exit Early on Error]
If the failure condition → The counter J is set beyond the maximum sequence count to terminate the processing loop immediately
[Cargo Data Content Check]
The cargo data content is evaluated for insert operation → If cargo data is not empty, not spaces, not low-values, and not underscores, then execute database insert operation, otherwise skip the insert operation
[Is Cargo Data Empty - Evaluate cargo data against multiple empty conditions (spaces, low-values, underscores) to determine delete vs update operation]
The cargo data field does not equal spaces AND does not equal low-values AND does not equal all underscores → The system proceeds with the insert operation
[Check Sequence Number Within Limit?]
The sequence number is checked against the maximum limit → Processing continues if J is less than or equal to GCSUSS99-S13-MAX-SEQ, otherwise processing ends
[Is Segment Key Empty AND Update/Delete Operation?]
The operation is update or delete → The processing for this sequence is skipped
[Is Segment Key Empty AND Operation is Update/Delete?]
The segment key is empty AND the function code is either update or delete → The current sequence is skipped and processing continues with the next sequence
[Replace Underscores with Spaces]
The operation type is not a get operation and not a get next operation → The system replaces all underscore characters with spaces in the cargo segment data
[Replace Underscores with Spaces in Data]
The system formats the data for database operation → All underscore characters in the cargo segment data are replaced with spaces
[Clear Data Structure on Error]
The system performs error cleanup → The cargo segment data structure (GCSUSS00) is cleared to spaces
[Replace with All Underscores]
The system processes each element in cargo segment arrays and finds an element that contains only spaces or all underscore characters → The system replaces that array element with all underscore characters to maintain consistent display formatting
[Keep Current Data]
The system processes each element in cargo segment arrays and finds an element that contains actual cargo data (not spaces or underscores) → The system preserves the current data in that array element without modification
[Array Element = Spaces OR All Underscores?]
The array element contains either spaces or all underscore characters → The element is identified as requiring underscore replacement
[Clear Segment Data]
Cleanup processing is performed → All segment data is cleared to prevent processing of invalid information

Module: GCX001 1 Consolidated Epic Story

Epic: GCX001 Complete EDI Specification Extracted from Legacy

Contains 17 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX001 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Validate Menu Screen Input]
If the message ID → If message ID equals GC-MENU-SCREEN, function key processing is performed, otherwise input field is cleared
[6:Handle Up Level Navigation, 7:Determine Navigation Target]
User presses UP-A-LEVEL function key → If S2MR-SPA contains data, navigate to S2MR-MENU; if S2MR-SPA is empty, navigate to SIGNOFF-SCREEN and clear output message
[8:Execute System Signoff]
System processes the navigation request → Output selection code is set to SIGNOFF-SCREEN and output message is cleared
[10:Clear Input Field]
System processes the message → Input field (GCMSG-INPUT-FIELD) is cleared to spaces
[Compare Message ID with Menu Screen ID]
The system compares the message ID (GCMSG-MSG-ID-NUM) with the menu screen identifier (GC-MENU-SCREEN) → The system identifies the message as either menu screen type or non-menu screen type for appropriate processing
[Message is Menu Screen Type]
The message ID matches the menu screen identifier → The system processes the message through menu-specific function key handling logic
[Message is Non-Menu Screen Type]
The message ID does not match the menu screen identifier → The system clears the input field (GCMSG-INPUT-FIELD) by setting it to spaces
[Clear Output Message]
System sets navigation to signoff screen → System clears the output message by setting it to spaces
[Clear Output Message]
System sets navigation target to signoff screen → System clears the output message by setting it to spaces
[Execute System Signoff - Clear output message and set signoff screen when no higher menu level exists]
The S2MR menu context (GCMSG-S2MR-SPA) is empty or contains only spaces indicating no higher menu level exists → The system sets the output selection code to signoff screen and clears the output message to spaces
[Clear Input Field - Reset input field when processing non-menu screen messages]
The message ID number != GC-MENU-SCREEN → The input field (GCMSG-INPUT-FIELD) is reset to spaces

Structural Validations

[4:Handle Enter Key Press]
User presses ENTER key → System sets ENTER-INVALID error message
[5:Handle Unavailable Function Selection]
User selects a function that is not available (SEL-NOT-AVAILABLE) → System sets FUNCTION-UNAVAILABLE error message
[9:Handle Invalid Function Key]
User presses a function key that is not ENTER, SEL-NOT-AVAILABLE, or UP-A-LEVEL → System sets PF-KEY-INVALID error message
[Handle Enter Key Press - Process invalid enter key usage and set appropriate error message]
The user presses the Enter key (PF-KEY equals ENTER-VALUE) → The system sets SYSTEM-MSG-NUM to ENTER-INVALID to display an error message indicating invalid Enter key usage
[Set Function Unavailable Error Message]
The user's function key selection equals the unavailable selection indicator (SEL-NOT-AVAILABLE) → The system sets the error message number to indicate function unavailability (FUNCTION-UNAVAILABLE)
[Handle Invalid Function Key - Process invalid PF key presses and set appropriate error message]
The function key pressed (GCMSG-PF-KEY) is not ENTER-VALUE, SEL-NOT-AVAILABLE, or UP-A-LEVEL → The system sets an invalid function key error message (PF-KEY-INVALID) in SYSTEM-MSG-NUM to inform the user of the invalid action

Module: GCX002 1 Consolidated Epic Story

Epic: GCX002 Complete EDI Specification Extracted from Legacy

Contains 941 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX002 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[152:Initialize Cargo Addition Process]
System initializes cargo addition process → 309 manual change flag is set, not-pre-emanifest flag is set, and PENDING status is assigned
[Initialize Entity Counter to Zero]
Entity array building begins → The entity counter is set to zero
[Initialize N1 Entity Processing]
Pre-edit processing begins for screen 3 → Entity processing counters and flags are initialized to starting values
[Initialize New Cargo Record]
The system initializes the cargo structure → The system creates empty cargo record with all segments initialized to default values
[Initialize Compression Process]
System begins compression processing → System initializes compression working fields and clears GCSCCS53 description segments

Core Acceptance Criteria

[82:Set Processing Mode and Screen ID]
Message ID is from main menu, cargo menu, or train display modules → Set processing mode to initial display and screen ID to cargo display screen 1
[83:Handle Program Entry Points]
Message ID indicates spawning program context → Preserve spawning program information and set initial display mode
[83:Handle Program Entry Points]
Message ID indicates log module entry → Save return data from USCUST-RESERVED field and set initial display mode
[83:Handle Program Entry Points]
Message ID indicates CDA cargo screen return → Restore saved processing mode and function from previous context
[20:Retrieve Cargo Data]
System needs to access cargo information → Use CCN as key to retrieve cargo control record and all associated segments
[87:Retrieve and Decompress Cargo Description]
Description data needs to be displayed or processed → Retrieve description data from GCSCCS52 and GCSCCS53 segments and decompress for display
[88:Build Entity Information Arrays]
Entity information needs to be processed → Extract entity data from GCSCCS55 segments and build working arrays for shipper, consignee, importer, and notify party information
[88:Build Entity Information Arrays]
Building entity information arrays → Process seal numbers from GCSCCS56 segment and handle special chemical shipment requirements
[133:Navigate Between Cargo Display Screens]
Current screen allows backward navigation → Navigate from Screen 3 to Screen 2 to Screen 1, show 'first page' message at Screen 1
[134:Navigate Between Cargo Display Screens Forward]
Current screen allows forward navigation → Navigate from Screen 1 to Screen 2 to Screen 3, show 'last page' message at Screen 3
[133:Navigate Between Cargo Display Screens]
User presses PF7 or PF8 for seal navigation → Navigate through seal pages 1-5 and show appropriate boundary messages
[134:Navigate Between Cargo Display Screens Forward]
User presses PF7 or PF8 for description scrolling → Navigate through description sequences 8 at a time and show appropriate boundary messages
[133:Navigate Between Cargo Display Screens]
User presses PF7 or PF8 for entity scrolling → Navigate through entity information 4 entities at a time and show appropriate boundary messages
[88:Build Entity Information Arrays]
CSA application is needed → Search for existing importer entity, create new importer if space available with AU table data, set CSA indicator
[23:Format Screen Display]
Amendment code needs to be displayed → Show amendment code only when 309 flag equals 'Y' for changes
[18:Finish Processing]
EDI transmission decision is needed → Skip for 6105I cargos and deleted post-arrival cargo, set notify customs flag for CPRS cargo, log non-CPRS cargo
[9:Print Cargo Documents]
Broker notification is needed → Validate delivery schedule requirements and send notifications via X12 EDI, Merlin, Fax, Internet, or Paper based on broker configuration
[Retrieve Cargo Data from Database]
The system attempts to retrieve cargo data from the database → The system uses the CCN as the primary key to fetch all cargo segments and related data
[Decompress Cargo Description]
The system processes the cargo description segments → The system decompresses description data across multiple segments and prepares it for screen display
[Build N1 Entity Arrays Shipper/Consignee/Notify Party]
The system processes entity information → The system builds working arrays for shipper, consignee, notify party, and importer entities with proper sequence tracking
[Display Amendment Codes if Change Operation]
The system is in change operation mode → The system displays the amendment code field for user input
[Process EDI Transmission]
The system processes EDI transmission → The system determines if customs notification is required and sends appropriate EDI messages to relevant systems
[Handle Broker Notifications]
The system handles broker notifications → The system sends notifications to relevant brokers through appropriate channels (EDI, Merlin, fax, internet, or paper) based on broker preferences and delivery schedules
[240:Apply Relaxed Edit Rules for Origin Station]
System applies relaxed edit rules for origin station → Origin station defaults to 'HAULAGE' if not provided and validation requirements are reduced
[241:Apply Relaxed Edit Rules for Destination Station]
System applies relaxed edit rules for destination station → Destination station defaults to 'HAULAGE' if not provided and validation requirements are reduced
[245:Apply Relaxed Edit Rules for Broker Information]
System applies relaxed edit rules for broker → Broker defaults to 'UNKNOWN' if not provided and validation requirements are reduced
[248:Apply Relaxed Edit Rules for Weight and Piece Count]
System applies relaxed edit rules for weight and pieces → Zero values are allowed for weight and piece count when relaxed edits are enabled
[154:Process Seal Number Array Management]
System processes seal number array management → Seal numbers are compressed and stored in GCSCCS56 segment with proper array structure
[155:Execute Cargo Database Addition]
System executes cargo database addition → New cargo record is inserted into database with all segments and indexes are cleared for return/transit cargo
[Commodity Code Validation]
The system processes the commodity code for dangerous goods classification → Lookup commodity code in COMODITY database and retrieve UN number from ISSCD segment if available, then set commodity description and danger information
[Future Date Check]
The system compares the input date to current system date → If input date is in the future, set future date error message and exit validation, otherwise continue to business rule validation
[Return Validation Result]
The system needs to return validation outcome to the calling process → The system returns the validation result including success flag and any error messages set during validation
[Skip Validation - Use Defaults]
If whether to apply strict validation or relaxed edit rules → If relaxed edits are allowed (not master manifest 6105E and not missing haulage SCAC), skip strict validation and use default values
[Apply Relaxed Edits?]
Relaxed edit rules are applicable for the current processing context → Copy the from port value to the to port field and proceed with sub-location calculation
[Copy From Port to To Port]
The system applies relaxed validation → Set the manifest to port equal to the manifest from port value
[Look up RF Table with Destination Station and Chop Code]
The system performs RF table lookup using destination station and chop code as keys → The system should retrieve the RF segment if a matching record exists
[Customer Code Found in RF Table?]
If the RF table lookup result → The system should proceed with customer sub-location processing if RF segment is found, otherwise proceed to CPRS processing
[Apply Customer Sub-Location Code]
The system applies customer sub-location code → The system should move the RF sub-location code to the cargo sub-location code field
[Look up MC Table for CPRS Sub-Location Code]
The system performs MC table lookup using manifest port as key → The system should retrieve the MC segment and extract the sub-location code
[Apply CPRS Sub-Location Code]
The system applies CPRS sub-location code → The system should move the MC sub-location code to the cargo sub-location code field
[Apply Default Zero Values]
Weight value is zero or not provided → Allow zero weight values and apply default zero values without generating validation errors
[Apply Default Zero Piece Count]
Piece count is not provided or is zero → Apply default zero piece count without generating validation errors
[Relaxed Edit Rules Apply?]
If validation strictness requirements → If relaxed edit rules apply, allow default zero values, otherwise enforce strict validation requirements
[Relaxed Edit Rules Apply?]
If relaxed edit rules should be applied based on cargo characteristics → If relaxed edit rules apply, allow default zero values for missing fields, otherwise require valid qualifier-unit combinations
[Apply Default Qualifier if Relaxed Edits]
The system processes the validation error under relaxed edit conditions → The system applies a default qualifier value instead of rejecting the input
[Apply Default Weight Units if Relaxed Edits Allowed]
Relaxed edits are allowed for the current cargo type → Apply default weight units and mark validation as successful
[compress multi-line descriptions for storage]
Description compression is triggered → Use GCCCOMP utility to compress description data for storage in GCSCCS53 segments
[compress multi-line descriptions for storage]
Sequence numbering is required → Assign sequential numbers to description segments to maintain proper ordering
[Validate CSA Cargo Function Restrictions]
A user attempts to perform CHANGE, DELETE, RELEASE, CANCEL-RELEASE, or RE-ADD function → The system denies the operation and displays error message indicating CSA cargo cannot be modified
[Generate Train Audit Messages]
The system processes the train update → The system generates detailed audit log messages including train information, cargo details, and change reason codes
[Delete Single Follower Manifest]
The deletion is confirmed by the user → The system updates cargo status to DELETED, clears cargo indexes, preserves train information if applicable, and sends EDI delete transmission for 6105E cargo types
[Process EDI Transmission]
The system processes EDI transmission → Send delete notification to customs systems for 6105E cargo types and update transmission logs
[Send EDI Notifications]
EDI notifications are required for the deleted manifests → The system must send appropriate EDI deletion notifications to customs, brokers, and other relevant parties
[Parse CCN Structure]
The system parses the CCN structure → The CCN is decomposed into identifiable components for further processing
[Extract Base CCN Portion]
The system extracts the base CCN portion → The base portion containing master manifest information is isolated
[Iron Highway Cargo?]
System processes post-update operations → System checks if cargo is Iron Highway type to determine if EDI transmission to customs system is required
[Send EDI Transmission to Customs System]
System processes post-update operations → System sends EDI transmission to customs system to notify of cargo re-add
[Create Audit Log Entry CARGO RE-ADDED]
System completes the re-add operation → System creates audit log entry with message 'CARGO RE-ADDED' including cargo details and timestamp
[Display Success Message]
System completes all re-add operations → System displays success message to user confirming cargo has been re-added
[Return to Display Mode]
System finishes displaying success message → System sets processing mode to VIEW and returns to cargo display screen
[Follower Manifest?]
An arrival request is submitted for the cargo → The system must reject the arrival request with error message indicating follower manifests cannot be arrived
[Send Arrival Message to Queue]
The system processes the arrival transaction → An arrival message must be sent to the processing queue with cargo and port information
[Check if Follower Manifest]
User attempts to process cargo arrival → System must reject the arrival request and display error message that follower manifests cannot be arrived
[Check CN Rail Conditions]
User attempts to process cargo arrival AND cargo type is 9 or CCN starts with '6105P' AND carrier is 999 → System must reject the arrival request and display error message that CN Rail arrival is not allowed for this cargo type
[Validate Border Arrival Requirements]
User attempts to process inland arrival AND border arrival date is not set or is empty → System must reject the arrival request and display error message that border arrival is required before inland arrival
[Send Arrival Message GCT1481E to Queue]
The arrival processing is ready to complete → The system sends GCT1481E arrival message to the processing queue
[Is Follower Manifest?]
The cargo is identified as a follower manifest (not a master manifest) → The system skips arrival processing and does not determine port code or spawn arrival messages
[Is Transit/Ocean Cargo?]
The cargo status is either transit or ocean → The system skips arrival processing and does not determine port code or spawn arrival messages
[Is Iron Highway Cargo 6105E?]
The cargo type is 6105E (Iron Highway cargo) → The system skips arrival processing and does not determine port code or spawn arrival messages
[Is Carrier Index = 105?]
The carrier index != 105 → The system skips arrival processing and does not determine port code or spawn arrival messages
[Set Arrival Port Code]
The system processes the extracted port code → The system sets the arrival port code for use in arrival message generation
[Spawn GCT1481E Arrival Message]
The system completes port code determination → The system spawns GCT1481E arrival message with the determined port code
[No Port Code Available]
No CM table entry is found for the destination station number → The system indicates that no port code is available and does not spawn arrival messages
[Edit Function Authorization]
If the cancel arrival function is currently available → The system must check if the cancel arrival function is enabled and accessible
[Format Print Request Message]
The system formats the print request message → The print request message is properly formatted with cargo data and routing information
[Spawn Message Queue Transaction]
The system spawns the message queue transaction → The appropriate transaction (GCT0191E or similar) is spawned to handle the print request transmission
[Send Broker Notifications via Multiple Channels]
The system sends broker notifications → Notifications are sent via configured channels including X12 EDI, MERLIN, Internet, Fax, or Paper based on broker preferences and delivery schedule requirements
[Generate Print Confirmation]
The system generates print confirmation → A confirmation message is displayed to the user indicating successful print request submission
[Send Broker Notifications]
The system processes broker notifications → The system sends notifications via X12 EDI by setting broker notification flag and calling GCCS309C, via Merlin by spawning GCT0191E with Merlin ID, via fax by spawning GCT0191E with fax number, via internet by spawning GCT0191E with internet address, or via paper by setting batch print call letters
[Display Print Confirmation]
The system displays confirmation to the user → The system shows appropriate confirmation message - 'PLEASE CONTINUE' for special manifests or standard completion message for regular print requests
[Delivery Schedule Type?]
Evaluating delivery schedule type → Route to appropriate validation based on schedule type: Default, Immediate, Consist, or Arrival
[Immediate Schedule - Check Train Assignment]
Processing delivery schedule → Check if cargo is assigned to a train before allowing delivery
[Access B1 Table Segment]
The system searches the B1 table → Access the B1 table segment using the prepared search key
[Set Broker Configuration Data]
The system processes broker validation → Set broker to 'UNKNOWN' as default value
[Access B1 Table Segment]
The system performs a secondary lookup → Search B1 table again using broker code, Canadian flag, and generic port code '000'
[Apply Relaxed Edit Rules if Allowed]
Relaxed edit rules are enabled for the current processing context → Set the broker to default value 'UNKNOWN' instead of rejecting the validation
[Cargo Status Valid for Release]
A user attempts to perform RELEASE function → The system rejects the function and displays an error message
[Process EDI Transmission]
The system processes EDI transmission requirements → Release notification is sent to customs via GCCS309C with appropriate action codes
[Handle Broker Notifications]
The system processes broker notification requirements → Release notifications are sent to brokers via configured delivery methods (EDI, Merlin, Fax, Internet, Paper)
[Release can be cancelled?]
The system validates release cancellation eligibility → Display error message that CSA cargo releases cannot be cancelled manually
[Release can be cancelled?]
The system validates release cancellation eligibility → Display error message that follower manifest releases cannot be cancelled
[Display Success Message]
The system completes the process → A success message must be displayed and the user returned to the cargo display screen
[Display Success Message]
The system completes all cancellation activities → A success message is displayed to confirm the place cancellation
[Query Successful?]
Query operation completes → If query is successful, display query results to user; if query fails, display error message to user
[Return to Cargo Display]
Query operation finishes → System returns user to the main cargo display screen for continued cargo processing
[Display Success Message]
The system displays success message → The system should show a confirmation message indicating successful multi-car manifest creation
[Return to Display Mode]
The system returns to display mode → The system should transition to display mode showing the newly created follower manifest
[Return to Request Screen]
The system returns to request screen → The system should navigate back to the request screen allowing user to retry or modify the request
[Display Confirmation Message to User]
The system detects the mismatch → A confirmation message is displayed to inform the user of the car ID discrepancy
[Present Generated CCN to User]
The system requests user decision on CCN acceptance → The generated CCN is presented to the user for review and confirmation
[Generate Delivery Audit Log Format Date for Message]
The system completes the delivery process → An audit log entry is created with formatted delivery date and cargo information for tracking purposes
[Set Origin Country Information]
The system processes origin country setup → Retrieve AU table segment using consignee chop and commodity code to establish origin country for CSA processing
[Apply CSA Importer Data If Required]
The system checks for existing importer entity in S55 data → If no importer entity found and space available, create new IM entity with AU table importer name, business number, qualifier 'M5', default address 'NA', and set CSA indicator ON
[Process EDI Transmission]
The system processes EDI transmission requirements → Skip transmission for 6105I cargos and deleted post-arrival cargo, set notify customs flag for CPRS cargo and log automatic transmission, otherwise log non-CPRS status
[Create Audit Log Entry]
The system creates audit log entry → Generate 'CARGO FINISHED' log entry via GCT1051E spawn with cargo details and processing information
[Display Success Message]
The system displays completion status → Show success message to user and set processing mode to VIEW for subsequent operations
[Update Database Records]
Database update is required → Cargo records must be updated with modified data, 309 manual change flag must be set, and appropriate indexes must be maintained for waybill and destination station information
[274:Generate Train Audit Messages]
TRAIN-REQUIRED-RESEND flag is set → Train records must be updated with resend flag and modification timestamps, and detailed audit log messages must be created documenting the cargo changes that triggered train resend
[181:Set Origin Country Information]
Origin country information is needed for CSA processing → AU table segment must be retrieved using consignee chop and commodity code to establish origin country data for subsequent CSA application logic
[182:Apply CSA Importer Data If Required]
CSA processing requirements are evaluated → CSA application is required if AU segment exists, importer name is present, and business number is available
[Set Status to SENT]
Cargo is 6105E type and not a follower manifest → Cargo status must be set to SENT to trigger automatic EDI transmission to customs systems
[58:Process EDI Transmission]
EDI transmission is required → EDI transmission must be skipped for 6105I cargo types, deleted cargo with border arrival must log 'MANIFEST NOT SENT TO CUSTOMS - DELETED POST ARR', non-CPRS cargo must log 'MANIFEST NOT SENT TO CUSTOMS - NON-CPRS', and CPRS cargo must set notify customs flag and log automatic transmission
[Send Data to Customs System]
Cargo data needs to be sent to customs → Waybill index must be updated from original waybill data if missing, and GCCS309C must be called to process EDI transmission with customs notification
[59:Handle Broker Notifications]
Broker notifications are required → Broker lookup must be performed using BK table with broker name, Canadian flag, and port code, and delivery schedule must be validated against train assignment and arrival requirements
[Send Notifications to Brokers]
Notifications need to be sent to brokers → Notifications must be sent via appropriate channels: X12 EDI sets broker notification flag and calls GCCS309C, Merlin/Fax/Internet spawn GCT0191E with respective contact information, and Paper sets batch print call letters or performs paper print
[Generate Finish Audit Message]
Finish audit message needs to be generated → 'CARGO FINISHED' log entry must be created via GCT1051E spawn, and additional processing checks must be performed for spawning GCT1481E when required
[Display Success Confirmation]
Finish processing is complete → Success confirmation must be displayed to the user and processing mode must be set to VIEW to prevent further modifications
[Search Existing N1 Entities for Importer Type 'IM']
The system searches through existing N1 entity segments for entity type 'IM' → The system identifies whether an importer entity already exists in the cargo data
[Skip CSA Processing - Importer Already Exists]
If whether to create a new importer entity → CSA processing is completed without creating a new importer entity
[Populate Importer Name from AU Table]
The system populates the importer name field → The N102 field is set to the importer name from the AU table segment
[Set Business Number from AU Table]
The system populates the business number field → The N104 field is set to the business number from the AU table segment
[Set Business Number Qualifier from AU Table]
The system populates the business number qualifier field → The N103 field is set to the business number qualifier from the AU table segment
[Fetch Related Segments]
The cargo retrieval process continues → The system fetches all related segments including descriptions, entities, seal numbers, and configuration data
[Retrieve GCSCCS52 Description]
Description data retrieval is initiated → The system fetches GCSCCS52 description segments and prepares them for decompression
[Retrieve GCSCCS53 Description]
Extended description data retrieval is initiated → The system fetches GCSCCS53 description segments for comprehensive cargo information
[Retrieve GCSCCS55 N1 Entities]
Entity data retrieval is initiated → The system fetches GCSCCS55 N1 entity segments containing shipper, consignee, importer, and notify party information
[Retrieve GCSCCS56 Seal Numbers]
Seal number data retrieval is initiated → The system fetches GCSCCS56 seal number segments for cargo security tracking
[Retrieve GCSCCS99 Configuration]
Configuration data retrieval is initiated → The system fetches GCSCCS99 configuration segments containing cargo control parameters
[Decompress Cargo Description]
Description processing is initiated → The system decompresses the cargo description data using GCCCOMP utility for readable format
[Build N1 Entity Arrays]
Entity array construction is initiated → The system builds working arrays containing entity information organized by type (shipper, consignee, importer, notify party)
[Process Seal Number Arrays]
Seal number processing is initiated → The system organizes seal numbers into paginated arrays supporting up to 5 pages of seal data
[Read GCSCCS55 Segment]
The system processes entity information → The GCSCCS55 segment data is read to extract entity details
[Extract Entity Information]
The system extracts entity information → All entity data fields are retrieved from the segment for mapping
[Map Entity ID and Name]
The system maps entity identification data → The chop code (SC301), entity ID (N101), and entity name (N102) are mapped to the working array
[Map Address Information]
The system maps address information → Address line 1 (N301) and address line 2 (N302) are mapped to the working array
[Map City, State, Country]
The system maps location information → City (N401), state/province (N402), and country (N404) are mapped to the working array
[Map Postal Code]
The system maps postal code information → The postal code (N403) is mapped to the working array
[Map Contact Information]
The system maps contact information → Contact name (PER02), contact qualifier (PER03), and contact number (PER04) are mapped to the working array
[Store in Working Array]
The system stores the entity data → All mapped entity information is stored in the corresponding working array position
[Retrieve Seal Numbers from GCSCCS56]
The system processes seal numbers for display → Seal numbers are retrieved from the cargo record and made available for pagination
[Show First Page Message]
User attempts to navigate to previous page using PF7 → System displays 'First Page' message and remains on current page
[Show Last Page Message]
User attempts to navigate to next page using PF8 → System displays 'Last Page' message and remains on current page
[Update GCSCCS56 Segment]
System saves seal data → The GCSCCS56 segment in the cargo record is updated with the processed seal information
[Display Amendment Codes]
The amendment code display section is processed and the 309 sent flag equals 'Y' → The system displays the amendment code field, otherwise the amendment code field remains hidden
[Display N1 Entity Information]
The entity display section is processed → The system displays up to 4 entities at a time showing entity type, name, address, city, state, postal code, country, and contact information with navigation messages for additional entities
[Apply Field Protection Rules]
Field protection logic is applied and cargo has pending status or edit errors exist → The system sets input field to no-cursor protect mode, protects importer/sub-location/EDA border date fields on Screen 1, allows super users to modify sub-location in CHANGE mode, makes description fields non-protected for CHANGE/ADD modes on Screen 2, and sets cursor on function field for Screen 3 errors
[PF1 - Backward Navigation]
The system processes the PF1 key press → The system should navigate to the previous screen in sequence (Screen 3 to Screen 2, Screen 2 to Screen 1) or display 'First Page' message if already on Screen 1
[PF2 - Forward Navigation]
The system processes the PF2 key press → The system should navigate to the next screen in sequence (Screen 1 to Screen 2, Screen 2 to Screen 3) or display 'Last Page' message if already on Screen 3
[Display _First Page_ Message]
User presses PF7 to navigate backward → System displays 'First Page' message and remains on page 1
[Display _Last Page_ Message]
User presses PF8 to navigate forward → System displays 'Last Page' message and remains on page 5
[Display _First Page_ Message]
User presses PF7 key → System displays 'FIRST-PAGE' message AND does not change description display position
[Display _Last Page_ Message]
User presses PF8 key → System displays 'LAST-PAGE' message AND does not change description display position
[At Beginning of Entities?]
System checks current panel position → If at beginning of entity list, system displays beginning message, otherwise calculates previous panel start
[At End of Entities?]
System checks current panel position → If at end of entity list, system displays end message, otherwise calculates next panel start
[Display _Beginning of Entities_ Message]
System determines user is already at the beginning of entity list → System displays message indicating user is at the beginning of entities and cannot navigate further backward
[Display _End of Entities_ Message]
System determines user is already at the end of entity list → System displays message indicating user is at the end of entities and cannot navigate further forward
[Display Updated Screen 3]
System completes navigation processing → System displays the updated Screen 3 with the correct entity panel, field attributes, and any boundary messages
[Apply Default Values]
The system processes origin station validation → Station name is set to 'HAULAGE' and province is set to 'MI' as default values
[Apply Default Values]
Edit relaxation is allowed for the current processing context → The system sets default station name to 'HAULAGE' and default province to 'ON'
[Copy From Port to To Port]
The system processes manifest port validation → The manifest from port value should be copied to the manifest to port field
[Customer Sub-Location Found?]
The lookup returns a valid RF segment with sub-location data → The system confirms customer sub-location is found and proceeds with customer processing
[Set Customer Sub-Location Code]
The system processes the RF segment data → The customer sub-location code is extracted from RF table and assigned to the cargo record
[CPRS Sub-Location Found?]
The lookup returns a valid MC segment with sub-location data → The system confirms CPRS sub-location is found and proceeds with CPRS processing
[Set CPRS Sub-Location Code]
The system processes the MC segment data → The CPRS sub-location code is extracted from MC table and assigned to the cargo record
[Record UN Number]
The system processes the dangerous goods details → If a UN number exists in the ISSCD segment of the dangerous goods record, record the UN number for the cargo
[Compress Multi-Line Description]
The system processes multiple description lines → Compress all description lines into standardized segments, removing empty lines and maintaining proper sequence numbering
[Update Description Segments]
The system updates the cargo record → Store compressed description data in appropriate cargo segments and update sequence tracking information
[At Beginning of Description?]
The system checks current position in description data → If current position is at the first description line, display 'First Page' message, otherwise calculate line position for display indicators
[At End of Description?]
The system checks current position in description data → If current position is at the last description line, display 'Last Page' message, otherwise calculate line position for display indicators
[Display First Page Message]
The system needs to inform user of position → Display 'First Page' message to indicate no more description lines are available above current position
[Display Last Page Message]
The system needs to inform user of position → Display 'Last Page' message to indicate no more description lines are available below current position
[Format Description Display]
The system formats the description display → Format current description lines for display with navigation indicators and position messages as appropriate
[Entity ID Code Present?]
The entity ID code field is empty or not present → The system continues processing without performing entity type validation
[Access CT Table Segment]
Country validation is initiated → Access the CT table segment containing country reference data
[Search for Country Code in CT Table]
Country code lookup is performed → Search CT table using the provided country code as search key
[Look up AC Table for Country 'CA']
The system performs a table lookup using country code 'CA' → The system should search the AC segment in the GCSTBRT table for the amendment code
[Generate Train Audit Messages]
The system processes the train resend update → Generate audit log message indicating cargo change requires train resend with cargo control number, train ID, and change reason
[Copy Description Data]
The system copies description information to follower → All description segments and commodity information are transferred
[Copy N1 Entity Data]
The system copies entity data to follower → All shipper, consignee, importer, and notify party information is transferred
[Search Existing N1 Entities for Importer]
The system searches existing N1 entities → The system scans all N1 segments looking for entity type 'IM' (Importer) and sets importer found indicator if located
[Importer Entity Found?]
An importer entity with type 'IM' is found in the existing N1 segments → CSA processing terminates as importer already exists and no further action is required
[Populate Importer Name from AU Table]
The system populates the importer name → The N102 field (entity name) is populated with the importer name from the AU table segment
[Set Business Number from AU Table]
The system sets the business number → The N104 field (identification code) is populated with the business number from the AU table segment
[Spawn GCT1051E Message for Train Update]
The train update notification process is initiated → The system spawns program GCT1051E to generate and send train update messages to downstream systems
[Is Iron Highway Idler Cargo? CCN starts with 6105I]
The cargo control number starts with '6105I' → Skip EDI transmission processing and exit the transmission routine
[Is Cargo Deleted?]
EDI transmission processing is initiated → Create an audit log entry stating 'MANIFEST NOT SENT TO CUSTOMS - DELETED POST ARR' and continue with EDI transmission
[Call GCCS309C for EDI Transmission to Customs]
The cargo is not CPRS cargo (don't notify customs flag is set) → Log 'MANIFEST NOT SENT TO CUSTOMS - NON-CPRS' and skip customs notification
[Call GCCS309C for EDI Transmission to Customs]
EDI transmission processing is initiated → Set notify customs flag to 'Y', log 'CARGO SENT AUTOMATICALLY', and call GCCS309C for EDI transmission
[Call GCCS309C for EDI Transmission to Customs]
EDI transmission processing is initiated → Update the waybill index key from the original waybill data before proceeding with transmission
[Primary Broker Exists?]
Primary broker name exists in the cargo record → Process primary broker notification through available communication channels
[Send Notification to Secondary Broker via: • X12 • MERLIN • FAX • Internet • Paper]
Broker notification is required → Send notifications via configured channels: set broker notification flag and call GCCS309C for X12 EDI, spawn GCT0191E for MERLIN/FAX/Internet, or set batch print call letters for paper notifications
[Send X12 Notification]
The system processes X12 notification for the broker → Set broker notification flag and call GCCS309C program to transmit X12 EDI notification to the broker
[Send X12 to Secondary Broker]
The system processes X12 notification for the secondary broker → Set broker notification flag and call GCCS309C program to transmit X12 EDI notification to the secondary broker
[Format Export Message]
The system formats the export message → The export message is formatted according to the required protocol specifications with all necessary data elements
[Send Export Transaction to Message Queue]
The system sends the export transaction to the message queue → The export transaction is transmitted to the designated message queue for further processing
[Create Export Audit Log Entry]
The system creates an export audit log entry → An audit log entry is created with transaction details, timestamp, and processing status for compliance tracking
[Format Delivery Date]
The delivery date is available in YYYYMMDD format → The delivery date is formatted as MM/DD/YYYY for inclusion in the audit log message
[Set Action Description]
Action-specific information is available (reason codes, screen numbers, delivery dates) → A descriptive action message is formatted including relevant details for the audit trail
[Send to Message Queue]
The audit message is ready for transmission → The audit message is sent to the message queue for processing by the external logging system
[GCT1051E Message]
The GCT1051E transaction is invoked with the audit message data → The audit log entry is processed and stored according to system logging standards
[Set Return Message]
System finalizes return navigation processing → System sets return message and context information appropriate for the calling program
[Transfer Control to Calling Program]
System completes PF11 return processing → System transfers control to the calling program with prepared context and message
[Look up Commodity in COMODITY Segment]
The system performs a lookup in the COMODITY database segment → Retrieve the commodity record containing description and hazardous material classification information
[Retrieve UN Number]
The system accesses the ISSCD segment of the commodity record → Extract and store the UN number for regulatory compliance and shipping documentation
[Skip EDI for Idler Cargo]
The cargo control number starts with '6105I' (Iron Highway idler cargo) → The system skips EDI transmission processing for this cargo
[Create Report Message]
The system creates the final report message → A complete customer notification message is created with all required cargo and operation information
[Send to Message Queue GCT1401E]
The system sends the report for processing → The report message is transmitted to the GCT1401E message queue for customer notification processing
[Customer Notification Sent]
The transmission is completed successfully → The system confirms that the customer notification has been sent and the reporting process is complete
[Is Cargo Iron Highway Type? CCN starts with 6105E]
The cargo control number starts with '6105E' indicating Iron Highway cargo type → Relaxed edits must be disabled and strict validation rules must be applied
[Is Linehaul Cargo on Screen 2 or 3?]
The cargo is classified as linehaul cargo type → Relaxed edits must be disabled to ensure complete data entry for linehaul requirements
[Apply Default Values: Origin Station: 'HAULAGE', Origin Province: 'MI', Destination Province: 'ON', Broker: 'UNKNOWN', Load/Empty Status: 'L', Weight/Piece Count: Zero]
Required fields are missing or empty → Default values must be applied: Origin Station as 'HAULAGE', Origin Province as 'MI', Destination Province as 'ON', Broker as 'UNKNOWN', Load/Empty Status as 'L', and Weight/Piece Count as Zero
[Copy Manifest From-Port to To-Port if missing]
The manifest to-port field is missing or empty → The manifest from-port value must be copied to the manifest to-port field
[Apply Zero Values for Weight and Quantity when missing]
Weight or quantity fields are missing or empty → Zero values must be applied to the missing weight and quantity fields
[Set Default Business Values for Required Fields]
Required business fields are missing or empty → Appropriate default business values must be assigned to ensure data completeness and processing continuation
[Enable Relaxed Edits - Apply default values where appropriate]
The cargo is not Iron Highway type AND haulage SCAC is present AND cargo is not linehaul on screens 2 or 3 → Relaxed edits must be enabled to allow default value application and reduced validation requirements
[Disable Relaxed Edits - Iron Highway requires strict validation]
The cargo is Iron Highway type:
haulage SCAC is missing
cargo is linehaul on screens 2
3
→ Relaxed edits must be disabled and strict validation rules must be applied requiring complete data entry
[Send EDI Transmission]
The status transition is completed → An EDI transmission should be sent to customs systems with the updated cargo information
[Notify Brokers]
The status transition is completed → Broker notifications should be sent via the broker's preferred method (EDI, Merlin, Fax, Internet, or Paper)
[Generate N1 Entity Keys BISH03 Section]
Processing N1 entity segments for database storage → Generate unique keys using cargo control number, entity type code, and sequence number for each N1 entity segment
[Generate Seal Number Keys CHEM01 Section]
Processing seal number data for database storage → Generate unique keys using cargo control number and seal sequence number for each seal number segment
[Generate Description Keys Sequence Processing]
Processing description segments for database storage → Generate unique keys using cargo control number and sequential description line numbers
[Generate Reference Keys Other Info Processing]
Processing reference information segments for database storage → Generate unique keys using cargo control number and reference sequence number for each reference pair
[Set Primary Key Fields]
Setting up segment keys for database operations → Set cargo control number as the primary key component for all segments
[Set Sequence Numbers]
Processing multi-occurrence segments like descriptions, seals, or entities → Assign sequential numbers starting from 1 to distinguish each occurrence
[Set Chop Code]
Processing N1 entity segments with business entity data → Set chop code based on the entity's business identifier or default to cargo-specific chop
[Set Entity Type Code]
Processing entity data for database storage → Set entity type code as SH for shipper, CN for consignee, IM for importer, and N1 for notify party
[Set Segment Identifiers]
Organizing cargo data into database segments → Set segment identifiers as BISH03 for entities, CHEM01 for seals, and appropriate codes for descriptions and references
[Store Generated Keys]
Finalizing segment preparation for database storage → Store generated keys in the appropriate key fields of each database segment structure
[Update Key Counters]
Completing key generation for a segment type → Update the counter to reflect the next available sequence number for future segments of the same type
[Process Next Segment]
Processing segments for a cargo record → Continue processing each remaining segment type until all segments have generated keys
[Add/Change Mode]
Field attributes are being set for screen display → Fields should be evaluated for editability based on user authorization and cargo status
[Super User]
Field protection attributes are being applied → Business number fields and other restricted fields should be made editable
[Pending/Active Cargo]
Field attributes are being evaluated → Fields should be made editable based on user type and field-specific restrictions
[Business Number Fields]
Field protection is being applied → The field should be protected for regular users but editable for super users
[Standard Fields]
Field protection is being applied in add or change mode → The field should be made editable if cargo status allows modifications
[115: Spawn Cargo Transaction Message]
The system processes a cargo transaction spawn request → The system prepares transaction data, sets security information, applies date/time stamps, sets action code, and sends GCT1051E message to the message queue
[235: Spawn Export Transaction Message]
The system checks export flag status and finds it is not set → The system sends GCT1231E message to the message queue for export processing
[Send Print Request Message]
The system receives a print request message → The system sets print destination ID and sends GCT0191E message to the message queue
[Send Arrival Message]
The system processes an arrival message request → The system sets arrival port code and sends GCT1481E message to the message queue
[Send Customer Report Message]
The system processes a customer report request → The system formats report data and sends GCT1401E message to the message queue
[Send Iron Highway Message]
The system processes an Iron Highway status message → The system sets status change data and sends Iron Highway notification message
[Message Type?]
If the message type → The system routes to cargo transaction, export transaction, print request, arrival processing, customer report, or Iron Highway status processing based on message type
[Apply Default Values if Relaxed Edits Allowed]
The validation fails but defaults are available → The system applies appropriate default values such as 'HAULAGE' for station names, 'UNKNOWN' for broker names, or zero values for numeric fields instead of setting validation errors
[Update Description Segments with Compressed Data]
The system updates the cargo record segments → The compressed description data is moved to the appropriate description segments in the cargo record
[Main Menu/Cargo Menu Entry]
The system determines the entry point source → The processing mode should be set to initial display and screen should be set to cargo display screen 1
[Equipment/Waybill Display Entry]
The system processes the entry point → The spawning program context should be preserved and processing mode should be set to initial display
[Save Return Data]
The system processes the log module entry → Return data should be saved from USCUST-RESERVED area and processing mode should be set to initial display
[Restore Previous Processing Mode]
The system processes the return from CDA screens → The previously saved processing mode and function code should be restored from saved state
[Set Initial Display Mode]
The message ID indicates access from main menu (GC-MENU-SCREEN), cargo menu (CARGO-MENU-SCREEN), or train display (TRAIN-DISPLAY-SCREEN) → The system sets processing mode to initial display (CST-FCT-ID-INITIAL-DISPLAY) and screen ID to cargo display screen 1 (CARGO-DISPLAY-SCR1-MOD)
[Set Return Program Context]
The message ID indicates access from equipment display (EQUIPMENT-DISPLAY-SCREEN), waybill display (WAYBILL-DISPLAY-SCREEN), or destination display (DESTINATION-DISPLAY-SCREEN) → The system preserves the spawning program context, sets processing mode to initial display (CST-FCT-ID-INITIAL-DISPLAY), and sets screen ID to cargo display screen 1 (CARGO-DISPLAY-SCR1-MOD)
[Set Log Module Context]
The message ID indicates access from log module (LOG-MODULE-SCREEN) → The system saves return data from USCUST-RESERVED area, sets processing mode to initial display (CST-FCT-ID-INITIAL-DISPLAY), and sets screen ID to cargo display screen 1 (CARGO-DISPLAY-SCR1-MOD)
[Restore Previous Processing Mode]
The message ID indicates access from CDA cargo screens (CARGO-REPORT-SCR1-MOD, CARGO-REPORT-SCR2-MOD, CARGO-REPORT-SCR3-MOD, or CARGO-REPORT-REQUEST-MOD) → The system restores the saved processing mode from GCCS-SAVED-PROCESSING-MODE and restores the saved function code from GCCS-SAVED-FUNCTION-CODE
[Main Menu Entry]
The message ID indicates main menu entry → Set processing mode to initial display and set current screen to cargo display screen 1
[Cargo Menu Entry]
The message ID indicates cargo menu entry → Set processing mode to initial display and set current screen to cargo display screen 1
[Train Display Entry]
The message ID indicates train display entry → Set processing mode to initial display and set current screen to cargo display screen 1
[Equipment Display Entry]
The message ID indicates equipment display entry → Save the spawning program context, set processing mode to initial display, and set current screen to cargo display screen 1
[Waybill Display Entry]
The message ID indicates waybill display entry → Save the spawning program context, set processing mode to initial display, and set current screen to cargo display screen 1
[Destination Display Entry]
The message ID indicates destination display entry → Save the spawning program context, set processing mode to initial display, and set current screen to cargo display screen 1
[Log Module Entry]
The message ID indicates log module entry → Save the return data from USCUST-RESERVED area, set processing mode to initial display, and set current screen to cargo display screen 1
[CDA Cargo Screen Entry]
The message ID indicates CDA cargo screen entry → Restore the saved processing mode and function code from previous session
[Program Entry Point Detection]
The system checks the message ID value → Route to the appropriate entry point processing based on the message ID value
[Compare Current CCN with Previous CCN]
The system compares the current CCN input field value with the previously saved CCN value → The comparison result determines whether the CCN value has changed from the previous processing cycle
[Set Transaction Code to Initial Display]
The processing mode is set to initial display mode → The transaction code should be set to initial display transaction code and stored for spawn message routing
[Set Transaction Code to Add Cargo]
The processing mode is set to add cargo mode → The transaction code should be set to add cargo transaction code and stored for spawn message routing
[Set Transaction Code to Change Cargo]
The processing mode is set to change cargo mode → The transaction code should be set to change cargo transaction code and stored for spawn message routing
[Set Transaction Code to Delete Cargo]
The processing mode is set to delete cargo mode → The transaction code should be set to delete cargo transaction code and stored for spawn message routing
[Set Transaction Code to Print Documents]
The processing mode is set to print documents mode → The transaction code should be set to print documents transaction code and stored for spawn message routing
[Set Transaction Code to Release Cargo]
The processing mode is set to release cargo mode → The transaction code should be set to release cargo transaction code and stored for spawn message routing
[Set Transaction Code to Deliver Cargo]
The processing mode is set to deliver cargo mode → The transaction code should be set to deliver cargo transaction code and stored for spawn message routing
[Set Transaction Code to Finish Processing]
The processing mode is set to finish processing mode → The transaction code should be set to finish processing transaction code and stored for spawn message routing
[Set Transaction Code to Query Status]
The processing mode is set to query status mode → The transaction code should be set to query status transaction code and stored for spawn message routing
[Set Transaction Code to Arrival Processing]
The processing mode is set to arrival processing mode → The transaction code should be set to arrival processing transaction code and stored for spawn message routing
[Store Transaction Code for Spawn Message]
The transaction code needs to be preserved for spawn message routing → The transaction code should be stored in the spawn message structure to maintain processing context
[Access GCSCCS52 Segment]
The system needs to access description information → The system should access the GCSCCS52 segment which contains the primary description data
[Access GCSCCS53 Segment]
The system needs to retrieve complete description information → The system should also access the GCSCCS53 segment which contains additional description lines
[Read Compressed Description Lines]
The system needs to process the description information → The system should read the compressed description lines from both GCSCCS52 and GCSCCS53 segments
[Call Decompression Routine]
The system needs to make description data readable for display → The system should call the decompression routine to convert compressed data into displayable format
[Set Empty Description Message]
The system needs to display description information → The system should set an appropriate empty description message for user display
[Get First N1 Entity Segment GCSCCS55]
System begins building entity arrays → The first GCSCCS55 N1 entity segment is retrieved
[N1 Entity Segment Found?]
An entity segment retrieval is attempted → System checks if the N1 entity segment was found and continues processing if found, or terminates entity processing if not found
[Map Entity ID N101]
Entity information is being extracted → The entity ID from N101 field is mapped to the working array
[Map Entity Name N102]
Entity information extraction occurs → The entity name from N102 field is mapped to the working array
[Map Address Line 1 N301]
Address data is being extracted → The primary address line from N301 field is mapped to the working array
[Map Address Line 2 N302]
Address data extraction occurs → The secondary address line from N302 field is mapped to the working array
[Map City N401]
Location data is being extracted → The city name from N401 field is mapped to the working array
[Map State/Province N402]
Geographic data extraction occurs → The state or province code from N402 field is mapped to the working array
[Map Country N404]
Country data extraction occurs → The country code from N404 field is mapped to the working array
[Map Postal Code N403]
Postal data extraction occurs → The postal code from N403 field is mapped to the working array
[Map Contact Qualifier PER02]
Contact data extraction occurs → The contact name qualifier from PER02 field is mapped to the working array
[Map Contact Method PER03]
Communication data extraction occurs → The communication method qualifier from PER03 field is mapped to the working array
[Map Contact Number PER04]
Contact number extraction occurs → The contact number from PER04 field is mapped to the working array
[Get Next N1 Entity Segment]
System needs to process additional entities → The next GCSCCS55 N1 entity segment is retrieved
[Store Total Entity Count]
Entity array building is complete → The total entity count is stored for future reference
[Display _More Above_ Message]
The system processes seal page display formatting → Display 'More Above' message to indicate additional seal pages are available in the upward direction
[Display _More Below_ Message]
The system processes seal page display formatting → Display 'More Below' message to indicate additional seal pages are available in the downward direction
[Clear Navigation Messages]
The system processes seal page display formatting → Clear all navigation messages (More Above/More Below) since no additional pages exist in the respective direction
[Set 'First Page' Message]
No previous pages are available → System displays 'beginning of descriptions' message and clears more above indicator
[Set 'Last Page' Message]
No additional pages are available → System displays 'end of descriptions' message and clears more below indicator
[Clear 'More Above' Indicator]
First page message is displayed → System clears the 'More desc above' indicator as no previous content exists
[Clear 'More Below' Indicator]
Last page message is displayed → System clears the 'More desc below' indicator as no additional content exists
[Set All Fields Protected]
The processing mode is VIEW or DISPLAY → All input fields are set to protected status to prevent editing
[Set Fields Editable]
The cargo status is PENDING or ACTIVE (not released) → Input fields are set to editable status to allow user modifications
[Allow Business Number Edit]
The user has SUPER-USER authority → All fields including business number fields are set to editable status
[Retrieve CSA Importer Information]
The system processes the cargo record for CSA indicator determination → The system retrieves importer information from the cargo record's entity data segments
[Handle N1 Entity Pagination Show More Above/Below Indicators]
Screen 3 is displaying entity information → Pagination indicators must show 'More Above' or 'More Below' messages when additional entities are available for viewing
[Set Screen Field Attributes Editable vs Protected Fields]
Screen 3 field attributes are being set → Fields must be set as editable for ADD/CHANGE modes and protected for VIEW mode
[Determine Current N1 Panel Being Edited]
The system needs to validate entity data → The current panel number (1-6) is determined based on the starting sequence to process entities in groups of 4
[Pre-Edit Screen 3 Data Cleanup]
Data preparation is required before validation → Preliminary cleanup operations are performed on the entity data
[Process Seal Numbers]
The system processes seal data for storage → Seal numbers are compressed and stored in GCSCCS56 segment, empty seal entries are removed, and seal data is properly formatted for chemical shipment requirements
[Calculate Sub-Location Codes]
The system calculates sub-location codes → RF table lookup is performed using destination station and consignee chop code, customer bonded indicator is set if RF segment found, CPRS sub-location code is determined through MC table lookup, and appropriate sub-location indicators are assigned
[Map N1 Entity Information]
The system processes entity information → All N1 entity fields are mapped including ID, name, address, contact information, business number qualifier processing sets ID code qualifier appropriately, importer entity information is updated in S55 working arrays, and CSA indicator is set based on business number qualifier
[Map Entity ID and Name]
System processes entity identification and name data → Entity ID (N101) and entity name (N102) are transferred from working arrays to corresponding fields in GCSCCS55 segment
[Map Address Information]
System processes address data for entity record → Address line information (N301, N302) is mapped from working arrays to GCSCCS55 segment address fields
[Map City, State/Province, Country]
System processes city, state/province, and country information → City (N401), state/province (N402), and country (N404) codes are transferred from working arrays to GCSCCS55 segment geographic fields
[Map Postal Code]
System processes postal code data → Postal code (N403) is mapped from working arrays to GCSCCS55 segment postal code field
[Map Contact Information]
System processes contact data for entity record → Contact name (PER02), communication qualifier (PER03), and communication number (PER04) are transferred from working arrays to GCSCCS55 segment contact fields
[Set Entity Type Code]
System determines entity type from N101 identification code → Entity type code is set in GCSCCS55 segment based on N101 value (SH=Shipper, CN=Consignee, IM=Importer, N1=Notify Party)
[Generate Database Key]
System prepares entity record for database storage → Unique database key is generated for GCSCCS55 segment using cargo control number and entity sequence information
[Transfer to GCSCCS55 Segment]
System executes entity data transfer operation → Complete entity record is transferred to GCSCCS55 segment with all identification, address, geographic, postal, and contact information
[Non-Released Cargo]
Field attributes are being configured for editing → Input fields should be set to editable status to allow user modifications
[Super User]
Field attributes are being configured in change mode → Input fields should be set to editable status to allow super user modifications of released cargo
[Equipment Fields]
The system determines field editability based on processing mode and user authorization → Equipment fields should be set to editable when authorized or protected when restricted
[Waybill Fields]
The system determines field editability based on processing mode and authorization → Waybill fields should be set to appropriate editing attributes according to business access rules
[Station Fields]
The system applies field protection rules based on user privileges → Station fields should be configured with appropriate editing attributes
[Broker Fields]
If editing permissions based on business rules → Broker fields should be set with proper editing attributes according to authorization levels
[Weight/Quantity Fields]
The system applies business rules for field access control → Weight and quantity fields should be configured with appropriate editing permissions
[Description Fields]
The system determines editing permissions based on processing mode → Description fields should be set with appropriate editing attributes
[N1 Entity Fields]
The system applies access control rules based on user authorization → Entity fields should be configured with proper editing attributes according to business rules
[Super User Only Field?]
Field attributes are being configured for editing access → The field should be set to protected status to prevent unauthorized access
[Business Number Fields]
If whether the field requires super user access → Business number fields should be protected if super user privileges are required, otherwise made editable based on standard rules
[Configure Cursor Position]
The cursor position is being configured for user interaction → The cursor should be positioned on the first editable field available to the user, or on a default position if no fields are editable
[Prepare Transaction Data]
The system initiates message queue transaction processing → The transaction data structure is initialized with default values and prepared for population
[Set Security Information]
Security information needs to be established for the message queue transaction → User ID, terminal ID, and security context are set in the transaction message
[Set Date and Time Stamps]
Date and time stamps need to be recorded for the transaction → Current system date and time are captured and formatted for the message queue transaction
[Set Action Code]
The system needs to identify the type of cargo operation for the message queue → Action code is set based on cargo processing mode (ADD, CHANGE, DELETE, FINISH, etc.)
[Set Cargo Control Number]
Cargo control number needs to be included in the message queue transaction → The cargo control number from the current processing context is set in the transaction message
[Set User Information]
User context information needs to be recorded → Current user ID, user type, and processing context are included in the transaction message
[Format Message Structure]
The message needs to be formatted for transmission to the message queue → Transaction data is formatted according to IMS message queue protocol and structure requirements
[Send to IMS Message Queue]
The system sends the transaction to the IMS message queue → The formatted message is transmitted to the designated IMS message queue for processing
[Log Transaction Success]
The system confirms successful message transmission → Success status is logged with transaction details for audit trail and monitoring
[Prepare Cargo Transaction Data]
The system prepares transaction data → The system sets cargo control number, function code, processing mode, screen identification, and cargo-specific data elements in the transaction message structure
[Prepare Print Request Data]
The system prepares print transaction data → The system sets Merlin ID, broker name, print type indicators, and destination information in the transaction message structure
[Prepare Export Transaction Data]
The system prepares export transaction data → The system sets export destination codes, routing parameters, and export-specific data elements in the transaction message structure
[Set Security Information]
The system sets security information → The system assigns current user ID, terminal ID, security group, and access level information to the transaction message
[Set Date and Time Stamps]
The system sets date and time stamps → The system assigns current system date, time, and timestamp information to the transaction message for audit and tracking purposes
[Set User Information]
The system sets user information → The system assigns user type (UPDATE-USER, SUPER-USER, etc.), authority level, SCAC code, and user-specific processing flags to the transaction message
[Format Message Structure]
The system formats the message structure → The system organizes all data elements into the required message format with proper field positioning, data types, and message headers for IMS queue processing
[Send to IMS Message Queue]
The system sends the message to IMS message queue → The system transmits the transaction message to the designated IMS queue and receives a transmission status indicator
[Log Transaction Success]
The system logs the successful transaction → The system creates audit log entries with transaction details, timestamp, user information, and success status for tracking and compliance purposes
[Look Up Country Code in CT Table]
The system performs a lookup in the CT (Country Table) using the provided country code → The system retrieves the country table segment to verify if the country code exists in the standard reference data
[Set Message: First Page Already Displayed]
User presses PF7 key for backward navigation → System displays message 'FIRST-PAGE' indicating user is already at the first page and no backward navigation is possible
[Set Fields Editable]
The screen is being configured for data entry → Input fields are set to editable status allowing user modification according to field-specific protection rules
[Set Business Number Fields Editable]
The user attempts to modify business number or CSA-related fields → The business number fields are made editable and can be modified
[Apply Screen 2 Attributes]
Field attributes are being configured for change or add mode → Description fields become non-protected to allow editing while weight and quantity fields follow standard protection rules
[Stack Entry Found?]
System checks if navigation stack entry was found → If no stack entry found, system completes navigation processing immediately, otherwise system proceeds to retrieve previous screen information
[Return to Main Menu]
The system processes the return navigation → The system should set message ID to 'GCMENU' and transfer control to main menu
[Return to Cargo Menu]
The system processes the return navigation → The system should set message ID to 'GCCMENU' and transfer control to cargo menu
[Return to Equipment Display]
The system processes the return navigation → The system should set message ID to 'GCEQP' and transfer control to equipment display
[Return to Waybill Display]
The system processes the return navigation → The system should set message ID to 'GCWB' and transfer control to waybill display
[Return to Train Display]
The system processes the return navigation → The system should set message ID to 'GCTRAIN' and transfer control to train display
[Return to Destination Display]
The system processes the return navigation → The system should set message ID to 'GCDEST' and transfer control to destination display
[Amendment Code Required?]
The system checks if amendment code is required → The system requires amendment code validation if the cargo has 309 sent flag set to 'Y', otherwise proceeds without amendment code requirement
[Set Customs Update Flag]
The system sets the customs update flag → The system activates the customs update indicator to trigger EDI transmission and customs notification processes
[Update Database Record]
The system updates the database record → The system applies all validated changes to the cargo record, sets 309 manual change flag, updates modification timestamps, and triggers appropriate notification processes
[Insert Follower Manifest]
The follower manifest is ready for storage → The system inserts the follower manifest into the database with all segments and sets the 309 manual change flag
[Set Manual Addition Flag]
The system processes the manual addition → The system sets the manual addition flag and 309 manual change flag
[Generate Unique Database Key]
The system generates a database key for the entity → Create a unique key combining cargo control number, segment type (S55), and entity sequence number
[Map Entity Data to Database Format]
The system maps entity data to database format → Transfer all entity fields (N101 identifier, N102 name, N301-N404 address fields, PER contact information) from working arrays to GCSCCS55 segment structure
[Store Entity in GCSCCS55 Segment]
The system stores the entity in the database segment → Place the entity data in the GCSCCS55 segment array using the generated key and sequence number
[Map Seals to GCSCCS56 Segment]
The system maps seal data to storage segments → Seal numbers are properly mapped to GCSCCS56 segment structure
[Set Manual Change Flag]
The cargo addition process begins → The manual change flag (309 flag) must be set to 'Y' to indicate customs notification is required
[Generate N1 Entity Keys]
The cargo addition process generates database keys → Each N1 entity segment must be assigned a unique key combining the cargo control number and entity sequence number
[Process Seal Number Arrays]
The cargo addition process prepares seal data → Seal numbers must be compressed and organized into storage arrays for the GCSCCS56 segment
[Database Insert Successful?]
The database operation completes → If the insert was successful, proceed with related segment insertions, otherwise handle the database error
[Insert GCSCCS52 Description Segment]
Related segments are being inserted → The GCSCCS52 description lines segment must be inserted into the database
[Insert GCSCCS53 Description Segment]
Related segments are being inserted → The GCSCCS53 compressed description segment must be inserted into the database
[Insert GCSCCS55 N1 Entity Segments]
Related segments are being inserted → All GCSCCS55 N1 entity segments must be inserted into the database with their generated keys
[Insert GCSCCS56 Seal Number Segments]
Related segments are being inserted → The GCSCCS56 seal number segments must be inserted into the database
[Insert GCSCCS99 Configuration Segment]
Related segments are being inserted → The GCSCCS99 configuration segment must be inserted into the database
[Update Master Manifest Car Sequence]
All cargo segments have been successfully inserted → The master manifest's car sequence number must be incremented to reflect the new follower
[Set Success Status]
The cargo addition process is finalizing → The success status must be set to indicate the cargo was successfully added to the database
[Update GCSCCS53 Segments]
The system updates the GCSCCS53 description segments → The system writes the compressed description data to the appropriate GCSCCS53 segments, ensuring data integrity and proper segment allocation
[Maintain Sequence Numbers]
The system assigns sequence numbers to description segments → The system maintains sequential numbering starting from 001, increments properly for each segment, and ensures no gaps in the sequence
[Amendment Code Required?]
The system checks if amendment code is required → Amendment code is required when cargo has sent 309 flag set to 'Y'
[Generate Train Audit Messages]
Train audit messages are generated → The system creates detailed log messages about cargo changes triggering train resend and spawns GCT1051E logging transaction with train and cargo information
[Update Database Record]
Database record is updated → The system updates cargo record with validated changes, sets 309 manual change flag, manages indexes for return/transit cargo, and creates customer reports via GCX140 processing
[Create Audit Log Entry]
Audit log entry is created → The system creates detailed log messages with reason codes and screen information for the cargo changes
[Generate Database Keys for N1 Entities]
Database keys need to be generated for entity storage → The system creates unique database keys for each N1 entity segment using the follower CCN and entity sequence numbers
[Compress and Store Description]
The description needs to be stored in the database → The system compresses the description data using GCCCOMP program and stores it in the appropriate database segments
[Display Success Message]
User feedback is required → The system displays a success message confirming the creation of the follower manifest with the new CCN
[N1 Entities Exist?]
If whether N1 entity segments contain any data → If no N1 entities exist, skip N1 processing entirely, otherwise proceed with entity key generation
[Generate Unique Database Key]
The system needs to store the entity in the database → Generate a unique database key using cargo control number, segment type, and entity sequence number
[Store Entity in Database Segment]
The system prepares the entity for database storage → Store the complete entity data in the GCSCCS55 database segment with proper key and sequence information
[Increment Entity Counter]
The system prepares to process the next entity → Increment the entity counter by one to maintain proper sequence numbering for subsequent entities
[Update GCSCCS56 Segment]
The system updates the GCSCCS56 segment → The GCSCCS56 database segment is updated with all processed seal number data including keys and sequence numbers
[More Seal Pages?]
The system checks for additional seal pages to process → If more seal pages exist, continue processing the next page; if no more pages exist, proceed to completion
[Update Configuration Segment GCSCCS99]
The system completes the cargo addition process → The configuration segment (GCSCCS99) must be updated to maintain system integrity and tracking information
[Update GCSCCS53 Segments]
System processes compressed description output → System moves compressed description data to GCSCCS53 segment fields maintaining proper segment structure
[Maintain Sequence Numbers]
System assigns sequence numbers to description segments → System sets sequential sequence numbers starting from '001' for each description segment
[Store Compressed Description]
System completes description compression processing → System stores updated GCSCCS53 segments in cargo record for database update
[Skip Compression - No Changes]
System determines no description lines have changed from original → System skips compression processing and maintains existing description segments unchanged
[Process EDI Transmission]
The system processes EDI transmission requirements → The system determines customs notification requirements and processes EDI transmission if cargo requires customs notification
[Create Audit Log Entry]
The system creates audit documentation → The system generates an audit log entry with re-add reason code and cargo identification information
[Display Success Message]
The system finalizes the re-add process → The system displays a success confirmation message to the user indicating the cargo has been re-added
[38:Validate Commodity Code]
Commodity code validation is performed → If commodity code is provided, lookup commodity in dangerous goods database and retrieve UN number and danger information from ISSCD segment
[240:Apply Relaxed Edit Rules for Origin Station]
The system processes origin station data → If relaxed edits are allowed, default origin station name to 'HAULAGE' when not provided, otherwise require valid station name and validate state/province codes against lookup table
[241:Apply Relaxed Edit Rules for Destination Station]
The system processes destination station data → If relaxed edits are allowed, default destination station name to 'HAULAGE' when not provided, otherwise require valid station name and validate state/province codes against lookup table
[245:Apply Relaxed Edit Rules for Broker Information]
The system processes broker data → If relaxed edits are allowed, default broker to 'UNKNOWN' when not provided; otherwise validate broker against BK table with Canadian flag and port code, allowing special values 'UNKNOWN', 'NOT-REQ', 'NOT REQ'
[264:Process Seal Number Array Compression]
The system processes seal numbers → Compress seal number data removing empty entries, organize across 5 pages with up to 20 total seals, and store in GCSCCS56 segment format
[269:Determine Edit Relaxation Rules]
The system determines edit relaxation applicability → No relaxed edits for master manifests ('6105E' CCNs), no relaxed edits when missing haulage SCAC on screen 1, no relaxed edits for linehaul cargo on screens 2 and 3, otherwise relaxed edits are allowed
[146:Execute Cargo Database Addition]
The system executes cargo database addition → Insert new cargo record with all segments, set 309 manual change flag, clear destination indexes for return/transit cargo, and create customer reports via GCX140 processing
[61:Create Audit Log Entries]
The system creates audit log entries → Generate detailed log messages with cargo information, user details, and operation type for audit trail purposes
[247: Validate Weight and Quantity]
Weight or quantity fields are empty or zero → Allow zero values and set appropriate default units when relaxed edits are permitted
[39: Process Cargo Description]
The system processes description data → Manage description sequence numbers and handle pagination across multiple description segments
[258: Compress and Store Cargo Description]
The system prepares description data for storage → Compress description data using compression utility and store in cargo record segments
[146: Execute Cargo Database Addition]
The system executes database addition operation → Insert new cargo record into database with all segments and set appropriate status flags
[103:Edit Screen 3 N1 Entity Data]
Entity data editing is initiated → The system must map screen data to internal arrays based on starting sequence, validate all N1 entity data, handle error positioning with cursor management, and compress empty entity records
[146:Execute Cargo Database Addition]
Database addition is executed → The system must create the main cargo record, create all N1 entity segments, create seal number segments, and create description segments in the database
[144:Process N1 Entity Key Generation]
Entity key generation is processed → The system must generate unique keys for each N1 entity segment maintaining proper sequence and relationships
[148:Compress and Store Cargo Description]
Description compression and storage is performed → The system must compress description data across multiple segments, handle description sequence numbering, and store compressed descriptions in database format
[240:Apply Relaxed Edit Rules for Origin Station]
The system applies validation rules for origin station → If relaxed edits are allowed, set default values for haulage scenarios and allow less strict validation for station names and numbers
[241:Apply Relaxed Edit Rules for Destination Station]
The system applies validation rules for destination station → If relaxed edits are allowed, set default values for haulage scenarios and allow less strict validation for station names and numbers
[245:Apply Relaxed Edit Rules for Broker Information]
The system validates broker data → If relaxed edits are allowed, set default broker to 'UNKNOWN' and allow special values like 'NOT-REQ' or 'NOT REQ'
[264:Process Seal Number Array Compression]
The system processes seal number data → Compress seal number arrays by removing empty entries and reorganizing remaining seals for proper storage in GCSCCS56 segment
[Generate Train Audit Messages]
The system generates audit messages → Create detailed log messages indicating cargo changes that triggered train resend requirements
[Execute Database Update]
The system executes database update → Update cargo record with new data, set 309 manual change flag, and update waybill indexes as needed
[Set Amendment Code Required]
Amendment code requirement is evaluated → Amendment code becomes a required field and must be provided before changes can be processed
[Update Cargo Record]
Cargo record update is performed → Cargo record is updated with new values for equipment, weight, quantity, descriptions, commodity code, consolidated flag, reference data, and amendment code, with 309 manual change flag set and modification timestamp updated
[Create Audit Log Entry]
Audit logging is performed → Detailed log message is created with reason code, screen identification (SCR2), change type classification, and specific field changes, then logged via GCT1051E spawn
[Update Train Information if Required]
Train update processing is performed → Train record is updated with resend flag and modification timestamp, and detailed log message about cargo change triggering train resend is created
[Display Success Message]
Success message display is triggered → Appropriate success message is displayed indicating changes have been saved and any additional processing (customs notification, train updates) has been initiated
[103:Edit Screen 3 N1 Entity Data]
Entity data editing is initiated → All N1 entities must be validated for required fields, address information, contact data, and country/state combinations
[109:Move N1 Data to Cargo Record]
Data is being moved to the cargo record → All N1 segment data including entity IDs, names, addresses, and contact information must be transferred to the cargo record structure
[Is Iron Highway Cargo? CCN starts with 6105E]
System evaluates cargo type for additional processing AND cargo control number starts with '6105E' → System identifies cargo as Iron Highway type requiring EDI transmission to customs
[Send EDI Transmission to Customs]
System processes customs notification requirements → System sends EDI transmission to customs authorities regarding the cargo deletion
[Create Audit Log Entry]
System completes deletion processing → System creates an audit log entry documenting the cargo deletion with relevant details
[Display Success Message]
System finalizes the deletion process → System displays success message confirming the cargo has been deleted
[Is Iron Highway Cargo?]
If post-deletion processing requirements → The system determines if the cargo is Iron Highway cargo requiring EDI transmission
[Send EDI Transmission]
Post-deletion processing occurs → The system sends an EDI transmission to notify relevant external systems of the cargo deletion
[Create Audit Log Entry]
The deletion process nears completion → The system creates an audit log entry documenting the manifest deletion with relevant details
[Display Deletion Confirmation]
The deletion process concludes → The system displays a confirmation message indicating successful deletion of the master manifest
[Notification Method?]
The notification method is evaluated → The system selects the appropriate communication method (X12 EDI, MERLIN, FAX, Internet, or Paper) based on broker configuration
[Send X12 Notification]
X12 notification is processed → The system sets broker notification flag and calls GCCS309C for EDI transmission, then proceeds to audit logging
[47:Validate Amendment Codes]
The system validates amendment code requirements → The system requires valid amendment codes from the Canadian amendment code table (AC table) for all changes, otherwise displays amendment code error
[58:Process EDI Transmission]
The system processes EDI transmission → The system calls GCCS309C program to transmit cargo changes to customs systems, sets notify customs flag, and logs automatic transmission message
[Set Amendment Code for Customs Changes]
Processing changes that require customs notification → Validate and set amendment code from screen input for customs processing
[Display Success Message]
Completing change processing → Display success message indicating changes have been saved
[48:Detect Data Changes]
The system compares current data with original data → Changes in car ID, conveying car, or any N1 segment fields trigger customs update flag, and car ID changes trigger train resend flag
[274:Generate Train Audit Messages]
The system generates train audit messages → Train records are updated with resend flags and audit messages are created with cargo and train information
[27:Paginate N1 Entities]
The system manages entity pagination → Entities are displayed 4 at a time with appropriate navigation messages for beginning and end of entity list
[Process EDI Transmission]
The system processes post-deletion activities → An EDI delete transmission is sent to notify external systems of the cargo deletion
[Is Iron Highway Cargo?]
The system checks the cargo type → The system determines if the cargo is an Iron Highway cargo requiring special EDI processing
[Send EDI Transmission]
The deletion process requires external notification → The system sends an EDI transmission to notify relevant parties of the cargo deletion
[Display Confirmation Message]
The deletion process is finalized → The system displays a confirmation message indicating successful deletion of the master manifest
[Send Broker Notifications via Multiple Channels]
The notification process is executed → Send notifications via X12 EDI, MERLIN, Internet, Fax, or Paper based on broker communication preferences
[Send Print Message to Queue]
The system processes the MST print request → The system should send the print message to the appropriate MST queue for processing
[Display Success Message]
The system completes all MST print processing steps → The system should display a success message confirming the print request submission
[Notification Method?]
The system determines the notification routing method → Route to X12 EDI if broker notification flag is set, route to MERLIN system if MERLIN ID exists, route to FAX if fax number exists, route to Internet if internet address exists, or route to paper print for batch processing
[Send via X12 EDI]
The system sends print request via X12 EDI → Set broker notification flag and call GCCS309C for EDI transmission processing
[Send via FAX]
The system sends print request via FAX → Spawn GCT0191E transaction with fax number for FAX transmission processing
[Send via Internet]
The system sends print request via Internet → Spawn GCT0191E transaction with internet address for Internet transmission processing
[58: Process EDI Transmission]
The system processes EDI transmission → The system skips transmission for 6105I cargos, logs appropriate messages for deleted or non-CPRS cargo, sets notify customs flag for CPRS cargo, and calls GCCS309C for EDI processing
[Generate Customer Reports]
The system generates customer reports → The system creates ADD/DEL customer reports via GCT1401E for applicable action types and cargo configurations
[Update Train Information]
The system updates train information and cargo is assigned to a train with resend requirements → The system updates train record with resend flag, modification timestamps, and creates detailed log message about cargo changes triggering train resend
[Return to View Mode]
The system completes the finish operation → The system sets processing mode to VIEW to prevent further modifications and displays success message
[274: Detect Changes in Screen 3 Data]
The system compares current Screen 3 field values against original cargo record values for all N1 segment fields → The system sets CUSTOMS-UPDT flag when car ID, conveying car, or any N1 segment fields (entity ID, name, address, state/province, city, postal code, contact data) have changed AND sets TRAIN-REQUIRED-RESEND flag when car ID has changed
[Any Changes Detected?]
If any change flags have been set → If no changes are detected, processing ends immediately AND if changes are detected, the system proceeds with change flag setting and data movement operations
[Update Cargo Record in Database]
The system performs the database update operation → The cargo record is updated in the database with all changed field values AND the 309 manual change flag is set AND index management is performed for return/transit cargo
[Generate Train Audit Messages]
The system generates audit messages → Detailed log messages are created documenting the cargo change that triggered train resend AND the messages include train and cargo identification information
[20: Retrieve Cargo Data - Refresh After Changes]
The system refreshes cargo data → Current cargo data is retrieved from the database using the cargo control number AND all cargo segments are refreshed to reflect the updated values
[87: Retrieve and Decompress Cargo Description]
The system processes cargo descriptions → Cargo description data is retrieved from database segments AND description data is decompressed using GCCCOMP for proper display formatting
[88: Build Entity Information Arrays]
The system builds entity information arrays → Entity information arrays are constructed from S55 data segments AND entity data is organized for proper screen display formatting AND entity sequence tracking is established for pagination
[Apply CSA Importer Data if Required]
The system checks if cargo requires CSA processing based on AU segment, importer name, and business number availability → If CSA is required and no importer entity exists, a new importer entity is created with AU table data and CSA indicator is activated
[Set SENT Status]
Cargo is 6105E type and not a follower manifest → Cargo status is set to SENT for automatic EDI transmission to customs
[Perform EDI Transmission]
The system performs EDI transmission processing → EDI transmission is sent to appropriate systems based on cargo type, customs notification requirements, and transmission rules
[Send Broker Notifications]
The system processes broker notifications → Broker notifications are sent via appropriate channels (X12 EDI, Merlin, Internet, Fax, Paper) based on broker preferences and delivery schedules
[Update Train Information]
The system checks if cargo is assigned to a train and requires train updates → Train information is updated with resend flags and modification timestamps, and detailed log messages are created for train notification
[Display Confirmation Message]
The system displays completion status to the user → A confirmation message is displayed indicating successful cargo finish processing
[Complete Finish Processing]
All finish processing steps have been completed successfully → Finish processing workflow is completed and control returns to main processing
[Look up AU Table using Origin Station Number]
System performs AU table lookup using consignee chop and commodity code → System retrieves AU table segment containing origin country data
[Set Origin Country Code from AU Table]
Origin country data is found in AU table → System sets origin country code from AU table segment data
[Set Origin Country Name from AU Table]
Origin country data is found in AU table → System sets origin country name from AU table segment data
[Log Warning: Origin Country Not Found]
Origin country data is not available → System logs warning message about missing origin country data
[Search Existing N1 Entities for Importer]
The system searches for existing importer entities → The system should scan through S55 entity data array looking for entity type 'IM' (Importer)
[Search Existing N1 Entities for Importer]
The system searches existing N1 entities for importer type → The system scans all N1 segments looking for entity type 'IM' (Importer) and sets importer found indicator accordingly
[Importer Entity Found?]
An importer entity with type 'IM' is found in existing N1 segments → CSA processing is skipped because importer already exists, otherwise proceed to check for available space
[Apply Importer Name from AU Table]
The system applies importer name data → The N102 field (entity name) is populated with the importer name from the AU table segment
[Apply Business Number from AU Table]
The system applies business number data → The N104 field (identification code) is populated with the business number from the AU table segment
[Skip CSA Processing - No Data Available]
AU segment does not contain required importer name or business number → CSA processing is skipped and cargo continues without CSA importer data
[Skip CSA Processing - Importer Already Exists]
An existing N1 entity with type 'IM' is found in the cargo manifest → CSA importer creation is skipped to avoid duplicate importer entities
[Block Function - CSA Delivered Restriction]
The function type is CHANGE, DELETE, RELEASE, CANCEL-RELEASE, or RE-ADD → The function is blocked and an appropriate error message is set indicating CSA delivered cargo cannot be modified
[Block Function - CSA Released Restriction]
The function type is CHANGE, DELETE, RELEASE, CANCEL-RELEASE, or RE-ADD → The function is blocked and an appropriate error message is set indicating CSA released cargo cannot be modified
[Reject Modification - Released Cargo Protected]
Cargo release type is not 'MANUAL':
cargo release type is not 'RETURN'
→ System rejects the modification and sets error message indicating released cargo cannot be modified
[Reject: Insufficient User Permissions]
The user does not have UPDATE-USER authority and does not have SUPER-USER authority → The system rejects the arrival request and displays error message about insufficient user permissions
[Reject: Follower Manifest Not Allowed]
The cargo is identified as a follower manifest → The system rejects the arrival request and displays error message that follower manifests cannot be arrived individually
[Reject: CN Rail Restrictions]
The cargo type is 9 or 6105P and the carrier is 999 → The system rejects the arrival request and displays error message about CN Rail cargo restrictions
[Process Border Arrival]
The arrival location is inland and no border arrival date exists → The system rejects the arrival request and displays error message that border arrival is required before inland arrival
[Follower Manifest?]
The cargo is identified as a follower manifest (car sequence number greater than 1) → Reject the arrival request with error message indicating follower manifests cannot arrive independently
[Is Follower Manifest?]
The cargo is identified as a follower manifest → The system must reject the arrival request and display error message indicating follower manifests cannot be arrived
[CN Rail Specific Conditions Met?]
The cargo does not have a border arrival date set → The system must reject the arrival request and display error message indicating border arrival is required before inland arrival
[Validate User Authorization for Re-Add Function]
The system validates user authorization and the user does not have SUPER-USER permissions → The system must reject the request and display error message 'Re-Add function requires SUPER-USER permissions'
[At First Description Line?]
User presses PF7 to navigate backward through description lines → System should display 'First Page' message and not move to previous lines
[At Last Description Line?]
User presses PF8 to navigate forward through description lines → System should display 'Last Page' message and not move to next lines
[Display _First Page_ Message]
User attempts to navigate to previous screen using PF1 → System displays 'First Page' message and remains on Screen 1
[Display _Last Page_ Message]
User attempts to navigate to next screen using PF2 → System displays 'Last Page' message and remains on Screen 3
[Format Screen Display]
System prepares screen for display → System formats screen layout, populates data fields, applies field attributes, and includes any status messages
[Display _First Page_ Message]
User presses PF1 (Previous Screen) navigation key → System displays 'First Page' message and remains on Screen 1 without navigation
[Display _Last Page_ Message]
User presses PF2 (Next Screen) navigation key → System displays 'Last Page' message and remains on Screen 3 without navigation
[Retrieve Train Data from Database]
The system needs to display train information → The train data is retrieved from the GCSB4RT train root segment using the train ID as the key
[Display 'No Train Assigned']
The train information section is formatted for display → The message 'No Train Assigned' is displayed on the cargo screen
[Set Train Resend Flag]
Train update processing occurs → The train resend flag is set to indicate the train manifest requires retransmission
[Send Train Update Message]
The message transmission process is executed → Train update notifications are sent to relevant external systems and the train list segment is updated
[User Authorization Check]
If authorization requirements → The system initiates user authorization validation before proceeding with the mode transition
[Multi-Car Add Request?]
A user attempts to perform a multi-car add function (MULTI or MULTI-MNL) → The system blocks the operation and sets error message indicating multi-car functions are not allowed on follower manifests
[Function Allowed for Followers?]
A user attempts to perform a cancel release function (CANCEL-RELEASE) → The system blocks the operation and sets error message indicating cancel release is not allowed on follower manifests
[Function Allowed for Followers?]
A user attempts to perform a re-release function (RE-RELEASE) → The system blocks the operation and sets error message indicating re-release is not allowed on follower manifests
[Block Follower Arrival]
A user attempts to perform an arrival function (ARRIVAL) → The system blocks the operation and sets error message indicating arrival is not allowed on follower manifests
[Function Allowed for Followers?]
A user attempts to perform a delivery function (DELIVER) → The system blocks the operation and sets error message indicating delivery is not allowed on follower manifests
[Block Operation - CSA Delivered/Released]
An operation is attempted on the cargo → Block the operation and display error message indicating CSA delivery/release restriction
[Return to Previous Screen]
The user acknowledges the error or the system completes error processing → The system should return the user to the previous screen without performing the print operation
[Parse Time Components HH:MM]
The system parses the time components → The time is separated into hour and minute components for individual range validation
[Format Audit Message Text]
The system formats the audit message → The audit message text is formatted with cargo identification, delivery date, and action description in a standardized format
[Create Delivery Audit Log Entry]
The system creates the audit log entry → A complete audit record is created with cargo ID, delivery date, user information, timestamp, and formatted message text
[Send Audit Message to Queue]
The system processes the audit entry → The audit message is sent to the audit processing queue via GCT1051E program for permanent logging
[Skip EDI Transmission No Customs Notification]
System processes EDI transmission for customs notification → System skips EDI transmission and does not send customs notification for the idler car
[Send EDI to Customs Normal Processing]
System processes EDI transmission for customs notification → System sends EDI transmission to customs following normal processing procedures
[Generate Arrival Message GCT1481E]
The arrival processing flag is set and port validation is complete → The system must generate arrival message GCT1481E to notify relevant systems and complete the arrival process
[Skip EDI Transmission]
The system checks the cargo control number pattern during EDI transmission processing → The EDI transmission is skipped and the cargo is excluded from customs notification
[PF7 - Navigate Backward]
The system processes the backward navigation request → The system moves to the previous panel of N1 entities or shows first page message if already at the beginning
[PF8 - Navigate Forward]
The system processes the forward navigation request → The system moves to the next panel of N1 entities or shows last page message if already at the end
[Set First Page Message]
The system cannot navigate further backward → The system displays a message indicating user is at the first page
[Set Last Page Message]
The system cannot navigate further forward → The system displays a message indicating user is at the last page
[Display Confirmation Message to User]
The regeneration process completes successfully → A confirmation message must be displayed to the user indicating the CCN has been corrected
[Route to Configured Notification Method]
The system routes the notification based on broker configuration → Route to the configured notification method (X12 EDI, Merlin, Internet, Fax, or Paper) as specified in the broker table configuration
[Is Follower Manifest?]
The cargo is identified as a follower manifest (not a master manifest) → The system skips port code processing and does not spawn GCT1481E message
[Is Transit/Ocean Cargo?]
The cargo status is either transit or ocean → The system skips port code processing and does not spawn GCT1481E message
[Is Iron Highway Cargo CCN starts with 6105E?]
The cargo control number starts with '6105E' indicating Iron Highway cargo → The system skips port code processing and does not spawn GCT1481E message
[Is Carrier Index = 105?]
The carrier index != 105 → The system skips port code processing and does not spawn GCT1481E message
[Spawn GCT1481E Message for Arrival Processing]
The port code assignment is complete → The system spawns GCT1481E message with the arrival port code for further arrival processing
[Determine Notification Method]
The system determines the notification method from broker configuration → The system should identify whether to use X12 EDI, MERLIN, Internet, or FAX notification based on broker setup
[Send X12 Notification to Secondary Broker]
The system processes X12 notification for the secondary broker → The system should set the secondary broker notification flag and call GCCS309C for EDI transmission
[Immediate Schedule - Send Immediately]
The delivery schedule type is evaluated as immediate → The broker notification is sent immediately without additional validation checks
[Schedule Validation Failed]
The validation process fails due to missing train assignment or cargo arrival → The broker notification process is prevented from proceeding
[Broker Delivery Schedule Valid?]
The system validates delivery schedule where DEFAULT-DELIVERY or IMMEDIATE-DELIVERY is always valid, CONSIST-DELIVERY requires train assignment, and ARRIVAL-DELIVERY requires both train assignment and arrival indicator → The system should determine if the delivery schedule is valid for the current cargo status
[X12 Method Available?]
The system checks if X12 method is available in broker configuration → If X12 method is available, the system should set broker notification flag and call GCCS309C for EDI transmission
[Set Immediate Delivery Schedule]
Delivery schedule preference is 'IMMEDIATE-DELIVERY' → System sets delivery schedule to immediate delivery configuration
[Configure X12 Notification]
X12 notification method is available and enabled for broker → System configures X12 EDI notification method for broker communication
[Delivery Schedule Type?]
If the delivery schedule type → The schedule is classified as Default, Immediate, Consist, or Arrival delivery type
[Set Immediate Schedule]
The system configures delivery schedule settings → Immediate delivery schedule is applied with no timing restrictions
[X12 Enabled?]
If X12 EDI notification capability → If X12 EDI is enabled, configure X12 notification; otherwise check next notification method
[Configure X12 Notification]
The system configures notification methods → X12 EDI notification is configured with appropriate broker notification flag settings
[Schedule Valid for Current Status?]
If schedule compatibility with cargo status → DEFAULT-DELIVERY and IMMEDIATE-DELIVERY are always valid, CONSIST-DELIVERY requires train assignment, ARRIVAL-DELIVERY requires train assignment and arrival indicator
[X12 Enabled?]
The system checks X12 EDI capability → X12 notification is sent if enabled, otherwise processing continues to check MERLIN capability
[Send X12 Notification]
The system processes X12 notification → The broker notification flag is set and GCCS309C is called for EDI transmission
[Export Flag Set?]
The export flag is set to indicate export processing should be skipped → The system bypasses export transaction message generation and continues to end processing
[Prepare Export Transaction Message]
The export flag indicates processing should proceed → The system begins preparing the export transaction message data
[Set Message Type to GCT1231E]
The message type needs to be specified for export processing → The system sets the message type to 'GCT1231E' for proper routing and processing
[Include Cargo Control Number]
The cargo control number is available from the current cargo record → The system includes the cargo control number in the export message for identification purposes
[Include Transaction Details]
Additional transaction details are required for export processing → The system includes relevant transaction details in the export message
[Send Message to IMS Queue]
The message is ready for transmission → The system sends the message to the IMS message queue for downstream processing
[Manifest To Port Present?]
The manifest to port field is empty or not provided → Check if relaxed edit rules apply to determine default handling
[Copy From Port to To Port]
The system needs a to port for processing → Copy the from port value to the to port field as default
[Is Lading Quantity Qualifier Present?]
The system checks for the presence of a lading quantity qualifier → If present, proceed with table validation; if not present, apply relaxed edit rules
[Relaxed Edits Allowed?]
The system checks if relaxed edits are allowed for the current cargo context → If relaxed edits are allowed, set default zero values; otherwise complete validation with error
[Set Default Zero Values]
No valid lading quantity qualifier is available → Default zero values are assigned to quantity-related fields
[Set Default Zero Values for Weight and Piece Count]
Edit relaxation is allowed for the current cargo type and processing context → The system accepts zero values for weight and piece count fields as valid defaults
[Accept Zero Values as Valid]
Weight or piece count values are zero → The system accepts these zero values as valid without generating validation errors
[Check for Description Changes]
The system compares current description content with previously stored description data → If description content has changed, compress the description data for storage AND update database segments AND set change flags for customs notification
[Compress Description for Storage]
The system processes the description for database storage → Compress the description data using standard compression algorithms AND prepare the compressed data for database segment updates
[Update Database Segments]
The system updates the cargo database with new description information → Update the appropriate database segments with compressed description data AND ensure data integrity is maintained
[Set Change Flags]
The system finalizes the description update process → Set customs update flags to trigger EDI transmission AND set audit flags for change tracking AND mark the cargo for customs notification processing
[Apply Default Zero Values]
The system processes the cargo quantity data → Default zero values are applied to pieces and weight fields
[Edit Relaxation Allowed?]
System evaluates edit relaxation eligibility based on cargo characteristics and processing mode → System enables relaxed edit rules if cargo qualifies for flexible validation OR applies standard strict validation rules if relaxed edits are not permitted
[Update Database Segments]
Database update is required for description changes → Update cargo description segments in the database with compressed description data
[Relaxed Edits Allowed?]
Relaxed edits mode is enabled for the current processing context → Bypass mandatory description content validation and proceed to format validation
[Store Compressed Data in GCSCCS53]
The system needs to persist the compressed description data → The system stores the compressed description data in GCSCCS53 database segments with proper segment identification
[Mark Description Segments for Update]
The system completes the description storage process → The system marks all affected description segments with update indicators to ensure database consistency during transaction commit
[Update GCSCCS56 Segment]
The system updates the cargo seal information → The GCSCCS56 segment is updated with the compressed seal array data and total seal count
[Is Cargo Iron Highway? CCN starts with '6105E'?]
The cargo control number starts with '6105E' indicating Iron Highway cargo → The system must disable relaxed edits and set RELAX-EDITS-NOT-ALLOWED flag
[Is Haulage SCAC Missing?]
The haulage SCAC code field is missing or empty → The system must disable relaxed edits and set RELAX-EDITS-NOT-ALLOWED flag
[Is Linehaul Cargo on Screen 2 or 3?]
The cargo is linehaul type and the current processing screen is either screen 2 (cargo details) or screen 3 (entity information) → The system must disable relaxed edits and set RELAX-EDITS-NOT-ALLOWED flag
[Allow Relaxed Edits Keep RELAX-EDITS-ALLOWED]
The cargo is not Iron Highway type AND haulage SCAC is present AND (cargo is not linehaul type:
current screen is screen 1)
→ The system must allow relaxed edits and keep RELAX-EDITS-ALLOWED flag
[Process Seal Numbers]
Seal numbers are being processed for database storage → Seal numbers are compressed and stored in the GCSCCS56 segment of the database record
[Compress and Store Description]
Description data is being stored in database → Compress description text across multiple segments and store in database format
[Spawn GCT1051E Message]
The audit log entry has been created successfully → The system spawns GCT1051E transaction with train number, cargo control number, and change reason information
[Format Train Resend Message]
The system prepares the audit message content → The message must be formatted with cargo control number, train identification, change reason code, and modification details in the standard audit format
[Spawn GCT1051E Message]
The audit log entry creation is completed → The GCT1051E logging transaction must be spawned with the formatted message to record the train update event
[Access COMODITY Database Segment]
The system needs to determine dangerous goods classification → Access the COMODITY database segment using the commodity code as the search key
[Retrieve Dangerous Goods Flag]
The system processes the commodity information → Retrieve the dangerous goods flag from the ISSCD segment of the commodity record
[Retrieve UN Number]
The system processes dangerous goods information → Extract the UN number from the ISSCD segment of the commodity record for regulatory identification
[Port/Station Table Lookup MC Segment]
The system looks up the identifier in the MC table → If found, return the port configuration including Canadian customs code and sub-location data; otherwise, return port not found error
[Broker Table Lookup BK Segment]
The system looks up the broker in the BK table using the port-specific lookup first, then generic lookup if not found → If the broker is found and authorized for the port, return broker information; otherwise, return broker not found or not authorized error
[SCAC Code Table Lookup SS Segment]
The system looks up the SCAC in the SS table using the port → If the SCAC exists and has a valid haulage agreement flag of 'Y', return success; otherwise, return SCAC invalid or no haulage agreement error
[Customer Sub-Location Table RF Segment]
The system looks up the combination in the RF table → If found, return the customer sub-location code and set customer bonded indicator; otherwise, proceed with CPRS sub-location logic
[Admin Settings Table AD Segment]
The system accesses the AD table segment → Return the current administrative configuration settings including flags and control parameters
[Origin Country Table AU Segment]
The system looks up the combination in the AU table → If found, return the origin country information including importer name and business number for CSA processing; otherwise, CSA processing is not applicable
[Generate Iron Highway Notification Message]
The system needs to process the Iron Highway status update → The system invokes the Iron Highway processing program with the prepared cargo data
[Format Report Message]
The system generates the report message → The report message is formatted according to customer specifications and operation type
[Send Report to Message Queue]
The report is ready for delivery → The report is sent to the designated message queue for customer notification processing
[Create Audit Log Entry]
Audit logging is required → An audit log entry is created documenting the report generation, type, and delivery status
[PF7 - Navigate Backward Through Description]
The system processes the PF7 key press for backward navigation through description lines → The system moves to the previous set of description lines, updates the display starting position, and shows appropriate navigation indicators or boundary messages
[PF8 - Navigate Forward Through Description]
The system processes the PF8 key press for forward navigation through description lines → The system moves to the next set of description lines, updates the display starting position, and shows appropriate navigation indicators or boundary messages
[Display _First Page_ Message]
The system detects the boundary condition → The system displays 'First Page' message to inform user they cannot navigate further backward
[Display _Last Page_ Message]
The system detects the boundary condition → The system displays 'Last Page' message to inform user they cannot navigate further forward
[Clear Navigation Indicators]
The system clears navigation indicators → All 'More Above' and 'More Below' indicators are cleared from the display
[Refresh Screen 2 Display]
The system refreshes Screen 2 display → The screen shows the updated description lines with appropriate navigation indicators and messages

Structural Validations

[19:Validate CCN Format]
CCN input field is empty or contains only spaces → Set error message 'ABSENT-CCN' and terminate processing
[62:Handle Error Processing]
Error conditions exist → Set appropriate error messages and prepare for error display
[19:Validate CCN Format]
Location data needs validation → Validate station names (default to 'HAULAGE' if relaxed edits) and province codes using state-country lookup table
[88:Build Entity Information Arrays]
N1 segment data needs validation → Require name and complete address for shipper/consignee, validate city (min 2 chars), postal code (min 3 chars), state/province for CA/US/MX, and country codes
[88:Build Entity Information Arrays]
Contact data needs validation → If contact name exists require communication qualifier, if qualifier/name exists require communication number, validate qualifier as blank/'FX'/'TE' only
[CCN Present?]
The CCN input field is empty or contains only spaces → The system displays an ABSENT-CCN error message and stops processing
[Waybill ID Entered?]
The waybill ID field is empty or not provided → The system displays an error message and prevents proceeding with manifest creation
[Process Manual Addition Screen 3]
The system processes Screen 3 validation → The system validates all N1 entity segments for required fields, address completeness, contact information, and entity type restrictions according to business rules
[Determine Duplicate Manifest Status]
The system checks for duplicate manifests using waybill information → The system prevents creation if a duplicate manifest is found and displays an appropriate error message
[246:Validate Load/Empty Status Indicator]
System validates the status indicator → Status must be 'L' for Load or 'E' for Empty, defaults to 'L' if relaxed edits allowed
[249:Validate Weight Units as Kilograms or Pounds]
System validates weight units → Units must be 'KG' for kilograms or 'LB' for pounds, can be spaces if weight is zero and relaxed edits allowed
[62:Handle Error Processing]
System handles error processing → Error messages are set, field attributes are updated, and user is returned to input screen for corrections
[Equipment ID Validation]
The system validates the equipment car ID format using car format validation program → If car ID format is invalid, set equipment field error attributes and display format error message, otherwise accept the valid car ID
[Equipment ID Validation]
The system validates the conveying car ID format using car format validation program → If conveying car ID format is invalid, set conveying car field error attributes and display format error message, otherwise accept the valid conveying car ID
[Origin Station Validation]
The system validates the origin station name → If origin station name is missing and edits are not relaxed, set origin station field error attributes and display required field error, otherwise if edits are relaxed, default to 'HAULAGE'
[Destination Station Validation]
The system validates the destination station name → If destination station name is missing and edits are not relaxed, set destination station field error attributes and display required field error, otherwise if edits are relaxed, default to 'HAULAGE'
[Broker Information Validation]
The system validates the broker name → If edits are relaxed and broker is missing, default to 'UNKNOWN', otherwise if broker is not 'UNKNOWN', 'NOT-REQ', or 'NOT REQ', validate against BK table using Canadian flag and port code, and if not found, set broker field error attributes and display invalid broker error
[Weight and Quantity Validation]
The system validates the load/empty status → If status is not 'L' or 'E' and edits are not relaxed, set load/empty field error attributes and display invalid status error, otherwise if edits are relaxed, default to 'L'
[Weight and Quantity Validation]
The system validates the number of pieces using numeric justification → If pieces is non-numeric or zero and edits are not relaxed, set pieces field error attributes and display validation error, otherwise if edits are relaxed, allow zero values
[Weight and Quantity Validation]
The system validates the weight using numeric justification → If weight is non-numeric or zero and edits are not relaxed, set weight field error attributes and display validation error, otherwise if edits are relaxed, allow zero values
[Weight and Quantity Validation]
The system validates the weight units → If units are not 'KG' or 'LB' and weight is not zero, set weight units field error attributes and display invalid units error, otherwise if weight is zero and edits are relaxed, allow spaces
[N1 Entity ID Validation]
The system validates the entity ID for the position → If entity ID is not valid for positions greater than 2, set entity ID field error attributes and display invalid entity ID error
[N1 Entity Name Validation]
The system validates the entity name field → If entity name (N102) is missing for shipper or consignee, set entity name field error attributes and display required field error
[N1 Entity Name Validation]
The system validates entity name requirement → If any address field is populated but entity name (N102) is missing, set entity name field error attributes and display required field error
[N1 Entity Address Validation]
The system validates address completeness → If any required address field (N301-address, N401-city, N402-state, N403-postal, N404-country) is missing, set corresponding address field error attributes and display required field error
[N1 Entity Address Validation]
The system validates city name length → If city name has less than 2 characters, set city field error attributes and display minimum length error
[N1 Entity Address Validation]
The system validates postal code length → If postal code has less than 3 characters, set postal code field error attributes and display minimum length error
[N1 Entity Address Validation]
The system validates state/province requirement → If country is CA, US, or MX and state/province (N402) is missing, set state field error attributes and display required field error, otherwise validate state code against lookup table
[N1 Entity Address Validation]
The system validates the country code using CT table lookup → If country code is not found in CT table, set country field error attributes and display country not found error, otherwise update country code field with standardized value from table
[N1 Entity Contact Validation]
The system validates contact information completeness → If contact name exists but communication qualifier is missing, set error 'REQUIRED-PER03', if communication number exists but qualifier is missing, set error 'REQUIRED-PER03', if qualifier or name exists but communication number is missing, set error 'REQUIRED-PER04'
[N1 Entity Contact Validation]
The system validates the communication qualifier value → If communication qualifier is not spaces, 'FX' (fax), or 'TE' (telephone), set error 'PER03-INVALID-VALUE'
[Mark Field in Error]
An equipment validation error occurs → Mark the corresponding equipment field in error state with appropriate error message and continue processing
[Set Error Flag]
The compression routine fails due to invalid car ID format or other validation errors → The system sets error flag, applies error field attributes, and displays appropriate error message
[Date Format Valid?]
If the ISDATECV return code → If return code indicates invalid format, set format error message and exit validation, otherwise continue to component validation
[Year/Month/Day Valid?]
The system validates each component against acceptable ranges → If any component is out of range, set format error message and exit validation, otherwise continue to current date validation
[Date Within Range?]
The system checks if date is within acceptable business range → If date is outside acceptable range, set range error message and exit validation, otherwise continue to reference date validation
[Set Format Error Message]
The system needs to communicate validation failure → The system sets format error message to inform user of date format problems
[Set Future Date Error]
The system needs to communicate future date restriction violation → The system sets future date error message to inform user that future dates are not allowed
[Set Range Error Message]
The system needs to communicate range validation failure → The system sets range error message to inform user that date is outside acceptable limits
[Set Business Rule Error]
The system needs to communicate business rule validation failure → The system sets business rule error message to inform user of the specific business constraint violation
[Is Date Format Valid?]
The system validates the date format using ISDATECV utility → If the date format is invalid or contains non-numeric characters, set error message 'INVALID DATE FORMAT' and mark field for correction
[Is Date in Future?]
The delivery date is compared against current machine date → If delivery date is greater than current machine date, set error message 'DELIVERY DATE CANNOT BE IN FUTURE' and mark field for correction
[Is Date Before Creation Date?]
The delivery date is compared against cargo creation date → If delivery date is less than cargo creation date, set error message 'DELIVERY DATE CANNOT BE BEFORE CREATION DATE' and mark field for correction
[Is Delivery Date Before Arrival Date?]
The delivery date is compared against cargo arrival date → If delivery date is less than arrival date, set error message 'DELIVERY DATE CANNOT BE BEFORE ARRIVAL DATE' and mark field for correction
[Date Validation Successful]
The date passes format validation, future date check, creation date check, and arrival date check → Mark delivery date as valid and allow processing to continue without error messages
[Apply Default Station Name]
The origin or destination station name is missing or empty → The system should apply the default station name 'HAULAGE' for the missing station
[Enforce Required Fields]
Station name validation is performed → The system should enforce that station names are required and cannot be empty
[Set Province Validation Error]
Province validation fails → Set province validation error message indicating invalid province-country combination and mark field for user correction
[Manifest To Port Present?]
The manifest to port field is empty or contains only spaces → Check if relaxed edits are applicable, otherwise proceed to sub-location calculation
[Enforce Non-Zero Weight Required]
Weight value is zero or not provided → Set weight required error to enforce non-zero weight entry
[Lading Quantity Qualifier Present?]
The system examines the lading quantity qualifier field → If the qualifier field is empty or spaces, skip qualifier validation and proceed to relaxed edit rules check, otherwise continue with MU table lookup
[Weight Units Present?]
The system examines the weight units field → If weight units are present, proceed to validate unit compatibility with qualifier, otherwise proceed to relaxed edit rules check
[Apply Default Zero Values]
Quantity or weight fields are missing or invalid → Set default zero values for pieces and weight fields to allow processing to continue
[Require Valid Qualifier-Unit Combination]
Quantity qualifier or weight unit validation fails → Set field attributes for error display and prevent processing until valid qualifier-unit combination is provided
[Weight Units Present?]
The system checks for the presence of weight units → If weight units are empty or spaces, apply default weight units if relaxed edits are allowed, otherwise continue validation
[Set Weight Unit Compatibility Error]
The system processes the incompatibility → Set an appropriate error message indicating weight unit compatibility issue and continue validation process
[Check description line requirements]
Relaxed edits are not allowed AND the first description line is empty → Set error indicating description is required
[Validate Amendment Codes]
The system validates the amendment code → The amendment code must be provided and valid according to Canadian amendment code table, otherwise an invalid amendment code error is displayed
[Check Cargo Status]
A user attempts to delete the cargo manifest → The system displays an error message 'Cannot Delete Cargo on Train' and prevents the deletion
[Is Cargo on Train?]
The cargo is currently assigned to a train → The system must reject the deletion request and display an error message indicating the cargo cannot be deleted while on train
[Follower on Train?]
Any follower manifest is currently assigned to a train → The system must reject the entire deletion request and display an error message indicating a follower manifest is on train and cannot be deleted
[Set Master Not Found Error]
The system sets a master not found error → An error message is set indicating that the master manifest could not be located and processing is terminated
[Display Error: Cargo Not Deleted]
User attempts to re-add the cargo manifest → System displays error message indicating cargo is not deleted and prevents re-add operation
[Future Date/Time?]
The system compares arrival date/time against current machine date/time → The arrival date/time must not be in the future or system returns error message
[Before Creation Date?]
The system compares arrival date/time against cargo creation date/time → The arrival date/time must not be before cargo creation date/time or system returns error message
[Check if Pending/Error/Reject Status]
User attempts to process cargo arrival AND cargo status is pending, error, or reject AND user does not have super user authority → System must reject the arrival request and display error message that cargo cannot be arrived in current status
[Check if Cargo on Train]
User attempts to process cargo arrival AND the cargo is not currently assigned to any train → System must reject the arrival request and display error message that Iron Highway cargo must be on train for arrival
[Validate Inland Arrival Requirements]
User attempts to process cargo arrival again AND user does not have super user authority → System must reject the arrival request and display error message that cargo has already been arrived
[Set Error Messages and Field Attributes]
The system encounters a validation error → Appropriate error messages are set, field attributes are updated, and cursor is positioned on the error field
[Display Error Message]
The system needs to communicate the error to the user → The system must display a clear error message explaining why the cancel arrival operation failed
[Validate Print ID Format]
The system validates the print ID → The print ID format is checked for validity and appropriate error messages are displayed for invalid formats
[Display Error Message]
The system handles the error condition → An appropriate error message is displayed to the user explaining the validation failure or processing issue
[Validate Broker Name Entry]
The system validates the broker name field → The system accepts the request if broker name is provided, otherwise displays error message for missing broker name
[Broker Delivery Schedule Valid?]
The system validates the broker delivery schedule → The system accepts DEFAULT-DELIVERY or IMMEDIATE-DELIVERY schedules always, accepts CONSIST-DELIVERY only if cargo is assigned to train, and accepts ARRIVAL-DELIVERY only if cargo is assigned to train and has arrival indicator
[Display Error Message]
The system displays error messages → The system shows specific error messages for invalid broker names, invalid delivery schedules, or other validation failures
[Train Assigned?]
Checking train assignment status → If train is assigned, allow delivery, otherwise set train required error
[Validate Broker Name Format]
The system validates the broker name format → The broker name must meet required format criteria before proceeding to table search
[Set Error - Broker Not Authorized for Port]
Relaxed edit rules are not enabled → Set an error indicating the broker is not authorized for the specified port and reject the validation
[Display Processing Error]
The system receives error status from GCCCCREL program → Display appropriate error message based on the error type returned and do not update cargo status
[Is Multi-Car Request?]
The system checks if this is a multi-car manifest request → The system should validate the request type and proceed with multi-car processing if confirmed, otherwise display error message
[Display Error Message]
The system displays error message → The system should show specific error messages indicating the reason for multi-car processing failure
[Generate Format Error Message]
The system needs to inform the user about the validation failure → An appropriate error message is generated explaining that the car ID format is invalid
[Validation Errors Found?]
Any validation errors are found on any of the three screens → Finish processing must be terminated and error messages must be displayed to the user
[CSA Importer Data Available in AU Segment?]
The system checks for CSA importer data availability in the AU segment → CSA processing continues if AU segment exists with importer name and business number, otherwise CSA processing is skipped
[Space Available for New Entity?]
The system checks if space is available for a new N1 entity → CSA importer creation proceeds if space is available, otherwise CSA processing is skipped
[Cargo Found?]
The main cargo record (GCSCCRT) does not exist in the database → The system sets cargo not found flag and returns without retrieving related segments
[At First Page?]
User attempts to navigate to previous page → System prevents navigation and displays first page message
[At Last Page?]
User attempts to navigate to next page → System prevents navigation and displays last page message
[Display _First Page_ Message]
User presses PF1 for backward navigation → The system should display 'First Page' message and remain on Screen 1
[Display _Last Page_ Message]
User presses PF2 for forward navigation → The system should display 'Last Page' message and remain on Screen 3
[Change Mode Navigation]
User presses PF7 or PF8 navigation keys → System first checks if validation errors are present before proceeding with navigation
[Validate Station Name Present]
The origin station name field is empty or contains only spaces → The system sets an error indicating that station name is required
[Validate Station Name Required]
The destination station name field is empty or not present → The system sets a validation error indicating station name is required
[Lookup From Port in MC Table]
The system validates the manifest from port → The port must exist in the MC table and have a valid Canadian customs code (not '00000'), otherwise set appropriate error message
[Lookup To Port in MC Table]
The system validates the manifest to port → The port must exist in the MC table and have a valid Canadian customs code (not '00000'), otherwise set appropriate error message
[Set Default 'UNKNOWN' Broker]
Edit relaxation is allowed for broker validation → The broker code is set to 'UNKNOWN' as the default value
[Apply Default Zero Values]
Weight or quantity fields are missing or invalid → Set default values of zero for pieces and weight fields to allow processing to continue
[Validate Weight Value Present]
The weight field is empty or not provided → Set weight required error to prevent cargo processing
[117:Validate N1 Entity ID and Name]
The entity ID code (N101) is missing or empty → Set validation error 'REQUIRED-N101' and mark field for cursor positioning
[117:Validate N1 Entity ID and Name]
The entity name (N102) is missing or empty → Set validation error 'REQUIRED-N102' and mark field for cursor positioning
[131:Validate PER Contact Information Requirements]
The communication number qualifier (PER03) is missing or empty → Set validation error 'REQUIRED-PER03' and mark field for cursor positioning
[131:Validate PER Contact Information Requirements]
The communication number (PER04) is missing or empty → Set validation error 'REQUIRED-PER04' and mark field for cursor positioning
[132:Validate PER Contact Qualifier Values]
The qualifier is not spaces, 'FX' (fax), or 'TE' (telephone) → Set validation error 'PER03-INVALID-VALUE' and mark field for cursor positioning
[121:Mark Fields with Error Indicators]
Field validation fails for any N1 or PER segment field → Set field attribute to error highlighting and mark field for visual indication to user
[Validate PER Contact Information Requirements]
The system validates contact information completeness → Contact qualifier and contact number must be provided as a pair
[Check Against Valid Entity Types - Validate entity type code against allowed values (SH, CN, NI, IM)]
The entity type code is evaluated against valid business entity types → The system accepts only SH (Shipper), CN (Consignee), NI (Notify Party), or IM (Importer) as valid entity types and rejects any other codes with an entity type error
[Set Country Not Found Error]
Country code validation fails → Set error message 'GEN-NOT-FOUND-ON-CT' and mark validation as failed
[Set Error: Contact Qualifier Required]
Contact name (PER02) is provided AND communication qualifier (PER03) is missing or spaces → Set error 'REQUIRED-PER03' and reject the contact information
[Set Error: Contact Qualifier Required]
Communication number (PER04) is provided AND communication qualifier (PER03) is missing or spaces → Set error 'REQUIRED-PER03' and reject the contact information
[Set Error: Invalid Qualifier Code]
Communication qualifier (PER03) is provided AND it is not spaces, 'FX' (fax), or 'TE' (telephone) → Set error 'PER03-INVALID-VALUE' and reject the contact information
[Set Error: Contact Number Required]
Communication qualifier (PER03) is provided:
contact name (PER02) is provided AND communication number (PER04) is missing
spaces
→ Set error 'REQUIRED-PER04' and reject the contact information
[Accept Contact Information]
All contact fields are empty:
(contact name, valid communication qualifier, and communication number are all provided)
→ Accept the contact information as valid
[Set Default Province - MI for Origin]
The origin station province code is missing or invalid → The system should set the default province code to 'MI' for the origin station
[Set Default Province - ON for Destination]
The destination station province code is missing or invalid → The system should set the default province code to 'ON' for the destination station
[Look up Country in CT Table]
The system performs country code lookup in the CT table using the country code as key → The system retrieves the country table segment and determines if the country code exists in the reference data
[Set Country Code Error]
The country code is not found in the CT table → The system sets error message 'GEN-NOT-FOUND-ON-CT' to indicate the country code is invalid
[CSA Importer Data Available in AU Segment?]
The system checks for CSA importer data availability → CSA processing continues only if AU segment exists with importer name and business number data
[Space Available for New Entity?]
The system checks for available space in the N1 entity array → CSA processing continues only if there is an empty slot available in the N1 entity array for creating a new importer
[Train Update Successful?]
The train update process completes → The system checks the return status to determine if the train update was successful or encountered errors
[Broker Delivery Schedule Valid?]
Broker notification is being processed → If delivery schedule is 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY' then allow notification, if 'CONSIST-DELIVERY' then require train assignment, if 'ARRIVAL-DELIVERY' then require both train assignment and arrival indicator
[Broker Delivery Schedule Valid?]
The system validates the delivery schedule requirements → If delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, then always valid; If CONSIST-DELIVERY, then valid only if cargo is assigned to train; If ARRIVAL-DELIVERY, then valid only if cargo is assigned to train and has arrival indicator set
[Secondary Broker Schedule Valid?]
The system validates the secondary broker delivery schedule requirements → If delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, then always valid; If CONSIST-DELIVERY, then valid only if cargo is assigned to train; If ARRIVAL-DELIVERY, then valid only if cargo is assigned to train and has arrival indicator set
[62.6: Store Error Message]
The error is being stored in the collection → The error message text is stored in the error collection array
[62.7: Display Error Messages to User]
Error processing is complete → All error messages are displayed to the user in a readable format
[Multi-Car Restriction]
A multi-car function (MULTI or MULTI-MNL) is attempted → The system blocks the function and displays error message 'MULTI NOT ALLOWED ON 6105E MASTER'
[Validate Train Assignment Required]
The cargo does not have a train assignment → The system blocks the arrival function and displays error message 'TRAIN REQUIRED FOR 6105E ARRIVAL'
[Validate Duplicate Manifests - Check for duplicate cargo manifests]
The system checks for existing manifests with the same cargo control number → If a duplicate manifest is found, the system sets a duplicate manifest error message and prevents further processing
[Set Duplicate Manifest Error Message]
The duplicate validation result is processed → The system sets a duplicate manifest error message to prevent manifest creation and inform the user
[Is Haulage SCAC Missing?]
The haulage SCAC code is missing or empty → Relaxed edits must be disabled to enforce SCAC code entry requirement
[Validate Key Uniqueness]
Validating key generation results → Verify that no duplicate keys exist within the same cargo record and segment type combination
[Position Cursor on Error Field]
The system finalizes cursor positioning → The system positions the cursor on the error field for immediate user correction
[User Can Correct Error]
The user interacts with the error field → The user can immediately correct the error without additional navigation or field selection
[Message Queue Success]
The system checks the operation result → The system confirms message queue success status
[Message Queue Error]
The system detects an error in message queue processing → The system sets message queue error status and handles the error condition
[Amendment Code Lookup AC Table]
The system validates the amendment code → The system looks up the amendment code in the AC table using country code 'CA' and sets a validation error if the code is not found
[CCN Input Field Present?]
If the presence of cargo control number input field → If no CCN input field is present, continue with processing without change detection, otherwise proceed to compare CCN values
[Description Data Found?]
The system checks for description content → The system should validate that description data exists in at least one of the segments
[On First Seal Page?]
The system checks the current seal page position → If on first seal page, clear navigation messages; otherwise display 'More Above' message to indicate additional seal pages exist above current page
[On Last Seal Page?]
The system checks the current seal page position → If on last seal page, clear navigation messages; otherwise display 'More Below' message to indicate additional seal pages exist below current page
[At First Page?]
Current position is at the first page of descriptions → System prevents backward navigation and displays first page message
[At Last Page?]
Current position is at the last page of descriptions → System prevents forward navigation and displays last page message
[Display Amendment Code Error]
The amendment code is not found in the AC table or is invalid → The system should display an appropriate error message indicating the amendment code is invalid
[Validate PER Contact Information Requirements]
Contact information validation is performed → If contact name exists, communication qualifier is required; if qualifier or name exists, communication number is required; qualifier must be blank, 'FX', or 'TE'
[Map Broker Information]
The system processes broker data → Broker name is mapped to database field, 'UNKNOWN' is set as default when edits are relaxed, special values like 'NOT-REQ' are allowed, and broker is validated against Canadian broker table
[Map Weight and Quantity]
The system processes weight and quantity data → Lading quantity qualifier is validated against MU table, pieces and weight are numerically validated and justified, weight units are validated as 'KG' or 'LB', and zero values are allowed when edits are relaxed
[Process Cargo Description]
The system processes description data → First description line is required unless sequence is less than '008', asterisk characters are prohibited, description data is compressed across multiple segments using GCCCOMP, and sequence numbers are managed for proper display
[Message Sent Successfully?]
The system receives a response from the message queue system → The response code is evaluated to determine if the transmission was successful or failed
[Handle Message Queue Error]
The system detects a transmission error → Error condition is logged and appropriate error handling procedures are initiated
[Set Address Required Error]
Address validation is performed → Set error message indicating address is required and mark validation as failed
[Message Sent Successfully?]
The system checks the transmission status → The system evaluates return codes and status indicators to determine if the message was successfully queued (success) or if transmission failed (error condition)
[Handle Message Queue Error]
The system handles the message queue error → The system logs error details, sets error indicators, captures error codes and descriptions, and prepares error response information for user notification
[Validate Contact Information]
The system validates PER segment contact information → Contact qualifier and contact number fields are validated for proper pairing
[Set Entity ID Error]
The N101 field validation error is detected → Set appropriate error message and field positioning for entity ID field
[Set Entity Name Error]
The N102 field validation error is detected → Set appropriate error message and field positioning for entity name field
[Set Address Error]
The N301 field validation error is detected → Set appropriate error message and field positioning for address field
[Set City Error]
The N401 field validation error is detected → Set appropriate error message and field positioning for city field
[Set State/Province Error]
The N402 field validation error is detected → Set appropriate error message and field positioning for state/province field
[Set Country Error]
The N404 field validation error is detected → Set appropriate error message and field positioning for country field
[Set Postal Code Error]
The N403 field validation error is detected → Set appropriate error message and field positioning for postal code field
[Set Contact Error]
The PER segment field validation error is detected → Set appropriate error message and field positioning for contact fields
[Validate N1 Entity Name Requirements - Ensure entity name is provided when entity ID code is specified]
The entity identification code (N101) is present AND the entity name (N102) is missing or empty → Set validation error indicating that entity name is required when entity identification code is specified
[Name Validation Passed]
Either the entity identification code (N101) is not present:
both entity identification code (N101) and entity name (N102) are present
→ Entity name validation passes and processing continues
[Set Address Required Error]
The address validation fails → The system sets error message 'REQUIRED-N301' to indicate that address line 1 is required
[Set Validation Error]
The system determines validation cannot be completed successfully → Set validation error flag and prepare error message for the invalid state/province code
[Country Code Found in Table?]
The country code is not found in the country table → Set error message 'GEN-NOT-FOUND-ON-CT' to indicate the country code is invalid
[Contact Qualifier PER03 Present?, Contact Number PER04 Present?]
The communication qualifier (PER03) is missing or empty → Set error 'REQUIRED-PER03' indicating communication qualifier is required
[Qualifier is Valid?]
The qualifier is not spaces, 'FX' (fax), or 'TE' (telephone) → Set error 'PER03-INVALID-VALUE' indicating invalid communication qualifier
[Contact Information Valid]
The communication number (PER04) is missing or empty → Set error 'REQUIRED-PER04' indicating communication number is required
[Start PER Contact Validation]
Contact name (PER02) is provided but communication qualifier (PER03) is missing → Set error 'REQUIRED-PER03' indicating communication qualifier is required
[Set Missing Number Error]
Communication number (PER04) is missing or empty → Set error 'REQUIRED-PER04' indicating communication number is required
[Set Missing Qualifier Error]
Communication qualifier (PER03) is missing or empty → Set error 'REQUIRED-PER03' indicating communication qualifier is required
[Set Invalid Qualifier Error]
Communication qualifier is not spaces, 'FX' (fax), or 'TE' (telephone) → Set error 'PER03-INVALID-VALUE' indicating invalid communication qualifier
[Check Qualifier Value]
Either contact name (PER02) or communication qualifier (PER03) is provided but communication number (PER04) is missing → Set error 'REQUIRED-PER04' to ensure complete contact information
[Display 'Last Page' Message]
User presses PF8 key for forward navigation → System displays 'Last Page' message and remains on screen 3 without advancing further
[Clear Error Messages]
User navigates to different screen or returns to previous context → All error messages are cleared AND error indicators are reset
[Validate Weight/Quantity Changes]
The system validates the weight and quantity changes → The system validates quantity qualifier against measurement unit table, verifies pieces and weight are numeric, ensures weight units are 'KG' or 'LB', and allows zero values when edits are relaxed
[Validate Description Changes]
The system validates the description changes → The system requires first description line when edits are not relaxed, prohibits asterisk characters in descriptions, compresses and reformats descriptions across multiple segments, and manages description sequence numbering
[Display Error Messages]
The system displays error messages → The system shows specific error messages for each validation failure, positions cursor on the first error field, sets appropriate field attributes, and returns to the input screen for correction
[Validate Equipment Changes]
Equipment validation is performed → The system validates car ID format using GCCARFM program and validates conveying car format if provided, setting error messages for invalid equipment
[Validate Station Changes]
Station validation is performed → The system validates station names (required unless relax edits allowed), validates state/province codes against lookup table, and determines country codes from state/province
[Validate Weight/Quantity Changes]
Weight and quantity validation is performed → The system validates quantity qualifier against MU table, validates numeric pieces and weight fields, ensures weight units are 'KG' or 'LB', and allows zero values when edits are relaxed
[Validate Description Changes]
Description validation is performed → The system requires first description line when edits not relaxed, prohibits asterisk characters in descriptions, compresses and reformats descriptions across multiple segments
[Edit Screen 3 N1 Entity Data]
Entity data validation is performed → The system validates entity ID codes, requires name and complete address for shipper/consignee, validates city name (minimum 2 characters), postal code (minimum 3 characters), and state/province for CA/US/MX
[Display Error Messages]
Error messages are displayed → The system sets field attributes for error fields, positions cursor on first error field, and displays appropriate error messages to the user
[Validate Car ID Format]
The car ID format is validated using GCCARFM program → The system either accepts the car ID if valid or rejects it with appropriate error message if invalid
[Handle Error]
Error handling is triggered → The system displays appropriate error messages, rolls back any partial changes, and returns to the previous state
[Seal Numbers Present?]
The system checks for the presence of seal numbers in the cargo data → If no seal numbers are present, skip seal processing and complete immediately; if seal numbers exist, proceed with seal validation and organization
[Is Cargo Still Pending?]
The system checks if the cargo has pending status → The system blocks the re-add operation if cargo is still pending and displays appropriate error message
[Station Names & Provinces]
The system validates station and province data during screen 1 validation → Station names are required unless relaxed edits are allowed (defaulting to 'HAULAGE'), provinces must be validated against state-country lookup table, and multi-car functions must have Canadian origin
[Broker Information]
The system validates broker information during screen 1 validation → Broker name defaults to 'UNKNOWN' for relaxed edits, allows special values 'UNKNOWN', 'NOT-REQ', 'NOT REQ', and must be validated against BK table using Canadian broker registry with port-specific and generic (000) lookups
[Weight & Quantity]
The system validates weight and quantity data during screen 2 validation → Lading quantity qualifier must be validated against MU table, pieces and weight must be numeric and can be zero if relaxed edits allowed, and weight units must be 'KG' or 'LB' (can be spaces if weight is zero and relaxed edits allowed)
[Cargo Description]
The system validates cargo description during screen 2 validation → First description line is required unless sequence is less than '008', no asterisk (*) characters are allowed in descriptions, and description data must be compressed across multiple segments with proper sequence numbering
[Commodity Code]
The system validates commodity code during screen 2 validation → Commodity code must be validated against COMODITY database, UN number retrieved from ISSCD segment if available, and commodity description and danger information must be set appropriately
[N1 Entity Information]
The system validates N1 entity information during screen 3 validation → Shipper and consignee must have name (N102) and complete address (N301, N401, N402, N403, N404), entity ID (N101) must be valid for positions greater than 2, and any entity with address data requires entity ID and name
[Contact Information]
The system validates contact information during screen 3 validation → If contact name exists then communication qualifier (PER03) is mandatory, if qualifier or name exists then communication number (PER04) is mandatory, valid qualifiers are blank, 'FX' (fax), or 'TE' (telephone) only, and PER data is removed if all contact fields are empty
[30:Validate Origin Station]
Origin station validation is performed → If edits are relaxed and station name is empty, set default to 'HAULAGE', otherwise validate station name is provided and station number is numeric
[31:Validate Destination Station]
Destination station validation is performed → If edits are relaxed and station name is empty, set default to 'HAULAGE', validate station number is numeric, lookup country code from state/province table, and set multi-car domestic restriction for non-Canadian origins
[35:Validate Broker Information]
Broker validation is performed → If edits are relaxed and broker is empty, set to 'UNKNOWN', allow special values 'UNKNOWN', 'NOT-REQ', 'NOT REQ', otherwise validate broker exists in Canadian broker table for the port
[37:Validate Weight and Quantity]
Weight and quantity validation is performed → Validate quantity qualifier exists in measurement unit table, pieces and weight are numeric, weight units are 'KG' or 'LB', and allow zero values only when edits are relaxed
[39:Process Cargo Description]
Description processing is performed → First description line is required unless sequence is less than '008', no asterisk characters are allowed in descriptions, and compress description data across multiple segments with sequence management
[42:Validate Contact Information]
Contact information validation is performed → If contact name is provided, communication qualifier is mandatory, if qualifier or name exists communication number is mandatory, and qualifier must be blank, 'FX' for fax, or 'TE' for telephone
[62:Handle Error Processing]
Error processing is performed → Set error indicators, prepare error messages, and determine appropriate error handling response
[236:Validate Equipment ID Format]
The system validates the equipment ID format using GCCARFM program → The equipment ID must pass format validation and decompression checks, otherwise set field attributes for invalid equipment and display error message
[265:Validate Amendment Code Against Country Table]
The system validates the amendment code → The amendment code must exist in AC table with country code 'CA', otherwise set amendment code validation error
[62:Handle Error Processing]
The system handles error processing → Set field attributes for error fields, position cursor on first error field, and prepare error messages for display to user
[247: Validate Weight and Quantity]
The system validates the lading quantity qualifier against the measurement unit table → If the qualifier is not found in the table, set error message for invalid measurement unit
[247: Validate Weight and Quantity]
The system validates the weight units field → If weight units are not 'KG' or 'LB', set error message for invalid weight units
[247: Validate Weight and Quantity]
The system validates numeric content of these fields → If fields contain non-numeric data, set error message and if valid, right-justify with zero fill
[39: Process Cargo Description]
The system validates description content and sequence is not less than '008' → If first description line is empty, set error message for required description
[39: Process Cargo Description]
The system validates description content → If asterisk characters are found, set error message for prohibited characters
[40: Validate Reference Numbers]
Reference qualifier or reference number is provided → If qualifier exists without number or number exists without qualifier, set error message for incomplete reference pair
[116:Validate N1 Entity Required Fields]
The entity is a Shipper (SH) or Consignee (CN) in positions 1 or 2, or any entity with address data populated → The system must validate that N102 (name), N301 (address), N401 (city), N402 (state), N403 (postal code), and N404 (country) are all populated, and if any required field is missing, set validation error and mark field for cursor positioning
[117:Validate N1 Entity ID and Name]
The entity has address information or is in a required position → The system must ensure N101 (entity ID) is populated and N102 (entity name) is provided, and for positions greater than 2, restrict valid entity IDs to approved values only
[118:Validate N1 Address Information]
Address fields are populated → The system must validate that city name has minimum 2 characters, postal code has minimum 3 characters, and all address components meet format requirements
[131:Validate PER Contact Information Requirements]
Any PER field (name, communication qualifier, or communication number) is populated → The system must validate that if PER02-NAME is provided then PER03-COMM-NUM-QUAL is required, if PER04-COMM-NUM is provided then PER03-COMM-NUM-QUAL is required, PER03 must be spaces, 'FX', or 'TE' only, and if PER03 or PER02 is provided then PER04-COMM-NUM is required
[130:Validate N1 Entity Country Code]
Country code validation is performed → The system must lookup the country code in the CT table and if not found set error 'GEN-NOT-FOUND-ON-CT', otherwise update the country code field with the standardized value from the table
[236:Validate Equipment ID Format]
The system validates equipment format → Equipment IDs must pass car format validation and be properly decompressed, otherwise display format error messages
[263:Validate Importer Business Number Requirements]
The system validates importer requirements → For CSA processing, validate business number qualifier and ensure proper importer entity setup in N1 segments
[265:Validate Amendment Code Against Country Table]
The system validates the amendment code → Amendment code must exist in AC table with country code 'CA' for Canadian amendment validation
[Validate Equipment IDs]
Equipment validation is performed during change processing → Car ID format is validated using GCCARFM program and conveying car ID format is validated if provided, with error messages set for invalid equipment
[Validate Weight and Quantity]
Weight and quantity validation is performed → Quantity qualifier is validated against MU table, pieces and weight are numeric validated, weight units must be 'KG' or 'LB', and zero values are allowed only when edits are relaxed
[Validate Commodity Code]
Commodity code validation is performed → Commodity code is looked up in COMODITY database to retrieve UN number from ISSCD segment if available and set commodity description and danger information
[Process Cargo Description]
Description processing is performed → First description line is required unless sequence is less than '008', no asterisk (*) characters are allowed in descriptions, and description data is compressed across multiple segments with proper sequence numbering
[Display Error Messages]
Error message display is triggered → Specific error messages are displayed corresponding to each validation failure including equipment format errors, weight/quantity errors, description errors, and reference data errors
[116:Validate N1 Entity Required Fields]
The entity type is shipper (SH) or consignee (CN) → The entity must have N102 name, N301 address line 1, N401 city, N402 state/province, N403 postal code, and N404 country code populated
[131:Validate PER Contact Information Requirements]
Contact name (PER02) is provided but communication qualifier (PER03) is missing:
communication number (PER04) is provided but communication qualifier (PER03) is missing
→ Set error REQUIRED-PER03 for missing communication qualifier
[47:Validate Amendment Codes]
Changes are being made to the cargo → A valid amendment code must be provided and validated against the AC amendment code table
[Is Cargo on Train?]
User attempts to delete the cargo AND the cargo is currently assigned to a train → System displays error message 'Cannot Delete Cargo on Train' and prevents the deletion operation
[Is Cargo on Train?]
The cargo is currently assigned to a train → The system displays an error message 'Cannot Delete Cargo on Train' and prevents the deletion operation
[Validate Delivery Schedule]
The delivery schedule is validated against cargo status → The system checks if delivery schedule requirements (default/immediate always allowed, consist/arrival require train assignment and arrival status) are satisfied
[111:Set Cursor on Error Fields]
The system sets cursor positioning for error correction → The system positions cursor on the first error field, sets appropriate field attributes for error highlighting, and prepares error message display
[Validate Equipment IDs]
Validating equipment information → Use GCCARFM program to decompress and validate car ID format and set error message if invalid
[Validate Equipment IDs]
Validating equipment information → Use GCCARFM program to validate conveying car format and set error message if invalid
[Validate Weight and Quantity]
Validating weight and quantity information → Weight units must be 'KG' or 'LB', or spaces if weight is zero and edits are relaxed
[Validate Weight and Quantity]
Validating weight and quantity information → Weight must be numeric and can be zero only if edits are relaxed
[Validate Weight and Quantity]
Validating weight and quantity information → Pieces must be numeric and can be zero only if edits are relaxed
[Display Error Messages]
Displaying validation results to user → Display specific error messages corresponding to each validation failure
[103:Edit Screen 3 N1 Entity Data]
The system validates the N1 entity information → All N1 entity fields must pass validation checks including required fields, address information, and contact details
[131:Validate PER Contact Information Requirements]
Contact name or communication number is provided → Communication number qualifier must be provided and must be spaces, 'FX' for fax, or 'TE' for telephone, and if qualifier or name is provided then communication number is required
[47:Validate Amendment Codes]
Screen 3 changes are being processed → Amendment code must be provided and must be valid according to the Canadian amendment code table
[Is Cargo on Train?]
The system checks if the cargo is currently assigned to a train → If the cargo is on a train, deletion must be rejected with error message 'Cannot Delete - Cargo on Train'
[Validate Print ID Format]
The MERLIN print ID is validated → Accept valid MERLIN IDs and reject invalid formats with appropriate error message
[Set Error Message]
The system detects invalid print ID or processing failure → The system should set appropriate error messages and terminate the print request
[Print ID Valid?]
The system validates the print ID format → The print ID must not be spaces and must be a valid format, otherwise set error message for invalid print ID
[Broker Name Required?]
The system processes the special broker print request → Broker name must be provided and cannot be spaces, otherwise set error message for missing broker name
[163: Process Manual Addition Screen 3]
The system processes manual addition validation for Screen 3 → The system validates equipment and performs comprehensive entity data validation for all N1 segments
[Origin Country Found in AU Table?]
System checks if AU table segment was found → System determines if origin country data is available for processing
[CSA Importer Data Available in AU Segment?]
The system checks for CSA importer data availability → The system should verify that AU segment exists, importer name is present, and business number is available
[CSA Importer Data Available in AU Segment?]
The system checks for CSA importer data availability → CSA processing continues only if AU segment contains importer name and business number, otherwise CSA processing is skipped
[Space Available for New Entity?]
The system checks for available space in N1 entity array → CSA processing continues if space is available (entity count < maximum), otherwise CSA processing is skipped due to no space
[Set Error: Multi-car not allowed for Iron Highway cargo]
The system detects the restriction violation → The system should set an appropriate error message indicating multi-car operations are not permitted for Iron Highway cargo
[Prevent Deletion - Display Error Message]
The cargo is currently assigned to an active train → The system must prevent the deletion and display an error message indicating the cargo cannot be deleted while assigned to a train
[Reject: Cargo in Pending/Error/Reject Status]
The cargo status is PENDING or ERROR or REJECT and the user does not have SUPER-USER authority → The system rejects the arrival request and displays error message that cargo cannot be arrived in current status
[Reject: Iron Highway Without Train]
The cargo does not have a train assignment → The system rejects the arrival request and displays error message that Iron Highway cargo requires train assignment for arrival
[Process Inland Arrival]
The cargo already has an arrival indicator set and the user does not have SUPER-USER authority → The system rejects the arrival request and displays error message that cargo has already been arrived
[Check Cargo Type]
The cargo control number starts with '6105E' (Iron Highway cargo) AND the cargo is not assigned to a train → Reject the arrival request with error message indicating Iron Highway cargo requires train assignment
[Validate CN Rail Arrival Restrictions - Prevent arrival processing for CN Rail cargo with specific conditions]
The system validates arrival eligibility for CN Rail cargo → The system must reject the arrival request and display error message indicating CN Rail cargo cannot be arrived under these conditions
[Check Cargo Status]
The cargo status is PENDING, ERROR, or REJECT → The system must reject the arrival request and display error message indicating invalid status for arrival
[Train Assignment Present?]
The cargo does not have a train assignment → The system must reject the arrival request and display error message indicating Iron Highway cargo requires train assignment
[Train Assignment Present?]
The cargo does not have a train assignment → The system must reject the arrival request and display error message indicating 6105E cargo requires train assignment for arrival
[CN Rail Specific Conditions Met?]
The cargo has already been arrived (arrival indicator is set) → The system must reject the arrival request and display error message indicating cargo has already been arrived
[Check Cargo Status]
The system checks the current cargo status and finds it is in PENDING status → The system must reject the re-add request and display error message 'Cannot re-add cargo still in pending status'
[Display _First Page_ Message]
Current seal page number is 1 (first page) → Display 'First Page' message and remain on current page
[Display _Last Page_ Message]
Current seal page number is 5 (last page) → Display 'Last Page' message and remain on current page
[Handle Error Processing]
System processes validation errors → System initiates error handling procedures and prepares error messages for display
[Apply Current Screen Changes]
User initiates navigation to another screen via PF1 or PF2 → System validates current screen changes and applies them before proceeding with navigation
[Display Error Messages]
Current screen changes fail validation checks → System displays error messages, positions cursor on error field, and prevents navigation until errors are resolved
[Display Archive Error Message]
The system checks the train archive status → An archive error message is displayed and access to the train display is denied
[Block Operation - Set Error Message]
The system blocks the operation → The system sets an appropriate error message indicating the archived train restriction
[Display Error to User]
The system needs to notify the user → The system displays the error message explaining the archived train restriction
[Display Authorization Error]
The system displays an authorization error → The system shows an appropriate error message indicating insufficient privileges and prevents the mode transition
[Display Error Message]
The system needs to communicate the restriction to the user → The system should display an appropriate error message indicating that printing is not allowed for idler manifest types
[Hour Valid 00-23?]
The system validates the hour component → The hour must be between 00 and 23 inclusive or an invalid hour error is set
[Prevent Multi-Car Creation Set Error Message]
User attempts to perform multi-car addition function → System prevents the multi-car creation and displays error message indicating multi-car not allowed for Iron Highway cargo
[Validate Delivery Schedule]
The system validates the delivery schedule against cargo status → If delivery schedule is DEFAULT or IMMEDIATE, allow delivery; if CONSIST delivery, require train assignment; if ARRIVAL delivery, require both train assignment and arrival indicator; otherwise set invalid delivery schedule error
[Validate Broker Delivery Schedule]
The system validates the broker's delivery schedule against cargo requirements → The system should verify that default delivery or immediate delivery is always valid, consist delivery requires train assignment, and arrival delivery requires both train assignment and arrival indicator
[Set Error Message]
The system determines the print ID is invalid → An appropriate error message is set to inform the user of the validation failure
[Consist Schedule - Validate Train Assignment]
The delivery schedule type is evaluated as consist → The system must validate that the cargo is assigned to a train before proceeding with notification
[Arrival Schedule - Validate Cargo Arrival Status]
The delivery schedule type is evaluated as arrival → The system must validate that the cargo has arrived at the destination before proceeding with notification
[Validate Broker Delivery Schedule]
The system validates the broker's delivery schedule against current cargo status → The delivery schedule requirements are checked for DEFAULT-DELIVERY, IMMEDIATE-DELIVERY, CONSIST-DELIVERY, or ARRIVAL-DELIVERY types
[Export Message Sent Successfully]
The message transmission completes without errors → The system confirms the export message was sent successfully
[Set Date Format Error Message]
The system processes the validation failure → Set a date format error message to inform the user of the invalid date format
[Set Field Attribute to Error]
The system updates field display attributes → Set the waybill date field attribute to error state to highlight the field for user attention
[Apply Default Values]
The system processes origin station validation → Default station name 'HAULAGE' and province 'MI' are applied to enable relaxed validation
[Set Station Name to 'HAULAGE']
The origin station name field requires a default value → The station name is set to 'HAULAGE'
[Set Province to 'MI']
The origin province field requires a default value → The province is set to 'MI'
[Apply Default Values]
The system processes destination station validation → The station name is set to 'HAULAGE' and the province is set to 'ON' as default values
[Set Station Name to 'HAULAGE']
Default values are being applied for station information → The destination station name is set to 'HAULAGE'
[Set Province to 'ON']
Default values are being applied for location information → The destination province is set to 'ON'
[Validate Station Name]
The system validates the destination station name → If no station name is present, a missing station name error is set
[Validate Province Code]
The system validates the province code → If no province code is present, a missing province error is set
[Set Missing Station Name Error]
No station name is provided or the station name field is empty → A missing station name error is set to inform the user of the validation failure
[Set Missing Province Error]
No province code is provided or the province field is empty → A missing province error is set to inform the user of the validation failure
[Set Port Error Message]
The system cannot proceed with sub-location calculation → The system should set an error message indicating port configuration issues
[Set Default 'UNKNOWN' Broker]
Edit relaxation is allowed for the current cargo processing context → The broker field is set to default value 'UNKNOWN'
[Skip Validation - Use Default]
The broker field is empty or contains only spaces → Broker validation is skipped and the default value is retained
[Set Default Value to 'L' - Load]
The system processes load/empty status validation → The default load/empty status is set to 'L' (Load)
[Set Error - Invalid Unit Qualifier]
The qualifier is not found in the MU unit table → An invalid unit qualifier error is set and relaxed edit rules are applied
[Set Error - Non-Zero Values Required]
Weight or piece count values are zero or empty → The system sets an error indicating that non-zero values are required for weight and piece count fields
[Set Default Units to 'KG']
Relaxed edit rules are enabled → The system sets the weight units to 'KG' (kilograms) as the default value
[Allow Zero Weight with Any Units]
The system validates weight units → The system accepts any weight units value without enforcing the standard 'KG' or 'LB' format requirement
[Set Error: Invalid Weight Units]
The system performs weight units validation → The system sets an invalid weight units error message and marks the weight units field with error attributes for user correction
[Set Error: Invalid Weight Units]
Relaxed edit rules are not enabled (strict validation applies) → The system sets an invalid weight units error and marks the field with error attributes
[Check First Description Line]
The system checks the first description line for required content → If the first description line is empty, set error 'Description Required' AND continue validation of remaining description lines
[Set Default 'UNKNOWN' Broker]
Edit relaxation is allowed for the current processing context → The broker code is automatically set to 'UNKNOWN' as the default value
[Set Default 'UNKNOWN' Broker]
The broker validation process is initiated with relaxed edit rules enabled → The system sets the broker field to 'UNKNOWN' as the default value AND completes broker validation successfully without requiring user input
[Validate Broker Code Entry]
The broker validation process checks for broker code presence → The system requires a valid broker code to be entered AND proceeds to validate the entered broker code against system tables
[Set Broker Not Found Error]
The broker validation process cannot find valid broker information → The system sets a broker not found error condition AND prevents further processing until valid broker information is provided
[Validate Load/Empty Status with Relaxed Rules - Validate L/E status indicator with default 'L' (Load) value when edit relaxation is allowed]
The load/empty status field is empty or blank → The system sets the default value to 'L' (Load) for the load/empty status field
[Validate L/E Status = 'L' or 'E'?]
The load/empty status value != 'L' (Load) AND not equal to 'E' (Empty) → The system sets an error message for invalid load/empty status AND marks the field with error attribute
[Require Valid Unit Code]
The qualifier is not found in the MU unit table → A validation error is set indicating invalid unit code
[Apply Relaxed Edit Rules for Weight and Piece Count - Apply default zero values for weight and piece count when edit relaxation is allowed]
Weight field is empty:
contains invalid data
piece count field is empty
contains invalid data
→ System applies default zero value for weight field AND applies default zero value for piece count field AND continues with standard validation processing
[Weight Unit Field Empty?]
The weight unit field is empty AND relaxed edit rules are enabled → The system sets the default weight unit to 'KG' (kilograms)
[Weight Unit Field Empty?]
The weight unit field is empty AND relaxed edit rules are not enabled → The system sets an invalid weight unit error
[Allow Zero Weight with Any Unit]
The weight value equals zero AND relaxed edit rules are enabled → The system accepts any weight unit value as valid
[Require Valid Unit Even for Zero Weight]
The weight value equals zero AND relaxed edit rules are not enabled → The system requires the weight unit to be either 'KG' or 'LB'
[Description Line 1 Empty?]
The first description line is empty or contains only spaces → Set validation error indicating description is required
[Validate Reference Number Qualifier Pairs - Validate reference qualifier and number pairs ensuring both are provided together]
The system validates reference data during cargo processing → Each reference pair must have both qualifier and number present together, or both must be empty - partial pairs with only qualifier or only number are rejected with appropriate error messages
[Set Duplicate Manifest Error Message]
The duplicate status indicates a manifest already exists → The system sets duplicate manifest error message and configures error field attributes to prevent processing
[Country Table Lookup CT Segment]
The system looks up the country code in the CT table → If the country code exists in the table, return the standardized country code; otherwise, return a country not found error
[Unit/Measurement Table Lookup MU Segment]
The system looks up the qualifier in the MU table → If the qualifier is valid, return success; otherwise, return invalid measurement unit error
[Amendment Code Table Lookup AC Segment]
The system looks up the amendment code in the AC table with country code 'CA' → If the amendment code is valid for Canada, return success; otherwise, return invalid amendment code error
[Return Table Not Found Error]
The requested data is not found in the corresponding table → Return an appropriate table-specific not found error message and halt processing that depends on the missing data
[At First Description Line?]
The system checks if the current position is at the first description line → If at first line, display 'First Page' message and prevent further backward navigation, otherwise allow backward movement
[At Last Description Line?]
The system checks if the current position is at the last description line → If at last line, display 'Last Page' message and prevent further forward navigation, otherwise allow forward movement

Module: GCX002B3 1 Consolidated Epic Story

Epic: GCX002B3 Complete EDI Specification Extracted from Legacy

Contains 13 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX002B3 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Communication Parameters]
The report transmission process begins → The communication function code is cleared to spaces and print counter is reset to zero

Core Acceptance Criteria

[Extract CCN from Cargo Segment]
The system processes the cargo segment → The cargo control number is extracted and stored in the report CCN field and working storage CCN field
[Extract Broker Name from Cargo Data]
The system processes broker information for report generation → The broker name from the cargo data is extracted and assigned to the report broker field
[Extract US Port of Exit Name]
The system processes the returned table segment → The US port of exit name and exit code are extracted from the table segment and populated in the report fields
[Extract US Port Exit Name]
The system processes the lookup results → The US port exit name and exit code are extracted from the returned table segment data
[Clear Function Code]
Communication parameters are being prepared → The user function code is set to spaces
[Reset Print Counter]
Print parameters are being initialized → The maximum print counter is set to zero
[Transmit Header to Destination Terminal]
Header transmission is requested → The system calls the communication module to send the header with destination terminal, communication control block, alternate PCB, call letters, and header data
[Line Counter <= 62?]
The system checks if the current line counter is less than or equal to 62 → The system continues processing if the counter is 62 or less, otherwise stops the transmission loop
[Get Current Report Line from Master Table]
The system needs to access a specific report line for transmission → The system retrieves the report line from the master table entry corresponding to the current line counter value
[Transmit Line to Destination Terminal]
The system executes the line transmission process → The system sends the report line to the destination terminal using the GCSTONLY communication module
[Set Wrap Function Code]
The system needs to finalize the report transmission → The system sets the user function code to 'WRAP' to signal completion
[Execute Final Transmission Call]
The system executes the final transmission call → The system calls the transmission service with destination terminal, communication control, alternate PCB, call letters, and header information

Structural Validations

None explicitly identified in logic extraction.

Module: GCX004 1 Consolidated Epic Story

Epic: GCX004 Complete EDI Specification Extracted from Legacy

Contains 30 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Screen Type Determination]
The message ID equals GC-MENU-SCREEN or TABLE-MENU-SCREEN → The system routes the request to menu screen processing
[2:Screen Type Determination]
The message ID matches any of the 25 display screen types (TABLE-AD-DISPLAY-SCREEN through TABLE-ST-DISPLAY-SCREEN) → The system routes the request to display screen processing
[2:Screen Type Determination]
The message ID matches any of the 25 update screen types (TABLE-AD-UPDATE-SCREEN through TABLE-ST-UPDATE-SCREEN) → The system routes the request to update screen processing
[2:Screen Type Determination]
The message ID does not match any known menu, display, or update screen types → The system defaults to menu screen processing
[3:Menu Screen Processing]
The message ID equals GC-MENU-SCREEN → The input field value is moved to the table ID and table ID attributes are cleared
[6:Display Screen Navigation]
The current table ID is different from the last valid table ID → The system sets message ID to table menu screen, clears function and screen message, and processes as menu request
[8:Menu Request Delegation]
Menu processing is required → The system calls GCX004A1 module with communication area, input message, table user segment, output message, table data, output select code, and system message number
[9:Display Request Delegation]
Display processing is required → The system calls GCX004B1 module with communication area, input message, table user segment, output message, table data, output select code, and system message number
[10:Update Request Delegation]
Update processing is required → The system calls GCX004C1 module with communication area, input message, table user segment, output message, table data, output select code, and system message number
[Identify as Menu Screen Type]
The message ID equals GC-MENU-SCREEN or TABLE-MENU-SCREEN → The system classifies the request as a menu screen type and routes it to menu processing
[Identify as Display Screen Type]
The message ID equals any of TABLE-AD-DISPLAY-SCREEN, TABLE-DR-DISPLAY-SCREEN, TABLE-LT-DISPLAY-SCREEN, TABLE-MC-DISPLAY-SCREEN, TABLE-MS-DISPLAY-SCREEN, TABLE-SC-DISPLAY-SCREEN, TABLE-SE-DISPLAY-SCREEN, TABLE-US-DISPLAY-SCREEN, TABLE-AU-DISPLAY-SCREEN, TABLE-AC-DISPLAY-SCREEN, TABLE-BK-DISPLAY-SCREEN, TABLE-CC-DISPLAY-SCREEN, TABLE-CT-DISPLAY-SCREEN, TABLE-RF-DISPLAY-SCREEN, TABLE-SD-DISPLAY-SCREEN, TABLE-SK-DISPLAY-SCREEN, TABLE-MU-DISPLAY-SCREEN, TABLE-DC-DISPLAY-SCREEN, TABLE-SS-DISPLAY-SCREEN, TABLE-ID-DISPLAY-SCREEN, TABLE-DS-DISPLAY-SCREEN, TABLE-KS-DISPLAY-SCREEN, TABLE-VI-DISPLAY-SCREEN, TABLE-ST-DISPLAY-SCREEN, or TABLE-S1-DISPLAY-SCREEN → The system classifies the request as a display screen type and routes it to display processing with additional validation logic
[Identify as Update Screen Type]
The message ID equals any of TABLE-AD-UPDATE-SCREEN, TABLE-DR-UPDATE-SCREEN, TABLE-LT-UPDATE-SCREEN, TABLE-MC-UPDATE-SCREEN, TABLE-MS-UPDATE-SCREEN, TABLE-SC-UPDATE-SCREEN, TABLE-SE-UPDATE-SCREEN, TABLE-US-UPDATE-SCREEN, TABLE-AU-UPDATE-SCREEN, TABLE-AC-UPDATE-SCREEN, TABLE-BK-UPDATE-SCREEN, TABLE-CC-UPDATE-SCREEN, TABLE-CT-UPDATE-SCREEN, TABLE-RF-UPDATE-SCREEN, TABLE-SD-UPDATE-SCREEN, TABLE-SK-UPDATE-SCREEN, TABLE-MU-UPDATE-SCREEN, TABLE-DC-UPDATE-SCREEN, TABLE-SS-UPDATE-SCREEN, TABLE-ID-UPDATE-SCREEN, TABLE-DS-UPDATE-SCREEN, TABLE-KS-UPDATE-SCREEN, TABLE-VI-UPDATE-SCREEN, TABLE-S1-UPDATE-SCREEN, or TABLE-ST-UPDATE-SCREEN → The system classifies the request as an update screen type and routes it to update processing
[Default to Menu Screen Type]
The message ID does not match any menu, display, or update screen identifiers → The system defaults to menu screen type processing to ensure the user has a valid navigation path
[Clear Function and Screen Message]
The system processes the table ID change → The system clears the function field and screen message field to prepare for menu navigation
[Set Screen to Table Menu]
The system processes the navigation request → The system sets the message ID to table menu screen for redirection
[Set Message ID to Table Menu Screen]
The user presses ENTER → The system sets the message ID to table menu screen to redirect the user to the menu
[Clear Function Field]
The redirection process is initiated → The system clears the function field by setting it to space
[Clear Screen Message]
The redirection process is initiated → The system clears the screen message field by setting it to space
[Route to Menu Processing]
The menu preparation is complete → The system performs the menu processing routine A100-REQUEST-FROM-MENU
[Navigate to Table Menu Screen]
System processes the navigation request → System sets message ID to table menu screen, clears function and screen message, and processes as menu request
[Clear Function and Screen Message]
System prepares to navigate to table menu → System sets function field to space and screen message field to space
[Compare Current Table ID with Last Valid Table ID]
Current table ID != the last valid table ID → System sets message ID to table menu screen AND clears function field AND clears screen message AND navigates to menu processing
[Set Message ID to Table Menu Screen]
System needs to redirect user to menu → System moves TABLE-MENU-SCREEN value to message ID number field
[Clear Function Field]
System prepares for menu navigation → System moves SPACE to function field to clear any previous function selection
[Clear Screen Message]
System prepares clean interface for menu display → System moves SPACE to screen message field to clear any previous messages
[Navigate to Menu Processing]
System needs to process the menu request → System performs A100-REQUEST-FROM-MENU section to handle menu processing
[Identify Update Screen Type]
If the message ID number to determine the specific update screen type → The system identifies the correct table update screen (AD, DR, LT, MC, MS, SC, SE, US, AU, AC, BK, CC, CT, RF, SD, SK, MU, DC, SS, ID, DS, KS, VI, S1, or ST) and routes to update request delegation
[Call GCX004A1 Module]
The system is ready to handle the menu operation → The system calls GCX004A1 module with all required parameters including communication area, input/output messages, table user segment, table data, output select code, and system message number
[Call GCX004B1 Module]
The system needs to handle display screen processing and data retrieval → The system calls the GCX004B1 module with communication area, input message, table user segment, output message, table work area, output select code, and system message number parameters
[Call GCX004C1 Module]
The system needs to process the update request → The system calls the GCX004C1 module passing the common control block, input message, table user segment, output message, table work area, output select code, and system message number

Structural Validations

None explicitly identified in logic extraction.

Module: GCX004A1 1 Consolidated Epic Story

Epic: GCX004A1 Complete EDI Specification Extracted from Legacy

Contains 42 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004A1 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[6:Tables Menu Display]
The system processes the menu request → The tables menu screen is displayed with cleared user messages
[11:Access Violation Processing]
The system detects the security violation → A security violation message is displayed and the user is returned to the table menu screen
[Extract Table ID Selection]
The numeric input is '5', '05', or ' 5' → The system converts it to MS-TABLE-ID for Message table
[Selection = '5', '05', or ' 5'? -> Transform to MS Table ID]
The selection is '5 ', '05', or ' 5' → The system transforms the selection to MS-TABLE-ID for Message table access
[Transform to MS Table ID]
The table selection is '5 ', '05', or ' 5' → The system transforms the input to MS-TABLE-ID for Message table access
[Message Access Valid?]
The system checks the user's message access rights → If the user has invalid message access, set error indicator to deny access
[Check Message Access]
The system checks the user's message access rights → Access is denied and error indicator is set if the user has invalid message permissions
[Display Security Violation Message]
The system processes the table access request with security restrictions → The system displays a security violation message, sets output to TABLE-MENU-SCREEN, and returns the input message
[PF Key = Invalid Selection?]
User presses a function key that equals INV-PFKEY-SELECTION → System sets invalid PF key message number, sets output to table menu screen, and copies input message to output message
[Clear User Message Area]
The system prepares to format the tables menu screen → The user message area is cleared to spaces
[Clear System Message Number]
The system prepares the menu display parameters → The system message number is cleared to spaces
[Prepare Input Message for Output]
The system prepares the output message content → The input message is moved to the output message area
[Clear User Message Area]
The display formatting process begins → The system clears the user message area to ensure clean display
[Set Invalid Selection Message]
The system prepares the error response → The system sets the message number to INV-SELECTION-MSG-NUM to display the invalid selection error
[Return to Table Menu]
The system completes error handling → The system sets the output select code to TABLE-MENU-SCREEN and preserves the input message for return to menu
[Display Invalid Selection Message]
The system needs to inform the user of the error → Display the invalid selection message number to provide user feedback about the error
[Return to Tables Menu]
The system completes error handling → Set output to display the table menu screen and preserve the current input message for user context
[Identify Table ID for Loading]
The system prepares to load table data → The table identifier from the input message is assigned to the table loading variable
[Set End Pointer for Loaded Data]
Parameters need to be passed to the display program → The system passes CCCOM, TABLE-ID, GCWTABLE, GCWTABLE-PTR, GCWTABLE-END-PTR, OUTPUT-MESSAGE, OUTPUT-SELECT-CODE, and SYSTEM-MSG-NUM as parameters
[Table Data Successfully Loaded]
The display screen needs to be prepared → The user message area (GCMTB-USER-MESSAGE) is cleared to spaces
[Memory Ready for Display Processing]
Output message needs to be set up → The INPUT-MESSAGE is copied to OUTPUT-MESSAGE
[Clear User Message Area]
The system prepares the message areas → The user message area is cleared to spaces
[Preserve Input Message]
The system processes the message structures → The input message is copied to the output message to preserve data
[Call Display Formatting Program GCX004DP]
The system invokes the display formatting process → The GCX004DP program is called with all required parameters including table ID, table data, pointers, and message structures
[Set Invalid Selection Message]
The system processes the selection error → The system message number is set to the invalid selection message identifier
[Return to Tables Menu Screen]
The system completes error processing → The output screen is set to the tables menu screen
[General Access Violation]
The access violation is for general table access (not US table specific) → The system sets the output to main menu screen, displays unauthorized access message, clears the user message area, and preserves the original input message
[US Table Security Violation]
The table ID equals US table ID and valid US security access equals '1' → The system sets output to table menu screen, displays security violation message, and preserves the original input message
[Set Unauthorized Access Message]
The violation processing is initiated → The system assigns the invalid authorization message number to the system message
[Set Security Violation Message]
The US table security violation processing is initiated → The system assigns the display violation message number to the system message
[Clear User Message Area]
The violation processing requires message area preparation → The system clears the rest of message area by setting it to spaces
[Set Menu Screen as Output]
The system needs to redirect the user to an appropriate screen → The system sets either the main menu screen for general violations or table menu screen for US table violations as the output select code

Structural Validations

[10:Invalid Selection Handling]
The system validates the table selection → An invalid selection error message is displayed and the user is returned to the table menu
[12:Error Message Management]
The system encounters the error condition → The CERR error handling program is called with appropriate error messages
[Call Error Handler]
System needs to handle the error → System moves abend message to error message field and calls CERR program with CCCOM parameter
[Invalid Table Selection]
The validation process determines the table ID is invalid → Set error highlighting for the table ID field, display invalid selection message, and return user to the tables menu
[Display Error Message to User]
The system prepares the response for the user → The original input message is copied to the output message to maintain user context
[Invalid PF Key Error]
User presses an invalid PF key selection → System sets invalid PF key message number, directs to table menu screen, and copies input message to output
[Access Authorization Error]
User authorization check fails → System sets invalid authorization message number, directs to main GC menu screen, clears message area, and copies input to output
[PF Key Processing Error]
System detects invalid PF key processing condition → System sets abend error message and calls error handler program
[Invalid Table Selection Error]
Table ID validation fails → System sets invalid selection message number, highlights table ID field with cursor, sets error table ID if empty, directs to table menu screen, and copies input to output
[Security Violation Error]
User Security table is requested and valid US security access flag is set to '1' → System sets display violation message number, directs to table menu screen, and copies input message to output

Module: GCX004B1 1 Consolidated Epic Story

Epic: GCX004B1 Complete EDI Specification Extracted from Legacy

Contains 56 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004B1 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program Control]
The program begins execution → The system captures current date and time, saves the current program name, sets the module name, extracts table ID from input message, and initializes all error and access indicators to blank

Core Acceptance Criteria

[3:Handle Security Violations]
The error indicator shows access violation → The system clears the message area, copies input to output, sets main menu screen code, and displays security violation message
[4:Handle US Table Special Security]
The table ID is US-TABLE-ID and the user has restricted US security access → The system clears the message area, copies input to output, sets table menu screen code, and displays security violation message
[6:Process Enter Key Request]
The PF key value equals Enter and function is either blank or expand function → The system processes the request directly, OR when function is not blank/expand and user has no US security restrictions, the system processes the request, OR when user has US security restrictions, the system formats error display and shows update violation message
[7:Validate Update Access Rights]
The user has US security access restrictions → The system formats error display and sets update violation message number
[9:Return to Main Menu]
The PF key equals main menu selection → The system clears screen message, copies input to output, sets main menu screen code, and clears system message number
[10:Return to Tables Menu]
The PF key equals up a level selection → The system clears screen message and table ID, copies input to output, sets table menu screen code, and clears system message number
[12:Find Table Start Position]
The find start process is needed → The system calls external positioning module with communication area, table ID, table structure, end pointer, table key, and current pointer
[13:Format Display Output]
The format display process is invoked → The system calls external formatting module with communication area, table ID, table structure, current pointer, end pointer, output message, select code, and system message number
[14:Extract Table Keys]
The table ID matches a known table type → The system extracts the corresponding key field: Customer Admin ID for AD tables, Range Name for DR tables, Terminal ID for LT tables, Manifest ID for MC tables, Message ID for MS tables, Station Code for SC tables, Station Name for SE tables, User Code for US tables, Auto ID for AU tables, Country Code and Amendment Code for AC tables, Broker Name and Port Code for BK tables, Carrier SCAC Display for CC tables, Country Name for CT tables, Sequence Number for RF tables, US Port Name for SD tables, Foreign Port Name for SK tables, Manifest Unit for MU tables, Disposition Code for DC tables, Carrier and Port for SS tables, Car ID for ID tables, Car Type for VI tables, KS Code for KS tables, DS Code for DS tables, Country and Status Code for S1 tables, or Code and Qualifier for ST tables
[15:Process Table Requests]
The request processing is invoked → The system calls external request processing module with communication area, input message, table structure, output message, select code, and system message number
[Extract Table ID from Input Message]
Program control initialization processes the input → The table identifier from GCMTB-TABLE-ID is moved to TABLE-ID for processing
[Table ID = MS?]
The system checks the user's message access level in their security profile → If the user has invalid message access, set error indicator to '1', otherwise set their message access level as valid access
[Check MS Table - Message Access]
The system checks the user's message access permission → If user has invalid message access, set error indicator to '1', otherwise set valid access level to user's message permission level
[Check User Message Access Permission]
The system checks the user's message access permission in their security profile → The system grants or denies access based on whether the user has valid message access rights
[Set Valid Access Level from User Profile]
The system processes MS table access request → The system assigns the user's message access level to the valid access indicator
[Clear Message Area]
The system prepares to handle the security violation → The rest of message area (GCMTB-REST-OF-MESSAGE) is cleared to SPACE
[Copy Input to Output Message]
The system processes the security violation response → The INPUT-MESSAGE is copied to OUTPUT-MESSAGE to preserve user input
[Set Menu Screen as Next Display]
The system determines the next screen to display → The OUTPUT-SELECT-CODE is set to GC-MENU-SCREEN to redirect to main menu
[Set Security Violation Message Number]
The system prepares the violation response message → The SYSTEM-MSG-NUM is set to DSP-VIOL-MSG-NUM to display security violation message
[Clear Message Area]
Preparing to display a security violation message → The system clears the rest of message area in the table message structure
[Set Security Violation Message]
Setting up the violation response → The system assigns the display violation message number to the system message
[Extract MS Table Key - Message ID]
Formatting error display for the table → The system extracts the first Message ID as the table key
[Start Position Required?]
The system checks if display is within segment end → If display within segment end is not zero, then start position finding is required
[Extract MS Table Key - Message ID]
The table type is MS-TABLE-ID (Message table) → The system extracts the first Message ID (GCM49-MSG-ID) as the table key
[Process Table Request]
The system needs to execute the table request → The system calls program GCX004B2 with input message, table data, and output parameters to process the request
[US Security Access Level?]
The system checks VALID-US-SEC-ACCESS indicator → If VALID-US-SEC-ACCESS equals SPACE then allow modification operation, otherwise deny access with update violation message
[Call External Paging Module GCX004B3]
The system needs to process the paging operation → The system calls external module GCX004B3 with input message, table data, and receives updated output message, selection code, and system message
[Clear Screen Message]
The system processes the main menu return request → The screen message field is cleared by setting it to spaces
[Copy Input to Output Message]
The system prepares the output for main menu display → The input message is copied to the output message to preserve user context
[Set Main Menu Screen Code]
The system determines the next screen to display → The output select code is set to main menu screen identifier
[Clear System Message]
The system finalizes the main menu return process → The system message number is cleared by setting it to spaces
[Clear Screen Message]
The system processes the return to tables menu request → The screen message field is cleared to spaces
[Copy Input to Output Message]
The system processes the return to tables menu request → The input message is copied to the output message field
[Clear System Message]
The system processes the return to tables menu request → The system message number is cleared to spaces
[Display Within Segment End > 0?]
The display within segment end indicator is greater than zero → The system should proceed to locate the starting position in the table data
[Call External Module GCX004DT]
The system needs to find the starting position in table data → The system should call external module GCX004DT with table identification, table data structure, table end pointer, and search key criteria to receive an updated table pointer
[Call External Display Module GCX004DP]
The format display process is initiated → The system calls external module GCX004DP with table identification, table data structure, current position pointer, end position pointer, output message structure, screen selection code, and system message number to format the display output
[Extract Message ID Key]
The system needs to extract the table key for message records → The message ID from the first record should be moved to the table key field
[Call Specialized Table Processing Module GCX004B2]
The system needs to process the table request → The system calls the specialized table processing module GCX004B2 with the input message, table data structure, and receives back the processed output message, updated screen selection code, and system message number
[Pass Input Message to Module]
The system calls the GCX004B2 module → The INPUT-MESSAGE containing the user's table request data is passed as a parameter to the processing module
[Receive Processed Output Message]
The module returns control to the main program → The system receives the processed OUTPUT-MESSAGE containing the results of the table operation
[Receive System Message Number]
The module returns control to the main program → The system receives the SYSTEM-MSG-NUM indicating the status or outcome message to display to the user
[Extract Message Table Key]
The system needs to extract the table key for error display → The system extracts the first message ID as the table key
[Display Position Available?]
The system needs to determine the starting display position → The system checks if the display within segment end position is not zero
[Find Starting Position in Table]
The system needs to find the starting position for table display → The system calls the table positioning service to find the start position using the table key
[Copy Input to Output Message]
The system prepares the error display output → The system copies the input message to the output message
[Format Display for Screen]
The system needs to format the error display → The system calls the display formatting service to prepare the screen output
[Set Invalid PF Key Message Number]
The error display process is completing → The system sets the invalid PF key message number as the system message
[Extract MS Table Key - Message ID]
Table key extraction is required for search or display operations → The Message ID from the first table entry should be extracted as the table key

Structural Validations

[16:Handle Error Display]
Error display handling is invoked → The system loads table data, extracts appropriate table key based on table type, finds start position if within segment end, copies input to output message, formats display output, and sets invalid PF key message number
[User Has Message Access?]
The user's message access permission equals INVALID-USER status → The system sets error indicator to '1' to deny access
[Format Error Display Screen]
The system needs to display the error screen → The system calls the display formatting service to prepare the output message and screen
[Set Invalid PF Key Message]
The system completes invalid PF key processing → The system sets the invalid PF key message number for display to the user
[Format Error Display]
If the user security access level → The system formats an error display and sets the system message to update violation message number

Module: GCX004B2 1 Consolidated Epic Story

Epic: GCX004B2 Complete EDI Specification Extracted from Legacy

Contains 35 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004B2 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Edit Request Validation]
Request validation is performed → The system calls the edit service to validate the request and returns validation status with any system messages
[4:Format Display Output]
Display formatting is requested → The system calls the display formatting service to create formatted output message and selection codes
[6:Format Update Output]
Update formatting is requested → The system calls the update formatting service to create formatted output message and selection codes
[8:Process Scroll Request]
Display data exists within segment boundaries → If request validation succeeds, format display output; if validation fails, find start position and then format display output
[9:Process Update Request]
Display data exists within segment boundaries:
function is ADD
→ If request validation succeeds, format update output; if validation fails and function is not ADD, find start position and display; if validation fails and function is ADD, set start position, find start position, and display
[Get Table ID from Input]
The system processes the input message → The table ID is extracted and stored for subsequent processing
[Start Edit Request Validation]
The system needs to validate the request → The system calls the GCX004ED validation service with required parameters
[Generate System Messages if Needed]
The system needs to communicate validation outcomes → The system generates appropriate system messages and updates message numbers as needed
[Format Table Data for Screen Display]
Display formatting is requested → System calls external formatting program to convert table data into screen display format using table ID, table data, position pointers and generates formatted output message, selection codes and system messages
[Generate Output Message]
External formatting program processes the table data → System produces output message containing formatted table data ready for screen presentation
[Prepare System Messages]
Formatting program completes processing → System generates system messages indicating the status of the display operation and any relevant information for the user
[Extract Message ID as Key]
The system needs to find the starting position in the table → The Message ID from the first table entry is extracted and used as the table key
[Message Table - Extract Message ID]
The system needs to determine the table key for positioning → The Message ID from the first table entry should be extracted and set as the table key
[Call Update Formatting Module GCX004UP]
The system needs to format the update operation output → The system calls the update formatting module with input message data, common control information, and generates formatted output message, selection codes, and system messages
[Set Message Number as Starting Position]
The system needs to set the starting position for the new record → The message number from the input key is moved to the first position of the message ID array
[Set Message Start Position]
Setting start position for table navigation → The table key should be set to the first message ID from the table
[Display Within Segment End ≠ Zero?]
The system checks for available data to display → If display within segment end is not equal to zero, proceed with validation, otherwise copy input to output
[Validate Input Request Parameters]
The system validates the scroll request parameters → The system calls validation routine and returns validation status
[Copy Input Message to Output]
The system processes the scroll request → The system copies the input message to output message
[Format Table Data for Display]
The system needs to present output to the user → The system formats the copied message for display
[Data Available to Process OR Add Function?]
If data availability conditions → The system proceeds with validation if display is within segment end OR function equals add function, otherwise copies input to output
[Format Update Output for Processing]
The system processes the validated update request → The system calls update formatting service to prepare output message and select code
[Format Display Output]
The system prepares recovery display → The system calls display formatting service to prepare output message and select code
[Copy Input to Output Message]
The system processes the request with no available data → The system copies the input message directly to output message
[Format Display Output]
The system prepares final display → The system calls display formatting service to prepare final output message and select code
[Operation Type?]
If the function type in the request → If function is empty/space, Execute scroll request processing, otherwise Execute update request processing
[Extract Message ID from First Table Entry]
The system needs to determine the starting position for display → Extract the message ID from the first table entry (GCM49-MSG-ID position 1) and use it as the table key
[Set Table Key = Message ID]
The system prepares to find the starting position in the message table → Set the table key equal to the extracted message ID value
[Find Starting Position in Message Table]
The system needs to position within the message table for display → Call the table positioning service to find the starting position using the message table ID, table data, and table key
[Extract Message Number from Input]
The system needs to initialize a new message entry → Extract the message number from the input message data (GCM49-MESSAGE-NUM)
[Set Message ID = Message Number]
The system initializes the first entry in the message table array → Set the message ID in the first table position equal to the extracted message number
[Position Table for New Message Entry]
The system needs to position the table for the add operation → Find the appropriate starting position in the message table and prepare for display
[Extract DS Code from Input Message]
The system processes a new DS code entry → The DS code from the input (GCMWK-DS-CODE) is moved to the first table entry position (GCMWK-DSCODE position 1)

Structural Validations

[Validate Request Parameters Against Table Structure]
The system validates the request parameters against the table structure → The system checks parameter compatibility with table definitions and sets validation status accordingly
[Check Input Message Format]
The system checks the input message format → The system validates message structure and format compliance

Module: GCX004B3 1 Consolidated Epic Story

Epic: GCX004B3 Complete EDI Specification Extracted from Legacy

Contains 101 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004B3 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Extract Table Information]
The system processes the input message → The system should extract the table ID from the input message for table processing
[7:Extract Table Key Based on Table Type]
The system needs to extract the table key → The system should extract Customer Admin ID for AD table, Range Name for DR table, Terminal ID for LT table, Manifest ID for MC table, Message ID for MS table, Station Code for SC table, Station Name for SE table, User Code for US table, Auto ID for AU table, Amendment Code for AC table, Broker Name and Port Code for BK table, Carrier SCAC for CC table, Country Name for CT table, Sequence Number for RF table, US Port Name for SD table, Foreign Port Name for SK table, Manifest Unit for MU table, Display Code for DC table, Carrier and Port for SS table, Car ID for ID table, Car Type for VI table, KS Code for KS table, DS Code for DS table, Country and Status Code for S1 table, or Code and Qualifier for ST table
[9:Calculate New Display Position]
The system calculates the new position → The system should search table configuration, validate forward page request if page forward key is pressed, or validate backward page request if page backward key is pressed, and clear screen messages
[12:Calculate Current Location]
The system calculates current location → The system should compute current location as (segment number minus 1) multiplied by entries per segment plus displacement within segment
[13:Calculate End Location]
The system calculates end location → The system should compute end location as (end segment number minus 1) multiplied by entries per segment plus displacement within end segment
[15:Handle End of Table]
The system compares new location with end location → The system should set pointer to table end if new location equals end location, calculate new segment position if new location is less than end location, or set last page message if new location exceeds end location
[16:Calculate New Segment Position]
The system calculates new segment position → The system should divide new location by entries per segment to get new segment number and remainder as new displacement within segment
[17:Adjust Segment Boundary]
The new displacement within segment equals zero → The system should set displacement to entries per segment and use new table pointer, otherwise add 1 to new segment number and use new table pointer
[18:Set Last Page Message]
The new location is greater than end location → The system should set the last page message number in system message
[20:Handle Beginning of Table]
Current location is not greater than entries per page → The system should set pointer to start position and set first page message number in system message
[21:Calculate Backward New Location]
The system calculates backward new location → The system should compute new location as current location minus entries per page, divide by entries per segment to get new segment number and displacement, and adjust segment boundary if displacement equals zero by setting displacement to entries per segment, otherwise add 1 to new segment number
[22:Clear Screen Messages]
The system finishes position calculations → The system should clear screen message field and function field by setting them to spaces
[23:Format Display Output]
The system needs to format output for display → The system should call the display formatting service with table ID, table data, current pointer, end pointer, output message, select code, and system message number
[Extract Table ID from Input Message]
The system needs to determine which table to process → The GCMTB-TABLE-ID from the input message must be moved to TABLE-ID for table processing
[Read Table ID from GCMTB-TABLE-ID Field]
The system needs to determine which table to process → The table ID is extracted from the GCMTB-TABLE-ID field in the input message and stored for processing
[Move Table ID to Working Storage Variable]
The system prepares for table processing operations → The table ID is moved to the TABLE-ID working storage variable for use in table loading and navigation functions
[Call External Module GCX004LD]
The system needs to load table data for processing → The external table loading module GCX004LD is invoked with the communication area, table identifier, working storage table structure, and table end pointer to load the complete table data into memory
[Pass Communication Area]
Table loading is initiated → The table identifier from the input message is moved to the working storage table ID field to establish which specific business table needs to be loaded
[Check User Input Key]
The system checks the PF-KEY field in the input message → The system determines if the key is PAGE-FWD, PAGE-BCK, or neither
[Process Navigation with Current Position]
DISPL-WITHIN-SEG-END != ZERO → The system finds current position, calculates new position, copies input to output message, and formats display
[Process Navigation without Position Change]
DISPL-WITHIN-SEG-END equals ZERO → The system clears screen messages and function fields, copies input to output message, and formats display
[Process Non-Navigation Request]
DISPL-WITHIN-SEG-END != ZERO → The system finds current position, copies input to output message, and formats display
[Clear Screen Messages]
DISPL-WITHIN-SEG-END equals ZERO → The system moves SPACE to GCMTB-SCREEN-MSG and GCMTB-FUNCTION fields
[Prepare for Display Processing]
All position calculations and message preparations are complete → The system invokes display formatting with input copied to output message
[Table Has Data Entries Available]
User requests page forward (PAGE-FWD) or page backward (PAGE-BCK) navigation → System performs current position finding, calculates new position, copies input message to output message, and formats display
[Table Has No Data Entries]
User requests page forward (PAGE-FWD) or page backward (PAGE-BCK) navigation → System clears screen message and function fields to spaces, copies input message to output message, and formats display without position calculations
[Proceed with Current Position Finding]
System processes the request → System performs current position finding, copies input message to output message, and formats display
[Clear Screen Messages and Functions]
System processes the request → System clears screen message and function fields to spaces, copies input message to output message, and formats display
[Extract MS Table Key - Message ID]
The system needs to extract the table key for position finding → The Message ID from the first displayed entry is moved to the table key
[Extract Message ID from first entry of GCM49-MSG-ID array]
The table ID equals MS-TABLE-ID → The system extracts the Message ID from the first entry of the GCM49-MSG-ID array and moves it to the TABLE-KEY field
[MS Table: Extract Message ID]
The system needs to extract a table key for position finding → The Message ID from the first table entry is moved to the table key
[Search Table Configuration for Entries Per Page and Entries Per Segment]
The system searches for table configuration parameters → The system retrieves entries per page and entries per segment for the specified table, or triggers an error if table is not found
[Calculate Current Location from Segment and Displacement]
Forward page navigation is requested → The system computes current location as (segment number - 1) multiplied by entries per segment plus displacement within segment
[Calculate End Location from End Segment and Displacement]
Forward page navigation boundary checking is performed → The system computes end location as (end segment number - 1) multiplied by entries per segment plus end displacement within segment
[Calculate New Segment Number and Displacement]
Forward navigation position needs to be converted to segment format → The system divides new location by entries per segment to get segment number and remainder as displacement
[Displacement is Zero?]
The displacement within segment equals zero → The system sets displacement to entries per segment and uses the calculated segment position
[Adjust to Previous Segment with Full Entries]
Position adjustment is needed for proper segment alignment → The system sets displacement to entries per segment value
[Set New Table Position]
Forward navigation position needs to be applied → The system moves the new calculated table pointer to the current table pointer
[Set Last Page Message]
The system cannot navigate further forward → The system sets the last page message number to inform the user
[Set Pointer to Start of Table and First Page Message]
Backward navigation is requested → The system sets pointer to start position and sets first page message number
[Calculate New Segment Number and Displacement for Backward]
Backward navigation position needs to be converted to segment format → The system divides new location by entries per segment to get segment number and remainder as displacement
[Backward Displacement is Zero?]
The displacement within segment equals zero → The system adjusts to previous segment with full entries, otherwise uses calculated position
[Adjust to Previous Segment for Backward Navigation]
Backward position adjustment is needed for proper segment alignment → The system sets displacement to entries per segment and adds 1 to segment number
[Set New Backward Table Position]
Backward navigation position needs to be applied → The system moves the new calculated table pointer to the current table pointer
[Clear Screen Messages and Function Fields]
The system finalizes the navigation process → The system clears screen message and function fields by moving spaces to them
[Search Through Configuration Table Entries]
The system searches through configuration table entries using the table ID → The system should find the matching table entry and extract entries per page and entries per segment values
[Extract Entries Per Segment Value]
The system continues retrieving configuration parameters → The system should extract and store the entries per segment value from the matched configuration entry
[Calculate Current Location - Current = 'Segment - 1' × Entries per Segment + Displacement]
Forward page navigation is requested → System calculates current location as (segment number minus 1) multiplied by entries per segment plus current displacement within segment
[Calculate End Location - End = 'End Segment - 1' × Entries per Segment + End Displacement]
Forward page navigation validation is performed → System calculates end location as (end segment number minus 1) multiplied by entries per segment plus end displacement within segment
[Calculate New Segment Number - Divide New Location by Entries per Segment]
Forward navigation is within valid bounds → System divides new location by entries per segment to get segment number and remainder as displacement within segment
[Set Displacement to Entries per Segment - Use Current Segment]
Forward navigation segment position is calculated → System sets displacement to entries per segment and uses current calculated segment number
[Add 1 to Segment Number - Use Calculated Displacement]
Forward navigation segment position is calculated → System adds 1 to calculated segment number and uses calculated displacement
[Set Last Page Message]
New location is greater than or equal to end location → System sets last page message to inform user they have reached the end of available data
[Calculate: Current Location = 'Segment Number - 1' × Entries Per Segment + Displacement Within Segment]
The system needs to calculate the absolute current location for navigation operations → The current location is computed as (segment number minus 1) multiplied by entries per segment plus displacement within current segment
[Calculate: Current Location = 'Segment Number - 1' × Entries Per Segment + Displacement Within Segment]
The system needs to calculate the absolute end location for boundary checking during navigation → The end location is computed as (end segment number minus 1) multiplied by entries per segment plus displacement within end segment
[Calculate: Current Location = 'Segment Number - 1' × Entries Per Segment + Displacement Within Segment]
The system calculates new position for forward navigation → The new location is computed as current location plus entries per page
[Calculate: Current Location = 'Segment Number - 1' × Entries Per Segment + Displacement Within Segment]
The system calculates new position for backward navigation → The new location is computed as current location minus entries per page
[Calculate: End Location = 'End Segment - 1' × Entries Per Segment + End Displacement]
The system needs to calculate the end location for table navigation → The end location is computed as (end segment number minus 1) multiplied by entries per segment plus the end displacement within the final segment
[Get Current Position from Segment Number and Displacement]
The system needs to calculate the current absolute position for forward navigation → The current position is calculated as (SEG-NO - 1) multiplied by WS-ENTRIES-PER-SEG plus DISPL-WITHIN-SEG
[Get End Position from End Segment and End Displacement]
The system needs to calculate the absolute end position for navigation boundary validation → The end position is calculated as (SEG-NO-END - 1) multiplied by WS-ENTRIES-PER-SEG plus DISPL-WITHIN-SEG-END
[Calculate New Segment Number by Dividing New Location by Entries Per Segment]
Forward navigation is within valid table bounds → The system divides NEW-LOCATION by WS-ENTRIES-PER-SEG to get NEW-SEG-NO and NEW-DISPL-WITHIN-SEG as remainder
[Set Displacement to Entries Per Segment and Use Current Segment]
Forward navigation calculation results in exact segment boundary positioning → The system sets NEW-DISPL-WITHIN-SEG to WS-ENTRIES-PER-SEG and uses NEW-GCTABLE-PTR as GCWTABLE-PTR
[Add 1 to Segment Number and Use Calculated Displacement]
Forward navigation calculation results in positioning within a segment → The system adds 1 to NEW-SEG-NO and sets GCWTABLE-PTR to NEW-GCTABLE-PTR
[Display Last Page Message]
User requests forward navigation that would go beyond available data → The system sets SYSTEM-MSG-NUM to LAST-PAGE-MSG-NUM to inform user they are at the last page
[Calculate New Segment Position]
The new position is within valid table bounds → The system calculates new segment number by dividing new location by entries per segment, determines displacement within segment from remainder, and adjusts segment number and sets table pointer if displacement is zero
[Set Last Page Message]
The calculated new position is greater than the end location of the table → The system sets a last page message number to inform the user no further forward navigation is possible
[Calculate New Segment Position - Divide new location by entries per segment to get new segment and displacement]
The system needs to determine the segment number and displacement within segment for the new location → The system divides the new location by entries per segment to get the segment number and remainder as displacement
[Is New Displacement Zero?]
The displacement within segment equals zero → The system sets the displacement to the maximum entries per segment value
[Add 1 to New Segment Number]
The segment position calculation is being finalized → The system adds 1 to the new segment number to get the correct segment position
[Update Table Pointer to New Position]
The position calculation is complete → The system moves the calculated new table pointer value to the active table pointer
[Is Displacement Zero?]
The displacement within segment equals zero → Set displacement to entries per segment value and use the calculated segment number as the new table pointer
[Add 1 to Segment Number]
The displacement within segment != zero → Add 1 to the calculated segment number and use the new segment number as the new table pointer
[Calculate New Segment and Displacement]
The new location needs to be converted to segment and displacement coordinates → Divide new location by entries per segment to get segment number and remainder as displacement within segment
[Set Last Page Message - Display message when user tries to go beyond last page]
The calculated new location is greater than the end location of available table entries → The system sets a last page message number to inform the user they cannot navigate further forward
[Calculate Current Position in Table]
User requests backward page navigation → System calculates current absolute position by multiplying segment number minus 1 by entries per segment and adding displacement within segment
[Display First Page Message]
User attempts to navigate to previous page → System sets first page message number to inform user they are at the beginning
[Determine New Segment Number]
System needs to determine table location → System divides new position by entries per segment to get segment number and remainder as displacement within segment
[Is Displacement Zero?]
System determines final table position → If displacement within segment equals zero, special boundary handling is required
[Adjust to Previous Segment End]
System sets final table position for backward navigation → System sets displacement to entries per segment to position at end of previous segment
[Set New Table Position]
System finalizes backward navigation position → System sets table pointer to new calculated table pointer position
[Increment Segment Number]
System determines final segment position → System adds 1 to new segment number to adjust for segment boundary calculation
[Handle Beginning of Table - Set pointer to start and display first page message when at beginning]
The current position is less than or equal to the number of entries per page (indicating the user is at or near the beginning of the table) → The system sets the table pointer to the start position and displays a first page message to inform the user they have reached the beginning
[Calculate Current Position in Table]
The system processes the backward navigation request → The system calculates the present location using the formula: (segment number - 1) multiplied by entries per segment plus displacement within segment
[Set First Page Message]
The system detects the user cannot navigate further backward → The system sets the first page message number to the system message to inform the user of their position
[Continue with Normal Backward Navigation]
A backward navigation request is processed → The system calculates the new location by subtracting entries per page from the current location and determines the appropriate new segment number and displacement within segment
[Calculate Current Position in Table]
The system needs to calculate the current absolute position for backward navigation → The current position is calculated as (segment number minus 1) multiplied by entries per segment plus the displacement within segment
[Is Current Position Near Beginning?]
If backward navigation is possible → If current position is not greater than entries per page, the system sets pointer to start and displays first page message, otherwise it proceeds with backward calculation
[Determine New Segment Number]
The system needs to determine the segment and displacement → The new location is divided by entries per segment giving the segment number and remainder giving the displacement within segment
[Is Displacement Zero?]
The displacement equals zero → The displacement is set to entries per segment and the table pointer is set to the new position, otherwise the segment number is incremented by 1 and the table pointer is set
[Position Set to New Location]
Backward navigation is requested → The table pointer is set to pointer start and the system message number is set to first page message
[Reset screen message and function fields to spaces]
Screen messages need to be cleared for display formatting → The screen message field is set to spaces AND the function field is set to spaces
[Format Display Output - Call external module to format the table data for display]
The format display process is initiated → The system calls external formatting module GCX004DP with all required parameters including communication area, table identifier, working storage table, current table position pointer, end table position pointer, output message structure, output select code, and system message number to produce formatted display output
[Search Configuration Table for Table ID]
The system searches for the table ID in the configuration table → The system should find the matching table ID and extract entries per page and entries per segment configuration values
[Extract Entries Per Segment Configuration]
The system continues to retrieve pagination settings for the table → The system should extract the entries per segment value from the configuration entry and store it in working storage

Structural Validations

[5:Check Table Data Availability]
The system checks for data availability → The system should determine if display within segment end is not equal to zero (indicating data exists) or equals zero (indicating no data)
[10:Search Table Configuration]
The system searches for table configuration → The system should find the matching table entry and extract entries per page and entries per segment, or trigger error handling if table configuration is not found
[24:Handle Table Configuration Error]
The table search fails to find matching configuration → The system should move table ID to error message, set error message, and call error handling service
[New Location Less Than End Location?]
The system checks if navigation is within bounds → If new location is less than end location, proceed with position calculation, otherwise set last page message
[Handle Table Configuration Error - Display error message and abend if table ID not found in configuration]
The table ID is not found in any configuration entries (search reaches end without match) → The system should move the table ID to error field, set appropriate error message, and terminate the program through error handler

Module: GCX004C1 1 Consolidated Epic Story

Epic: GCX004C1 Complete EDI Specification Extracted from Legacy

Contains 296 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004C1 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[4:Invalid Function Handling - Invalid DELETE/EXPAND]
The current function is set to DELETE or EXPAND → The system treats this as an invalid operation and displays appropriate restriction message
[6:Table Key Construction - Set Table Key]
Table key construction is required for table positioning → The system builds the appropriate key structure based on table type (AD uses customer admin ID, DR uses range name, BK uses broker name and port, SS uses SCAC and port codes, etc.)
[8:Display Screen Formatting - Format Display Screen]
Screen display formatting is initiated → The system calls GCX004DP program to format the display screen with current table data, output message, select code, and system message number
[11:Update Request Processing - Process Update]
The system checks if display segment end is not zero:
function is ADD
→ If condition is met, proceed with validation and update process; otherwise clear function and message fields and display current screen
[12:Data Validation - Validate Update]
Data validation is initiated → The system calls GCX004C2 program to validate input data and returns validation status, output message, select code, and system message
[13:Database Update - Update Table Database]
Database update is initiated → The system calls GCX004C3 program to update the table database and returns system message number
[15:Main Menu Navigation - Return to Menu]
Main menu navigation is initiated → The system clears the rest of message field, sets main menu screen as output select code, and clears system message number
[16:Display Refresh - Format Display]
Display refresh is initiated → The system loads tables, sets table key if display segment end is not zero, finds start position, clears function and message fields, copies input to output message, and formats display screen
[Check MS Table - Message Access]
The system checks the user's message security level → Access is denied if the user has invalid message privileges by setting error indicator to '1'
[Check Message Permission]
The system checks the user's message security permission → Access is denied if the user has invalid message permissions
[Check MS Table - Message Privileges]
The system checks the user's message privileges → Grant update authorization if user has UPDATE-USER or SUPER-USER privileges, otherwise deny authorization
[Check Message Privilege]
The system checks user privileges for Message table updates → The system allows update if user has UPDATE-USER or SUPER-USER privileges, otherwise maintains error indicator
[Route to Invalid PF Key Handler]
The function is DELETE-FUNCTION or EXPAND-FUNCTION → The system routes to invalid PF key processing (A200-INVALID-PFKEY) and sets appropriate error message (EXPAND-MSG-NUM for expand function)
[Route to Invalid PF Key Handler]
The user does not have update permissions (ERROR-INDICATOR is not SPACE after update check) → The system routes to invalid PF key processing (A200-INVALID-PFKEY) and sets table update not allowed message (TBL-UPD-NOT-ALLOWED)
[DELETE Function Invalid]
The function type is DELETE → The system sets the confirm delete message number and proceeds to determine the appropriate table-specific update screen
[EXPAND Function Invalid]
The function type is EXPAND → The system sets the expand message number and proceeds to determine the appropriate table-specific update screen
[Set Invalid PF Key Message]
The function is not DELETE and not EXPAND → The system sets the invalid PF key message number
[Apply Field Protection Settings]
Field protection needs to be applied for the specific table type → The system sets all relevant fields to non-editable protection status and copies input message to output message
[Map to MS Table Update Screen]
The table ID is MS-TABLE-ID (Message table) → The system sets the output select code to TABLE-MS-UPDATE-SCREEN
[Set AD Table Field Protection]
Field protection settings are applied → All AD table fields including Public Merlin ID, DC Merlin fields, Purge Days, Warning Days, Escalation Hours, Readd Flag, Auto Fax, System Merlin Fax, and X400 fields are set to non-editable AND input message is copied to output message
[Set DR Table Field Protection]
Field protection settings are applied → All 20 station number fields (01 through 20) are set to non-editable
[Set LT Table Field Protection]
Field protection settings are applied → Alternate and Supervisor Merlin ID fields are set to non-editable AND input message is copied to output message
[Set MC Table Field Protection]
Field protection settings are applied → All MC fields including Canadian Customs Code, Sublocation, US Station Exit, Station Number, Merlin ID, IM Indicator, Print Batches, Border Port, Call Letters, Alt Merlin ID, Vista Class SCAC/FSAC, and Set Clear Carload/Intermodal fields are set to non-editable AND input message is copied to output message
[Set MS Table Field Protection]
Field protection settings are applied → Message English Text, Message Error Type, and Message Notes fields are set to non-editable AND input message is copied to output message
[Set SC Table Field Protection]
Field protection settings are applied → All SC fields including Canadian/US Station Names and Codes, Fax Numbers, Fax Copy ID, Fax Flag, FIRMS Code, and Time Zone are set to non-editable AND input message is copied to output message
[Set SE Table Field Protection]
Field protection settings are applied → Input message is copied to output message
[Set US Table Field Protection]
Field protection settings are applied → User Name field is set to non-editable AND special user security field protection is applied AND input message is copied to output message
[Apply User Security Special Protection]
Special user security protection is executed → All user permission fields including Amendment, Manifest Station, Cargo Charges, Train Charges, Administration, Message, Cargo Delete, Train Delete, Automotive, Manifest Unit, Cargo Add, Train Add, Broker, Bond Siding, Cargo Readd, Train Readd, Carrier Code, Station Entry, Cargo Arrival, Train Arrival, Country, Schedule D, Cargo Cancel Arrival, Train Cancel Arrival, Disposition Code, Station Selection, Cargo Export, Train Enroute, Manifest Upon, Schedule K, Cargo Cancel Export, Train Overtime Error, Train Special Manifest, Car ID, User Security, Cargo International Export, SK by Port, Car Kind, Cargo Cancel Place, Error Route, Cargo Cancel Suspend, Cargo Cancel Release, Crossing, Cargo Restriction, and Broker Name fields are set to non-editable
[Set SCAC Arrays Protection]
SCAC array protection is executed → All 5 elements of SCAC Allowed array are set to non-editable AND all 5 elements of SCAC Refused array are set to non-editable
[Set AU Table Field Protection]
Field protection settings are applied → Importer and Business Number fields are set to non-editable AND input message is copied to output message
[Set AC Table Field Protection]
Field protection settings are applied → Amendment Description field is set to cursor-protected AND input message is copied to output message
[Set BK Table Field Protection]
Field protection settings are applied → All BK fields including Broker Office Code, Fax Number, Full Name, Merlin, Use Fax, Use Merlin, Use X12, Use Internet, X12 Header, Internet, CA Filer Code, Use Paper, Delivery Schedule, LTerm, Info fields, and Alt Code are set to non-editable AND input message is copied to output message
[Set CC Table Field Protection]
Field protection settings are applied → Carrier Name, CCRA Code, USCS Code, Arrival Report, Export Report, and IRS Number fields are set to non-editable AND input message is copied to output message
[Set CT Table Field Protection]
Field protection settings are applied → ISO Country Code field is set to non-editable AND input message is copied to output message
[Set RF Table Field Protection]
Field protection settings are applied → Sub Location Code field is set to cursor-protected AND input message is copied to output message
[Set SD Table Field Protection]
Field protection settings are applied → All SD fields including US Port Code, Merlin, Destination Station, SPLC, Route Suppress IT/TE, Customer Auth IT/TE, Cancel Merlin, Vista Class SCAC/FSAC, Set Clear Carload/Intermodal, FIRMS Code, SPLC Codes 1-4, and Arrival/Export Days are set to non-editable AND input message is copied to output message
[Set SK Table Field Protection]
Field protection settings are applied → Foreign Port Code field is set to non-editable AND input message is copied to output message
[Set MU Table Field Protection]
Field protection settings are applied → Manifest Unit Description field is set to non-editable AND input message is copied to output message
[Set DC Table Field Protection]
Field protection settings are applied → All DC fields including Disposition Code Description, Location, Quantity Action, Process Type, Merlin Messages, Counterpart DC fields 1-10, CTP Match Method fields 1-10, Notify IM, and Post to DB are set to non-editable AND input message is copied to output message
[Set SS Table Field Protection]
Field protection settings are applied → Automated Carrier, Haulage Agreement, Line Bill Init, Line Bond Init, Haul Bill Init, Haul Bond Init, and SNP Indicator fields are set to non-editable AND input message is copied to output message
[Set ID Table Field Protection]
Field protection settings are applied → Canadian Empty Manifest, Canadian Loaded Manifest, American Empty Manifest, and American Loaded Manifest fields are set to non-editable AND input message is copied to output message
[Set VI Table Field Protection]
Field protection settings are applied → Description, Loaded, Empty, Transit, Conveying, and APHIS fields are set to non-editable AND input message is copied to output message
[Set KS Table Field Protection, Set DS Table Field Protection]
Field protection settings are applied → Name field is set to non-editable AND input message is copied to output message
[Set S1 Table Field Protection]
Field protection settings are applied → CSD Code field is set to non-editable AND input message is copied to output message
[Set ST Table Field Protection]
Field protection settings are applied → Description and all Type Code, Country, and Description fields for types 01, 02, and 03 are set to non-editable AND input message is copied to output message
[Copy Input Message to Output Message]
All field protections have been applied → The input message should be copied to the output message
[Set Public Merlin ID Field as Non-Protected]
The system processes field protection settings for the Administration table → All administrative fields including Public Merlin ID, DC Merlin fields (1-5), Purge Days, Warning Days, Escalation Hours, Readd Flag, Auto Fax, System Merlin Fax, and X400 fields are set as non-protected and the input message is copied to output message
[Update Screen Message]
The system completes field protection processing for Administration table → The input message is copied to the output message to update the screen display
[Apply Protection Settings to Screen]
The system completes the field protection setup process → The input message must be copied to the output message to maintain screen state consistency
[Set Communication Settings Fields Protection (Readd Flag, Auto Fax, System Merlin Fax, X400)]
The system needs to set field protection for communication settings → The system shall set no-cursor protection on Readd Flag field, Auto Fax field, System Merlin Fax field, and X400 field, and update the input message to output message
[Update Screen Message]
The system completes the field protection process → The system shall move INPUT-MESSAGE to OUTPUT-MESSAGE to update the screen display
[Set Station Number Fields Protection (Station Numbers 01-20)]
The table ID is DR-TABLE-ID (Station Range table) → The system shall set protection attributes on all 20 station number fields (GCM44-STATION-NUM-01-A through GCM44-STATION-NUM-20-A) to prevent user input and copy the input message to output message
[Copy Input Message to Output Message]
Finalizing MC table field protection → The input message should be copied to the output message
[Copy Input Message to Output Message]
The system finalizes MC table processing → The input message should be copied to the output message to preserve the original request context
[Copy Input Message to Output Message]
All MC table fields have been protected → The input message content is copied to the output message to preserve the original message data
[Set Broker Office Code Field as Editable]
The broker office code field protection is being configured → The broker office code field should be set as editable to allow user input
[Set Broker FAX Number Field as Editable]
The broker FAX number field protection is being configured → The broker FAX number field should be set as editable to allow user input
[Set Broker Full Name Field as Editable]
The broker full name field protection is being configured → The broker full name field should be set as editable to allow user input
[Set Broker Merlin ID Field as Editable]
The broker Merlin ID field protection is being configured → The broker Merlin ID field should be set as editable to allow user input
[Set Use FAX Flag Field as Editable]
The use FAX flag field protection is being configured → The use FAX flag field should be set as editable to allow user input
[Set Use Merlin Flag Field as Editable]
The use Merlin flag field protection is being configured → The use Merlin flag field should be set as editable to allow user input
[Set Use X12 Flag Field as Editable]
The use X12 flag field protection is being configured → The use X12 flag field should be set as editable to allow user input
[Set Use Internet Flag Field as Editable]
The use Internet flag field protection is being configured → The use Internet flag field should be set as editable to allow user input
[Set X12 Header Field as Editable]
The X12 header field protection is being configured → The X12 header field should be set as editable to allow user input
[Set Internet Address Field as Editable]
The Internet address field protection is being configured → The Internet address field should be set as editable to allow user input
[Set Canadian Filer Code Field as Editable]
The Canadian filer code field protection is being configured → The Canadian filer code field should be set as editable to allow user input
[Set Use Paper Flag Field as Editable]
The use paper flag field protection is being configured → The use paper flag field should be set as editable to allow user input
[Set Delivery Schedule Field as Editable]
The delivery schedule field protection is being configured → The delivery schedule field should be set as editable to allow user input
[Set Terminal ID Field as Editable]
The terminal ID field protection is being configured → The terminal ID field should be set as editable to allow user input
[Set Broker Info Line 1 Field as Editable]
The broker information line 1 field protection is being configured → The broker information line 1 field should be set as editable to allow user input
[Set Broker Info Line 2 Field as Editable]
The broker information line 2 field protection is being configured → The broker information line 2 field should be set as editable to allow user input
[Set Alternative Code Field as Editable]
The alternative code field protection is being configured → The alternative code field should be set as editable to allow user input
[Copy Input Message to Output Message]
All broker table field protections have been configured → The input message should be copied to the output message to preserve the original message content
[Copy Input Message to Output]
The system completes setting broker fields as editable → The input message is copied to the output message to maintain data continuity
[Update Screen Message]
The field protection process is finalized → The input message must be copied to the output message to maintain screen display consistency
[Update Input Message to Output Message]
The screen message needs to be updated for user display → The input message content must be copied to the output message for display to the user
[Copy Input Message to Output Message]
The system completes CC table field protection configuration → The input message should be copied to the output message
[Set Carrier Name Field as Editable]
The system processes field protection settings for carrier information → The carrier name field should be set as editable (WS-NOCUR-PROTECT) to allow user input
[Set CCRA Code Field as Editable]
The system processes field protection settings for carrier regulatory information → The CCRA code field should be set as editable (WS-NOCUR-PROTECT) to allow user input
[Set USCS Code Field as Editable]
The system processes field protection settings for carrier customs information → The USCS code field should be set as editable (WS-NOCUR-PROTECT) to allow user input
[Set Arrival Report Field as Editable]
The system processes field protection settings for carrier reporting configuration → The arrival report field should be set as editable (WS-NOCUR-PROTECT) to allow user input
[Set Export Report Field as Editable]
The system processes field protection settings for carrier export reporting configuration → The export report field should be set as editable (WS-NOCUR-PROTECT) to allow user input
[Set IRS Number Field as Editable]
The system processes field protection settings for carrier tax identification → The IRS number field should be set as editable (WS-NOCUR-PROTECT) to allow user input
[Copy Input Message to Output Message]
The system completes the field protection configuration process → The input message should be copied to the output message to maintain message continuity
[Copy Input Message to Output]
The field protection setup is completed → The input message should be copied to the output message to maintain screen display consistency
[Set US Port Code Field as Editable]
The table ID is SD-TABLE-ID → The US Port Code field should be set as editable (no cursor protection)
[Set US Merlin Field as Editable]
The table ID is SD-TABLE-ID → The US Merlin field should be set as editable (no cursor protection)
[Set US Destination Station Field as Editable]
The table ID is SD-TABLE-ID → The US Destination Station field should be set as editable (no cursor protection)
[Set US SPLC Field as Editable]
The table ID is SD-TABLE-ID → The US SPLC field should be set as editable (no cursor protection)
[Set Route Suppression IT Field as Editable]
The table ID is SD-TABLE-ID → The Route Suppression IT field should be set as editable (no cursor protection)
[Set Route Suppression TE Field as Editable]
The table ID is SD-TABLE-ID → The Route Suppression TE field should be set as editable (no cursor protection)
[Set Customer Authorization IT Field as Editable]
The table ID is SD-TABLE-ID → The Customer Authorization IT field should be set as editable (no cursor protection)
[Set Customer Authorization TE Field as Editable]
The table ID is SD-TABLE-ID → The Customer Authorization TE field should be set as editable (no cursor protection)
[Set US Cancel Merlin Field as Editable]
The table ID is SD-TABLE-ID → The US Cancel Merlin field should be set as editable (no cursor protection)
[Set Vista Class SCAC Field as Editable]
The table ID is SD-TABLE-ID → The Vista Class SCAC field should be set as editable (no cursor protection)
[Set Vista Class FSAC Field as Editable]
The table ID is SD-TABLE-ID → The Vista Class FSAC field should be set as editable (no cursor protection)
[Set Settlement Clearance Carload Field as Editable]
The table ID is SD-TABLE-ID → The Settlement Clearance Carload field should be set as editable (no cursor protection)
[Set Settlement Clearance Intermodal Field as Editable]
The table ID is SD-TABLE-ID → The Settlement Clearance Intermodal field should be set as editable (no cursor protection)
[Set FIRMS Code Field as Editable]
The table ID is SD-TABLE-ID → The FIRMS Code field should be set as editable (no cursor protection)
[Set SPLC Code 1-4 Fields as Editable]
The table ID is SD-TABLE-ID → All SPLC Code fields (1 through 4) should be set as editable (no cursor protection)
[Set Arrival Days Field as Editable]
The table ID is SD-TABLE-ID → The Arrival Days field should be set as editable (no cursor protection)
[Set Export Days Field as Editable]
The table ID is SD-TABLE-ID → The Export Days field should be set as editable (no cursor protection)
[Copy Input Message to Output Message]
The table ID is SD-TABLE-ID and all field protections are set → The input message should be copied to the output message
[Set US Port Code Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The US Port Code field protection attribute should be set to non-editable status
[Set US Merlin Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The US Merlin field protection attribute should be set to non-editable status
[Set US Destination Station Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The US Destination Station field protection attribute should be set to non-editable status
[Set US SPLC Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The US SPLC field protection attribute should be set to non-editable status
[Set Route Suppression IT Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Route Suppression IT field protection attribute should be set to non-editable status
[Set Route Suppression TE Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Route Suppression TE field protection attribute should be set to non-editable status
[Set Customer Authorization IT Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Customer Authorization IT field protection attribute should be set to non-editable status
[Set Customer Authorization TE Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Customer Authorization TE field protection attribute should be set to non-editable status
[Set US Cancel Merlin Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The US Cancel Merlin field protection attribute should be set to non-editable status
[Set Vista Class SCAC Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Vista Class SCAC field protection attribute should be set to non-editable status
[Set Vista Class FSAC Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Vista Class FSAC field protection attribute should be set to non-editable status
[Set Settlement Clearance Carload Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Settlement Clearance Carload field protection attribute should be set to non-editable status
[Set Settlement Clearance Intermodal Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Settlement Clearance Intermodal field protection attribute should be set to non-editable status
[Set FIRMS Code Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The FIRMS Code field protection attribute should be set to non-editable status
[Set SPLC Code Fields 1-4 Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The SPLC Code fields 1, 2, 3, and 4 protection attributes should be set to non-editable status
[Set Arrival Days Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Arrival Days field protection attribute should be set to non-editable status
[Set Export Days Field Protection to Non-Editable]
The table being processed is identified as SD-TABLE-ID → The Export Days field protection attribute should be set to non-editable status
[Copy Input Message to Output Message]
All field protection attributes have been set → The input message should be copied to the output message to preserve the original request context
[Set Route Management Fields Protection (Route Suppression IT/TE, Customer Authorization IT/TE)]
The table type is SD Schedule D table → The system shall set protection on Route Suppression IT field, Route Suppression TE field, Customer Authorization IT field, and Customer Authorization TE field, and update the input message to output message
[Update Input Message to Output Message]
The system completes field protection setup → The input message is copied to the output message to preserve user data
[Set Merlin Message 1 Field Protection]
The system sets field protection for DC table fields → The Merlin message 1 field must be set to no-cursor protection mode
[Set Merlin Message 2 Field Protection]
The system sets field protection for DC table fields → The Merlin message 2 field must be set to no-cursor protection mode
[Copy Input Message to Output Message]
The system completes field protection setup for DC table → The input message must be copied to the output message to maintain message continuity
[Set Merlin Message Fields Protection]
Field protection is being applied → Both Merlin message 1 and Merlin message 2 fields are set to no-cursor protection mode
[Set Merlin Message Fields Protection (Merlin Message 1 and 2)]
The system needs to set field protection for screen display → The system shall apply non-cursor protection attribute to both GCMWB-MERLIN-MESSAGE1-A and GCMWB-MERLIN-MESSAGE2-A fields to prevent user modification
[Apply Protection Settings to Screen Fields]
The system completes the field protection process → All protection settings are applied to their respective screen fields making them non-editable
[Set SS Table Field Protection]
The table ID is SS-TABLE-ID → All SS table fields including automated carrier, haulage agreement, line bill initial, line bond initial, haul bill initial, haul bond initial, and SNP indicator should be set to no-cursor protection mode and the input message should be copied to output message
[Copy Input Message to Output Message]
Completing SS table field protection configuration → The input message should be copied to the output message
[Copy Input Message to Output Message]
The system completes the field protection configuration for SS table → The input message should be copied to the output message to preserve message content
[Copy Input Message to Output Message]
The system completes field protection setup → The input message should be copied to the output message to maintain message continuity
[Copy Input Message to Output Message]
The system completes ID table field protection setup → The input message is copied to the output message to maintain message continuity
[Copy Input Message to Output Message]
The system completes the field protection setup → The input message should be copied to the output message to maintain message continuity
[Copy Input Message to Output Message]
The system completes field protection setup for VI table → The input message must be copied to the output message to preserve user data
[Set Description Field as Editable]
The system needs to set up field protection attributes for the screen → The car description field (GCMWH-DESCRIPTION-A) must be set as editable to allow user modifications
[Set Loaded Indicator Field as Editable]
The system needs to set up field protection attributes for the screen → The loaded indicator field (GCMWH-LOADED-A) must be set as editable to allow user modifications
[Set Empty Indicator Field as Editable]
The system needs to set up field protection attributes for the screen → The empty indicator field (GCMWH-EMPTY-A) must be set as editable to allow user modifications
[Set Transit Indicator Field as Editable]
The system needs to set up field protection attributes for the screen → The transit indicator field (GCMWH-TRANSIT-A) must be set as editable to allow user modifications
[Set Conveying Indicator Field as Editable]
The system needs to set up field protection attributes for the screen → The conveying indicator field (GCMWH-CONVEYING-A) must be set as editable to allow user modifications
[Set APHIS Indicator Field as Editable]
The system needs to set up field protection attributes for the screen → The APHIS indicator field (GCMWH-APHIS-A) must be set as editable to allow user modifications
[Copy Input Message to Output Message]
The system has completed setting up field protection attributes → The original input message must be copied to the output message to preserve user context
[Set ST Table Field Protection]
The table ID is ST-TABLE-ID → The system shall set protection attributes for description field, three sets of type code fields, three sets of type country fields, three sets of type description fields, and copy the input message to output message
[Copy Input Message to Output Message]
Completing ST table field protection setup → The system shall copy the input message to the output message
[Copy Input Message to Output Message]
Finalizing the status table protection process → The input message must be copied to the output message for user display
[Start ST Table Field Protection]
The table ID equals ST-TABLE-ID → The system must set protection on the main description field and all three type code groups (01, 02, 03) including their associated country and description fields, then copy the input message to output message
[Copy Input Message to Output]
Completing the field protection process → The system must copy the input message to the output message to maintain message continuity
[Identify Table ID for Loading]
The system needs to determine which table to load → The table ID is extracted from the input message and set for loading operations
[Build Message ID Key]
The system needs to construct a table key for database operations → The message ID (GCM4A-MSG-ID) is moved to the TABLE-KEY field
[Clear Function and Message Fields]
The system begins formatting the display screen → The function field and rest of message field are cleared to spaces
[Copy Input Message to Output Message]
The display screen formatting process is executing → The input message is copied to the output message structure
[Call GCX004DP Display Program]
The display screen formatting is requested → The GCX004DP display program is called with the complete set of parameters
[Set AD Table Fields Protection]
The table type is identified as AD-TABLE-ID → All administration-related fields including customer admin ID, merlin IDs, purge days, warning days, escalation hours, readd flag, auto fax, system merlin fax, and X400 fields are set to non-editable protection status and the input message is copied to output message
[Set DR Table Fields Protection]
The table type is identified as DR-TABLE-ID → All 20 station number fields (01 through 20) are set to non-editable protection status
[Set LT Table Fields Protection]
The table type is identified as LT-TABLE-ID → The alternate terminal and supervisor merlin ID fields are set to non-editable protection status and the input message is copied to output message
[Set MC Table Fields Protection]
The table type is identified as MC-TABLE-ID → All manifest station fields including Canadian customs code, customs sublocation, US station exit, station number, merlin ID, import indicator, print batches, border port, call letters, alternate merlin ID, vista class codes, and settlement clearing flags are set to non-editable protection status and the input message is copied to output message
[Set MS Table Fields Protection]
The table type is identified as MS-TABLE-ID → The message English text, message error type, and message notes fields are set to non-editable protection status and the input message is copied to output message
[Set SC Table Fields Protection]
The table type is identified as SC-TABLE-ID → All station entry fields including Canadian station name and code, US station name and code, Canadian fax number, fax copy ID, fax flag, FIRMS code, US fax number, and time zone are set to non-editable protection status and the input message is copied to output message
[Set SE Table Fields Protection]
The table type is identified as SE-TABLE-ID → The input message is copied directly to the output message without any field protection changes
[Set US Table Fields Protection]
The table type is identified as US-TABLE-ID → The user name field is set to non-editable protection status, special user security field protection is applied to all permission fields, and the input message is copied to output message
[Set AU Table Fields Protection]
The table type is identified as AU-TABLE-ID → The importer and business number fields are set to non-editable protection status and the input message is copied to output message
[Set AC Table Fields Protection]
The table type is identified as AC-TABLE-ID → The amendment description field is set to cursor protection status and the input message is copied to output message
[Set BK Table Fields Protection]
The table type is identified as BK-TABLE-ID → All broker fields including office code, fax number, full name, merlin ID, communication flags for fax/merlin/X12/internet, X12 header, internet address, Canadian filer code, paper usage flag, delivery schedule, terminal, information fields, and alternate code are set to non-editable protection status and the input message is copied to output message
[Set CC Table Fields Protection]
The table type is identified as CC-TABLE-ID → All carrier fields including carrier name, CCRA code, USCS code, arrival report flag, export report flag, and IRS number are set to non-editable protection status and the input message is copied to output message
[Set CT Table Fields Protection]
The table type is identified as CT-TABLE-ID → The ISO country code field is set to non-editable protection status and the input message is copied to output message
[Set RF Table Fields Protection]
The table type is identified as RF-TABLE-ID → The sub-location code field is set to cursor protection status and the input message is copied to output message
[Set SD Table Fields Protection]
The table type is identified as SD-TABLE-ID → All US port fields including port code, merlin ID, destination station, SPLC codes, route suppression flags, customer authorization flags, cancel merlin, vista class codes, settlement clearing flags, FIRMS code, SPLC codes 1-4, and arrival/export days are set to non-editable protection status and the input message is copied to output message
[Set SK Table Fields Protection]
The table type is identified as SK-TABLE-ID → The foreign port code field is set to non-editable protection status and the input message is copied to output message
[Set MU Table Fields Protection]
The table type is identified as MU-TABLE-ID → The manifest unit description field is set to non-editable protection status and the input message is copied to output message
[Set DC Table Fields Protection]
The table type is identified as DC-TABLE-ID → All disposition code fields including description, location, quantity action, process type, merlin messages, counterpart disposition codes with match methods (01-10), notify import flag, and post to database flag are set to non-editable protection status and the input message is copied to output message
[Set SS Table Fields Protection]
The table type is identified as SS-TABLE-ID → All SCAC code fields including automated carrier flag, haulage agreement, line bill initial, line bond initial, haul bill initial, haul bond initial, and SNP indicator are set to non-editable protection status and the input message is copied to output message
[Set ID Table Fields Protection]
The table type is identified as ID-TABLE-ID → All car manifest fields including Canadian empty manifest, Canadian loaded manifest, American empty manifest, and American loaded manifest are set to non-editable protection status and the input message is copied to output message
[Set VI Table Fields Protection]
The table type is identified as VI-TABLE-ID → All car type fields including description, loaded flag, empty flag, transit flag, conveying flag, and APHIS flag are set to non-editable protection status and the input message is copied to output message
[Set KS Table Fields Protection]
The table type is identified as KS-TABLE-ID → The name field is set to non-editable protection status and the input message is copied to output message
[Set DS Table Fields Protection]
The table type is identified as DS-TABLE-ID → The name field is set to non-editable protection status and the input message is copied to output message
[Set S1 Table Fields Protection]
The table type is identified as S1-TABLE-ID → The CSD code field is set to non-editable protection status and the input message is copied to output message
[Set ST Table Fields Protection]
The table type is identified as ST-TABLE-ID → All status type fields including description and three sets of type code, country, and description fields (01-03) are set to non-editable protection status and the input message is copied to output message
[Apply User Security Special Protection]
The special user security protection is invoked → All user permission fields including amendment, manifest station, cargo charges, train charges, administration, message, cargo delete, train delete, automotive, manifest unit, cargo add, train add, broker, bond siding, cargo readd, train readd, carrier code, station entry, cargo arrival, train arrival, country, schedule D, cargo cancel arrival, train cancel arrival, disposition code, station selection, cargo export, train enroute, manifest upon, schedule K, cargo cancel export, train overtime error, train special manifest, car ID, user security, cargo cancel international export, SK by port, car kind, cargo cancel place, error route, cargo cancel suspend, crossing, cargo cancel release, cargo restriction, broker name, and all SCAC allowed and refused arrays (5 elements each) are set to non-editable protection status
[AD Table - Administration Fields]
Field protection is being applied to the Administration table screen → All Administration table fields including Public Merlin ID, DC Merlin fields, Purge Days, Warning Days, Escalation Hours, Readd Flag, Auto Fax, System Merlin Fax, and X400 fields are set to non-cursor protection mode and input message is copied to output message
[LT Table - Terminal Fields]
Field protection is being applied to the Terminal table screen → Terminal Alternate and Supervisor Merlin ID fields are set to non-cursor protection mode and input message is copied to output message
[MC Table - Manifest Station Fields]
Field protection is being applied to the Manifest Station table screen → All manifest station fields including Canadian Customs Code, Canadian Customs Sublocation, US Station Exit, US Station Exit Code, Station Number, Merlin ID, IM Indicator, Print Batches, Border Port, Call Letters, Alternate Merlin ID, Vista Class SCAC, Vista Class FSAC, Set Clear Carload, and Set Clear Intermodal fields are set to non-cursor protection mode and input message is copied to output message
[MS Table - Message Fields]
Field protection is being applied to the Message table screen → Message English Text, Message Error Type, and Message Notes fields are set to non-cursor protection mode and input message is copied to output message
[SC Table - Station Code Fields]
Field protection is being applied to the Station Code table screen → All station fields including Canadian Station Name, Canadian Station Code, US Station Name, US Station Code, Canadian Fax Number, Fax Copy ID, Fax Flag, FIRMS Code, US Fax Number, and Time Zone fields are set to non-cursor protection mode and input message is copied to output message
[SE Table - Station Selection Fields]
Field protection is being applied to the Station Selection table screen → Input message is copied to output message without additional field protection
[US Table - User Security Fields]
Field protection is being applied to the User Security table screen → User Name field is set to non-cursor protection mode, special screen field protection is applied to all security permission fields, and input message is copied to output message
[AU Table - Automotive Fields]
Field protection is being applied to the Automotive table screen → Importer and Business Number fields are set to non-cursor protection mode and input message is copied to output message
[AC Table - Amendment Fields]
Field protection is being applied to the Amendment table screen → Amendment Description field is set to cursor protection mode and input message is copied to output message
[BK Table - Broker Fields]
Field protection is being applied to the Broker table screen → All broker fields including Office Code, Fax Number, Full Name, Merlin, Use Fax, Use Merlin, Use X12, Use Internet, X12 Header, Internet, CA Filer Code, Use Paper, Delivery Schedule, LTerm, Info fields, and Alternative Code are set to non-cursor protection mode and input message is copied to output message
[CC Table - Carrier Fields]
Field protection is being applied to the Carrier table screen → All carrier fields including Carrier Name, CCRA Code, USCS Code, Arrival Report, Export Report, and IRS Number are set to non-cursor protection mode and input message is copied to output message
[CT Table - Country Fields]
Field protection is being applied to the Country table screen → ISO Country Code field is set to non-cursor protection mode and input message is copied to output message
[RF Table - Bonded Sidings Fields]
Field protection is being applied to the Bonded Sidings table screen → Sub Location Code field is set to cursor protection mode and input message is copied to output message
[SD Table - Schedule D Fields]
Field protection is being applied to the Schedule D table screen → All Schedule D fields including US Port Code, US Merlin, US Destination Station, US SPLC, Route Suppression IT/TE, Customer Authorization IT/TE, US Cancel Merlin, Vista Class SCAC/FSAC, Set Clear Carload/Intermodal, FIRMS Code, SPLC Codes 1-4, and Arrival/Export Days are set to non-cursor protection mode and input message is copied to output message
[SK Table - Schedule K Fields]
Field protection is being applied to the Schedule K table screen → Foreign Port Code field is set to non-cursor protection mode and input message is copied to output message
[MU Table - Manifest Unit Fields]
Field protection is being applied to the Manifest Unit table screen → Manifest Unit Description field is set to non-cursor protection mode and input message is copied to output message
[DC Table - Disposition Code Fields]
Field protection is being applied to the Disposition Code table screen → All disposition code fields including Description, Location, Quantity Action, Process Type, Merlin Messages, Counterpart Disposition Codes 1-10, Counterpart Match Methods 1-10, Notify IM, and Post to Database are set to non-cursor protection mode and input message is copied to output message
[SS Table - SCAC Code Fields]
Field protection is being applied to the SCAC Code table screen → All SCAC fields including Automated Carrier, Haulage Agreement, Line Bill Initial, Line Bond Initial, Haul Bill Initial, Haul Bond Initial, and SNP Indicator are set to non-cursor protection mode and input message is copied to output message
[ID Table - Car ID Fields]
Field protection is being applied to the Car ID table screen → All car manifest fields including Canadian Empty Manifest, Canadian Loaded Manifest, American Empty Manifest, and American Loaded Manifest are set to non-cursor protection mode and input message is copied to output message
[VI Table - Car Kind Fields]
Field protection is being applied to the Car Kind table screen → All car kind fields including Description, Loaded, Empty, Transit, Conveying, and APHIS are set to non-cursor protection mode and input message is copied to output message
[KS Table - KS Code Fields]
Field protection is being applied to the KS Code table screen → KS Name field is set to non-cursor protection mode and input message is copied to output message
[DS Table - DS Code Fields]
Field protection is being applied to the DS Code table screen → DS Name field is set to non-cursor protection mode and input message is copied to output message
[S1 Table - Status Code Fields]
Field protection is being applied to the S1 Status Code table screen → CSD Code field is set to non-cursor protection mode and input message is copied to output message
[ST Table - Status Type Fields]
Field protection is being applied to the Status Type table screen → All status type fields including Description and Type Code/Country/Description fields for entries 01-03 are set to non-cursor protection mode and input message is copied to output message
[Apply Special US Table Security Rules]
Special screen field protection is being applied to User Security table → All user security permission fields including Amendment, Manifest Station, Cargo Charges, Train Charges, Administration, Message, Cargo Delete, Train Delete, Automotive, Manifest Unit, Cargo Add, Train Add, Broker, Bond Siding, Cargo Readd, Train Readd, Carrier Code, Station Entry, Cargo Arrival, Train Arrival, Country, Schedule D, Cargo Cancel Arrival, Train Cancel Arrival, Disposition Code, Station Selection, Cargo Export, Train En Route, Manifest Upon, Schedule K, Cargo Cancel Export, Train Over Turn Error, Train Special Manifest, DS by Port, SCAC Code, Cargo International Export, SK by Port, Car Kind, Cargo Cancel Place, Error Route, Cargo Cancel Suspend, SCAC Allowed arrays, Cargo Cancel Release, Crossing, Cargo Restriction, SCAC Refused arrays, and Broker Name are set to non-cursor protection mode
[Set Message Field Protection]
System applies field protection for message access control → Message field is set to no-cursor protection mode preventing user input
[Set Message Field Protection to Non-Cursor Protected]
The message field protection is being configured → The message field should be set to non-cursor protected status
[Set Automotive Table Fields Protection]
The system processes field protection for the Automotive table → The system applies non-cursor protection to the Importer field and Business Number field, and copies the input message to output message
[Set Manifest Unit Table Fields Protection]
The system processes field protection for the Manifest Unit table → The system applies non-cursor protection to the Manifest Unit Description field and copies the input message to output message
[Set Broker Table Fields Protection]
The system processes field protection for the Broker table → The system applies non-cursor protection to broker office code, FAX number, full name, Merlin ID, communication preference fields (FAX, Merlin, X12, Internet usage), X12 header, Internet address, CA filer code, paper usage, delivery schedule, terminal, and information fields, then copies the input message to output message
[Set Bonded Siding Table Fields Protection]
The system processes field protection for the Bonded Siding table → The system applies cursor protection to the Sub Location Code field and copies the input message to output message
[Set Message Field Protection]
The field protection setup is executed → The message field should be set to no-cursor protection status to prevent user modification
[Set Base User Security Fields Protection]
The system needs to protect individual user permission fields → All user security permission fields (Amendment, Manifest Station, Cargo Change, Train Change, Administration, Message, Cargo Delete, Train Delete, Automotive, Manifest Unit, Cargo Add, Train Add, Broker, Bond Siding, Cargo Readd, Train Readd, Carrier Code, Station Entry, Cargo Arrival, Train Arrival, Country, Schedule D, Cargo Cancel Arrival, Train Cancel Arrival, Disposition Code, Station Selection, Cargo Export, Train Enroute, Manifest Upon, Schedule K, Cargo Cancel Export, Train Overturn Error, DS By Port, SCAC Code, Cargo International Export, Train Special Manifest, Car ID, User Security, Cargo Cancel International Export, SK By Port, Car Kind, Cargo Cancel Place, Error Route, Cargo Cancel Suspend, Cargo Cancel Release, Crossing, Cargo Restriction, and Broker Name) are set to non-cursor protection mode
[Set Message Field Protection]
Message field protection is being set → Message field is set to non-cursor protection mode
[Set Message Field Protection]
The message field protection is being set → The message field should be protected with non-cursor protection attribute
[Check if Display Position Valid OR Add Function?]
If update eligibility conditions → The system allows update processing if display segment end position is not zero OR if the function is an add operation, otherwise it skips validation and update steps
[Call Validation Program GCX004C2]
The system needs to validate the update request → The system calls program GCX004C2 with input message, table data, table pointers, validation flag, output message, screen code, and system message parameters
[Call Database Update Program GCX004C3]
The system needs to commit changes to the database → The system calls program GCX004C3 with input message, table data, table pointers, and system message parameters to update the database
[Copy Input to Output Message]
The system prepares the output response → The system copies the input message to the output message to maintain the original user input
[Format Current Display Screen]
The system needs to display the current state to the user → The system performs the display screen formatting process (B140-FORMAT-DISPLAY-SCREEN) to show the current table view
[Is Function ADD?]
The function type is ADD-FUNCTION → The system allows update processing to continue regardless of display position
[Invalid Position - Cannot Update]
The function type is not ADD-FUNCTION → The system prevents update processing and prepares to display current screen without modifications
[Clear Function and Message Fields]
The system prepares to display current screen → The system clears GCMTB-FUNCTION and GCMTB-REST-OF-MESSAGE fields to SPACE
[Copy Input to Output Message]
The system prepares output for display → The system copies INPUT-MESSAGE to OUTPUT-MESSAGE to preserve user input
[Call GCX004C2 Validation Program]
The system needs to validate update data → The system calls GCX004C2 validation program with input message, table data, table pointers, and output parameters
[Call GCX004C3 Database Update Program]
The system calls the GCX004C3 database update program with input message, table data structure, table end pointer, current table position, and system message number parameters → The database update operation is executed and a system message number is returned indicating the result
[Pass Input Message to Update Program]
The system calls the database update program → The input message parameter is passed to provide the update data
[Receive System Message Number]
The database update program completes its operation → A system message number is returned to indicate the result of the update operation
[Set Invalid Authorization Message]
The table ID is US-TABLE-ID → The system clears GCMTB-REST-OF-MESSAGE, copies INPUT-MESSAGE to OUTPUT-MESSAGE, sets OUTPUT-SELECT-CODE to GC-MENU-SCREEN, and sets SYSTEM-MSG-NUM to INV-AUTH-MSG-NUM
[Set Table Update Not Allowed Message]
The update permission check fails → The system performs A200-INVALID-PFKEY and sets SYSTEM-MSG-NUM to TBL-UPD-NOT-ALLOWED
[Set Confirm Delete Message]
GCMTB-FUNCTION equals DEL-FUNCTION → The system sets SYSTEM-MSG-NUM to CONFIRM-DEL-MSG-NUM
[Set Expand Function Message]
GCMTB-FUNCTION equals EXPAND-FUNCTION → The system sets SYSTEM-MSG-NUM to EXPAND-MSG-NUM
[Set Invalid Authorization Message]
The system processes the access violation for the User Security table → The system clears the rest of message field AND copies the input message to output message AND sets the output screen to main menu AND sets the system message to invalid authorization message number
[Set Confirm Delete Message]
The system processes the delete request → The system sets the system message number to confirm delete message
[Set Table Update Not Allowed Message]
The system validates the update permission → The system sets the system message number to table update not allowed message
[F12 Key Pressed]
User presses F12 key (GC-MAIN-MENU function key) → System clears the rest of message area, sets output screen to main menu, clears system message number, and returns user to main menu screen
[Clear Rest of Message Area]
System processes the main menu navigation request → System moves spaces to GCMTB-REST-OF-MESSAGE field to clear any existing messages
[Set Output Screen to Main Menu]
System continues processing the main menu navigation request → System moves GC-MENU-SCREEN value to OUTPUT-SELECT-CODE to specify main menu as the target screen
[Clear System Message Number]
System finalizes the main menu navigation request → System moves spaces to SYSTEM-MSG-NUM field to clear any existing system message numbers
[Display Within Segment End ≠ Zero?]
If display requirements → If the display within segment end value is not equal to zero, the system proceeds to build table key, otherwise it skips key building and positioning steps
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the customer administration ID from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the range name from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the logical terminal identifier from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the manifest identifier from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the message identifier from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the station code from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the station name from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the user code from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the automotive identifier from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the amendment code from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the broker name to positions 1-14 of the table key and the broker port to positions 15-18 of the table key
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the railroad SCAC key from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the country name from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the sequence number from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the US port name from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the foreign port name from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the manifest unit identifier from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the disposition code from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system clears the working storage SCAC table key, moves the SCAC code and port code to the working storage key, then moves the complete working storage key to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the car identifier from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the car type from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the KS code from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system moves the DS code from the message structure to the table key field
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system clears the table key, moves the country code to positions 1-2 of the table key, and moves the status code to positions 3-9 of the table key
[Build Table Key Based on Table Type]
The system needs to build a table key for positioning → The system clears the table key, moves the code to positions 1-7 of the table key, and moves the qualifier to positions 8-9 of the table key
[Clear Function and Message Fields]
Function and message fields need to be reset → The system moves spaces to the function field and the rest of message field to clear any previous values
[Copy Input Message to Output]
The output message needs to be prepared → The system moves the input message content to the output message field
[Format Display Screen Layout]
The screen needs to be formatted for display → The system calls the display formatting module with the common control block, table identifier, table data structure, table pointer, end pointer, output message, output select code, and system message number to format the display screen

Structural Validations

[4:Invalid Function Handling - Handle Invalid Function]
The system detects the invalid input or unauthorized function attempt → The system displays appropriate error message and routes to the corresponding table update screen
[14:Error Message Handling - Set Invalid Authorization]
Access denial processing is initiated → The system clears the rest of message field, copies input to output message, sets menu screen as output select code, and sets invalid authorization message number
[Set Office Code Field as Editable]
The system processes the invalid PF key for broker table → The broker office code field is set as editable (no cursor protection)
[Set FAX Number Field as Editable]
The system processes the invalid PF key for broker table → The broker FAX number field is set as editable (no cursor protection)
[Set Full Name Field as Editable]
The system processes the invalid PF key for broker table → The broker full name field is set as editable (no cursor protection)
[Set Merlin ID Field as Editable]
The system processes the invalid PF key for broker table → The broker Merlin ID field is set as editable (no cursor protection)
[Set Use FAX Flag as Editable]
The system processes the invalid PF key for broker table → The broker use FAX flag field is set as editable (no cursor protection)
[Set Use Merlin Flag as Editable]
The system processes the invalid PF key for broker table → The broker use Merlin flag field is set as editable (no cursor protection)
[Set Use X12 Flag as Editable]
The system processes the invalid PF key for broker table → The broker use X12 flag field is set as editable (no cursor protection)
[Set Use Internet Flag as Editable]
The system processes the invalid PF key for broker table → The broker use Internet flag field is set as editable (no cursor protection)
[Set X12 Header Field as Editable]
The system processes the invalid PF key for broker table → The broker X12 header field is set as editable (no cursor protection)
[Set Internet Address as Editable]
The system processes the invalid PF key for broker table → The broker Internet address field is set as editable (no cursor protection)
[Set CA Filer Code as Editable]
The system processes the invalid PF key for broker table → The broker CA filer code field is set as editable (no cursor protection)
[Set Use Paper Flag as Editable]
The system processes the invalid PF key for broker table → The broker use paper flag field is set as editable (no cursor protection)
[Set Delivery Schedule as Editable]
The system processes the invalid PF key for broker table → The broker delivery schedule field is set as editable (no cursor protection)
[Set Terminal ID as Editable]
The system processes the invalid PF key for broker table → The broker terminal ID field is set as editable (no cursor protection)
[Set Info Fields 1 & 2 as Editable]
The system processes the invalid PF key for broker table → The broker information fields 1 and 2 are set as editable (no cursor protection)
[Set Alternative Code as Editable]
The system processes the invalid PF key for broker table → The broker alternative code field is set as editable (no cursor protection)
[Clear Function and Message Fields]
The system handles the invalid update condition → The system moves spaces to both the function field (GCMTB-FUNCTION) and the rest of message field (GCMTB-REST-OF-MESSAGE)
[Is Position Within Valid Segment?]
The system checks if the display position is within a valid segment → If DISPL-WITHIN-SEG-END is not equal to ZERO, the position allows updates and processing continues
[Set Invalid Flag and Error Messages]
The system processes failed validation result → The system continues with current screen state without performing database updates
[Set Invalid PF Key Message]
GCMTB-FUNCTION equals DEL-FUNCTION or EXPAND-FUNCTION → The system performs A200-INVALID-PFKEY and sets SYSTEM-MSG-NUM to EXPAND-MSG-NUM if function is EXPAND-FUNCTION
[Set Invalid PF Key Message]
GCMTB-FUNCTION != DEL-FUNCTION → The system performs A200-INVALID-PFKEY
[Set Invalid PF Key Message]
The operation is determined to be invalid → The system sets SYSTEM-MSG-NUM to INV-PFKEY-MSG-NUM
[Set Expand Not Allowed Message]
The system validates the expand function request → The system sets the system message number to expand message number
[Set Invalid PF Key Message]
The system processes the function key input → The system sets the system message number to invalid function key message number

Module: GCX004C3 1 Consolidated Epic Story

Epic: GCX004C3 Complete EDI Specification Extracted from Legacy

Contains 648 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004C3 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize New User Security Record]
The system processes a new user addition → The system initializes a new user security record structure with spaces and sets the table ID to US-TABLE-ID, user code to the input user code, and segment count to zero
[Initialize New Dummy Segment Structure]
A new dummy segment structure needs to be created → The system should initialize all dummy segment fields to spaces or default values
[Initialize Dependent Segment Counter]
Dependent segment processing needs to begin → The system should set the dependent segment counter to 1 to start processing
[Initialize Segment Count to Zero]
The system initializes segment tracking → The administrative segment count is set to zero
[Initialize Segment Count to Zero]
Initializing the record structure → The segment count is set to zero
[Initialize Segment Count to Zero]
The system initializes the record structure → The segment count is set to zero to indicate no dependent segments
[Initialize Segment Count to Zero]
The segment count is initialized → The MC segment count is set to zero
[Initialize Segment Count to Zero]
Setting up the message record structure → The segment count is initialized to zero
[Initialize Segment Count to Zero]
The segment count needs to be initialized → The segment count is set to zero
[Initialize Segment Count to Zero]
The system sets up the record structure → The segment count is initialized to zero to indicate this is a new record with no existing segments
[Initialize Segment Count to Zero]
The system sets up the record structure → The segment count must be initialized to zero to indicate this is a new record with no existing segments
[Initialize Segment Count to Zero]
The segment count needs to be initialized → The segment count field is set to zero
[Initialize Segment Count to Zero]
The system initializes the record structure → The segment count should be set to zero
[Initialize Segment Count to Zero]
The system initializes the record structure → The segment count field is set to zero
[Initialize Segment Count to Zero]
The system initializes the record structure → The segment count must be set to zero to indicate no dependent segments
[Initialize Segment Count to Zero]
The system initializes the record structure → The segment count is set to zero

Core Acceptance Criteria

[Message Configuration Update]
The table ID matches MS-TABLE-ID → The system updates the message English text, message error type, and message notes
[Disposition Code Update]
The table ID matches DC-TABLE-ID → The system updates disposition code description, quantity action, location, process type, Merlin messages 1-2, counterpart disposition codes 1-10 with match methods, IM notification flag, and database posting flag
[New Record Position Determination]
The table is empty (displacement within segment end equals zero) → The system sets the position as valid and uses the current table pointer as the end pointer
[Table Pointer Management]
The displacement within segment exceeds the maximum segment size for any table type → The system resets displacement to 1 and increments the segment number to create a new segment
[Record Deletion Processing]
The table ID matches US-TABLE-ID and the record exists → The system deletes both the US record and the corresponding U1 record, then sets the delete success message
[Table Access Permission Mapping]
Processing US table access control fields → The system maps permissions for amendment, administration, automotive, broker, carrier code, country, disposition code, manifest upon station range, DS by port, car ID, SK by port, error routing, manifest station, message, manifest unit, bonded sidings, station entry, schedule D, station selection, schedule K, SCAC code, user security, car kind, crossing table, and broker name access
[Read Input Function Type from GCMTB-FUNCTION]
The system reads the function type from the input message → The function type value is captured for routing decision
[Update Publication Merlin ID]
The administrative settings update is processed → The publication Merlin ID is updated with the new value from the input message
[Update DC Processing Merlin IDs 1-5]
The administrative settings update is processed → All five DC processing Merlin IDs (DC-P-MERLIN-1 through DC-P-MERLIN-5) are updated with corresponding values from the input message
[Update Purge Days Settings]
The administrative settings update is processed → The purge days setting is updated with the new value from the input message
[Update Warning Days Settings]
The administrative settings update is processed → The warning days setting is updated with the new value from the input message
[Update Escalation Hours]
The administrative settings update is processed → The escalation hours setting is updated with the new value from the input message
[Update Re-add Flag]
The administrative settings update is processed → The re-add flag is updated with the new value from the input message
[Update Auto-FAX Settings]
The administrative settings update is processed → The auto-FAX setting is updated with the new value from the input message
[Update System Merlin FAX]
The administrative settings update is processed → The system Merlin FAX identifier is updated with the new value from the input message
[Update Bond Merlin ID]
The administrative settings update is processed → The bond Merlin identifier is updated with the new value from the input message
[Update US Purge Days]
The administrative settings update is processed → The US-specific purge days setting is updated with the new value from the input message
[Update US Warning Days]
The administrative settings update is processed → The US-specific warning days setting is updated with the new value from the input message
[Update X400 Settings]
The administrative settings update is processed → The X400 configuration is updated with the new value from the input message
[Retrieve Terminal Record by LTERM ID]
The system attempts to retrieve the terminal record using the LTERM ID as the key → The system should locate and load the terminal configuration record from the database
[Update Alternate Terminal Setting]
The system processes the terminal configuration update → The alternate terminal setting should be updated with the new value from GCM46-ALTERNATE to GCSTBRT-LT-ALTERNATE
[Update Supervisor Merlin ID]
The system processes the terminal configuration update → The supervisor Merlin ID should be updated with the new value from GCM46-SUP-MERLIN-ID to GCSTBRT-LT-SUP-MERLIN-ID
[Configuration Valid]
The system performs the database update operation → The system should execute the table root access with replace function code
[Extract Canadian Customs Code from GCM48-CAN-CUSTOMS-CD]
The system processes the GCM48 manifest station message → The Canadian customs code is extracted from GCM48-CAN-CUSTOMS-CD field
[Extract Sub-Location Code from GCM48-CAN-CUSTOMS-SUBLOC]
The system processes the GCM48 manifest station message → The Canadian customs sub-location code is extracted from GCM48-CAN-CUSTOMS-SUBLOC field
[Update GCSTBRT-MC-CAN-CUSTOMS-CD]
The system performs the manifest station table update → The GCM48-CAN-CUSTOMS-CD value is moved to GCSTBRT-MC-CAN-CUSTOMS-CD in the database segment
[Update GCSTBRT-MC-SUB-LOCATION-CODE]
The system performs the manifest station table update → The GCM48-CAN-CUSTOMS-SUBLOC value is moved to GCSTBRT-MC-SUB-LOCATION-CODE in the database segment
[Extract Canadian Customs Code from Input]
The system processes the MC table ID for manifest station updates → The Canadian customs code is extracted from GCM48-CAN-CUSTOMS-CD and prepared for validation
[Extract Sub-Location Code from Input]
The system processes the MC table for manifest station updates → The sub-location code is extracted from GCM48-CAN-CUSTOMS-SUBLOC for database storage
[Update Sub-Location Code in Database]
The system processes the sub-location code from the input message → The sub-location code from GCM48-CAN-CUSTOMS-SUBLOC is moved to GCSTBRT-MC-SUB-LOCATION-CODE in the database record
[Update US Station Exit Name]
The system processes MC table configuration changes → The US station exit name is moved to GCSTBRT-MC-US-STAT-EXIT field in the database segment
[Update US Station Exit Code]
The system processes MC table configuration changes → The US station exit code is moved to GCSTBRT-MC-US-STAT-EXIT-CD field in the database segment
[Retrieve Message Record by Message ID]
The system attempts to retrieve the message record from the database → The system should locate and load the existing message configuration record for modification
[Update Message English Text]
The system processes the message text update request → The message English text field should be updated with the new text value
[Update Message Notes]
The system processes the message notes update request → The message notes field should be updated with the new notes content
[Save Updated Message Configuration]
The system saves the updated message configuration → The system should Execute a database replace operation to persist all changes to the message record
[Set Root Key Value to Station Name]
The system sets up the database key value → The station name from the input message should be used as the key value
[Update US Crossing Point Implementation]
The system processes the US crossing point implementation field → The US crossing point implementation should be updated with the value from the input message
[Update Table Access Permissions]
The system processes table access permission updates → The system maps amendment access to AMENDMENT, administration to ADMINISTRATION, automotive to AUTOMOTIVE, broker to BROKER, carrier code to CARRIER, country to COUNTRY-CODE, disposition code to DISPOSITION-CODE, manifest upon station range to MAN-UPON-STN-RANGE, DS by port to DS-BY-PORT, car ID to CAR-ID, SK by port to SK-BY-PORT, error routing to ERROR-ROUTING, manifest station to MANIFEST-STATION, message to MESSAGE, manifest unit to MANIFEST-UNIT, bonded sidings to BONDED-SIDINGS, station entry to STATION-ENTRY, schedule D to SCHEDULE-D, station selection to STATION-SELECTION, schedule K to SCHEDULE-K, SCAC code to SCAC-CODE, user security to USER-SECURITY, car kind to CAR-KIND, crossing table to CROSSING-TABLE, and broker name to BROKER-NAME
[Create New US1 Security Record]
The system processes US1 record creation for new users → The system creates a new US1 record with table ID 'U1', user code, segment count of 0, user name, and department information, then inserts it using ISRT function code
[Message Table Access]
Message table access permission is being validated → The message table access flag is mapped from input to user security record
[Map Permission to Database Field]
The system updates user security records → All US cargo operation permissions are mapped from message fields to corresponding database fields including change, delete, add, re-add, arrive, cancel arrive, export, cancel export, international export, cancel international export, and cancel release operations
[Check US Cargo Change Permission]
The system processes user security permissions for US cargo operations → The US cargo change permission is mapped to GCSTBRT-US-UCF-CHANGE field in the database segment
[Continue with Other US Cargo Permissions]
The system processes user security permissions for US cargo operations → The US cargo delete permission is mapped to GCSTBRT-US-UCF-DELETE field in the database segment
[Continue with Other US Cargo Permissions]
The system processes user security permissions for US cargo operations → The US cargo add permission is mapped to GCSTBRT-US-UCF-ADD field in the database segment
[Continue with Other US Cargo Permissions]
The system processes user security permissions for US cargo operations → The US cargo re-add permission is mapped to GCSTBRT-US-UCF-RE-ADD field in the database segment
[Continue with Other US Cargo Permissions]
The system processes user security permissions for US cargo operations → The US cargo arrival permission is mapped to GCSTBRT-US-UCF-ARRIVE field in the database segment
[Continue with Other US Cargo Permissions]
The system processes user security permissions for US cargo operations → The US cargo cancel arrival permission is mapped to GCSTBRT-US-UCF-CANC-ARRIVE field in the database segment
[Map US Transit Change Permission to Database Field]
The system processes US transit change permission from input message GCM4G-US-TRN-CHGE → The permission value is mapped to database field GCSTBRT-US-UTF-CHANGE
[Map US Transit Delete Permission to Database Field]
The system processes US transit delete permission from input message GCM4G-US-TRN-DEL → The permission value is mapped to database field GCSTBRT-US-UTF-DELETE
[Map US Transit Add Permission to Database Field]
The system processes US transit add permission from input message GCM4G-US-TRN-ADD → The permission value is mapped to database field GCSTBRT-US-UTF-ADD
[Map US Transit Re-Add Permission to Database Field]
The system processes US transit re-add permission from input message GCM4G-US-TRN-READD → The permission value is mapped to database field GCSTBRT-US-UTF-RE-ADD
[Map US Transit Arrival Permission to Database Field]
The system processes US transit arrival permission from input message GCM4G-US-TRN-ARR → The permission value is mapped to database field GCSTBRT-US-UTF-ARRIVE
[Map US Transit Cancel Arrival Permission to Database Field]
The system processes US transit cancel arrival permission from input message GCM4G-US-TRN-CAN-ARR → The permission value is mapped to database field GCSTBRT-US-UTF-CAN-ARRIVE
[Map US Transit En-Route Permission to Database Field]
The system processes US transit en-route permission from input message GCM4G-US-TRN-ENRTE → The permission value is mapped to database field GCSTBRT-US-UTF-ENROUTE
[Map US Transit Special Manifest Permission to Database Field]
The system processes US transit special manifest permission from input message GCM4G-US-TRN-SPEC-MANI → The permission value is mapped to database field GCSTBRT-US-UTF-SPEC-MANI
[Update Importer Information]
The system processes the automotive configuration update → The system should update the importer field in the automotive record with the new importer information from the message
[Update Business Number Information]
The system processes the automotive configuration update → The system should update the business number field in the automotive record with the new business number from the message
[Build Composite Key]
The system builds the table root key → The key value is constructed with country code in positions 1-2 and amendment code in positions 3-4
[Update Amendment Description]
The system processes the update request → The amendment description field is updated with the new value from the amendment message
[Update FAX Usage Preference]
The system processes the broker FAX usage preference from input message GCM4M-BROKER-USE-FAX → The FAX usage preference is updated in the broker database record GCSTBRT-BK-USE-FAX
[Update Merlin Usage Preference]
The system processes the broker Merlin usage preference from input message GCM4M-BROKER-USE-MERLIN → The Merlin usage preference is updated in the broker database record GCSTBRT-BK-USE-MERLIN
[Update X12 Usage Preference]
The system processes the broker X12 usage preference from input message GCM4M-BROKER-USE-X12 → The X12 usage preference is updated in the broker database record GCSTBRT-BK-USE-X12
[Update Internet Usage Preference]
The system processes the broker Internet usage preference from input message GCM4M-BROKER-USE-INTERNET → The Internet usage preference is updated in the broker database record GCSTBRT-BK-USE-INTERNET
[Update Paper Usage Preference]
The system processes the broker paper usage preference from input message GCM4M-BROKER-USE-PAPER → The paper usage preference is updated in the broker database record GCSTBRT-BK-USE-PAPER
[Set FAX Usage Preference]
The system processes the broker FAX usage preference from input message GCM4M-BROKER-USE-FAX → The FAX usage preference is set in the new broker database record GCSTBRT-BK-USE-FAX
[Set Merlin Usage Preference]
The system processes the broker Merlin usage preference from input message GCM4M-BROKER-USE-MERLIN → The Merlin usage preference is set in the new broker database record GCSTBRT-BK-USE-MERLIN
[Set X12 Usage Preference]
The system processes the broker X12 usage preference from input message GCM4M-BROKER-USE-X12 → The X12 usage preference is set in the new broker database record GCSTBRT-BK-USE-X12
[Set Internet Usage Preference]
The system processes the broker Internet usage preference from input message GCM4M-BROKER-USE-INTERNET → The Internet usage preference is set in the new broker database record GCSTBRT-BK-USE-INTERNET
[Set Paper Usage Preference]
The system processes the broker paper usage preference from input message GCM4M-BROKER-USE-PAPER → The paper usage preference is set in the new broker database record GCSTBRT-BK-USE-PAPER
[Update ISO Country Code]
The table ID is CT-TABLE-ID and function is change operation → The system updates the ISO country code field with the new value from the input message
[Create New Country Code Record]
The table ID is CT-TABLE-ID and function is ADD → The system initializes a new country code record structure with table ID and zero segment count
[Set Country Name as Key]
The table ID is CT-TABLE-ID and function is ADD → The system sets the country name from the input message as the table value key
[Set ISO Country Code]
The table ID is CT-TABLE-ID and function is ADD → The system sets the ISO country code field with the value from the input message
[Locate Country Code Record]
The table ID is CT-TABLE-ID and function is DEL → The system locates the country code record using the country name from the input message as the key
[Clean Up Table Entries]
The table ID is CT-TABLE-ID and function is DEL → The system updates dummy segments and performs table maintenance operations
[Retrieve Current Reference Code Record]
The system performs a database lookup operation → The system retrieves the current reference code record data into the working segment
[Update Sub-Location Code Field]
The system processes the field update → The system moves the new sub-location code from the input message to the database record field
[Update IT Route Suppression Authorization]
The system processes the RTE-SUPPR-IT field from the input message → The IT authorization field in the database segment is updated with the route suppression IT value
[Update TE Route Suppression Authorization]
The system processes the RTE-SUPPR-TE field from the input message → The TE authorization field in the database segment is updated with the route suppression TE value
[Update Customer IT Authorization]
The system processes the CUSTOMER-AUTH-IT field from the input message → The customer IT authorization field in the database segment is updated with the customer authorization IT value
[Update Customer TE Authorization]
The system processes the CUSTOMER-AUTH-TE field from the input message → The customer TE authorization field in the database segment is updated with the customer authorization TE value
[Save Authorization Settings]
The system executes the table root access with replace function code → The authorization settings are permanently saved to the Schedule D table
[Validate IT Route Suppression Flag]
The system processes a change operation for SD table ID → The IT route suppression authorization field in the database segment (GCSTBRT-SD-IT-AUTH) is updated with the value from GCM4U-RTE-SUPPR-IT
[Validate TE Route Suppression Flag]
The system processes a change operation for SD table ID → The TE route suppression authorization field in the database segment (GCSTBRT-SD-TE-AUTH) is updated with the value from GCM4U-RTE-SUPPR-TE
[Validate IT Customer Authorization]
The system processes a change operation for SD table ID → The IT customer authorization field in the database segment (GCSTBRT-SD-CUST-AUTH-IT) is updated with the value from GCM4U-CUSTOMER-AUTH-IT
[Validate TE Customer Authorization]
The system processes a change operation for SD table ID → The TE customer authorization field in the database segment (GCSTBRT-SD-CUST-AUTH-TE) is updated with the value from GCM4U-CUSTOMER-AUTH-TE
[Update Authorization Flags]
The system processes the SD table update → The IT route suppression authorization, TE route suppression authorization, customer IT authorization, and customer TE authorization flags are updated in the database segment
[Validate Vista Class Codes]
The system processes the SD table update → The Vista class SCAC and Vista class FSAC codes are updated in the database segment
[Apply Business Rules Validation]
The system processes the SD table update → The set clearance carload and set clearance intermodal flags are updated in the database segment
[Validate SPLC Routing Codes]
The system processes the SD table update → The SPLC codes 1 through 4 are updated in the database segment for routing validation
[Update GCSTBRT-SD-IT-AUTH]
The system processes the GCM4U port message data → The IT route suppression authorization value from GCM4U-RTE-SUPPR-IT is moved to GCSTBRT-SD-IT-AUTH in the database segment
[Update GCSTBRT-SD-TE-AUTH]
The system processes the GCM4U port message data → The TE route suppression authorization value from GCM4U-RTE-SUPPR-TE is moved to GCSTBRT-SD-TE-AUTH in the database segment
[Update GCSTBRT-SD-CUST-AUTH-IT]
The system processes the GCM4U port message data → The customer IT authorization value from GCM4U-CUSTOMER-AUTH-IT is moved to GCSTBRT-SD-CUST-AUTH-IT in the database segment
[Update GCSTBRT-SD-CUST-AUTH-TE]
The system processes the GCM4U port message data → The customer TE authorization value from GCM4U-CUSTOMER-AUTH-TE is moved to GCSTBRT-SD-CUST-AUTH-TE in the database segment
[Save Updated Foreign Port Record]
All foreign port modifications are complete → The system saves the updated record using replace operation and sets change validation message
[Create New Foreign Port Record]
Processing a foreign port add request → The system creates a new foreign port record with table ID 'SK', foreign port name as table value, and zero segment count
[Insert New Record into Database]
Finalizing the foreign port add operation → The system inserts the record into the database using insert operation and sets add validation message
[Clean Up Foreign Port Key References]
Completing the foreign port delete operation → The system removes the foreign port key from the table structure, shifts remaining entries, and sets delete validation message
[Create New MU Record]
The system processes the add request → The system initializes a new record structure, sets MU-TABLE-ID as the table ID, uses manifest unit code as the table value, and sets segment count to zero
[Set Manifest Unit Key]
The system assigns the record key → The system moves GCM4Y-MANIFEST-UNIT to the appropriate table code position based on segment number and displacement within segment
[Update Merlin Message 1]
The Merlin message 1 field is provided in the input → The system updates the Merlin message 1 field in the database record with the new value
[Update Merlin Message 2]
The Merlin message 2 field is provided in the input → The system updates the Merlin message 2 field in the database record with the new value
[Read Counterpart Disposition Code 01]
The system processes the disposition code counterpart mapping → The counterpart disposition code 01 and match method 01 are stored in the database counterpart array position 1
[Read Counterpart Disposition Code 02]
The system processes the disposition code counterpart mapping → The counterpart disposition code 02 and match method 02 are stored in the database counterpart array position 2
[Read Counterpart Disposition Code 03]
The system processes the disposition code counterpart mapping → The counterpart disposition code 03 and match method 03 are stored in the database counterpart array position 3
[Read Counterpart Disposition Code 04]
The system processes the disposition code counterpart mapping → The counterpart disposition code 04 and match method 04 are stored in the database counterpart array position 4
[Read Counterpart Disposition Code 05]
The system processes the disposition code counterpart mapping → The counterpart disposition code 05 and match method 05 are stored in the database counterpart array position 5
[Read Counterpart Disposition Code 06]
The system processes the disposition code counterpart mapping → The counterpart disposition code 06 and match method 06 are stored in the database counterpart array position 6
[Read Counterpart Disposition Code 07]
The system processes the disposition code counterpart mapping → The counterpart disposition code 07 and match method 07 are stored in the database counterpart array position 7
[Read Counterpart Disposition Code 08]
The system processes the disposition code counterpart mapping → The counterpart disposition code 08 and match method 08 are stored in the database counterpart array position 8
[Read Counterpart Disposition Code 09]
The system processes the disposition code counterpart mapping → The counterpart disposition code 09 and match method 09 are stored in the database counterpart array position 9
[Read Counterpart Disposition Code 10]
The system processes the disposition code counterpart mapping → The counterpart disposition code 10 and match method 10 are stored in the database counterpart array position 10
[Process Counterpart Code 01]
The system encounters counterpart disposition code 01 and its matching method → The counterpart code 01 and matching method 01 are moved to the database segment structure
[Process Counterpart Code 02]
The system encounters counterpart disposition code 02 and its matching method → The counterpart code 02 and matching method 02 are moved to the database segment structure
[Process Counterpart Code 03]
The system encounters counterpart disposition code 03 and its matching method → The counterpart code 03 and matching method 03 are moved to the database segment structure
[Process Counterpart Code 04]
The system encounters counterpart disposition code 04 and its matching method → The counterpart code 04 and matching method 04 are moved to the database segment structure
[Process Counterpart Code 05]
The system encounters counterpart disposition code 05 and its matching method → The counterpart code 05 and matching method 05 are moved to the database segment structure
[Process Counterpart Code 06]
The system encounters counterpart disposition code 06 and its matching method → The counterpart code 06 and matching method 06 are moved to the database segment structure
[Process Counterpart Code 07]
The system encounters counterpart disposition code 07 and its matching method → The counterpart code 07 and matching method 07 are moved to the database segment structure
[Process Counterpart Code 08]
The system encounters counterpart disposition code 08 and its matching method → The counterpart code 08 and matching method 08 are moved to the database segment structure
[Process Counterpart Code 09]
The system encounters counterpart disposition code 09 and its matching method → The counterpart code 09 and matching method 09 are moved to the database segment structure
[Process Counterpart Code 10]
The system encounters counterpart disposition code 10 and its matching method → The counterpart code 10 and matching method 10 are moved to the database segment structure
[Store Counterpart Relationships]
The system processes the notify IM flag and post to database flag → The notification indicator and database posting flag are stored in the database segment
[Retrieve Disposition Code from Input Message]
The system processes DC table operations → The disposition code is retrieved from GCMWB-DISP-CODE field
[Store Matching Method 01 Configuration]
The system stores the disposition code configuration → The disposition code description, quantity action, location, process type, Merlin messages, notification settings, and database posting flag are stored in the database record
[Set Merlin Messages]
The system processes Merlin message settings → Merlin message 1 is set from GCMWB-MERLIN-MESSAGE1 and Merlin message 2 is set from GCMWB-MERLIN-MESSAGE2
[Extract SCAC Code from Input Message]
Processing the message for SCAC code → The SCAC code is extracted from GCMWD-SCAC-CODE field
[Extract Port Code from Input Message]
Processing the message for port code → The port code is extracted from GCMWD-PORT-CODE field
[Combine SCAC and Port Codes as Key Value]
Creating the database key for SCAC Port record → The SCAC code is placed in the SCAC portion and port code in the port portion of the composite key
[Update Canadian Empty Manifest Number]
The system updates the Car ID record fields → The system moves the Canadian empty manifest number from input to database record, moves the Canadian loaded manifest number from input to database record, moves the US empty manifest number from input to database record, and moves the US loaded manifest number from input to database record
[Update Car Type Description]
The car type description field contains a new value in the input message → The system updates the car type description field in the database record with the new value
[Set Car Type Code as Key]
The car type code is provided in the input message → The system assigns the car type code as the table key and table value in the database record
[Set Car Type Description]
The car type description is provided in the input message → The system assigns the description to the car type description field in the database record
[Retrieve Schedule K Code from Input Message]
The system needs to identify the specific Schedule K record → The system retrieves the Schedule K code from the input message field GCMWJ-KSCODE
[Access Database with Schedule K Code as Key]
The system needs to access the corresponding database record → The system uses the Schedule K code as the table root key value and performs a database lookup operation
[Extract Disposition Status Code from Input Message GCMWL]
The system processes the update request for DS table type → The disposition status code (GCMWL-DSCODE) is extracted and used as the table key value
[Set Change Valid Message Number]
The database update operation completes without errors → The system sets a change valid message number to indicate successful update completion
[Build Composite Key from Country + Status Code]
The system needs to access the S1 table record → The system should build a composite key with country code in positions 1-2, status code in positions 3-9, and spaces as filler
[Update CSD Status Code Field]
The system processes the status code update → The system should move the new CSD status code from the input message to the database record field
[Map Station Type Fields]
Creating a new station type record → The system assigns the station code to key position 1-7, qualifier to key position 8-9, spaces to filler, zero to segment count, and maps the description and type code information
[Is Table Empty?]
The system checks if the table is empty → The position is marked as found AND the table pointer is set to the end position for insertion
[Advance Table Pointer]
The system needs to advance to the next table position → The displacement within segment is incremented by 1 AND if displacement exceeds segment maximum, reset to 1 and increment segment number
[Map Input Keys for Comparison]
Input keys need to be mapped for comparison with existing table entries → For AD table, map customer admin ID AND for DR table, map range name AND for LT table, map terminal ID AND for MC table, map manifest ID AND for MS table, map message ID AND for SC table, map station code AND for SE table, map station name AND for US table, map user code AND for AU table, map auto ID AND for AC table, map country code and amendment code AND for BK table, map broker key AND for CC table, map railroad SCAC key AND for CT table, map country name AND for RF table, map sequence number AND for SD table, map US port name AND for SK table, map foreign port name AND for MU table, map manifest unit AND for DC table, map disposition code AND for SS table, map SCAC code and port code AND for ID table, map car ID AND for VI table, map car type AND for KS table, map KS code AND for DS table, map DS code AND for S1 table, map country and status code AND for ST table, map STCC code and qualifier
[Map Message ID GCM4A-MSG-ID → IN-CODE]
The system processes the input key mapping for addition → The message ID (GCM4A-MSG-ID) is mapped to the input code (IN-CODE) for comparison with existing table entries
[Increment Displacement Within Segment by 1]
The system needs to advance to the next position within a table segment → The displacement within segment counter is incremented by 1
[Administrative Table - Max 50]
The displacement within segment exceeds the maximum of 50 records (AD-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Station Range Table - Max 25]
The displacement within segment exceeds the maximum of 25 records (DR-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Terminal Table - Max 100]
The displacement within segment exceeds the maximum of 100 records (LT-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Manifest Station Table - Max 50]
The displacement within segment exceeds the maximum of 50 records (MC-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Message Table - Max 200]
The displacement within segment exceeds the maximum of 200 records (MS-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Station Code Table - Max 75]
The displacement within segment exceeds the maximum of 75 records (SC-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Station Entry Table - Max 50]
The displacement within segment exceeds the maximum of 50 records (SE-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[User Security Table - Max 100]
The displacement within segment exceeds the maximum of 100 records (US-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Automotive Table - Max 25]
The displacement within segment exceeds the maximum of 25 records (AU-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Amendment Code Table - Max 100]
The displacement within segment exceeds the maximum of 100 records (AC-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Broker Table - Max 200]
The displacement within segment exceeds the maximum of 200 records (BK-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Carrier Code Table - Max 150]
The displacement within segment exceeds the maximum of 150 records (CC-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Country Code Table - Max 50]
The displacement within segment exceeds the maximum of 50 records (CT-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Reference Code Table - Max 100]
The displacement within segment exceeds the maximum of 100 records (RF-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Schedule D Table - Max 75]
The displacement within segment exceeds the maximum of 75 records (SD-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Foreign Port Table - Max 200]
The displacement within segment exceeds the maximum of 200 records (SK-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Manifest Unit Table - Max 50]
The displacement within segment exceeds the maximum of 50 records (MU-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Disposition Code Table - Max 100]
The displacement within segment exceeds the maximum of 100 records (DC-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[SCAC Port Table - Max 150]
The displacement within segment exceeds the maximum of 150 records (SS-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Car ID Table - Max 100]
The displacement within segment exceeds the maximum of 100 records (ID-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Car Type Table - Max 75]
The displacement within segment exceeds the maximum of 75 records (VI-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Schedule K Table - Max 50]
The displacement within segment exceeds the maximum of 50 records (KS-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Disposition Status Table - Max 25]
The displacement within segment exceeds the maximum of 25 records (DS-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Status Code Table - Max 100]
The displacement within segment exceeds the maximum of 100 records (S1-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Station Type Table - Max 50]
The displacement within segment exceeds the maximum of 50 records (ST-SEGMENT-MAX) → The displacement is reset to 1 and the segment number is incremented by 1
[Insert Administrative Customer ID Key]
The table type is identified as AD-TABLE-ID → The customer administration ID should be inserted as the key in the appropriate segment and displacement position
[Insert Station Range Name Key]
The table type is identified as DR-TABLE-ID → The range name should be inserted as the key in the appropriate segment and displacement position
[Insert Terminal LTERM Key]
The table type is identified as LT-TABLE-ID → The logical terminal identifier should be inserted as the key in the appropriate segment and displacement position
[Insert Manifest Station Key]
The table type is identified as MC-TABLE-ID → The manifest station identifier should be inserted as the key in the appropriate segment and displacement position
[Insert Message ID Key]
The table type is identified as MS-TABLE-ID → The message identifier should be inserted as the key in the appropriate segment and displacement position
[Insert Station Code Key]
The table type is identified as SC-TABLE-ID → The station code should be inserted as the key in the appropriate segment and displacement position
[Insert Station Entry Name Key]
The table type is identified as SE-TABLE-ID → The station entry name should be inserted as the key in the appropriate segment and displacement position
[Insert User Code Key]
The table type is identified as US-TABLE-ID → The user code should be inserted as the key in the appropriate segment and displacement position
[Insert Automotive ID Key]
The table type is identified as AU-TABLE-ID → The automotive identifier should be inserted as the key in the appropriate segment and displacement position
[Insert Amendment Composite Key Country Code + Amendment Code]
The table type is identified as AC-TABLE-ID → The country code should be inserted in positions 1-2 and the amendment code should be inserted in positions 3-4 of the composite key in the appropriate segment and displacement position
[Insert Broker Key]
The table type is identified as BK-TABLE-ID → The broker key should be inserted as the key in the appropriate segment and displacement position
[Insert Railroad SCAC Key]
The table type is identified as CC-TABLE-ID → The railroad SCAC key should be inserted as the key in the appropriate segment and displacement position
[Insert Country Name Key]
The table type is identified as CT-TABLE-ID → The country name should be inserted as the key in the appropriate segment and displacement position
[Insert Reference Sequence Number Key]
The table type is identified as RF-TABLE-ID → The sequence number should be inserted as the key in the appropriate segment and displacement position
[Insert US Port Name Key]
The table type is identified as SD-TABLE-ID → The US port name should be inserted as the key in the appropriate segment and displacement position
[Insert Foreign Port Name Key]
The table type is identified as SK-TABLE-ID → The foreign port name should be inserted as the key in the appropriate segment and displacement position
[Insert Manifest Unit Key]
The table type is identified as MU-TABLE-ID → The manifest unit identifier should be inserted as the key in the appropriate segment and displacement position
[Insert Disposition Code Key]
The table type is identified as DC-TABLE-ID → The disposition code should be inserted as the key in the appropriate segment and displacement position
[Insert SCAC Port Composite Key SCAC Code + Port Code]
The table type is identified as SS-TABLE-ID → The SCAC code and port code should be combined into a composite key and inserted in the appropriate segment and displacement position
[Insert Car ID Key]
The table type is identified as ID-TABLE-ID → The car identifier should be inserted as the key in the appropriate segment and displacement position
[Insert Car Type Key]
The table type is identified as VI-TABLE-ID → The car type identifier should be inserted as the key in the appropriate segment and displacement position
[Insert Schedule K Code Key]
The table type is identified as KS-TABLE-ID → The schedule K code should be inserted as the key in the appropriate segment and displacement position
[Insert Disposition Status Code Key]
The table type is identified as DS-TABLE-ID → The disposition status code should be inserted as the key in the appropriate segment and displacement position
[Insert Status Composite Key Country + Status Code]
The table type is identified as S1-TABLE-ID → The country should be inserted in positions 1-2, the status code should be inserted in positions 3-9, and spaces should be inserted in the filler area of the composite key in the appropriate segment and displacement position
[Insert Station Type Composite Key Code + Qualifier]
The table type is identified as ST-TABLE-ID → The code should be inserted in positions 1-7, the qualifier should be inserted in positions 8-9, and spaces should be inserted in the filler area of the composite key in the appropriate segment and displacement position
[Retrieve Current Dummy Segment Record]
The system attempts to retrieve the current dummy segment record using the table ID as key → The system should locate and read the existing dummy segment record for further processing
[Delete Existing Dummy Segment]
The system needs to update the dummy segment structure → The system should delete the existing dummy segment record to prepare for replacement
[Set Table Root Key Information]
The table root key information needs to be established → The system should copy the working storage table root key to the dummy segment key field
[Set Segment Count to Current End Position]
The segment count needs to be established → The system should set the segment count field to the current end segment number
[Insert New Dummy Segment Record]
The new dummy segment record needs to be stored → The system should insert the new dummy segment record into the database
[More Dependent Segments to Process?]
The system checks if more segments need processing → If the current counter is less than or equal to the end segment number, continue processing; otherwise, complete the operation
[Insert Current Dependent Segment]
A dependent segment record needs to be created → The system should insert a new dependent segment record with the current counter as the key
[Copy Table Data to Dependent Segment]
Table data needs to be transferred to the dependent segment → The system should copy the table segment data from working storage array to the dependent segment data field
[Increment Dependent Segment Counter]
The system needs to move to the next segment → The system should increment the dependent segment counter by 1
[Set Customer Admin ID as Key]
The system assigns the record key → The customer administrative ID from GCM42-CUST-ADM-ID is assigned as the table value key
[Set Publication Merlin ID]
The system configures publication settings → The publication Merlin ID from GCM42-PUB-MERLIN-ID is assigned to the administrative record
[Set DC Processing Merlin IDs 1-5]
The system configures DC processing settings → All five DC processing Merlin IDs (GCM42-DC-P-MERLIN-1 through GCM42-DC-P-MERLIN-5) are assigned to the administrative record
[Configure Purge Days Settings]
The system configures data retention settings → The purge days value from GCM42-PURGE-DAYS is assigned to the administrative record
[Configure Warning Days Settings]
The system configures notification settings → The warning days value from GCM42-WARNING-DAYS is assigned to the administrative record
[Set Escalation Hours]
The system configures escalation settings → The escalation hours value from GCM42-ESCALATION-HOURS is assigned to the administrative record
[Configure Re-add Flag]
The system configures re-addition behavior settings → The re-add flag value from GCM42-READD-FLAG is assigned to the administrative record
[Set Auto-FAX Settings]
The system configures FAX transmission settings → The auto-FAX setting from GCM42-AUTO-FAX is assigned to the administrative record
[Configure System Merlin FAX]
The system configures system FAX settings → The system Merlin FAX setting from GCM42-SYSTEM-MERLIN-FAX is assigned to the administrative record
[Set Bond Merlin ID]
The system configures bond processing settings → The bond Merlin ID from GCM42-BOND-MERLIN is assigned to the administrative record
[Configure US Purge Days]
The system configures US data retention settings → The US purge days value from GCM42-PURGE-DAYS-US is assigned to the administrative record
[Configure US Warning Days]
The system configures US notification settings → The US warning days value from GCM42-WARNING-DAYS-US is assigned to the administrative record
[Set X400 Configuration]
The system configures X400 messaging settings → The X400 configuration from GCM42-X400 is assigned to the administrative record
[Set Range Name from Input Message]
Creating a new station range record → The range name from the input message is assigned to the database record
[Map Station Number 01 from Input]
Creating a new station range record → Each station number (01 through 20) from the input is mapped to the corresponding database record field
[Set Terminal Key from Input Message]
The system processes the terminal creation request → The terminal identifier from the input message is assigned as the table value key
[Map Alternate Terminal Setting]
The system processes the terminal configuration → The alternate terminal setting is mapped from the input message to the terminal record
[Map Supervisor Merlin ID]
The system processes the terminal configuration → The supervisor Merlin ID is mapped from the input message to the terminal record
[Set Manifest Station Key from Input]
The primary key is being established for the new record → The table value is set to the manifest station code from GCM48-MANIF
[Set Message Table ID to MS]
The system initiates message record creation process → The table identifier is set to MS to designate the message table
[Extract Message ID from Input]
Creating a new message record → The message ID from input is assigned as the table value key for the record
[Map English Message Text]
Creating a message record → The English text is mapped to the message English text field in the database record
[Map Message Notes]
Creating a message record → The notes are mapped to the message notes field in the database record
[Set Database Insert Function]
Preparing to save the message record → The database function is set to insert mode
[Execute Database Insert Operation]
Executing the database operation → The message record is inserted into the database through the table root access procedure
[Set Segment Count to Zero]
The system initializes the record structure → The segment count is set to zero in GCSTBRT-SC-SEG-COUNT
[Set Station Name as Primary Key]
The primary key needs to be established → The station name from the input message is set as the table value key
[Set US Crossing Point Implementation Flag]
The crossing point flag needs to be set → The US crossing point implementation flag is copied from the input message to the database record
[Set AEI Block Flag to TRUE]
The AEI block settings are being configured → The AEI block flag is set to TRUE and the current user ID is captured for tracking
[Clear AEI Block Flag and User ID]
The AEI block settings are being configured → Both the AEI block flag and user ID fields are cleared to spaces
[Set Table ID to US]
The system initializes the record structure → The table ID is set to 'US' and the user code is assigned as the key value with zero segment count
[Map Amendment Table Access]
Creating the user security record → All table access permissions are mapped including amendment, administration, automotive, broker, carrier code, country code, disposition code, manifest station range, disposition status by port, car ID, foreign port by port, error routing, manifest station, message, manifest unit, bonded sidings, station entry, schedule D, station selection, schedule K, SCAC code, user security, car kind, crossing, and broker name tables
[Map Basic User Information]
The system processes user security permission assignment → The user name from the input message is mapped to the database user name field
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo change permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo delete permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo add permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo re-add permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo arrive permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo cancel arrive permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo export permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo cancel export permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo international export permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo cancel international export permission is assigned to the user's security profile
[Assign US Cargo Operation Permissions]
The system processes US cargo operation permissions → The US cargo cancel release permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo change permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo delete permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo add permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo re-add permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo arrive permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo cancel place permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo cancel suspend permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo cancel release permission is assigned to the user's security profile
[Assign Canadian Cargo Operation Permissions]
The system processes Canadian cargo operation permissions → The Canadian cargo restrict permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit change permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit delete permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit add permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit re-add permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit arrive permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit cancel arrive permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit enroute permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit over transit error permission is assigned to the user's security profile
[Assign US Transit Operation Permissions]
The system processes US transit operation permissions → The US transit special manifest permission is assigned to the user's security profile
[Assign Canadian Transit Operation Permissions]
The system processes Canadian transit operation permissions → The Canadian transit change permission is assigned to the user's security profile
[Assign Canadian Transit Operation Permissions]
The system processes Canadian transit operation permissions → The Canadian transit delete permission is assigned to the user's security profile
[Assign Canadian Transit Operation Permissions]
The system processes Canadian transit operation permissions → The Canadian transit add permission is assigned to the user's security profile
[Assign Canadian Transit Operation Permissions]
The system processes Canadian transit operation permissions → The Canadian transit re-add permission is assigned to the user's security profile
[Assign Canadian Transit Operation Permissions]
The system processes Canadian transit operation permissions → The Canadian transit arrive permission is assigned to the user's security profile
[Assign Canadian Transit Operation Permissions]
The system processes Canadian transit operation permissions → The Canadian transit over transit error permission is assigned to the user's security profile
[Assign Canadian Transit Operation Permissions]
The system processes Canadian transit operation permissions → The Canadian transit special manifest permission is assigned to the user's security profile
[Grant Universal SCAC Access]
The system processes SCAC access control → The user is granted universal SCAC access by assigning '****' to the first SCAC allowed access entry
[Assign Specific SCAC Allowed List]
The system processes SCAC access control → The system assigns all 5 specific SCAC codes from the input message to the user's SCAC allowed access list
[Assign SCAC Refused List]
The system processes SCAC access control → The system assigns all 5 SCAC codes from the refused list to the user's SCAC refuse access list
[Assign Table Access Permissions]
The system processes table access permissions → The system assigns permissions for amendment, administration, automotive, broker, carrier code, country, disposition code, manifest station range, disposition status by port, car ID, schedule K by port, error routing, manifest station, message, manifest unit, bonded sidings, station entry, schedule D, station selection, schedule K, SCAC code, user security, car kind, crossing, and broker name tables
[Map Auto ID from Input Message]
The system processes the automotive record creation → The auto ID from the input message is mapped to the table value field in the database record
[Set Segment Count to Zero]
The record structure is being initialized → The segment count field is set to zero
[Map Importer Information]
The system processes the automotive record creation → The importer information is mapped to the AU-IMPORTER field in the database record
[Map Business Number]
The system processes the automotive record creation → The business number is mapped to the AU-BUSINESS-NBR field in the database record
[Build Composite Key from Country Code and Amendment Code]
The system creates the amendment code record key → The country code is placed in positions 1-2 of the table value and the amendment code is placed in positions 3-2 of the table value to form a composite key
[Map Amendment Description from Input Message]
The system processes the amendment code data → The amendment description from the input message is mapped to the amendment description field in the database record
[Map Broker Key from Input]
The broker record is being created → The broker key from the input message is mapped to the table value field
[Set Segment Count to Zero]
The segment count needs to be initialized → The segment count is set to zero
[Map Office Code]
The broker record is being populated → The office code is mapped from the input to the broker office code field
[Map FAX Number]
The broker record is being populated → The FAX number is mapped from the input to the broker FAX number field
[Map Filer Code]
The broker record is being populated → The filer code is mapped from the input to the broker filer code field
[Map Full Broker Name]
The broker record is being populated → The full broker name is mapped from the input to the broker name long field
[Map Merlin ID]
The broker record is being populated → The Merlin ID is mapped from the input to the broker Merlin field
[Map FAX Usage Flag]
Communication preferences are being mapped → The FAX usage flag is mapped from the input to the broker FAX usage field
[Map Merlin Usage Flag]
Communication preferences are being mapped → The Merlin usage flag is mapped from the input to the broker Merlin usage field
[Map X12 Usage Flag]
Communication preferences are being mapped → The X12 usage flag is mapped from the input to the broker X12 usage field
[Map Internet Usage Flag]
Communication preferences are being mapped → The Internet usage flag is mapped from the input to the broker Internet usage field
[Map X12 Header Information]
The broker record is being populated → The X12 header is mapped from the input to the broker X12 header field
[Map Alternate US Code]
The broker record is being populated → The alternate US code is mapped from the input to the broker alternate US code field
[Map Canadian Filer Code]
The broker record is being populated → The Canadian filer code is mapped from the input to the broker Canadian filer code field
[Map Paper Usage Flag]
The broker record is being populated → The paper usage flag is mapped from the input to the broker paper usage field
[Map Delivery Schedule]
The broker record is being populated → The delivery schedule is mapped from the input to the broker delivery schedule field
[Map Terminal Information]
The broker record is being populated → The terminal information is mapped from the input to the broker terminal field
[Map Additional Info Field 1]
The B1 dependent record is being populated → The additional info field 1 is mapped from the input to the B1 info field 1
[Map Additional Info Field 2]
The B1 dependent record is being populated → The additional info field 2 is mapped from the input to the B1 info field 2
[Map Internet Address]
The B1 dependent record is being populated → The Internet address is mapped from the input to the B1 Internet address field
[Create New B1 Record]
The system processes the B1 record creation → A new B1 record is created using ISRT function after initializing the B1 segment and setting the broker key
[Update B1 Supplementary Information]
The system populates the B1 record with supplementary data → The B1 record is updated with broker information fields and internet address from the input message
[Set B1 Supplementary Information]
The system populates the B1 record with supplementary data → The B1 record is populated with broker information fields and internet address from the corresponding input message fields
[Extract Office Code from Message]
The system processes the broker table update request → The broker office code is extracted from GCM4M-BROKER-OFFICE-CODE field
[Apply Case Conversion Transform]
The system processes the broker office code for database storage → The office code undergoes case conversion transformation using INSPECT statement
[Map Railroad SCAC Key to Table Value]
Creating a new carrier code record → The railroad SCAC key is mapped as the primary table value identifier
[Set Segment Count to Zero]
Initializing the record structure → The segment count is set to zero to indicate a new record
[Map Carrier Name from Input Message]
Creating a new carrier code record → The carrier name is mapped from the input message to the database record
[Map CCRA Code from Input Message]
Creating a new carrier code record → The CCRA code is mapped from the input message to the database record
[Map USCS Code from Input Message]
Creating a new carrier code record → The USCS code is mapped from the input message to the database record
[Map IRS Number from Input Message]
Creating a new carrier code record → The IRS number is mapped from the input message to the database record
[Map Arrival Report Setting from Input Message]
Creating a new carrier code record → The arrival report setting is mapped from the input message to configure reporting requirements
[Map Export Report Setting from Input Message]
Creating a new carrier code record → The export report setting is mapped from the input message to configure export reporting requirements
[Extract Country Name from Input Message GCM4Q]
The system processes the country code record creation → The country name from GCM4Q-COUNTRY-NAME must be extracted and assigned as the table key value
[Map ISO Country Code from Input to Database Field]
The system processes the country code record creation → The ISO country code must be mapped from GCM4Q-ISO-COUNTRY-CODE to GCSTBRT-CT-COUNTRY-CODE in the database record
[Start New Reference Code Record Creation]
The system processes a new reference code record creation request for RF table → The system extracts the sequence number as the key, maps the sub-location code to the database field, and creates a new record with zero segment count
[Set Sequence Number as Root Key Value]
The system creates a new reference code record → The sequence number is assigned as the root key value for the database record
[Map Sub-Location Code to Database Field GCSTBRT-RF-SUB-LOCATION-CODE]
The system creates the database record for reference code → The sub-location code is mapped to GCSTBRT-RF-SUB-LOCATION-CODE field in the database record
[Map US Port Name as Primary Key]
The primary key needs to be established → The US port name from the input message is mapped to the table value field
[Set US Port Code]
The port code needs to be configured → The US port code from the input message is mapped to the port code field
[Configure Merlin Communication Settings]
The Merlin settings need to be configured → The US Merlin identifier from the input message is mapped to the Merlin field
[Set Cancel Merlin ID]
The cancel Merlin ID needs to be set → The US cancel Merlin identifier from the input message is mapped to the cancel Merlin field
[Configure Destination Station Number]
The destination station needs to be configured → The US destination station number from the input message is mapped to the destination station field
[Set Route Suppression Authorization for IT]
The IT route suppression authorization needs to be configured → The route suppression IT flag from the input message is mapped to the IT authorization field
[Set Route Suppression Authorization for TE]
The TE route suppression authorization needs to be configured → The route suppression TE flag from the input message is mapped to the TE authorization field
[Set Customer Authorization for IT]
The customer IT authorization needs to be configured → The customer authorization IT flag from the input message is mapped to the customer IT authorization field
[Set Customer Authorization for TE]
The customer TE authorization needs to be configured → The customer authorization TE flag from the input message is mapped to the customer TE authorization field
[Configure SPLC Code]
The SPLC code needs to be configured → The US SPLC code from the input message is mapped to the SPLC field
[Set Vista Class SCAC Code]
The Vista Class SCAC code needs to be set → The Vista Class SCAC code from the input message is mapped to the Vista Class SCAC field
[Set Vista Class FSAC Code]
The Vista Class FSAC code needs to be set → The Vista Class FSAC code from the input message is mapped to the Vista Class FSAC field
[Configure Set/Clear Carload Flag]
The carload flag needs to be configured → The set/clear carload flag from the input message is mapped to the carload field
[Configure Set/Clear Intermodal Flag]
The intermodal flag needs to be configured → The set/clear intermodal flag from the input message is mapped to the intermodal field
[Set FIRMS Code]
The FIRMS code needs to be set → The FIRMS code from the input message is mapped to the FIRMS code field
[Configure SPLC Code 1]
The first SPLC code needs to be configured → The SPLC code 1 from the input message is mapped to the SPLC code 1 field
[Configure SPLC Code 2]
The second SPLC code needs to be configured → The SPLC code 2 from the input message is mapped to the SPLC code 2 field
[Configure SPLC Code 3]
The third SPLC code needs to be configured → The SPLC code 3 from the input message is mapped to the SPLC code 3 field
[Configure SPLC Code 4]
The fourth SPLC code needs to be configured → The SPLC code 4 from the input message is mapped to the SPLC code 4 field
[Set Arrival Days Configuration]
The arrival days need to be set → The arrival days from the input message are mapped to the arrival days field
[Set Export Days Configuration]
The export days need to be set → The export days from the input message are mapped to the export days field
[Get Foreign Port Name from Input Message]
The system processes the input message → The foreign port name should be extracted and assigned as the table value
[Map Foreign Port Code from Input Message]
The system processes the port information → The foreign port code should be mapped to the city code field in the database record
[New Manifest Unit Record Creation]
The system processes the add function for manifest unit table → A new manifest unit record is created with the manifest unit code as the table value, segment count initialized to zero, and the manifest unit description stored in the database record
[Move Manifest Unit Code to Table Value]
The system creates the manifest unit record → The manifest unit code is stored as the table value field in the database record
[Move Manifest Unit Description from Input Message]
The system creates the manifest unit record → The manifest unit description is stored in the database record field GCSTBRT-MU-MANIFEST-UNIT-DESC
[Set Disposition Code as Key Value]
Creating a new disposition code record → The disposition code value is assigned as the primary key for the record
[Map Disposition Code Description]
Creating the disposition code record → The description is mapped to the database record description field
[Map Quantity Action Setting]
Creating the disposition code record → The quantity action setting is mapped to the database record
[Map Location Information]
Creating the disposition code record → The location information is mapped to the database record location field
[Map Process Type Configuration]
Creating the disposition code record → The process type is mapped to the database record process type field
[Map Primary Merlin Message]
Creating the disposition code record → The primary Merlin message is mapped to the database record first message field
[Map Secondary Merlin Message]
Creating the disposition code record → The secondary Merlin message is mapped to the database record second message field
[Map Counterpart Disposition Code 01 through 10 and their Match Methods]
Creating the disposition code record → All counterpart disposition codes (01-10) and their corresponding match methods are mapped to the database record
[Map IM Notification Setting]
Creating the disposition code record → The IM notification setting is mapped to the database record notification field
[Map Post-to-Database Flag]
Creating the disposition code record → The post-to-database flag is mapped to the database record
[Update Counterpart Code 01 & Match Method 01]
The system processes counterpart disposition codes and match methods from GCMWB message → All 10 counterpart disposition codes and their corresponding match methods must be mapped from GCMWB fields to GCSTBRT database fields in sequential order (01 through 10)
[Set Counterpart Code 01 & Match Method 01]
The system processes counterpart disposition codes and match methods from GCMWB message for insertion → All 10 counterpart disposition codes and their corresponding match methods must be mapped from GCMWB fields to GCSTBRT database fields in sequential order (01 through 10) for the new record
[Read Disposition Code Message GCMWB]
The system processes the disposition code message GCMWB → The disposition code description, quantity action, location, process type, merlin messages 1 and 2, notify IM flag, and post to database flag must be mapped from GCMWB to GCSTBRT fields
[Receive Disposition Code Input]
The table ID is DC-TABLE-ID and disposition code data is provided → The disposition code description should be moved from input to database segment
[Validate Quantity Action Rules]
The DC table processing is active → The quantity action field should be transferred from input message to database segment
[Validate Location Assignment]
Processing DC table changes → The location field should be moved from input to database segment
[Validate Process Type]
Updating DC table records → The process type should be transferred from input message to database segment
[Validate Merlin Message Configuration]
Processing DC table modifications → Both Merlin message 1 and message 2 fields should be moved from input to database segment
[Validate Notification Settings]
Updating DC table records → The notify import flag should be moved from input message to database segment
[Validate Post-to-DB Flag]
Processing DC table modifications → The post-to-database flag should be transferred from input to database segment
[Update Database Record GCSTBRT]
The disposition code is being updated in the database → The notification immediate indicator and post to database indicator are moved to the corresponding database fields
[Process Counterpart DC Position 01]
The system processes counterpart disposition code data for position 01 → The counterpart disposition code 01 from the input message is moved to the database segment position 01
[Validate Match Method 01]
The system processes counterpart match method data for position 01 → The counterpart match method 01 from the input message is moved to the database segment position 01
[Process Counterpart DC Position 02]
The system processes counterpart disposition code data for position 02 → The counterpart disposition code 02 from the input message is moved to the database segment position 02
[Validate Match Method 02]
The system processes counterpart match method data for position 02 → The counterpart match method 02 from the input message is moved to the database segment position 02
[Process Counterpart DC Position 03]
The system processes counterpart disposition code data for position 03 → The counterpart disposition code 03 from the input message is moved to the database segment position 03
[Validate Match Method 03]
The system processes counterpart match method data for position 03 → The counterpart match method 03 from the input message is moved to the database segment position 03
[Process Counterpart DC Position 04]
The system processes counterpart disposition code data for position 04 → The counterpart disposition code 04 from the input message is moved to the database segment position 04
[Validate Match Method 04]
The system processes counterpart match method data for position 04 → The counterpart match method 04 from the input message is moved to the database segment position 04
[Process Counterpart DC Position 05]
The system processes counterpart disposition code data for position 05 → The counterpart disposition code 05 from the input message is moved to the database segment position 05
[Validate Match Method 05]
The system processes counterpart match method data for position 05 → The counterpart match method 05 from the input message is moved to the database segment position 05
[Process Counterpart DC Position 06]
The system processes counterpart disposition code data for position 06 → The counterpart disposition code 06 from the input message is moved to the database segment position 06
[Validate Match Method 06]
The system processes counterpart match method data for position 06 → The counterpart match method 06 from the input message is moved to the database segment position 06
[Process Counterpart DC Position 07]
The system processes counterpart disposition code data for position 07 → The counterpart disposition code 07 from the input message is moved to the database segment position 07
[Validate Match Method 07]
The system processes counterpart match method data for position 07 → The counterpart match method 07 from the input message is moved to the database segment position 07
[Process Counterpart DC Position 08]
The system processes counterpart disposition code data for position 08 → The counterpart disposition code 08 from the input message is moved to the database segment position 08
[Validate Match Method 08]
The system processes counterpart match method data for position 08 → The counterpart match method 08 from the input message is moved to the database segment position 08
[Process Counterpart DC Position 09]
The system processes counterpart disposition code data for position 09 → The counterpart disposition code 09 from the input message is moved to the database segment position 09
[Validate Match Method 09]
The system processes counterpart match method data for position 09 → The counterpart match method 09 from the input message is moved to the database segment position 09
[Process Counterpart DC Position 10]
The system processes counterpart disposition code data for position 10 → The counterpart disposition code 10 from the input message is moved to the database segment position 10
[Validate Match Method 10]
The system processes counterpart match method data for position 10 → The counterpart match method 10 from the input message is moved to the database segment position 10
[Build Composite Key from SCAC and Port Codes]
The system constructs the record key → The table value is built by placing SCAC code in the SCAC position and port code in the port position of the composite key
[Set Segment Count to Zero]
The system initializes record counters → The segment count is set to zero
[Map Automated Carrier Setting]
The system maps input data to database fields → The automated carrier value is copied to the corresponding database field
[Map Haulage Agreement Setting]
The system maps input data to database fields → The haulage agreement value is copied to the corresponding database field
[Map Line Bill Initials]
The system maps input data to database fields → The line bill initials value is copied to the corresponding database field
[Map Line Bond Initials]
The system maps input data to database fields → The line bond initials value is copied to the corresponding database field
[Map Haul Bill Initials]
The system maps input data to database fields → The haul bill initials value is copied to the corresponding database field
[Map Haul Bond Initials]
The system maps input data to database fields → The haul bond initials value is copied to the corresponding database field
[Map Railroad Initials]
The system maps input data to database fields → The railroad initials value is copied to the corresponding database field
[Map SNP Indicator]
The system maps input data to database fields → The SNP indicator value is copied to the corresponding database field
[Map Car ID from Input Message]
The system processes the car ID for database storage → The car ID from the input message must be mapped to the table value field in the database record
[Set Segment Count to Zero]
The system initializes the record structure → The segment count must be set to zero to indicate this is a new record with no existing segments
[Map Canadian Empty Manifest Number]
The system processes manifest information for the car → The Canadian empty manifest number must be mapped to the empty Canadian CCN field in the database record
[Map Canadian Loaded Manifest Number]
The system processes manifest information for the car → The Canadian loaded manifest number must be mapped to the loaded Canadian CCN field in the database record
[Map US Empty Manifest Number]
The system processes manifest information for the car → The US empty manifest number must be mapped to the empty US CCN field in the database record
[Map US Loaded Manifest Number]
The system processes manifest information for the car → The US loaded manifest number must be mapped to the loaded US CCN field in the database record
[Map Car Type Code from Input Message]
The system processes the car type code → The car type code from the input message is mapped to the database record table value field
[Set Segment Count to Zero]
The system initializes the record structure → The segment count is set to zero
[Map Car Type Description]
The system processes the car type information → The car type description is mapped from the input message to the database record
[Convert Loaded Car Numeric Code, Store Loaded Car Code]
The system processes the loaded car code → The loaded car code is converted using prefix and suffix transformation and stored in the database record
[Convert Empty Car Numeric Code, Store Empty Car Code]
The system processes the empty car code → The empty car code is converted using prefix and suffix transformation and stored in the database record
[Convert Transit Car Numeric Code, Store Transit Car Code]
The system processes the transit car code → The transit car code is converted using prefix and suffix transformation and stored in the database record
[Convert Conveying/ER Car Numeric Code, Store Conveying/ER Car Code]
The system processes the conveying car code → The conveying car code is converted using prefix and suffix transformation and stored in the ER field of the database record
[Convert APHIS Car Numeric Code, Store APHIS Car Code]
The system processes the APHIS car code → The APHIS car code is converted using prefix and suffix transformation and stored in the database record
[Extract Schedule K Code from Input Message GCMWJ-KSCODE]
The system processes the Schedule K creation request → The Schedule K code must be extracted from field GCMWJ-KSCODE in the input message
[Set Table Value to Schedule K Code]
The system assigns the primary key for the new record → The Schedule K code must be set as the table value for record identification
[Extract Schedule K Name from Input Message GCMWJ-NAME]
The system processes the Schedule K name information → The Schedule K name must be extracted from field GCMWJ-NAME in the input message
[Move Schedule K Name to Database Field GCSTBRT-KS-NAME]
The system populates the database record fields → The Schedule K name must be moved to database field GCSTBRT-KS-NAME
[New Disposition Status Record Creation - Creates new disposition status records with names]
The system processes an ADD function for DS table type → A new disposition status record is created with the code as the table value and the name stored in the database segment
[Extract Disposition Status Code from Input Message GCMWL-DSCODE]
The system processes the disposition status record → The disposition status code is extracted and used as the table value key
[Map Disposition Status Name from GCMWL-NAME to Database Field]
The system maps the input data to database fields → The disposition status name is moved to GCSTBRT-DS-NAME field
[Map Country Code to Status Country Field]
The system processes the country information → The country code is mapped to the status country field in the database record
[Map Status Code to Status Code Field]
The system processes the status code information → The status code value is mapped to the status code field in the database record
[Set Segment Count to Zero]
The system initializes the record counters → The segment count is set to zero
[Map CSD Status Code from Input Message]
The system processes the CSD information → The CSD status code is mapped to the CSD status code field in the database record
[Map Station Type Description]
The system processes the station type record → The description is mapped to the database record description field
[Move Station Type Description]
Station type data is being processed for classification → The description from the input message is moved to the corresponding database record field
[Decrease End Pointer]
The table cleanup process is executed → The end pointer is decremented by one position and segment boundaries are adjusted according to table-specific maximum segment sizes
[Deletion Complete - Success Message]
All cleanup and associated record deletions are finished → The system message number is set to DELETE-VALID-MSG-NUM to indicate successful deletion
[AD Table - Administrative Settings]
The search displacement exceeds the AD segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[DR Table - Station Range]
The search displacement exceeds the DR segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[LT Table - Terminal Configuration]
The search displacement exceeds the LT segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[MC Table - Manifest Station]
The search displacement exceeds the MC segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[MS Table - Message Configuration]
The search displacement exceeds the MS segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[SC Table - Station Code]
The search displacement exceeds the SC segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[SE Table - Station Entry]
The search displacement exceeds the SE segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[US Table - User Security]
The search displacement exceeds the US segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[AU Table - Automotive]
The search displacement exceeds the AU segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[AC Table - Amendment Code]
The search displacement exceeds the AC segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[BK Table - Broker Information]
The search displacement exceeds the BK segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[CC Table - Carrier Code]
The search displacement exceeds the CC segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[CT Table - Country Code]
The search displacement exceeds the CT segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[RF Table - Reference Code]
The search displacement exceeds the RF segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[SD Table - Schedule D Port]
The search displacement exceeds the SD segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[SK Table - Foreign Port]
The search displacement exceeds the SK segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[MU Table - Manifest Unit]
The search displacement exceeds the MU segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[DC Table - Disposition Code]
The search displacement exceeds the DC segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[SS Table - SCAC Port Combination]
The search displacement exceeds the SS segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[ID Table - Car ID]
The search displacement exceeds the ID segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[VI Table - Car Type]
The search displacement exceeds the VI segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[KS Table - Schedule K]
The search displacement exceeds the KS segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[DS Table - Disposition Status]
The search displacement exceeds the DS segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[S1 Table - Status Code]
The search displacement exceeds the S1 segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[ST Table - Station Type]
The search displacement exceeds the ST segment maximum limit → The displacement is reset to 1 and the segment number is incremented by 1
[Handle Segment Boundary Crossing for Table Pointer]
The displacement within segment exceeds the maximum segment size for the table type → Reset displacement to 1 and increment the segment number to move to the next segment
[Handle Segment Boundary Crossing for Search Pointer]
The search displacement exceeds the maximum segment size for the table type → Reset search displacement to 1 and increment the search segment number to move to the next segment
[Clear Administrative Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Administrative table code entry at the specified position should be set to spaces
[Clear Station Range Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Station Range table code entry at the specified position should be set to spaces
[Clear Terminal Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Terminal table code entry at the specified position should be set to spaces
[Clear Manifest Station Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Manifest Station table code entry at the specified position should be set to spaces
[Clear Message Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Message table code entry at the specified position should be set to spaces
[Clear Station Code Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Station Code table code entry at the specified position should be set to spaces
[Clear Station Entry Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Station Entry table code entry at the specified position should be set to spaces
[Clear User Security Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The User Security table code entry at the specified position should be set to spaces
[Clear Automotive Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Automotive table code entry at the specified position should be set to spaces
[Clear Amendment Code Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Amendment Code table code entry at the specified position should be set to spaces
[Clear Broker Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Broker table code entry at the specified position should be set to spaces
[Clear Carrier Code Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Carrier Code table code entry at the specified position should be set to spaces
[Clear Country Code Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Country Code table code entry at the specified position should be set to spaces
[Clear Reference Code Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Reference Code table code entry at the specified position should be set to spaces
[Clear Schedule D Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Schedule D table code entry at the specified position should be set to spaces
[Clear Foreign Port Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Foreign Port table code entry at the specified position should be set to spaces
[Clear Manifest Unit Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Manifest Unit table code entry at the specified position should be set to spaces
[Clear Disposition Code Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Disposition Code table code entry at the specified position should be set to spaces
[Clear SCAC Port Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The SCAC Port table code entry at the specified position should be set to spaces
[Clear Car ID Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Car ID table code entry at the specified position should be set to spaces
[Clear Car Type Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Car Type table code entry at the specified position should be set to spaces
[Clear Schedule K Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Schedule K table code entry at the specified position should be set to spaces
[Clear Disposition Status Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Disposition Status table code entry at the specified position should be set to spaces
[Clear Status Code Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Status Code table code entry at the specified position should be set to spaces
[Clear Station Type Table Key Entry]
The system needs to clean up the deleted key entry at the end segment and displacement position → The Station Type table code entry at the specified position should be set to spaces
[Subtract 1 from End Position Within Segment]
The end pointer adjustment process begins → The displacement within segment end counter is decremented by 1
[End Position = Zero?]
The displacement within segment end equals zero → The system triggers segment number adjustment and sets position to maximum for the table type
[Subtract 1 from End Segment Number]
Segment boundary crossing is required → The segment number end is decremented by 1
[Set End Position to AD Segment Max]
The table type is Administrative (AD) → The displacement within segment end is set to AD segment maximum value
[Set End Position to DR Segment Max]
The table type is Station Range (DR) → The displacement within segment end is set to DR segment maximum value
[Set End Position to LT Segment Max]
The table type is Terminal (LT) → The displacement within segment end is set to LT segment maximum value
[Set End Position to MC Segment Max]
The table type is Manifest Station (MC) → The displacement within segment end is set to MC segment maximum value
[Set End Position to MS Segment Max]
The table type is Message (MS) → The displacement within segment end is set to MS segment maximum value
[Set End Position to SC Segment Max]
The table type is Station Code (SC) → The displacement within segment end is set to SC segment maximum value
[Set End Position to SE Segment Max]
The table type is Station Entry (SE) → The displacement within segment end is set to SE segment maximum value
[Set End Position to US Segment Max]
The table type is User Security (US) → The displacement within segment end is set to US segment maximum value
[Set End Position to AU Segment Max]
The table type is Automotive (AU) → The displacement within segment end is set to AU segment maximum value
[Set End Position to AC Segment Max]
The table type is Amendment Code (AC) → The displacement within segment end is set to AC segment maximum value
[Set End Position to BK Segment Max]
The table type is Broker (BK) → The displacement within segment end is set to BK segment maximum value
[Set End Position to CC Segment Max]
The table type is Carrier Code (CC) → The displacement within segment end is set to CC segment maximum value
[Set End Position to CT Segment Max]
The table type is Country Code (CT) → The displacement within segment end is set to CT segment maximum value
[Set End Position to RF Segment Max]
The table type is Reference Code (RF) → The displacement within segment end is set to RF segment maximum value
[Set End Position to SD Segment Max]
The table type is Schedule D (SD) → The displacement within segment end is set to SD segment maximum value
[Set End Position to SK Segment Max]
The table type is Foreign Port (SK) → The displacement within segment end is set to SK segment maximum value
[Set End Position to MU Segment Max]
The table type is Manifest Unit (MU) → The displacement within segment end is set to MU segment maximum value
[Set End Position to DC Segment Max]
The table type is Disposition Code (DC) → The displacement within segment end is set to DC segment maximum value
[Set End Position to SS Segment Max]
The table type is SCAC Port (SS) → The displacement within segment end is set to SS segment maximum value
[Set End Position to ID Segment Max]
The table type is Car ID (ID) → The displacement within segment end is set to ID segment maximum value
[Set End Position to VI Segment Max]
The table type is Car Type (VI) → The displacement within segment end is set to VI segment maximum value
[Set End Position to KS Segment Max]
The table type is Schedule K (KS) → The displacement within segment end is set to KS segment maximum value
[Set End Position to DS Segment Max]
The table type is Disposition Status (DS) → The displacement within segment end is set to DS segment maximum value
[Set End Position to S1 Segment Max]
The table type is Status Code (S1) → The displacement within segment end is set to S1 segment maximum value
[Set End Position to ST Segment Max]
The table type is Station Type (ST) → The displacement within segment end is set to ST segment maximum value
[Map Message ID Key]
The table type is identified as MS (Message) → The message identifier is mapped as the delete key value
[Map Basic User Information]
The system processes user security field mapping → The user name and department are mapped to the corresponding database fields
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo change permission is mapped to the database UCF change field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo delete permission is mapped to the database UCF delete field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo add permission is mapped to the database UCF add field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo re-add permission is mapped to the database UCF re-add field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo arrival permission is mapped to the database UCF arrive field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo cancel arrival permission is mapped to the database UCF cancel arrive field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo export permission is mapped to the database UCF export field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo cancel export permission is mapped to the database UCF cancel export field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo international export permission is mapped to the database UCF international export field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo cancel international export permission is mapped to the database UCF cancel international export field
[Map US Cargo Function Permissions]
The system processes US cargo function permissions mapping → The US cargo cancel release permission is mapped to the database UCF cancel release field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo change permission is mapped to the database CCF change field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo delete permission is mapped to the database CCF delete field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo add permission is mapped to the database CCF add field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo re-add permission is mapped to the database CCF re-add field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo arrival permission is mapped to the database CCF arrive field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo cancel place permission is mapped to the database CCF cancel place field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo cancel suspend permission is mapped to the database CCF cancel suspend field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo cancel release permission is mapped to the database CCF cancel release field
[Map Canadian Cargo Function Permissions]
The system processes Canadian cargo function permissions mapping → The Canadian cargo restriction permission is mapped to the database CCF restrict field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit change permission is mapped to the database UTF change field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit delete permission is mapped to the database UTF delete field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit add permission is mapped to the database UTF add field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit re-add permission is mapped to the database UTF re-add field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit arrival permission is mapped to the database UTF arrive field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit cancel arrival permission is mapped to the database UTF cancel arrive field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit enroute permission is mapped to the database UTF enroute field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit over transit error permission is mapped to the database UTF over transit error field
[Map US Transit Function Permissions]
The system processes US transit function permissions mapping → The US transit special manifest permission is mapped to the database UTF special manifest field
[Map Canadian Transit Function Permissions]
The system processes Canadian transit function permissions mapping → The Canadian transit change permission is mapped to the database CTF change field
[Map Canadian Transit Function Permissions]
The system processes Canadian transit function permissions mapping → The Canadian transit delete permission is mapped to the database CTF delete field
[Map Canadian Transit Function Permissions]
The system processes Canadian transit function permissions mapping → The Canadian transit add permission is mapped to the database CTF add field
[Map Canadian Transit Function Permissions]
The system processes Canadian transit function permissions mapping → The Canadian transit re-add permission is mapped to the database CTF re-add field
[Map Canadian Transit Function Permissions]
The system processes Canadian transit function permissions mapping → The Canadian transit arrival permission is mapped to the database CTF arrive field
[Map Canadian Transit Function Permissions]
The system processes Canadian transit function permissions mapping → The Canadian transit over transit error permission is mapped to the database CTF over transit error field
[Map Canadian Transit Function Permissions]
The system processes Canadian transit function permissions mapping → The Canadian transit special manifest permission is mapped to the database CTF special manifest field
[Check Special Access?]
The first SCAC allowed entry equals '****' → The system sets universal SCAC access flag and maps the special indicator to database
[Set Individual SCAC Access]
The first SCAC allowed entry does not equal '****' → The system maps all 5 SCAC allowed entries and all 5 SCAC refused entries to corresponding database fields
[Map Table Access Permissions]
The system processes table access permissions mapping → All table access permissions including amendment, administration, automotive, broker, carrier code, country, disposition code, manifest station range, disposition status by port, car ID, schedule K by port, error routing, manifest station, message, manifest unit, bonded sidings, station entry, schedule D, station selection, schedule K, SCAC code, user security, car kind, crossing, and broker name are mapped to corresponding database fields
[Message Table Access]
The system processes message table access permissions → The message table access permission is set in the user profile
[Configure Amendment Table Access]
Amendment table access permission is being configured → The amendment table access flag is set from the user security input message
[Configure Administration Table Access]
Administration table access permission is being configured → The administration table access flag is set from the user security input message
[Configure Automotive Table Access]
Automotive table access permission is being configured → The automotive table access flag is set from the user security input message
[Configure Broker Table Access]
Broker table access permission is being configured → The broker table access flag is set from the user security input message
[Configure Carrier Code Table Access]
Carrier code table access permission is being configured → The carrier code table access flag is set from the user security input message
[Configure Country Code Table Access]
Country code table access permission is being configured → The country code table access flag is set from the user security input message
[Configure Disposition Code Table Access]
Disposition code table access permission is being configured → The disposition code table access flag is set from the user security input message
[Configure Manifest Upon Station Range Access]
Manifest upon station range access permission is being configured → The manifest upon station range access flag is set from the user security input message
[Configure Disposition Status by Port Access]
Disposition status by port access permission is being configured → The disposition status by port access flag is set from the user security input message
[Configure Car ID Table Access]
Car ID table access permission is being configured → The car ID table access flag is set from the user security input message
[Configure Schedule K by Port Access]
Schedule K by port access permission is being configured → The schedule K by port access flag is set from the user security input message
[Configure Manifest Station Table Access]
Manifest station table access permission is being configured → The manifest station table access flag is set from the user security input message
[Configure Message Table Access]
Message table access permission is being configured → The message table access flag is set from the user security input message
[Configure Manifest Unit Table Access]
Manifest unit table access permission is being configured → The manifest unit table access flag is set from the user security input message
[Configure Bonded Sidings Table Access]
Bonded sidings table access permission is being configured → The bonded sidings table access flag is set from the user security input message
[Configure Station Entry Table Access]
Station entry table access permission is being configured → The station entry table access flag is set from the user security input message
[Configure Schedule D Table Access]
Schedule D table access permission is being configured → The schedule D table access flag is set from the user security input message
[Configure Station Selection Table Access]
Station selection table access permission is being configured → The station selection table access flag is set from the user security input message
[Configure Schedule K Table Access]
Schedule K table access permission is being configured → The schedule K table access flag is set from the user security input message
[Configure SCAC Code Table Access]
SCAC code table access permission is being configured → The SCAC code table access flag is set from the user security input message
[Configure User Security Table Access]
User security table access permission is being configured → The user security table access flag is set from the user security input message
[Configure Car Kind Table Access]
Car kind table access permission is being configured → The car kind table access flag is set from the user security input message
[Configure Crossing Table Access]
Crossing table access permission is being configured → The crossing table access flag is set from the user security input message
[Configure Broker Name Table Access]
Broker name table access permission is being configured → The broker name table access flag is set from the user security input message
[Map Amendment Table Access]
The system processes user security permissions mapping → The amendment table access permission is transferred from input message to user security database record
[Map Administration Table Access]
The system processes user security permissions mapping → The administration table access permission is transferred from input message to user security database record
[Map Automotive Table Access]
The system processes user security permissions mapping → The automotive table access permission is transferred from input message to user security database record
[Map Broker Table Access]
The system processes user security permissions mapping → The broker table access permission is transferred from input message to user security database record
[Map Carrier Code Table Access]
The system processes user security permissions mapping → The carrier code table access permission is transferred from input message to user security database record
[Map Country Code Table Access]
The system processes user security permissions mapping → The country code table access permission is transferred from input message to user security database record
[Map Disposition Code Table Access]
The system processes user security permissions mapping → The disposition code table access permission is transferred from input message to user security database record
[Map Manifest Upon Station Range Access]
The system processes user security permissions mapping → The manifest upon station range access permission is transferred from input message to user security database record
[Map DS by Port Table Access]
The system processes user security permissions mapping → The DS by port table access permission is transferred from input message to user security database record
[Map Car ID Table Access]
The system processes user security permissions mapping → The car ID table access permission is transferred from input message to user security database record
[Map SK by Port Table Access]
The system processes user security permissions mapping → The SK by port table access permission is transferred from input message to user security database record
[Map Manifest Station Table Access]
The system processes user security permissions mapping → The manifest station table access permission is transferred from input message to user security database record
[Map Message Table Access]
The system processes user security permissions mapping → The message table access permission is transferred from input message to user security database record
[Map Manifest Unit Table Access]
The system processes user security permissions mapping → The manifest unit table access permission is transferred from input message to user security database record
[Map Bonded Sidings Table Access]
The system processes user security permissions mapping → The bonded sidings table access permission is transferred from input message to user security database record
[Map Station Entry Table Access]
The system processes user security permissions mapping → The station entry table access permission is transferred from input message to user security database record
[Map Schedule D Table Access]
The system processes user security permissions mapping → The schedule D table access permission is transferred from input message to user security database record
[Map Station Selection Table Access]
The system processes user security permissions mapping → The station selection table access permission is transferred from input message to user security database record
[Map Schedule K Table Access]
The system processes user security permissions mapping → The schedule K table access permission is transferred from input message to user security database record
[Map SCAC Code Table Access]
The system processes user security permissions mapping → The SCAC code table access permission is transferred from input message to user security database record
[Map User Security Table Access]
The system processes user security permissions mapping → The user security table access permission is transferred from input message to user security database record
[Map Car Kind Table Access]
The system processes user security permissions mapping → The car kind table access permission is transferred from input message to user security database record
[Map Crossing Table Access]
The system processes user security permissions mapping → The crossing table access permission is transferred from input message to user security database record
[Map Broker Name Table Access]
The system processes user security permissions mapping → The broker name table access permission is transferred from input message to user security database record

Structural Validations

[Invalid Function Error]
The function code is not MOD-FUNCTION, EXPAND-FUNCTION, ADD-FUNCTION, or DEL-FUNCTION → The system generates an invalid function error message and calls error handling routine
[Set Error Message: Invalid Function]
The function type is not MOD-FUNCTION, EXPAND-FUNCTION, ADD-FUNCTION, or DEL-FUNCTION → The system moves the invalid function type to ERROR-TABLE1 and sets GCX004C3-ERROR-MSG1 as the error message
[Call Error Handler CERR]
The error condition needs to be processed → The system calls the CERR error handling program with CCCOM parameters
[Canadian Customs Code Valid?]
The Canadian customs code is provided in the input message → The system should move the Canadian customs code to the database segment
[Validate Sub-Location Code]
The Canadian customs sub-location code is provided in the input message → The system should move the sub-location code to the database segment
[US Station Exit Valid?]
The US station exit name is provided in the input message → The system should move the US station exit name to the database segment
[Validate US Station Exit Code]
The US station exit code is provided in the input message → The system should move the US station exit code to the database segment
[Station Number Valid?]
The station number is provided in the input message → The system should move the station number to the database segment
[Validate Merlin ID Configuration]
The Merlin ID is provided in the input message → The system should move the Merlin ID to the database segment
[Validate Merlin ID Configuration]
The import/export indicator is provided in the input message → The system should move the import/export indicator to the database segment
[Validate Merlin ID Configuration]
The print batches flag is provided in the input message → The system should move the print batches flag to the database segment
[Border Port Valid?]
The border port code is provided in the input message → The system should move the border port code to the database segment
[Validate Call Letters]
The call letters are provided in the input message → The system should move the call letters to the database segment
[Validate Alternative Merlin ID]
The alternative Merlin ID is provided in the input message → The system should move the alternative Merlin ID to the database segment
[Validate Vista Class Codes]
The Vista class SCAC code is provided in the input message → The system should move the Vista class SCAC code to the database segment
[Validate Vista Class Codes]
The Vista class FSAC code is provided in the input message → The system should move the Vista class FSAC code to the database segment
[Validate Carload/Intermodal Settings]
The set clear carload flag is provided in the input message → The system should move the set clear carload flag to the database segment
[Validate Carload/Intermodal Settings]
The set clear intermodal flag is provided in the input message → The system should move the set clear intermodal flag to the database segment
[Customs Code Valid?]
The system attempts to retrieve the corresponding record from the database → If the database operation returns successful status, the customs code is considered valid, otherwise it is invalid
[Update Message Error Type]
The system processes the error type update request → The message error type field should be updated with the new error type classification
[Map US Transit Over-Turn Error Permission to Database Field]
The system processes US transit over-turn error permission from input message GCM4G-US-TRN-OVTRNERR → The permission value is mapped to database field GCSTBRT-US-UTF-OVER-TRNERR
[Validate Disposition Code Format]
The system validates the disposition code → The disposition code format is checked against business validation rules
[Dummy Segment Record Exists?]
The system checks if the dummy segment record was successfully found → If the record does not exist, the system should invoke error handling procedures
[Call Error Handler]
The return status indicates the record was not found → The system should call the error handler program to manage the failure condition
[Map Error Type Classification]
Creating a message record → The error type is mapped to the message error type field in the database record
[Set Segment Count to Zero]
The system initializes the database record → The segment count is set to zero for the new reference code record
[Check Counterpart Code Relationships]
Processing DC table changes → All 10 counterpart disposition codes and their corresponding match methods should be transferred from input to database segment
[Read Disposition Code Message GCMWB]
The system processes the disposition code for validation → All counterpart codes (01-10) and their corresponding match methods are read from GCMWB and transferred to the database record GCSTBRT
[Type Code 01 First Character Valid?]
The first character of type code 01 is space, low-value, or high-value → Use only the last 2 characters of the 3-character type code 01, otherwise use the full 3-character code
[Type Code 02 First Character Valid?]
The first character of type code 02 is space, low-value, or high-value → Use only the last 2 characters of the 3-character type code 02, otherwise use the full 3-character code
[Type Code 03 First Character Valid?]
The first character of type code 03 is space, low-value, or high-value → Use only the last 2 characters of the 3-character type code 03, otherwise use the full 3-character code
[Configure Error Routing Table Access]
Error routing table access permission is being configured → The error routing table access flag is set from the user security input message
[Map Error Routing Table Access]
The system processes user security permissions mapping → The error routing table access permission is transferred from input message to user security database record

Module: GCX004DP 1 Consolidated Epic Story

Epic: GCX004DP Complete EDI Specification Extracted from Legacy

Contains 198 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004DP EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Database Access Parameters]
The system initializes database access parameters → Database access flags are cleared, function code is set to retrieve operation, and key structure is prepared for LT table access

Core Acceptance Criteria

[7:Message Table Display]
The system processes each message record until screen line exceeds MS-LINE-MAX → The system displays message ID and English text
[28:Table Pointer Management]
The system increments the display position within segment and the position exceeds the table-specific segment maximum → The system resets position to 1 and advances to the next segment number
[29:Database Record Retrieval]
The system calls database retrieval with table ID and root value → The system retrieves the table segment data or generates error message for unsuccessful retrieval
[Is Function = ADD-FUNCTION?]
The system checks if the current function is ADD-FUNCTION → If the function is ADD-FUNCTION, continue processing without setting error message, otherwise set NO-ENTRIES-MSG-NUM to SYSTEM-MSG-NUM to indicate no entries available
[Set NO-ENTRIES-MSG-NUM to SYSTEM-MSG-NUM]
The system needs to communicate the empty table status → The system sets SYSTEM-MSG-NUM to NO-ENTRIES-MSG-NUM to display appropriate no entries message to the user
[Is Table Entry Empty?]
The AD table code at the current segment position is empty or contains spaces → The system should skip this entry and move to the next table position
[Prepare Database Key]
The AD table code is extracted from the current segment position → The system should move the table code to the temporary root key for database access
[Database Call Successful?]
The database call returns an unsuccessful status → The system should Throw error: and invoke error handling procedures
[Prepare Database Key]
The system prepares to retrieve the full record from the database → The system should move the DR table code from the current segment position to the temporary root key field
[Skip Empty Entry - Advance Pointer]
The DR table code at the current segment and display position equals space → The system advances the table pointer without processing the entry data
[Retrieve LT Table Root Segment]
System needs to format entry for display → System retrieves root segment data using the table code as key
[Format Terminal ID Display Field]
System formats display fields → Logical terminal ID is moved to terminal display field at current screen line
[Format Alternate Terminal Display Field]
System formats display fields → Alternate terminal information is moved to alternate display field at current screen line
[Format Supervisor Merlin ID Display Field]
System formats display fields → Supervisor Merlin ID is moved to supervisor display field at current screen line
[Advance Table Pointer to Next Entry]
System completes entry formatting or skipping → Table pointer is advanced to next entry position using segment management logic
[Call Database Interface GCCTBIO]
The system calls the database interface program GCCTBIO → The database interface is invoked with all required parameters to retrieve the LT table root segment
[Move Retrieved Segment to GCSTBRT Structure]
The system processes the retrieved data → The table segment data is moved to the GCSTBRT structure for subsequent use
[Prepare Database Key]
The system prepares to retrieve detailed MC table data from the database → The MC table code from the current segment position is moved to the temporary root key for database lookup
[Extract MC Table Fields]
The system processes the retrieved table segment → The table segment data is moved to the GCSTBRT structure for field extraction
[Display blank line on screen]
The table pointer exceeds the end of available table entries → A blank message field is displayed on the current screen line and the screen line counter is incremented by 1
[Skip empty entry and advance pointer]
The current message table code at the segment position is empty (space) → The system advances the table pointer to the next entry without displaying any data
[Retrieve message record from database]
The message table code is not empty → The system calls the database retrieval function to get the complete message record using the table code as the lookup key
[Extract message ID from database record]
The system processes the message record for display formatting → The message ID field is extracted from the database record and moved to the corresponding screen display field for the current line
[Extract English text from database record]
The system processes the message record for display formatting → The English text field is extracted from the database record and moved to the corresponding screen display field for the current line
[Advance to next table entry]
The entry processing is complete → The system increments the display position within the segment and handles segment boundary crossing if the maximum segment size is reached
[Move to next screen line]
The display formatting is complete → The screen line counter is incremented by 1 to position for the next entry display
[End of Records - Display Blank Line]
The current pointer position exceeds the end of available records → A blank message field is displayed on the current screen line and the screen line counter is incremented
[Skip Empty Record - Move to Next Position]
The current message table code is empty or contains only spaces → The system moves to the next record position without displaying any data
[Prepare Database Key with Message Code]
The system needs to retrieve detailed message information from the database → The message table code from the current record is moved to the temporary root key for database retrieval
[Call Database Retrieval Function]
The system needs to retrieve the complete message record → The database retrieval function is called to fetch the message data
[Extract Message ID from Retrieved Record]
The system needs to format the message information for display → The message ID is extracted from the retrieved record structure
[Extract English Text from Retrieved Record]
The system needs to complete the message formatting for display → The English text content is extracted from the retrieved record structure
[Format Message ID for Display]
The system formats the message data for screen presentation → The message ID is moved to the appropriate display field for the current screen line
[Format Message Text for Display]
The system completes the message formatting for screen presentation → The English message text is moved to the appropriate display field for the current screen line
[Move to Next Record Position]
The system needs to continue processing additional message records → The record position pointer is advanced to the next available record
[Increment Screen Line Counter]
The system completes the display of one message record → The screen line counter is incremented by one to move to the next display line
[Call database to retrieve station code record]
The database call is executed with the station code key → The system calls GCCTBIO program with communication area, flags, function code, segment name, keys, and return flag parameters
[Extract station code information]
The return flag indicates successful status → The system moves the table segment data to the station code table root structure (GCSTBRT)
[Prepare Database Key with SE Table Code]
System needs to retrieve SE table data from the database → System moves the SE table code to the temporary root key variable for database retrieval
[Extract Station ID from Database Record]
System processes the retrieved SE table record for display formatting → System moves the station ID from the database record to the display screen station name field
[Move to Next Table Entry Position]
The system needs to move to the next entry position → The system increments the display position within the current segment and advances the screen line counter
[Reset to First Entry in Segment]
The display position within the segment exceeds the maximum allowed entries for user security tables → The system resets the display position to 1 and increments the segment number to move to the next segment
[Is Table Code Empty/Space?]
The US table code at the current segment and display position equals space → The system should skip processing this entry and move the table position pointer to the next entry
[Call Database Retrieval Function]
The system needs to retrieve user security data for display formatting → The system should prepare the database key with table ID and US code, then call the database retrieval function to get the user security record
[Update Table Position Pointer]
The system needs to move to the next table entry → The system should increment the display within segment counter, and if it exceeds the US segment maximum, reset to position 1 and increment the segment number
[Move to next table entry]
The system needs to move to the next table entry → The system increments the display position within the segment and resets to the beginning of the next segment if the current segment maximum is exceeded
[Skip Empty Entry - Advance Pointer]
The AU table code at the current segment and display position equals SPACE → The entry formatting is skipped and the pointer advancement routine (B110-ADD-TO-PTR) is performed to move to the next entry
[Retrieve AU Table Root Segment]
The AU table code from the current segment and display position is moved to the temporary root variable → The root segment retrieval routine (B120-RETRIEVE-ROOT) is performed to fetch the complete AU table data
[Format Auto ID Field]
The AU table data formatting is being performed → The Auto ID field (GCSTBRT-AU-AUTO-ID) from the root segment is moved to the display field (GCM4H-AU-AUTO-ID) at the current screen line position
[Format Authorization Type Field]
The AU table data formatting is being performed → The Authorization Type field (GCSTBRT-AU-TYPE) from the root segment is moved to the display field (GCM4H-AU-CODE) at the current screen line position
[Extract AU Table Code from Current Position]
The AU table code at the current segment position contains valid data → The system should extract the AU table code and prepare it for database retrieval operations
[Call Database Interface to Retrieve Root Segment]
The system needs to retrieve the complete AU table data → The system should call the database interface with proper parameters to retrieve the AU table root segment
[Move AU Auto ID to Display]
The system needs to prepare AU data for display → The system should move the AU Auto ID from the retrieved data to the display field for the current screen line
[Move AU Authorization Type to Display]
The system continues mapping AU data fields for display → The system should move the AU authorization type from the retrieved data to the display field for the current screen line
[Update Table Position Pointer]
The system needs to continue processing the next AU table entry → The system should increment the table position pointer and handle segment boundary transitions if the current segment is exhausted
[Move to Next Table Position]
The current record processing is complete → The system advances the table pointer to the next position and manages segment boundaries according to table structure
[Extract Broker Information from Record]
The system needs to access broker information → The system should move the table segment data to the broker root structure for field extraction
[Skip Empty Record]
The broker table code at the current segment position is empty or contains only spaces → The system skips processing this record, advances the pointer to the next entry, and continues without displaying any broker information
[Call Database Retrieval Function GCCTBIO]
The system needs to retrieve CC table record details → The GCCTBIO database retrieval function is invoked to fetch the record from the GCSTBRT database segment
[Update Table Pointer Position]
The system needs to move to the next table entry → The pointer advancement logic is performed to update the display position within the segment and handle segment boundaries
[Check if CC Table Entry Exists]
The CC table code at the current segment position is empty or contains spaces → The entry should be skipped and the pointer should advance to the next entry without performing any data extraction or display formatting
[Database Record Retrieval - Retrieve CC Root Segment]
The CC table code is not empty or spaces → The system should retrieve the CC root segment data from the database using the table code as the key and store it in the table segment structure for further processing
[Extract Carrier SCAC Code]
Formatting CC table data for display → The carrier SCAC code should be extracted from the root segment and moved to the corresponding display field for the current screen line
[Extract Carrier Name]
Formatting CC table data for display → The carrier name should be extracted from the root segment and moved to the corresponding display field for the current screen line
[Extract CCRA Code]
Formatting CC table data for display → The CCRA code should be extracted from the root segment and moved to the corresponding display field for the current screen line
[Extract USCS Code]
Formatting CC table data for display → The USCS code should be extracted from the root segment and moved to the corresponding display field for the current screen line
[Extract Arrival Report Flag]
Formatting CC table data for display → The arrival report flag should be extracted from the root segment and moved to the corresponding display field for the current screen line
[Extract Export Report Flag]
Formatting CC table data for display → The export report flag should be extracted from the root segment and moved to the corresponding display field for the current screen line
[IRS Number Present?]
The IRS number field is not empty or spaces → The IRS number display field should be filled with asterisks instead of showing the actual IRS number value
[IRS Number Present?]
The IRS number field is empty or contains spaces → The IRS number display field should remain empty without any masking or special formatting
[Retrieve Country Data from Database]
The system needs to display country information → The country table code is moved to temporary root key and database retrieval process is performed to get complete country record
[Advance Table Position Pointer]
The system needs to move to the next table entry → The display within segment counter is incremented, and if it exceeds CT segment maximum, it resets to 1 and segment number is incremented
[Check Segment Boundary]
The display within segment counter is compared against the country table segment maximum → If the counter exceeds CT-SEGMENT-MAX, prepare to reset to next segment, otherwise continue within current segment
[Reset to Next Segment]
The system needs to continue processing more country entries → The display within segment counter is reset to 1 and the segment number is incremented by 1
[Call Database I/O Module GCCTBIO]
The system needs to retrieve table data → The GCCTBIO module is called with all required parameters to Execute the database operation
[Move Retrieved Segment to Working Storage]
The database operation returns success status → The retrieved table segment is moved to the GCSTBRT working storage area for data formatting
[Update Table Pointer Position]
The pointer position needs to be updated for the next entry → The display within segment counter is incremented, and if it exceeds the SD segment maximum, reset to 1 and increment the segment number
[Move to Next Table Position]
The system needs to move to the next table position → The system should increment the display position within the segment and handle segment boundary crossing if necessary
[Call Database Interface GCCTBIO]
The system needs to retrieve the actual record data → The system should call the GCCTBIO program with all required parameters including function code, segment names, keys, and return flags
[Move Retrieved Data to GCSTBRT Structure]
The table segment contains the retrieved record information → The system should move the table segment data to the GCSTBRT structure for field extraction
[Extract SD table code for database lookup]
The SD table code at current segment position is not empty → Move the SD table code to temporary root variable for database retrieval
[Retrieve SK table root segment from database]
The system needs to display foreign port information → The system retrieves the SK table root segment from the database using the table code
[Extract foreign port name from database record]
The system processes the foreign port data record → The foreign port name is extracted from the GCSTBRT-SK-NAME field
[Extract foreign port city code from database record]
The system processes the foreign port data record → The foreign port city code is extracted from the GCSTBRT-SK-CITY-CODE field
[Set Root Key Value from SK Table Code]
The system prepares the database key for retrieval → The root key value is set to the SK table code from the current display position within the segment
[Move Retrieved Data to GCSTBRT Structure]
The system needs to prepare the data for display processing → The retrieved table segment data is moved to the GCSTBRT structure
[Move to next table position]
The MU table code at the current segment position equals space → The system performs the pointer advancement routine to move to the next table position
[Prepare database key with MU table code]
The system needs to retrieve detailed MU table data from the database → The system moves the MU table code to the temporary root working storage field to prepare for database retrieval
[Extract manifest unit code from retrieved data]
The database retrieval operation completed successfully → The system extracts the manifest unit code from the retrieved table segment data structure
[Extract manifest unit description from retrieved data]
The database retrieval operation completed successfully → The system extracts the manifest unit description from the retrieved table segment data structure
[Increment table pointer for next entry]
The current entry processing is finished → The system performs the B110-ADD-TO-PTR operation to increment the pointer and handle segment boundaries
[Advance table pointer to next entry]
The system needs to continue processing the table → The table pointer is advanced to the next entry position within the current segment or moves to the next segment if the current segment is complete
[Advance to next table position]
The system needs to move to the next table entry for processing → The system performs the pointer advancement routine to update the current position within the table segment
[Update Table Position Pointer]
The system needs to advance to the next table position → The system should call the pointer advancement routine (B110-ADD-TO-PTR) to increment the position within the segment or move to the next segment if the current segment is complete
[Advance to next table entry]
The system needs to move to the next entry → Increment the display position within segment, and if it exceeds ID segment maximum, reset to position 1 and advance to next segment
[Prepare car ID for database lookup]
The car ID needs to be retrieved from the database → The car ID table code from the current segment position is moved to the temporary root field for database lookup
[Call database to retrieve car ID record]
The database retrieval operation is executed → The system calls GCCTBIO program with communication area, flags, function code, segment name, keys, and table segment parameters
[Extract car ID from retrieved record]
The record data needs to be processed → The system moves the table segment data to the car ID root structure and extracts the car ID value to the display field
[Skip Empty Entry - Advance Pointer]
The VI table code at the current segment position equals SPACE → Skip data retrieval and formatting, and advance the table pointer to the next position
[Advance Table Pointer]
Entry processing is complete → Call pointer advancement routine to move to next table position and handle segment boundaries
[Advance Table Pointer]
The pointer needs to advance to the next entry → Increment the display position within segment and reset to next segment if maximum is exceeded
[Move to next table position]
The entry processing is complete → The display position within the segment is incremented, and if the segment maximum is exceeded, the position resets to 1 and the segment number is incremented
[Prepare KS table key for database lookup]
System needs to retrieve detailed KS table information from database → System moves the KS table code from current segment position to temporary root key for database retrieval
[DS Table Code Entry Empty?]
The DS table code at the current position is checked for content → If the DS table code equals SPACE, skip the entry and increment pointer, otherwise process the entry
[Increment Display Position]
Position advancement is required → Increment display within segment counter and add 1 to screen line position
[Move to Next Table Position]
The S1 table code at the current segment position is empty or contains only spaces → The system should move to the next table position without formatting any display data
[S1 Table Entry Empty?]
The S1 table code at the current segment position equals SPACE → Skip this entry by performing pointer increment operation without processing the data
[Prepare Database Key]
The system needs to retrieve the full S1 table record from database → Move the S1 table code from current segment position to temporary root key for database lookup
[Update Table Navigation Pointers]
The system needs to move to the next table entry → Execute pointer increment operation which adds 1 to display position and handles segment boundary crossing when position exceeds S1 segment maximum
[Move to Next Table Entry Position]
The formatting is complete → The system increments the table position counter and handles segment boundaries if necessary
[Retrieve STCC Database Record]
The system needs to retrieve STCC information from the database → The system should call the database retrieval routine to fetch the complete STCC record using the table code as the lookup key
[Increment Display Position Within Segment]
The system needs to move to the next record within the current segment → The display position within segment counter is incremented by 1
[AD Table: Display Position > AD Segment Max?]
The display position within segment exceeds the AD segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[DR Table: Display Position > DR Segment Max?]
The display position within segment exceeds the DR segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[LT Table: Display Position > LT Segment Max?]
The display position within segment exceeds the LT segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[MC Table: Display Position > MC Segment Max?]
The display position within segment exceeds the MC segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[MS Table: Display Position > MS Segment Max?]
The display position within segment exceeds the MS segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[SC Table: Display Position > SC Segment Max?]
The display position within segment exceeds the SC segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[SE Table: Display Position > SE Segment Max?]
The display position within segment exceeds the SE segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[US Table: Display Position > US Segment Max?]
The display position within segment exceeds the US segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[AU Table: Display Position > AU Segment Max?]
The display position within segment exceeds the AU segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[AC Table: Display Position > AC Segment Max?]
The display position within segment exceeds the AC segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[BK Table: Display Position > BK Segment Max?]
The display position within segment exceeds the BK segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[CC Table: Display Position > CC Segment Max?]
The display position within segment exceeds the CC segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[CT Table: Display Position > CT Segment Max?]
The display position within segment exceeds the CT segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[RF Table: Display Position > RF Segment Max?]
The display position within segment exceeds the RF segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[SD Table: Display Position > SD Segment Max?]
The display position within segment exceeds the SD segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[SK Table: Display Position > SK Segment Max?]
The display position within segment exceeds the SK segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[MU Table: Display Position > MU Segment Max?]
The display position within segment exceeds the MU segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[DC Table: Display Position > DC Segment Max?]
The display position within segment exceeds the DC segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[SS Table: Display Position > SS Segment Max?]
The display position within segment exceeds the SS segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[ID Table: Display Position > ID Segment Max?]
The display position within segment exceeds the ID segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[VI Table: Display Position > VI Segment Max?]
The display position within segment exceeds the VI segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[KS Table: Display Position > KS Segment Max?]
The display position within segment exceeds the KS segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[DS Table: Display Position > DS Segment Max?]
The display position within segment exceeds the DS segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[S1 Table: Display Position > S1 Segment Max?]
The display position within segment exceeds the S1 segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[ST Table: Display Position > ST Segment Max?]
The display position within segment exceeds the ST segment maximum → The display position is reset to 1 and the segment number is incremented by 1
[Call Database Interface GCCTBIO]
The system executes the database retrieval operation → The GCCTBIO database interface program is called with all required parameters including communication area, flags, function code, segment name, keys, and return flag
[Move Retrieved Data to Table Segment Structure]
The system processes the retrieved data → The table segment data is moved to the GCSTBRT structure for use by the calling program

Structural Validations

[31:Error Message Handling - Invalid Table ID]
The system cannot find a matching table type in the evaluation logic → The system moves the invalid table ID to error field and generates an error message
[2:Table Entry Validation - Entries Available?]
The system checks if display entries exist (DISPL-WITHIN-SEG-END equals zero) and the function is not ADD-FUNCTION → The system sets no entries message number when no entries are available for display
[Generate Invalid Table ID Error]
The table ID does not match any known table type → The system moves the table ID to error field, sets error message, and calls error handling program
[Current Table Entry Empty?]
The AD table code at the current segment and display position is evaluated → If the table code equals SPACE, the entry is considered empty; otherwise it contains valid data
[Check AD Table Code Entry]
The AD table code at the current segment position is evaluated → If the code equals SPACE, skip to next entry, otherwise proceed with data extraction
[DR Table Entry Exists?]
The system examines the DR table code field for the current entry → The system should determine if the entry contains a space (empty) or valid data
[Check LT Table Entry]
System checks the table code at current segment position → System determines if entry is empty (space) or contains valid data
[Generate Database Error Message]
The system handles the error condition → The table root key is moved to error context and standard error message GCX004DP-ERROR-MSG2 is set for display
[Call Error Handler CERR]
The system needs to handle the error condition → The error handler program CERR is called with the common communication area to process the error
[Check if Current MC Entry is Empty]
The MC table code at the current segment position equals space → The system should identify the entry as empty and skip processing
[Check MC Table Entry]
The system examines the MC table code at the current segment position → The system determines if the entry is empty (space) or contains valid data to be processed
[Handle Database Error]
The return flag indicates an unsuccessful database operation → The table root key is moved to error fields, an error message is set, and the error handling routine CERR is called
[Generate Database Error Message]
The database retrieval operation returns an unsuccessful status → An error message is generated using the retrieval key and the error handling function is called
[Check if station code entry is blank]
The system examines the station code table entry content → If the entry equals SPACE, it is considered blank, otherwise it contains valid data
[Handle database error]
The return flag indicates UNSUCCESSFUL status → The system moves the table root key to error root key, moves the error message to communication error message, and calls CERR program with communication area
[Check SE Table Entry]
The system examines the SE table code at the current segment position → The system determines if the entry is empty (space) or contains valid data for processing
[Check if SE Table Code is Empty]
The SE table code at the current segment position equals SPACE → System skips the empty entry and increments the table pointer to move to the next position
[Generate Database Error Message]
The return flag indicates unsuccessful database operation → System moves the table root key to error key field, sets error message, and calls error handling routine
[Database Record Not Found Error]
The database retrieval function returns an unsuccessful status indicating the record was not found → The system should Throw error: indicating the database record retrieval failure and call the error handling routine
[Generate Database Error Message]
The database retrieval operation returns an unsuccessful status → The system should generate a database error message and terminate the AU table processing
[Check if Table Entry is Empty]
The system examines the amendment code table entry at the current segment and display position → The system determines if the entry is empty (contains spaces) or contains valid amendment code data
[Check if Current Entry is Empty]
The broker table code at the current segment and display position equals space → The system identifies the entry as empty and requires skipping
[Check if Broker Code Exists]
The broker table code at the current segment position equals space → The system should identify this as an empty entry that needs to be skipped
[Generate Database Error Message]
The system cannot find the requested broker record → The system should move the table root key to error root key, set the appropriate error message, and call the error handling routine
[Check if Current Record is Empty]
The system checks the table code value at the current segment position → The system determines if the record is empty (contains spaces) or has valid data
[Check if CC Table Code is Empty]
The CC table code at the current segment position is evaluated → The system determines if the code is empty (space) or contains valid data
[Generate Database Error Message]
The database retrieval function returns an unsuccessful status → The system moves the table root key to error fields, sets an error message, and calls the error handling routine
[Current Entry Valid - Not Blank Space?]
The system checks the CT table code at current segment position → The system determines if the entry is valid (not equal to space) or invalid (equal to space)
[Check if Country Code Entry Exists]
The country table code at the current segment and display position is evaluated → If the country code equals SPACE, treat as empty entry, otherwise treat as valid entry with data
[Handle Database Error]
The database retrieval returns an unsuccessful status → An error message is generated and error handling procedures are invoked
[Generate Database Error Message]
The return flag indicates unsuccessful operation → The system moves the table root key to error root key field and sets the appropriate error message for display
[Call Error Handler CERR]
A database retrieval failure occurs → The CERR error handling routine is invoked with the common communication area to process the error
[Check SD Table Entry]
The SD table code at the current segment and display position is evaluated → If the table code is empty or space, skip the entry and advance pointer, otherwise retrieve and format the table record
[Check if Current SD Table Entry is Empty]
The SD table code at the current segment position equals SPACE → The system should identify the entry as empty and skip processing
[Handle Database Error - Set Error Message]
The return flag indicates UNSUCCESSFUL status → The system should move the table root key to error root key, set the error message to GCX004DP-ERROR-MSG2, and call the CERR error handling program
[Check if current SD table entry is empty]
The SD table code at the current segment position is checked → If the table code equals SPACE, skip the entry, otherwise proceed with data extraction
[Set Error Message for Failed Retrieval]
The system needs to handle the unsuccessful data access → The table root key is moved to error context and a standardized error message is set for display
[Check if MU table code is empty]
The system examines the MU table code value at the current position → If the MU table code equals space, it is considered empty; otherwise it contains a valid code
[Generate database error message]
The return flag indicates unsuccessful retrieval → The system moves the table root key to error root key field, sets the error message, and calls the error handling routine
[Check DC Table Code Entry]
The system examines the DC table code value → If code is empty or space, skip to next entry, otherwise proceed with data retrieval
[Generate Database Error Message]
The database retrieval returns unsuccessful status → Generate error message with root key information and call error handling routine
[Check if DC table code exists]
The system checks if the DC table code equals space or is empty → The system determines whether the table code is valid for processing or should be skipped
[Check if Current SS Table Entry is Empty]
The SS table code at the current segment position is evaluated → If the table code equals SPACE, the entry is considered empty and should be skipped
[Check if Current SS Table Entry is Empty]
The system checks if the SS table code at the current position equals SPACE → If the table code is empty (SPACE), the entry is considered empty and should be skipped, otherwise the entry contains valid data for processing
[Check if current table entry is empty]
The table code at the current segment position is evaluated → If the table code equals SPACE, the entry is considered empty and skipped, otherwise it is processed as a valid entry
[Handle database error]
The return flag indicates unsuccessful retrieval → The system moves the table root key to error root key field, sets the error message, and calls the error handling program CERR
[Handle Database Error - Record Not Found]
The database return flag indicates unsuccessful retrieval → Throw error: and call error handling routine
[Check if current KS table entry is empty]
System examines the KS table code at current segment number and display position → System determines if the table entry is empty (contains spaces) or contains valid data
[Handle database error - record not found]
Database retrieval returns unsuccessful status indicating record not found → System generates error message with root key information and calls error handling routine
[Check DS Table Entry]
If DS-TBL-CODE at the current segment and display position → The system determines whether the entry is empty (equals SPACE) or contains valid data
[Handle Database Error]
The return flag indicates unsuccessful retrieval → Generate error message with root key information and call error handling routine CERR
[Generate Database Error Message]
The database return flag indicates unsuccessful retrieval → Move the table root key to error root key field, set error message, and call error handling program CERR
[Check if Valid STCC Record Available]
The system checks if the STCC table code at the current segment position is empty or contains spaces → If the STCC table code is empty or spaces, skip processing and move to next entry, otherwise proceed with STCC data extraction
[Generate Database Error Message]
The system handles the database error → An error message is generated containing the table root key that caused the failure and a predefined error message is set
[Call Error Handler]
The system needs to handle the database failure → The CERR error handling program is called with the communication area to process the error
[Invalid Table ID Error]
The table identifier does not match any of the supported table types (AD, DR, LT, MC, MS, SC, SE, US, AU, AC, BK, CC, CT, RF, SD, SK, MU, DC, SS, ID, VI, KS, DS, S1, ST) → The system shall set the invalid table identifier in the error message, set the appropriate error message for invalid table, and invoke the error handler to display the error to the user
[Database Record Not Found Error]
The database retrieval operation returns an unsuccessful status indicating the record was not found → The system shall set the table root key in the error message, set the appropriate error message for record not found, and invoke the error handler to display the error to the user
[Call Error Handler]
The error processing logic determines that the error handler should be invoked → The system shall call the CERR program with the common communication area to handle the error display and processing

Module: GCX004DT 1 Consolidated Epic Story

Epic: GCX004DT Complete EDI Specification Extracted from Legacy

Contains 149 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004DT EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Handle Invalid Table ID]
The system encounters an unrecognized table ID → The table ID is moved to error field, error message is set to GCX004DT-ERROR-MSG1, and error handler CERR is called
[29:Navigate Table Segments]
The system reaches the end of current segment → Reset display position to 1 and increment segment number by 1
[Is Search Key Equal to AD Table Code?]
The search key equals the AD table code at the current segment and position AND the search key is not spaces → Mark the search as finished with valid status indicating exact match found
[Is Search Key Less Than AD Table Code?]
The search key is less than the AD table code at the current segment and position AND the search key is not spaces → Mark the search as finished with valid status indicating proper insertion position found
[Move to Next Position in Segment]
No terminating condition is met for the current position → Increment the display position within the current segment by 1
[Continue to Next Table Entry]
No match conditions are satisfied (exact match, less than, or range match) → The system advances to the next table entry by incrementing the display within segment counter
[Is DR-KEY = DR-TBL-CODE at current position?]
The DR-KEY equals the DR-TBL-CODE at the current segment and position AND the DR-KEY is not spaces → The search is marked as complete with exact match found
[Is DR-KEY < DR-TBL-CODE at current position?]
The DR-KEY is less than the DR-TBL-CODE at the current segment and position AND the DR-KEY is not spaces → The search is marked as complete with insertion position identified
[Move to next position in segment]
Neither exact match nor insertion point conditions are met → The display position within segment is incremented by 1
[Has segment boundary been exceeded?]
The display position within segment exceeds DR-SEGMENT-MAX → The position is reset to 1 and the segment number is incremented by 1
[Continue to Next Table Entry]
No matching condition is met for the current table position → The system increments the display position within the current segment to continue searching through the table
[Move to next position in LT table]
No match condition is met at current position → Increment the displacement within segment by 1 to move to next position
[Has displacement exceeded LT segment maximum?]
The displacement within segment exceeds the LT segment maximum → Reset displacement to 1 and advance to the next segment number
[Continue to Next Table Entry]
The search key is neither equal to nor less than the current table code (for standard tables):
the search key is greater than the current table code (for S1/ST tables)
→ The system increments the display position within the current segment to continue searching
[Increment Position Within Segment]
The search key does not match and is not less than the current table code → The display position within segment is incremented by 1
[Continue to Next Table Entry]
The search key does not match any of the completion criteria (exact match, less than, or range match depending on table type) → The system advances the position within the current segment to continue searching
[Move to Next Table Entry]
Neither exact match nor less-than condition is met with a non-space key → Increment the display position within the current segment by 1
[Increment Position Within Segment, Increment position within segment by 1]
The search needs to continue within the current segment → The position within the segment is incremented by 1
[Reset Position to 1, Increment Segment Number]
A new segment needs to be accessed → The position is reset to 1 and the segment number is incremented by 1
[Continue to Next Table Entry]
The search key does not match any comparison criteria for the current table entry → The system increments the display position within the current segment to continue searching
[Move to next position in SE table]
The search key does not match and is not less than the current table code → The position counter is incremented by 1 to move to the next position within the segment
[Reached end of current segment?]
The display position within the segment exceeds the SE segment maximum → Reset the position to 1 and advance to the next segment number
[Continue to Next Position]
The search key does not match any of the comparison criteria (exact match, less than, or less than equal depending on table type) → The system increments the position within the current segment to continue searching
[Move to Next Position in Segment]
No completion condition has been met for the current position → Increment the position counter within the current segment by 1
[Position Exceeds US Segment Maximum?]
The position within the segment exceeds the US segment maximum limit → Reset the position within segment to 1 AND increment the segment number by 1
[Continue to Next Table Entry]
The current table entry does not meet the match criteria for the search key → The system increments the position within the current segment to examine the next table entry
[Move to next position in segment]
AU-KEY does not match and is not less than AU-TBL-CODE at current position → Increment position counter to move to next entry within current segment
[Has segment boundary been exceeded?]
Current position exceeds AU-SEGMENT-MAX boundary → Reset position to 1 and advance to next segment number
[Continue to Next Table Entry]
The search key does not exactly match the table code AND is not less than the table code (for standard tables):
does not meet the less-than-or-equal criteria (for S1/ST tables)
→ The system advances the position counter within the current segment to continue searching
[Move to Next Position in Segment]
Neither exact match nor insertion position criteria are met → Increment the display position within the current segment by 1
[Reset to First Position in Segment]
Position within segment is greater than AC segment maximum → Reset display position to 1 and increment segment number by 1
[Move to Next Position in Segment]
Neither exact match nor less-than position conditions are satisfied → Increment the position counter to move to the next entry within the current segment
[Has Segment Boundary Been Exceeded?]
The current position within the segment exceeds the BK segment maximum limit → Reset the position to the first entry and advance to the next segment
[Move to Next Position in Segment]
Neither exact match nor position criteria are met → Increment the display position within the current segment by 1
[Has Segment Boundary Been Exceeded?]
The display position within segment exceeds the CC segment maximum → Reset display position to 1 and increment segment number by 1
[Continue to Next Table Entry]
The search key does not exactly match the current table entry and is not less than the current table entry → The search continues by advancing the position within the current segment to examine the next table entry
[Is CT-KEY = CT-TBL-CODE at current position?]
The CT-KEY equals the CT-TBL-CODE at the current segment and displacement position AND the CT-KEY is not spaces → Mark the search as complete by setting SEARCH-FINISHED-FLAG to WS-VALID
[Is CT-KEY < CT-TBL-CODE at current position?]
The CT-KEY is less than the CT-TBL-CODE at the current segment and displacement position AND the CT-KEY is not spaces → Mark the search as complete by setting SEARCH-FINISHED-FLAG to WS-VALID
[Has displacement exceeded CT segment maximum?]
DISPL-WITHIN-SEG is greater than CT-SEGMENT-MAX → Reset DISPL-WITHIN-SEG to 1 and increment SEG-NO by 1
[Is RF-KEY = RF-TBL-CODE at current position?]
The RF-KEY equals the RF-TBL-CODE at the current segment and position → An exact match condition is identified for further processing
[Move to next position in RF table]
No completion conditions are satisfied → Increment the display position within the current segment by 1
[Reached end of current RF segment?]
The display position within segment is greater than RF-SEGMENT-MAX → The end of current segment boundary is reached
[Reset to first position in segment]
Segment boundary is reached → Set display position within segment to 1
[Move to next RF segment]
Position within segment is reset to 1 → Increment the segment number by 1
[Exceeded RF table boundaries?]
GCWTABLE-PTR is greater than GCWTABLE-END-PTR → The overall table boundaries have been exceeded
[Mark search complete and reset to table start]
Table end is reached after moving to next segment → Set search finished flag to valid status and reset GCWTABLE-PTR to POINTER-START
[Exceeded RF table boundaries?]
GCWTABLE-PTR is greater than GCWTABLE-END-PTR → The overall table boundaries have been exceeded within segment
[Mark search complete and reset to table start]
Table end is reached within segment → Set search finished flag to valid status and reset GCWTABLE-PTR to POINTER-START
[Is SD-KEY = SD-TBL-CODE at current position?]
The SD-KEY equals the SD-TBL-CODE at the current segment and position AND the SD-KEY is not empty spaces → Mark the search as complete indicating an exact match has been found
[Is SD-KEY < SD-TBL-CODE at current position?]
The SD-KEY is less than the SD-TBL-CODE at the current segment and position AND the SD-KEY is not empty spaces → Mark the search as complete indicating the correct insertion position has been found
[Move to next position in SD table]
Neither exact match nor insertion point conditions are met → Increment the position counter within the current segment by 1
[Move to Next Position in Segment]
Neither exact match nor less-than condition is met for the current table position → The position counter within the segment is incremented by 1 to move to the next table entry
[Has Segment Boundary Been Exceeded?]
The display position within segment exceeds the SK segment maximum limit → Reset the position to 1 and advance to the next segment number to continue searching
[Move to Next Position in Segment]
The search key does not match criteria for completion → Increment the position counter within the current segment by 1
[Move to next position in DC table]
No exact match or insertion point is found at current position → Increment the displacement within the current segment to move to the next position
[Has displacement exceeded DC segment maximum?]
The displacement within the segment exceeds the DC segment maximum → Reset displacement to 1 and advance to the next segment number
[Move to next position in SS table]
No match condition is met at current position → Increment the position counter to move to next entry within the segment
[Reached end of current SS segment?]
The position counter exceeds the SS segment maximum limit → Reset position to first entry and advance to next segment
[Mark search complete and reset to start position]
Table boundaries are exceeded during search process → Set search finished flag to valid status and reset table pointer to starting position
[Check if VI-KEY equals VI-TBL-CODE at current position]
The VI search key equals the VI table code at the current segment and position AND the VI search key is not spaces → The search completion flag is set to valid indicating successful match found
[Check if VI-KEY is less than VI-TBL-CODE at current position]
The VI search key is less than the VI table code at the current segment and position AND the VI search key is not spaces → The search completion flag is set to valid indicating insertion point found
[Increment position within segment by 1]
The current position needs to be advanced for continued searching → The position within segment counter is incremented by 1
[Check if position exceeds VI segment maximum]
The position within segment exceeds the VI segment maximum limit → The position is reset to 1 and the segment number is incremented by 1
[Is VI-KEY equal to VI-TBL-CODE at current position?]
The VI search key equals the VI table code at the current segment and display position AND the VI search key is not empty spaces → The search is marked as complete with exact match found
[Is VI-KEY less than VI-TBL-CODE at current position?]
The VI search key is less than the VI table code at the current segment and display position AND the VI search key is not empty spaces → The search is marked as complete with insertion position found
[Move to next table entry]
The VI search key does not match and is not less than the current table code:
the search key is empty spaces
→ The system increments the display position within the current segment to move to the next table entry
[Move to next table entry]
The display position within segment exceeds the VI segment maximum → The system resets display position to 1 and increments the segment number to move to the next segment
[Move to Next Position in KS Table]
The KS search key does not match and is not less than the current table code → The display within segment counter is incremented by 1 to move to next position
[Reset to First Position in Segment, Move to Next Segment]
The display within segment counter has exceeded the segment maximum → The display within segment counter is reset to 1 AND the segment number is incremented by 1
[Set Search Complete Flag, Reset Pointer to Table Start]
The table pointer is greater than the table end pointer → The search finished flag is set to valid AND the table pointer is reset to pointer start
[Move to next position in DS table segment]
The current position does not satisfy the search completion conditions → Increment the position counter to move to the next entry within the current DS table segment
[Has segment boundary been exceeded?]
The position within the segment exceeds the DS segment maximum limit → Reset the position to 1 and advance to the next DS table segment
[Continue to next table position]
The DS search key does not match the current table code AND is not less than the current table code:
the search key is empty
spaces
→ The search continues by incrementing the position within the current segment
[Move to Next Position in Current Segment]
The search needs to continue within the current segment → The position counter is incremented by 1 to move to the next entry in the segment
[Reset to First Position in Segment]
The position counter has exceeded the current segment maximum → The position is reset to 1 and the segment number is incremented by 1
[Move to Next Table Position]
The search key is greater than the current S1 table code:
the search key is empty
→ The system increments the position within the current segment to continue searching
[Move to Next Position in Segment]
The system needs to continue searching within the current segment → The display position within the segment is incremented by 1
[Reset to First Position in Segment]
The system needs to move to the next segment for continued searching → The display position within segment is reset to 1 AND the segment number is incremented by 1
[Move to Next Position in ST Table]
The search needs to continue to find the appropriate position → Increment the position counter within the current segment by 1
[Reset to First Position in Segment]
The segment boundary is reached during the search process → Reset the position counter to 1 and increment the segment number by 1
[Increment Displacement Within Segment]
The system needs to move to the next entry in the current segment → The displacement within segment counter is incremented by 1
[Reset Displacement to 1]
The system needs to move to the next segment → The displacement within segment is reset to 1
[Increment Segment Number]
The system needs to continue searching in the next segment → The segment number is incremented by 1
[Increment Displacement Within Current Segment]
The system needs to move to the next table entry position → The displacement within the current segment is incremented by 1
[Reset Displacement to 1]
The system detects that the current segment boundary has been crossed → The displacement within segment is reset to 1 to start at the beginning of a new segment
[Increment Segment Number]
The system needs to move to the next available segment → The segment number is incremented by 1
[Set Search Complete Flag]
The table boundary check is performed after segment advancement → The search finished flag is set to valid to indicate search completion
[Reset Pointer to Start Position]
The system needs to reset the table position for cleanup → The table pointer is moved back to the pointer start position
[Set Search Complete Flag]
The table boundary check is performed within the same segment → The search finished flag is set to valid to indicate search completion

Structural Validations

[Invalid Table ID - Set Error Message]
The table ID does not match any of the supported table types (AD, DR, LT, MC, MS, SC, SE, US, AU, AC, BK, CC, CT, RF, SD, SK, MU, DC, SS, ID, VI, KS, DS, S1, ST) → The system should move the invalid table ID to error table field, set the error message to GCX004DT-ERROR-MSG1, and call the error handler program CERR
[Set Error Message]
The system needs to prepare an error response → The standard error message for invalid table ID (GCX004DT-ERROR-MSG1) should be assigned to the communication error message field
[Call Error Handling Routine]
The system needs to process the error condition → The CERR error handling program should be called with the communication control block (CCCOM) to process the error
[Exceeded Segment Maximum?]
The display position within segment is greater than the AD segment maximum → Reset the display position to 1 and advance to the next segment
[Exceeded Table End?]
The table pointer is greater than the table end pointer → Mark the search as complete and reset the table pointer to the starting position
[Has table end been reached?]
The GCWTABLE-PTR is greater than GCWTABLE-END-PTR → The search is marked as complete and the pointer is reset to table start
[Has table pointer exceeded end of table?]
The table pointer exceeds the end pointer of LT table → Mark search as complete and reset pointer to starting position
[Position > MC Segment Maximum?]
The display position within segment is greater than the MC segment maximum → The position is reset to 1 and the segment number is incremented by 1
[Table Pointer > End of Table?]
The table pointer is greater than the table end pointer → The search finished flag is set to valid and the table pointer is reset to the start position
[Reached End of Current Segment?]
The display position within segment exceeds the MS segment maximum → Reset display position to 1 and advance to the next segment
[Exceeded Table End?]
The table pointer exceeds the table end pointer → Mark search as complete and reset pointer to table start position
[Position > SC Segment Maximum?]
The current position exceeds the SC segment maximum limit → The segment boundary has been reached and segment advancement is required
[Reached end of entire SE table?]
The table pointer exceeds the table end pointer → Mark the search as complete and reset the pointer to the table start position
[Table Pointer Exceeds End Pointer?]
The table pointer is greater than the table end pointer → Set the search completion flag AND reset the table pointer to the start position
[Has table end been reached?]
GCWTABLE-PTR is greater than GCWTABLE-END-PTR → Mark search as complete and reset pointer to table start
[Position Exceeds Segment Maximum?]
The display position within segment exceeds the AC segment maximum limit → Reset position to 1 and prepare to move to next segment
[Table Pointer Exceeds End?]
The table pointer exceeds the table end pointer → Mark search as complete and reset pointer to start position
[Has Table End Been Reached?]
The table pointer exceeds the table end pointer → Mark search as complete and reset pointer to table start
[Has table pointer exceeded end of table?]
GCWTABLE-PTR is greater than GCWTABLE-END-PTR → Mark search as complete by setting SEARCH-FINISHED-FLAG to WS-VALID and reset GCWTABLE-PTR to POINTER-START
[Is RF-KEY equal to RF-TBL-CODE?]
The system compares RF-KEY with RF-TBL-CODE at the current segment and display position → The system determines if an exact match exists between the search key and table code
[Has segment boundary been exceeded?]
The current position (DISPL-WITHIN-SEG) exceeds the SD segment maximum (SD-SEGMENT-MAX) → Reset the position to 1 and advance to the next segment
[Has table end been reached?]
The table pointer (GCWTABLE-PTR) exceeds the table end pointer (GCWTABLE-END-PTR) → Mark the search as complete and reset the pointer to the table start position
[Has Table End Been Reached?]
The table pointer exceeds the table end pointer after segment advancement → Mark the search as complete and reset the pointer to the table start position
[Has Table End Been Reached?]
The table pointer exceeds the table end pointer while staying in the same segment → Mark the search as complete and reset the pointer to the table start position
[Reached End of Current Segment?]
The position within segment exceeds the MU segment maximum → Reset position to 1 and advance to the next segment
[Reached End of Table?]
The table pointer exceeds the table end boundary after moving to next segment → Mark search as complete and reset pointer to table start position
[Reached End of Table?]
The table pointer exceeds the table end boundary while advancing within segment → Mark search as complete and reset pointer to table start position
[Has table pointer exceeded end of table?]
The table pointer exceeds the end of the DC table → Mark the search as complete and reset the pointer to the starting position
[Check if position exceeds ID segment maximum]
The position within segment exceeds the ID segment maximum → The position is reset to 1 and the segment number is incremented by 1
[Check if table pointer exceeds end pointer]
The table pointer exceeds the table end pointer → The search is marked as complete and valid, and the table pointer is reset to the start position
[Check if table pointer exceeds end pointer]
The table pointer exceeds the table end pointer boundary → The search completion flag is set to valid and the pointer is reset to start position
[Reached End of Current Segment?]
The display within segment counter exceeds the KS segment maximum limit → The segment boundary has been reached and segment transition is required
[Exceeded Table End Pointer?]
The current table pointer exceeds the table end pointer → The table boundary has been exceeded and search completion is required
[Has table end been reached?]
The table pointer is greater than the DS table end pointer → Mark the search as complete and reset the pointer to the table start position
[Exceeded Current Segment Maximum?]
The current position counter exceeds the segment maximum limit → The system identifies that segment boundary has been reached and segment transition is required
[Exceeded Table End Boundary?]
The table pointer exceeds the table end boundary pointer → The system identifies that the entire table has been searched and no more entries are available
[Exceeded Segment Maximum?]
The display position within the segment exceeds the ST segment maximum limit → The segment boundary has been exceeded and segment transition is required
[Exceeded Table End?]
The table pointer exceeds the table end pointer boundary → The end of the ST table has been reached and no more entries are available for searching
[Displacement Exceeds Segment Maximum?]
The system checks if the displacement exceeds the segment maximum limit → If displacement is greater than segment maximum, segment boundary is exceeded, otherwise continue within current segment
[Table Pointer Exceeds End Pointer?]
The system checks if the table pointer exceeds the table end pointer → If table pointer is greater than end pointer, table boundary is exceeded, otherwise continue search in new segment
[Table Pointer Exceeds End Pointer?]
The system checks if the table pointer exceeds the table end pointer → If table pointer is greater than end pointer, table boundary is exceeded, otherwise continue search at current position

Module: GCX004ED 1 Consolidated Epic Story

Epic: GCX004ED Complete EDI Specification Extracted from Legacy

Contains 652 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004ED EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Table Search]
The system needs to search for existing message records → The system should initialize match found flag to not valid, start position flag to not valid, set table pointer to start position, and copy message number to search key
[Initialize Search Parameters]
The validation process begins → Search parameters are initialized with table root key as CC, found flag set to No, segment counter set to 1, and segment number set to zero
[Initialize Search Parameters]
The system begins SCAC code retrieval process → Search parameters are initialized with empty table root key, zero dependency key, not-found flag, zero segment numbers, and segment counter set to 1
[Initialize Segment Counter]
The system prepares to process dependent segments → Segment counter is initialized to 1 to begin sequential processing of carrier dependent segments
[Initialize Search Parameters]
The system begins the carrier table search process → Search parameters are initialized with empty table root key, zero dependency key, not-found indicator, zero segment number, and segment counter set to 1
[Initialize Segment Counter to 1]
The system prepares to process segments sequentially → The segment counter is initialized to 1 to begin with the first segment
[Initialize Code Position Counter]
The system prepares to examine individual SCAC codes within the segment → The code position counter is initialized to 1 to begin with the first code position
[Initialize Search Variables]
The system begins port code validation process → The system should initialize table root key to spaces, dependency key to zeros, found flag to 'N', segment number to zeros, and segment counter to 1
[Get Segment Count -> Initialize Segment Counter]
The system needs to process port code segments → The system should set segment count from retrieved table data and initialize segment counter to 1
[Initialize SCAC Validation Parameters]
System initializes validation parameters → Table root key is cleared, dependent key is zeroed, found flag is set to 'N', segment numbers are zeroed, and segment counter is set to 1
[Initialize Segment Counter to 1]
System prepares for segment iteration → Segment number counter is set to 1 to start processing from first segment
[Initialize Search Parameters]
The system begins the SCAC code search process → Search parameters are initialized with default values including clearing table root key, resetting dependent key, setting found flag to 'N', clearing segment numbers, and setting segment counter to 1
[Initialize Segment Counter to 1]
The system prepares to iterate through table segments → The segment number counter is set to 1 to begin processing from the first segment
[Initialize Code Position Tracer to 1]
The system prepares to examine individual SCAC codes within the segment → The code position tracer is set to 1 to begin processing from the first code position
[Initialize Program Variables]
The system begins processing the request → The program name is saved, module name is set as current program, pointer positions are initialized to 1, and edit flag is set to valid status
[Initialize Search Parameters]
The system begins SCAC code cross-validation → Search parameters are initialized with spaces for table root key, zeros for dependent key, 'N' for found flag, zeros for segment number, and counter set to 1
[Initialize Segment Counter to 1]
The system prepares to process dependent segments → Segment number counter is initialized to 1 to begin sequential processing
[Initialize Code Tracer to 1]
The system prepares to examine carrier codes within the segment → Code tracer is initialized to 1 and process switch is set to continue processing
[Initialize SCAC Lookup Variables]
The system begins the validation process → All lookup variables are cleared, table root key is reset, dependent key is zeroed, found flag is set to 'N', segment counters are initialized to zero and one respectively
[Initialize Segment Counter to 1]
The system prepares for segment iteration → The segment number counter is set to 1 to start processing from the first segment
[Initialize SCAC Lookup Variables - Set up search parameters and counters for comprehensive SCAC validation process]
The SCAC validation process is initiated → All lookup variables are initialized with default values including cleared table root key, reset database key to zeros, code found flag set to 'N', segment number reset to zero, segment counter set to 1, table ID set to 'CC' for carrier table, and SCAC code copied to comparison variable
[Initialize Search Parameters]
The system begins the validation process → All search parameters are cleared, found flag is set to not found, segment counters are reset to initial values, and process is ready for carrier table lookup
[Initialize Search Parameters]
The system prepares to search for the port code → The system should initialize search flags to 'N', set segment counter to 1, and clear search keys
[Initialize Search Parameters]
The system begins the cross-reference search process → Search parameters are initialized with empty table root key, zero dependent key, not found flag, zero segment number, and segment counter set to 1
[Initialize Code Tracer to 1]
The system prepares to scan through carrier codes in the segment → The code tracer is set to 1 to begin processing from the first code position
[Initialize Carrier Table Search]
The system prepares to search carrier table segments → The table root key is cleared, dependency key is reset to zeros, found flag is set to not found, segment counters are initialized to starting values, and table ID is set to 'CC' for carrier table identification
[Initialize Segment Counter to 1]
The system prepares to process dependent segments sequentially → The segment counter is set to 1 to begin processing from the first dependent segment
[Initialize Segment Counter to 1]
The system begins multi-segment table traversal → The segment counter is set to 1, match found flag is set to NOT-VALID, start position found flag is set to NOT-VALID, and table pointer is set to start position

Core Acceptance Criteria

[4:Administration Table Validation]
User has display-only permission and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[5:Destination Range Table Validation]
User has display-only permission for manifest station range and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[6:Terminal Table Validation]
User has display-only permission for error routing and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[7:Manifest Station Table Validation]
User has display-only permission for manifest station and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[8:Message Table Validation]
User has display-only permission for message and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[9:Station Entry Table Validation]
User has display-only permission for station entry and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[10:Station Selection Table Validation]
User has display-only permission for station selection and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[11:User Security Table Validation]
User has display-only permission for user security and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[11:User Security Table Validation]
User Code equals current user's ID → System sets error flag, highlights User Code field, and displays invalid user message
[12:Automotive Table Validation]
User has display-only permission for automotive and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[13:Amendment Table Validation]
User has display-only permission for amendment and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[14:Broker Table Validation]
User has display-only permission for broker and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[15:Carrier Table Validation]
User has display-only permission for carrier and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[16:Country Code Table Validation]
User has display-only permission for country code and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[17:Bonded Sidings Table Validation]
User has display-only permission for bonded sidings and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[18:Schedule D Table Validation]
User has display-only permission for Schedule D and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[19:Schedule K Table Validation]
User has display-only permission for Schedule K and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[20:Manifest Unit Table Validation]
User has display-only permission for manifest unit and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[21:Disposition Code Table Validation, 27:CN0003 Disposition Code Validation, 28:CN0004 Status Code Validation]
User has display-only permission for disposition code and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[22:SCAC Code Table Validation]
User has display-only permission for SCAC code and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[23:Car ID Table Validation]
User has display-only permission for car ID and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[23:Car ID Table Validation]
Car ID is blank, error character, or fails external ISCCARID validation → System sets error flag, highlights Car ID field, and displays invalid Car ID key message
[24:Vehicle Type Table Validation]
User has display-only permission for car kind and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[25:Schedule K by Port Validation]
User has display-only permission for SK by port and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[26:Schedule D by Port Validation]
User has display-only permission for DS by port and function is ADD, MOD, or DEL → System sets error flag, highlights function field, and displays display-only allowed message
[29:Code Existence Validation for ADD]
Record with the same key already exists in the table → System sets error flag, highlights function field, and displays add invalid message
[30:Code Existence Validation for MOD/EXPAND]
Record with the specified key does not exist in the table → System sets error flag, highlights function field, and displays modify invalid message
[31:Code Existence Validation for DEL]
Record with the specified key does not exist in the table → System sets error flag, highlights function field, and displays delete invalid message
[32:Display Mode Code Lookup]
Record with the specified key does not exist but valid start position is found → System sets valid return flag, highlights entry field, and displays continuation message
[32:Display Mode Code Lookup]
Record with the specified key does not exist and no valid start position is found → System sets error flag, highlights entry field, and displays invalid display message
[Map MS - Message Number]
System processes input field mapping → Message Number field value is moved to ENTERED-CODE
[Set Pointer to Start Position]
System validates field entry → Pointer is set to start position and edit flag is set to space for display mode
[Set EDIT-FLAG to SPACE - Valid for display]
Function field is also blank (no specific operation requested) → System sets edit flag to valid state and positions table pointer to start for display browsing
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Administration table → If user has display-only permission for Administration table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Destination Range table → If user has display-only permission for Destination Range table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Logical Terminal table → If user has display-only permission for Logical Terminal table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Manifest Station table → If user has display-only permission for Manifest Station table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Message table → If user has display-only permission for Message table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Station Entry table → If user has display-only permission for Station Entry table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Station Selection table → If user has display-only permission for Station Selection table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on User Security table → If user has display-only permission for User Security table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Automotive table → If user has display-only permission for Automotive table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Amendment Code table → If user has display-only permission for Amendment Code table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Broker table → If user has display-only permission for Broker table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Carrier table → If user has display-only permission for Carrier table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Country table → If user has display-only permission for Country table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Bonded Sidings table → If user has display-only permission for Bonded Sidings table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Schedule D table → If user has display-only permission for Schedule D table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Schedule K table → If user has display-only permission for Schedule K table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Manifest Unit table → If user has display-only permission for Manifest Unit table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Disposition Code table → If user has display-only permission for Disposition Code table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on SCAC Code table → If user has display-only permission for SCAC Code table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Car ID table → If user has display-only permission for Car ID table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Car Kind table → If user has display-only permission for Car Kind table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on SK by Port table → If user has display-only permission for SK by Port table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on DS by Port table → If user has display-only permission for DS by Port table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Status Code table → If user has display-only permission for Status Code table, the operation is blocked with display-only error message and function field is highlighted
[Check Display-Only Permissions for Each Table Type]
The user attempts to perform ADD, MOD, or DEL function on Status Table → If user has display-only permission for Status Table, the operation is blocked with display-only error message and function field is highlighted
[Display-Only Access Detected]
User attempts ADD, MOD, or DEL function on Administration table → System blocks the operation and returns display-only access error message
[Search AD Table for Code Match]
System processes the request → System searches Administration table segments to find matching code and sets match status
[Search Table Segments for DR Code]
The system searches table segments → The system continues searching until a match is found, insertion point is identified, or all segments are processed
[Code Found in Segment?]
The search key matches a destination code in the current segment position → The system marks the record as found and sets match flag to valid
[Code Less Than Current Entry?]
The search key is less than the current segment entry → The system marks insertion point as found and sets start position flag to valid
[Move to Next Entry in Segment]
The system needs to continue searching within the segment → The system increments the displacement counter to move to the next entry in the segment
[End of Current Segment?]
The displacement counter exceeds the maximum entries for DR segment → The system resets displacement to 1 and increments segment number to move to next segment
[More Segments Available?]
The table pointer is still within the valid range of segments → The system continues searching in the next available segment
[Search Terminal Table for Code Match]
The system searches the Terminal table segments → The system should iterate through table entries to find exact matches or determine the correct insertion position based on alphabetical ordering
[More Entries in Current Segment?]
The current displacement within segment exceeds the Terminal segment maximum → The system should reset displacement to 1 and increment to the next segment number to continue searching
[Check User Permissions for Manifest Station]
The user's security profile indicates display-only access for manifest station data → The system should reject the operation and display an access restriction message
[Move to Next Segment]
The displacement within segment exceeds the maximum segment size → The system should reset displacement to 1 and increment the segment number to move to the next segment
[Check User Permission]
The user attempts to perform ADD, MOD, or DEL function → The system should reject the operation with 'Display Only Access' error and highlight the function field
[Message Code Found?]
The message search key equals the message table code at current segment and displacement position → The system should set match found flag to valid and complete the search
[Code Less Than Current Entry?]
The message search key is less than the current message table code → The system should set start position found flag to valid indicating the insertion point
[Move to Next Table Entry]
The system needs to continue searching within the current segment → The system should increment the displacement within segment counter by 1
[End of Current Segment?]
The displacement within segment exceeds the maximum segment size for Message table → The system should reset displacement to 1, increment segment number by 1, and continue to next segment
[More Segments Available?]
The table pointer exceeds the end table pointer:
match is found
insertion point is found
→ The system should complete the message table validation and return results
[User has Display-Only Permission?]
The user attempts to perform an ADD, MOD, or DEL function → The system should reject the operation with an error message indicating only display operations are allowed AND highlight the function field
[Train ID Found in Table?]
The system searches through Station Entry table segments comparing the Train ID with existing table entries → If an exact match is found, the system should set the match found flag to valid AND stop searching
[More Segments to Search?]
The system reaches the end of current segment entries → If more segments exist, the system should move to the next segment AND reset the position counter to 1 AND continue searching
[Search Table Segments]
The system searches through table segments using the Station ID as the search key → The system should iterate through segments until a matching record is found, a valid insertion position is identified, or all segments are exhausted
[Station ID Found in Table?]
The search key matches an existing Station ID in the table → The system should mark the record as found and set the match found flag to valid
[Empty Slot Found?]
An existing table entry is not blank and the search key is less than the existing entry → The system should mark the insertion position as found and set the start position found flag to valid
[User Code equals Current User?]
The entered user code matches the current logged-in user's ID → The system should set validation error flag, highlight the user code field, and display cannot modify self error message if no other system message exists
[Search US Table for User Code]
The system searches the User Security table for the entered user code → The system should traverse table segments comparing the user code with existing entries and set match found flag if found or insertion point flag if appropriate position is located
[User Code Found in Table?]
The entered user code matches an existing user code in the current table segment → The system should set the match found flag to valid and complete the search process
[More Table Segments?]
The current displacement within segment exceeds the maximum segment size → The system should reset displacement to 1, increment segment number, and continue searching if more segments exist
[Display-Only Access Restriction]
The user attempts to perform an ADD, MOD, or DEL function → The system should reject the operation, set the edit flag to invalid, display an 'allowed display only' message, and highlight the function field
[Search AU Table Segments]
The system searches through AU table segments using the Auto ID as the search key → The system should initialize search flags, set the table pointer to start position, move the Auto ID to the table key, and Execute segment matching until a match is found, start position is found, or end of table is reached
[Auto ID Found in Table]
Comparing the search key with table entries in the current segment → If the AU key equals the AU table code at the current position, set match found flag to valid. If the table code is not empty and the AU key is less than the table code, set start position found flag to valid. Otherwise, increment the displacement within segment, and if displacement exceeds AU segment maximum, reset displacement to 1 and increment segment number
[User has Display-Only Permission?]
The user attempts to perform ADD, MOD, or DEL function on Amendment Code table → The system blocks the operation, highlights the function field, and displays 'Display-Only Access' error message
[Code Found in Table?]
System searches through Amendment Code table segments → The system sets match found flag if exact key match is located in any table segment
[More Segments to Check?]
Current segment is fully processed and no match found and more segments exist → The system moves to next segment and continues search process
[Check User Permissions]
The user attempts to perform an add function or modify function or delete function → The system rejects the operation with an allowed display-only error message and highlights the function field
[Search Existing Broker Records]
The system searches through broker table segments using the combined broker name and port code key → The system sets match found flag when exact key match is located or sets start position found flag when insertion point is identified or continues to next segment when no match and no insertion point found
[Record Match Found]
The search key equals the broker table code in the current segment and displacement position → The system sets the match found flag to valid status
[Found Insertion Point?]
The broker table code in current segment is not empty and the search key is less than the broker table code in current segment → The system sets the start position found flag to valid status indicating the insertion point
[Continue to Next Segment]
The current displacement within segment is processed → The system increments displacement within segment by 1 and if displacement exceeds broker segment maximum then resets displacement to 1 and increments segment number by 1
[Block ADD/MOD/DEL Operations]
The user attempts to perform ADD, MOD, or DEL function on carrier table → The system blocks the operation and displays 'Display Only Allowed' error message
[Search CC Table Segments]
The system searches the carrier table segments → The system iterates through table entries to find exact match or insertion point
[Move to Next Table Entry]
The search key is greater than or equal to current entry or current entry is blank → The system increments displacement within segment to check next entry
[Move to Next Segment]
Displacement within segment exceeds maximum segment size → The system resets displacement to 1 and increments segment number to continue search
[User has Display-Only Permission?]
The user attempts to perform an ADD, MOD, or DEL function → The system blocks the operation, highlights the function field, and displays an 'allowed display only' message
[Search Through CT Table Segments]
The system searches through CT table segments → The system iterates through table entries, comparing the search key with existing country codes until a match is found, insertion point is identified, or all segments are processed
[Country Name Found in Table?]
The country name search key exactly equals a country code entry in the current segment and position → The system marks the record as found and sets the match found flag to valid
[More Entries in Current Segment?]
There are more entries available in the current segment → The system increments the displacement within segment counter to examine the next entry, OR if the displacement exceeds the segment maximum, resets to position 1 and moves to the next segment
[Check User Permissions]
The user has display-only permissions for bonded sidings AND attempts to perform ADD, MOD, or DEL function → The system denies access, sets edit flag to invalid, displays allowed display-only message, and highlights the function field
[Search RF Table Segments]
The system searches RF table segments using the sequence number as the key → The system finds exact match, identifies insertion position, or continues searching until all segments are processed
[Move to Next Table Entry]
There are more entries within the current segment → The system increments the displacement within segment counter, or moves to the next segment if the current segment is exhausted
[Code Found in Table?]
The search key equals an existing SD table code at the current segment and displacement position → The system should set the match found flag to valid
[More Segments to Search?]
If search continuation criteria → The system should set start position found flag to valid, OR increment displacement within segment, OR move to next segment when displacement exceeds segment maximum
[Port Name Found in Table?]
The system searches through SK table segments for matching foreign port name → The system identifies if an exact match exists and marks the record as found
[Move to Next Table Entry]
The system continues searching within the segment → The system moves to the next entry within the current segment
[Move to Next Segment]
The system needs to continue searching in additional segments → The system resets displacement to 1 and increments to the next segment number
[Check Display-Only Permissions]
The user attempts ADD, MOD, or DEL function → The system rejects the operation, sets validation error flag, highlights the function field, and displays allowed display-only message
[Search MU Table Segments]
The system needs to verify record existence or find insertion point → The system searches through table segments starting from the beginning pointer position
[Move to Next Table Entry]
More entries exist in the current segment → The system increments the displacement counter to examine the next entry in the segment
[Move to Next Segment]
No match or insertion point has been found in the current segment → The system resets displacement to 1 and increments segment number to continue search in next segment
[Check User Permissions]
The user attempts to perform ADD, MOD, or DEL function → The system should reject the operation with 'Display Only Access' error message and highlight the function field
[Search Table Segments for Code]
The system searches through table segments for the disposition code → The system should find exact code match OR find insertion point where code is less than current entry OR continue to next segment until all segments are processed
[Move to Next Entry in Segment]
The system processes the current segment position → The system should increment displacement within segment OR reset to segment 1 and increment segment number when reaching segment maximum
[Retrieve CC Table Root Segment]
The system attempts to retrieve the Carrier Code table root segment → If successful, the segment count is obtained from the root segment, otherwise the validation fails
[Retrieve Next CC Table Segment]
The system retrieves the next Carrier Code table segment using the segment counter as the key → If the segment is successfully retrieved, it becomes available for code comparison, otherwise the counter is incremented to try the next segment
[Port Type Check]
The system needs to determine which carrier code field to compare against the input SCAC code → If the port code starts with 'C' then use CCRA code for Canadian ports, otherwise use USCS code for US ports
[Increment Segment Counter and More Segments to Check?]
The system needs to continue searching for the SCAC code → The segment counter is incremented and if it does not exceed the total segment count, the next segment is retrieved, otherwise the search ends with no match found
[Is Current Position Empty?]
The current position in the dependent data array contains spaces → The system marks the process as complete and stops further validation
[Retrieve SCAC Code Details]
The system performs a table segment retrieval for the SCAC code → The system attempts to retrieve the carrier details from the database
[Move to Next Position in Segment]
The system needs to continue validation with the next position → The system increments the tracer to move to the next position in the segment
[Mark Process Complete - Code Not Found]
No matching SCAC code has been found in the segment → The system sets the process switch to complete indicating validation failure
[Retrieve Carrier Root Segment]
The system performs carrier root segment retrieval → Carrier root segment is accessed using table I/O service with unqualified SSA and GU function code
[Root Segment Found?]
The system checks the retrieval result → If retrieval was successful, processing continues to get segment count; otherwise, SCAC code is marked as not found
[Get Segment Count]
The system prepares for dependent segment processing → Segment count from carrier root segment is copied to processing variables for loop control
[Retrieve Dependent Segment]
The system accesses a specific carrier dependent segment → Dependent segment is retrieved using table I/O service with current segment counter as dependency key
[Segment Retrieved?]
The system checks retrieval status → If successful, segment contents are processed for port code type; otherwise, segment counter is incremented to try next segment
[Check Port Code Type]
The system analyzes port code type for SCAC validation → Port code first character is evaluated to determine processing path for Canadian ('C') versus US (numeric) ports
[Extract CCRA Code for Canadian Ports]
The system extracts carrier code for comparison → CCRA code from carrier root segment is assigned to comparison variable for SCAC matching
[Extract USCS Code for US Ports]
The system extracts carrier code for comparison → USCS code from carrier root segment is assigned to comparison variable for SCAC matching
[SCAC Match Found?]
The system determines validation outcome → If codes match exactly, found flag is set to yes and processing completes; otherwise, processing continues to next segment
[Increment Segment Counter]
The system continues search process → Segment counter is incremented by 1 and tracer is incremented to process next available segment
[More Segments?]
The system checks for continuation of search → If segment counter is within total segment count and tracer is under limit (200), search continues; otherwise, search terminates as not found
[SCAC Code Not Found]
The system completes validation process without finding match → SCAC code is marked as invalid and not found in carrier table
[Retrieve Root Carrier Table Segment]
The system attempts to access the carrier table → The root carrier table segment is retrieved using table I/O operations
[Root Segment Retrieved Successfully?]
The system checks the retrieval operation result → If retrieval was successful, continue with segment processing; otherwise, terminate search as not found
[Get Total Number of Carrier Segments]
The system needs to determine the scope of the search → The total segment count is extracted from the root segment and stored for iteration control
[More Segments to Process?]
The current segment counter is compared against the total segment count → If the counter is less than or equal to the total segments, continue processing; otherwise, complete search as not found
[Retrieve Next Carrier Segment]
The system attempts to retrieve the next segment using the current counter → The carrier segment corresponding to the current counter value is retrieved
[Segment Retrieved Successfully?]
The system checks the segment retrieval operation result → If retrieval was successful, process the segment contents; otherwise, move to the next segment
[More Codes in Current Segment?]
The current code position counter is compared against the maximum positions (200) → If the counter is less than or equal to 200, continue processing codes; otherwise, move to the next segment
[Get Next SCAC Code from Segment]
The system accesses the code at the current position → The SCAC code value at the current position is extracted for evaluation
[Move to Next Code Position]
The system continues searching within the current segment → The code position counter is incremented by 1 to move to the next position
[Move to Next Segment]
The system continues searching in additional segments → The segment counter is incremented by 1 to move to the next carrier segment
[SCAC Code Search Complete - Not Found]
The search process is completed → The search terminates with a not-found status and the SCAC code validation fails
[Retrieve Table Segment Count]
The system needs to determine search scope → The system should retrieve the table segment and extract the segment count for the selected table type
[More Segments to Search?]
The current segment counter exceeds the total segment count → The system should stop searching and mark port code as invalid
[Retrieve Next Table Segment]
The system needs to access the next table segment → The system should set the dependency key to current segment counter, clear the table root key value, and retrieve the table segment
[Segment Retrieved Successfully?]
The segment retrieval operation fails → The system should increment the segment counter and try the next segment
[Search Port Codes in Segment]
The system needs to find matching port codes → The system should copy the table segment to dependent structure, set process switch to 'N', initialize tracer to 1, and begin iterative port code comparison
[Set Port Code Valid Flag]
The input port code matches a code found in the appropriate table (MC or SD) → The system should set the process switch to 'Y', set the found flag to 'Y', and terminate the search by setting segment counter to 99
[Increment Segment Counter]
The system needs to continue searching → The system should increment the segment counter by 1 to proceed to the next segment
[Set Port Code Invalid Flag]
No matching port code was found in any segment → The system should leave the found flag as 'N' indicating the port code is invalid
[Retrieve Port Code Entry from Table]
The system moves the dependent data table code to the search key and performs table retrieval → The port code entry is retrieved from the table for comparison
[Move to Next Entry in Segment]
The system increments the tracer counter to move to the next entry → If the tracer exceeds the segment limit (50 entries), the search process is marked as complete
[Call GCCTBIO to Retrieve Table Segment]
The system calls GCCTBIO to retrieve the table segment → The system should attempt to access the specified port table and return retrieval status
[Retrieve Dependent Table Segment]
The system attempts to retrieve a dependent table segment → The system should call GCCTBIO with current segment counter as key and return segment data
[Increment Segment Counter -> More Segments?]
The system increments segment counter → The system should increment counter by 1 and continue if counter is within segment limit (50), otherwise terminate with not found status
[Set Found Flag to Yes -> Port Code Validation Complete]
The found flag is set to 'Y' → The system should terminate segment processing and complete validation with success status
[Retrieve MC Table Segment for Canadian validation]
The system performs table lookup → Retrieve the MC (Manifest Station) table segment for validation processing
[Retrieve SD Table Segment for US validation]
The system performs table lookup → Retrieve the SD (Schedule D) table segment for validation processing
[Entry is Empty/Spaces?]
The current segment entry contains only spaces or is empty → The system sets the process completion flag and stops searching
[Retrieve Table Segment via GCCTBIO]
The system needs to validate the port code against table data → The system calls GCCTBIO to retrieve the corresponding table segment
[Move to Next Entry in Segment]
The system needs to continue searching within the segment → The system increments the entry counter to move to the next entry
[Reached Maximum Entries?]
The entry counter reaches the maximum number of entries for the segment type → The system determines that all entries have been processed
[Set Process Complete - Not Found]
No matching port code has been found → The system sets the process completion flag indicating unsuccessful search
[Retrieve Manifest Station Table Segments]
The system accesses the manifest station table (MC) → The system retrieves the table segments containing manifest station codes for comparison
[Get Segment Count from Table]
The system needs to process all table segments → The system obtains the segment count from the table structure to determine iteration boundaries
[More Segments to Process?]
The system checks if more segments need to be processed → If the segment counter is less than or equal to the total segment count, continue processing; otherwise, complete validation
[Retrieve Next Table Segment]
The system needs to access the next segment → The system retrieves the specific segment identified by the current segment counter
[Code Found in Segment?]
The system compares the Canadian port code digits with segment codes → If a match is found, set the match found flag; otherwise, continue to next segment
[User has Display-Only Permission?]
The user attempts to perform ADD, MOD, or DEL function → The system should reject the operation and display an error message indicating only display operations are allowed
[ISCCARID Validation Successful?]
The ISCCARID service returns a validation result → If validation is successful, the system should update the Car ID with the formatted output from ISCCARID service, otherwise mark validation as invalid, highlight the Car ID field, and display invalid Car ID error message
[Search Table Segments for Car ID Match]
The system performs the search operation → The system should continue searching until a match is found, an insertion point is identified, or the end of table is reached
[Car ID Found in Table?]
Comparing the search key with table entries → If the Car ID matches an existing table entry, mark match as found, otherwise if the table entry is not empty and the search key is less than the table entry, mark insertion position as found, otherwise advance to the next entry in the segment
[Check User Permissions]
The requested function is ADD, MOD, or DEL → The system should reject the operation with a display-only access restriction message and highlight the function field
[Search VI Table Segments]
The system searches through VI table segments → The system should initialize search flags, set table pointer to start position, copy car type to search key, and Execute matching until record found, start position found, or end of table reached
[Car Type Found in Table]
Comparing the search key with table entries → If exact match found, mark as found; if current entry is not empty and search key is less than current entry, mark start position found; otherwise increment displacement within segment, and if displacement exceeds segment maximum, reset to 1 and move to next segment
[Search Table Segments for KS Code]
The system searches through table segments → The system finds exact match, determines insertion point, or completes search when reaching end of table
[Code Found in Segment]
The KS key equals an existing KS table code in the current segment position → The system sets match found flag to valid
[Code Less Than Current Entry]
The current table entry is not empty and the KS key is less than the current table entry → The system sets start position found flag to indicate insertion point
[Move to Next Entry in Segment]
No match or insertion point is found at current position → The system increments displacement within segment and moves to next segment if current segment is exhausted
[Search DS Table Segments]
The system searches through DS table segments → The system should compare the DS Code against each table entry, set match found flag if exact match exists, or set start position found flag if insertion point is located
[Move to Next Table Entry]
The current table entry does not match and search key is not less than table code → The system should increment displacement within segment, and if segment maximum is exceeded, reset displacement to 1 and move to next segment
[Display-Only Permission?]
The user attempts to perform ADD, MOD, or DEL function → The system blocks the operation and displays 'Display Only Allowed' error message with function field highlighted
[Move to Next Segment]
More segments exist in the S1 table → The system resets displacement counter to 1 and increments segment number to continue search
[User has Display-Only Permission?]
The user attempts to perform ADD, MOD, or DEL function → The system blocks the operation, sets validation flag to invalid, highlights the function field, and displays allowed display-only message
[Search Table Segments for Code Match]
The system searches table segments using combined code and qualifier as table key → The system iterates through table segments until match is found, valid start position is found, or end of table is reached
[Code Found in Table?]
The search key matches an existing table entry exactly → The system sets match found flag to valid indicating the code exists in the table
[Insertion Point Found?]
A table entry is not empty and the search key is less than the current table entry → The system sets start position found flag to valid indicating a valid insertion point for new entries
[Retrieve Table Segment for Verification]
The system needs to verify the existing record → The system must retrieve the table segment using the table ID and entered code
[Success]
The table segment retrieval is successful → The system must set error status, display 'code already exists' message, highlight the function field, and return invalid status
[Failure]
The table segment retrieval fails due to database error → The system must set database error, call error handler, and return invalid status
[Retrieve Table Segment]
The system attempts to retrieve the table segment containing the code → The system calls the table I/O module to access the specific table segment
[Retrieve Table Segment for Code]
The system attempts to retrieve the table segment for the found code → The system calls the table retrieval service to get the complete record information
[Table Retrieval Successful?]
The table retrieval operation completes → If retrieval is successful, set valid return flag, otherwise call error handler for system issues
[Highlight Function Field]
The error message is being prepared for display → The system highlights the function field with cursor positioning to show the error location
[Code Match Found? - Yes - Exact Match]
The system finds an exact match for the entered code → The system should retrieve the complete table segment data for the matched code
[Table Retrieval Successful? - Success]
The table segment retrieval operation completes successfully → The system should return valid status and make the retrieved table data available for display
[Table Retrieval Successful? - Failure]
The table segment retrieval operation fails → The system should return invalid status and reject the display request
[Insertion Point Found? - Yes - Valid Position]
The system finds a valid insertion point where the code would be positioned in the sorted table → The system should set display continue message, highlight the code field for insertion point reference, and return valid status
[Prepare Root Segment Request]
The system prepares root segment request parameters → The system sets segment name to root segment, assigns table ID from maintenance request, assigns entered code as key value, and initializes dependent key to zeros
[Prepare Dependent Segment Request]
The system prepares dependent segment request parameters → The system sets segment name to dependent segment, assigns table ID from maintenance request, clears key value, and sets dependent key to segment counter value
[Call GCCTBIO Database Service]
The system calls the GCCTBIO database service → The system invokes GCCTBIO with communication area, PCB flags, function code, segment name, table key, dependent key, table segment buffer, and return status
[Load Table Segment Data]
The system processes the retrieved table segment → The system loads segment data into working storage and sets segment count from retrieved root segment for subsequent dependent segment processing
[Retrieve Carrier Table Root Segment]
System retrieves carrier table root segment → Table segment retrieval is performed and return status is captured
[Root Segment Retrieved Successfully?]
System checks retrieval status → If retrieval is successful, continue with validation process, otherwise mark SCAC as invalid
[Get Carrier Segment Count]
System processes root segment information → Carrier segment count is extracted and stored for iteration control
[Retrieve Dependent Segment by Counter]
System retrieves dependent segment using current counter value → Dependent segment is retrieved using counter as dependent key and retrieval status is captured
[Dependent Segment Retrieved?]
System checks retrieval status → If retrieval is successful, process segment data, otherwise increment counter and continue
[Segment Data Empty?]
System evaluates if segment data is empty (spaces) → If segment data is empty, set process complete flag, otherwise extract carrier code for validation
[Get Carrier Code from Segment]
System processes segment data → Carrier table code is extracted from segment and moved to table root key value for lookup
[Retrieve Carrier Root by Code]
System retrieves carrier root segment using extracted code → Carrier root segment is retrieved and return status is captured for validation
[Carrier Root Retrieved?]
System checks retrieval status → If retrieval is successful, proceed with code comparison, otherwise increment counter and continue
[Port Code Type?]
System determines which carrier code to use for comparison → If port code first character is 'C', use Canadian CCRA code, otherwise use US USCS code
[Get Canadian CCRA Code]
System selects appropriate carrier code → Canadian CCRA code is extracted from carrier root segment for comparison
[Get US USCS Code]
System selects appropriate carrier code → US USCS code is extracted from carrier root segment for comparison
[Increment Segment Counter]
System prepares for next segment → Segment number counter is incremented by 1 to process next available segment
[Counter Exceeds Segment Count?]
System checks iteration boundary → If counter exceeds total segment count, terminate search, otherwise check maximum counter limit
[Counter Exceeds Maximum 200?]
System checks safety limit → If counter exceeds 200, set process complete flag, otherwise continue with next segment retrieval
[Set Process Complete Flag]
System sets completion status → Process switch is set to 'Y' to indicate validation process should terminate
[Retrieve Root Carrier Table Segment]
A table segment retrieval is performed for the carrier table → The root segment of the carrier table is retrieved using the table retrieval service
[Get Total Segment Count]
The system needs to determine how many segments to process → The carrier segment count from the root segment is moved to the local segment number variable
[More Segments to Process?]
A segment processing iteration completes → If the segment number counter is less than or equal to the total segment number, continue processing; otherwise, terminate the search
[Retrieve Next Dependent Segment]
The system needs to access the next segment → The table dependent retrieval service is called to get the segment data using the current segment counter
[More Codes in Current Segment?]
A code position examination completes → If the tracer position is within bounds (less than or equal to 200), continue processing; otherwise, move to the next segment
[Code Position Empty?]
The position contains only spaces (empty) → The process switch is set to 'Y' to indicate completion of the current segment processing
[Get SCAC Code from Position]
The system needs to access the specific carrier code → The carrier code from the current tracer position is moved to the table root key value for individual record retrieval
[Retrieve Individual Carrier Record]
The system needs to access the full carrier record details → The table segment retrieval service is called to get the individual carrier record using the extracted code
[Move to Next Code Position]
The system needs to continue searching within the segment → The tracer position is incremented by 1 to examine the next code position
[Move to Next Segment]
The system needs to continue searching in additional segments → The segment number counter is incremented by 1 to process the next segment
[Retrieve Table Segment for Code]
The system attempts to retrieve the corresponding table segment → The system calls the table retrieval function to get the segment data for the specified code
[Determine Port Code Type]
The system needs to determine the correct SCAC code type for comparison → The system checks if the first character of the port code is 'C' to determine if it's a Canadian port code
[Get CCRA Code for Comparison]
The system needs to select the appropriate SCAC code for comparison → The system moves the CCRA code from the table segment to the comparison code field
[Get USCS Code for Comparison]
The system needs to select the appropriate SCAC code for comparison → The system moves the USCS code from the table segment to the comparison code field
[Extract Code from Table Position]
The system attempts to extract a code from the calculated position → The code at that position is returned for further processing
[Move to Next Position in Segment]
The system needs to continue searching within the same segment → DISPL-WITHIN-SEG counter is incremented by 1 to move to next position
[End of Current Segment?]
The counter value is compared against the segment maximum limit → If counter exceeds segment maximum, segment end is detected; otherwise continue within segment
[Move to Next Segment]
Search needs to continue in additional segments → SEG-NO is incremented by 1 to move to the next segment
[Reset Position Counter to 1]
Position tracking needs to start from beginning of new segment → DISPL-WITHIN-SEG is reset to 1 to start at first position of new segment
[Set Database Access Parameters]
Database access parameters need to be configured → Set second PCB flag to space, unqualified SSA flag to space, and user function code to GU (Get Unique)
[Specify Root Segment Name]
Root segment name needs to be specified for table access → Set the working storage segment name to root segment name
[Set Table ID and Code Value]
Table identification needs to be set for segment retrieval → Set table root key ID to the specified table ID and table root key value to the entered code
[Call GCCTBIO Database Program]
Table segment data needs to be retrieved from database → Call GCCTBIO program with communication area, PCB flags, function code, segment name, table root key, dependent key, table segment, and return flag parameters
[Load Table Segment Data]
Table segment data is available from database → Make the retrieved table segment data available for processing operations
[Return Success Status]
Retrieval operation is complete → Return success status to indicate successful table segment retrieval
[User Has Display-Only Permission for Table?]
The requested function is ADD, MOD, or DEL → The system sets error flag to NOT-VALID AND sets error message to ALLOWED-DISPLAY-ONLY AND highlights the function field
[Increment Position Within Segment]
Continuing search within the same segment → DISPL-WITHIN-SEG is incremented by 1
[Position > Segment Maximum?]
DISPL-WITHIN-SEG exceeds the segment maximum limit → Position is reset to 1 and segment number is incremented to move to next segment
[Set Edit Flag to Valid]
The system prepares to validate entry fields → The edit flag is set to valid state to begin validation process
[Perform Field Entry Validation]
The system performs entry field validation → Field validation routine is executed to check entered codes and function validity
[Set Return Flag to Valid]
The edit flag equals space → Return flag is set to valid indicating successful validation for display operation
[Perform Request Code Validation]
The system performs request code validation → Request code validation routine is executed to verify table-specific permissions and constraints
[Set Return Flag to Invalid]
Table ID is user security table AND user ID equals current user code → Return flag is set to invalid and input message is copied to output message to prevent self-modification
[Map MS Table - Message Number]
System processes input field mapping → Message Number field value is mapped to ENTERED-CODE for further processing
[Move to Next Entry in Segment]
More entries exist in the current segment → Displacement within segment counter is incremented by 1 to move to next entry
[End of Current Segment?]
Displacement within segment exceeds the maximum entries for current segment → Displacement is reset to 1 and segment number is incremented by 1
[Check GCSTBRT-US-ADMINISTRATION]
The user attempts to perform ADD, MOD, or DEL function on Administration table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-MAN-UPON-STN-RANGE]
The user attempts to perform ADD, MOD, or DEL function on Destination Range table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-MANIFEST-STATION]
The user attempts to perform ADD, MOD, or DEL function on Manifest Station table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-MESSAGE]
The user attempts to perform ADD, MOD, or DEL function on Message table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-STATION-ENTRY]
The user attempts to perform ADD, MOD, or DEL function on Station Entry table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-STATION-SELECTION]
The user attempts to perform ADD, MOD, or DEL function on Station Selection table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-USER-SECURITY]
The user attempts to perform ADD, MOD, or DEL function on User Security table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-AUTOMOTIVE]
The user attempts to perform ADD, MOD, or DEL function on Automotive table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-AMENDMENT]
The user attempts to perform ADD, MOD, or DEL function on Amendment table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-BROKER]
The user attempts to perform ADD, MOD, or DEL function on Broker table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-CARRIER]
The user attempts to perform ADD, MOD, or DEL function on Carrier table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-COUNTRY-CODE]
The user attempts to perform ADD, MOD, or DEL function on Country Code table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-BONDED-SIDINGS]
The user attempts to perform ADD, MOD, or DEL function on Bonded Sidings table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-SCHEDULE-D]
The user attempts to perform ADD, MOD, or DEL function on Schedule D table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-SCHEDULE-K]
The user attempts to perform ADD, MOD, or DEL function on Schedule K table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-MANIFEST-UNIT]
The user attempts to perform ADD, MOD, or DEL function on Manifest Unit table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-DISPOSITION-CODE]
The user attempts to perform ADD, MOD, or DEL function on Disposition Code table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-SCAC-CODE]
The user attempts to perform ADD, MOD, or DEL function on SCAC Code table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-CAR-ID]
The user attempts to perform ADD, MOD, or DEL function on Car ID table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-CAR-KIND]
The user attempts to perform ADD, MOD, or DEL function on Vehicle Type table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-SK-BY-PORT]
The user attempts to perform ADD, MOD, or DEL function on Schedule K by Port table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Check GCSTBRT-US-DS-BY-PORT]
The user attempts to perform ADD, MOD, or DEL function on Schedule D by Port table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Set EDIT-FLAG to SPACE - Allow display mode]
The entered code is blank and the function code is blank → The system sets the edit flag to allow display mode and positions the pointer to the start of the table
[Retrieve Carrier Table Root Segment]
The system retrieves the carrier table root segment → Table segment retrieval is performed using the established parameters
[Root Segment Retrieved Successfully?]
The carrier table root segment retrieval is unsuccessful → SCAC code validation is marked as not found and process terminates
[Get Segment Count from Root]
The system processes the root segment information → Segment count is extracted from the carrier table root and assigned to processing variables
[Retrieve Table Dependent Segment]
The system retrieves a carrier table dependent segment → Dependent segment is accessed using current segment counter value and table root key
[Dependent Segment Retrieved?]
The dependent segment retrieval is unsuccessful → Segment counter is incremented to attempt next segment
[Retrieve Carrier Root by Code]
The system retrieves carrier root information by code → Table segment retrieval is performed using the extracted carrier code as key
[Get CCRA Code for Canadian Ports]
The system processes Canadian port validation → CCRA code is extracted from carrier table root segment for comparison
[Get USCS Code for US Ports]
The system processes US port validation → USCS code is extracted from carrier table root segment for comparison
[Increment Code Tracer]
The system continues searching within current segment → Code tracer is incremented by 1 to examine next carrier code entry
[More Codes in Segment?]
The system checks for more entries in current segment → If tracer is 200 or less, continue examining entries; if tracer exceeds 200, move to next segment
[Increment Segment Counter]
The system advances segment processing → Segment counter is incremented by 1 to access next dependent segment
[More Segments to Process?]
The system checks segment availability → If segment counter is less than or equal to total segment count, retrieve next segment; otherwise, validation fails
[SCAC Code Validation Complete - Not Found]
The validation process completes → Found flag remains 'N' and validation process terminates with failure status
[Set Table ID: MC - Manifest Station]
The system processes the Canadian port code → The system extracts characters 2-4 as numeric portion, assigns MC (Manifest Station) table for validation, and retrieves MC segment count for cross-reference validation
[Set Table ID: SD - Schedule D]
The system processes the US port code → The system assigns SD (Schedule D) table for validation and retrieves SD segment count for cross-reference validation
[Begin Segment Search Loop]
Executing the search loop for any table type (AD, DR, LT, MC, MS, SC, SE, US, AU, AC, BK, CC, CT, RF, SD, SK, MU, DC, SS, ID, VI, KS, DS, S1, ST) → The corresponding table-specific matching routine is performed until match is found or start position is found or table pointer exceeds end pointer
[Current Code = Target Code?]
The table key equals the table code at current segment and displacement position → Match found flag is set to valid indicating exact match was located
[Move to Next Position in Segment]
No match found and no insertion point identified at current position → Displacement within segment counter is incremented by 1
[End of Current Segment?]
Displacement within segment exceeds the segment maximum for the table type → System recognizes end of current segment has been reached
[Move to Next Segment]
More segments are available for searching → Segment number is incremented by 1 and displacement within segment is reset to 1
[Search Complete - No Match]
No match found and no insertion point found and table pointer exceeds end pointer → Search operation terminates with no match found status
[Display-Only Permission?]
The user has display-only permission and attempts to perform ADD, MOD, or DEL function → The system should reject the operation with an 'allowed display only' error message and highlight the function field
[Retrieve CC Table Root Segment]
The system calls the table I/O service to retrieve the root segment → The table I/O service is invoked with carrier table parameters and returns success or failure status
[Get CC Segment Count]
The system processes the root segment data → The segment count from the table root is moved to the working segment number variable
[More Segments to Process?]
If continuation criteria → Processing continues if counter is less than or equal to total segments, otherwise validation concludes as not found
[Retrieve Next CC Table Segment]
The system requests the next table segment → The table I/O service is called with the current segment counter as the dependent key
[Get CC Table Code from Segment]
The system processes the segment content → The carrier code from the segment is moved to the table root key value for subsequent lookup
[Retrieve CC Root Segment for Code]
The system requests the carrier root segment for that code → The table I/O service is called to retrieve the root segment with the specific carrier code
[Port Code Type?]
If the port code type → If port code starts with 'C', Canadian CCRA code is extracted; otherwise, US USCS code is extracted
[Increment Segment Counter]
The system continues processing → The tracer counter is incremented by 1 to move to the next segment
[Set Process Complete Flag]
The system determines processing should end → The process switch is set to 'Y' to indicate completion
[Return SCAC Not Found Result]
The validation process completes → The system returns with found flag indicating unsuccessful SCAC validation
[Reset Segment Number to Zero]
The system continues initialization process → The segment number is reset to zero to prepare for segment counting
[Set Segment Counter to 1]
The system continues initialization → The segment counter is set to 1 to begin processing from the first table segment
[Set Table ID to 'CC' for Carrier Table]
The system specifies the target table for lookup → The table ID is set to 'CC' to identify the carrier table for SCAC validation
[Call GCCTBIO to Retrieve Root Segment]
The system calls the database access module → GCCTBIO is invoked to retrieve the carrier table root segment using the specified search parameters
[Root Segment Retrieved Successfully?]
The database access operation completes → If return flag indicates successful retrieval, processing continues to extract segment information, otherwise error handling is initiated
[Extract Segment Count from Root]
The system processes the root segment data → The segment count is extracted from the root segment and stored for controlling subsequent dependent segment searches
[Set Baseline for Dependent Searches]
The system prepares for dependent segment processing → The segment count is assigned to control variables for iterating through all available carrier table segments during SCAC validation
[Set Table ID to CC]
The system needs to access carrier table segments → The table identifier is set to 'CC' and segment counter is initialized to 1
[Call GCCTBIO to Retrieve Segment]
The system calls the database interface to retrieve segment data → The segment data is retrieved and return status indicates success or failure
[Move Segment Data to Working Storage]
The segment data is available for processing → The segment data is moved to working storage, segment count is captured, and processing variables are initialized
[Start Code Checking Process]
SCAC code validation process begins → Processing switch is set to continue, tracer position is set to 1, and validation loop is initiated
[More Codes in Segment?]
The system checks if more codes exist in the segment → If dependent data at tracer position is spaces, processing stops; otherwise, continue with next code
[Retrieve Individual CC Record]
The system needs to validate the SCAC code against this carrier record → The carrier code is used as key to retrieve the individual carrier record from the database
[Move to Next Code Position]
The system needs to continue validation with next available code → Tracer position is incremented by 1 to point to next code in segment
[Reached Segment Limit?]
The tracer position reaches the maximum limit of 200 codes → Processing is terminated to prevent infinite loops
[Continue to Next Segment]
More carrier segments are available for processing → Segment counter is incremented and processing continues with next segment
[Extract Carrier Code from Segment]
The system processes the segment entry → The carrier code is extracted and moved to the table root key value for lookup
[Retrieve CC Table Entry for Code]
The system performs a table lookup using the carrier code → The system attempts to retrieve the corresponding carrier record from the CC table
[Move to Next Segment Entry]
The system needs to continue searching → Increments the tracer to move to the next segment entry position
[Complete Processing - Code Not Found]
No matching carrier code was found during the search → Completes processing with found flag remaining 'N' indicating unsuccessful validation
[Set Table ID to 'MC']
The system prepares to validate against the Manifest Station table → The table root key ID should be set to 'MC' and the system should retrieve the MC table root segment
[Get MC Segment Count]
The system needs to determine how many dependent segments to process → The system should extract the MC segment count from the root segment data
[Segment Counter <= MC Segment Count?]
The system processes dependent segments sequentially → The system should continue processing while the segment counter is less than or equal to the total segment count, otherwise stop processing
[Set MC Table Root Key ID]
The system prepares to retrieve MC table dependent segments → The table root key ID is set to MC and segment counter is initialized to 1
[Call GCCTBIO to Retrieve Table Segment]
The system calls GCCTBIO to retrieve the table segment → The table segment data is retrieved and return status indicates success or failure
[Retrieval Successful?]
The retrieval return status is evaluated → If successful, process the segment data; if unsuccessful, increment segment counter and continue
[Move Table Segment to Dependent Data]
The segment data needs to be processed for port code validation → The table segment is moved to dependent data structure and processing flags are initialized
[Retrieve Port Code Table Segment]
The system moves the table code to root key value and calls GCCTBIO → The corresponding port code table segment is retrieved for customs code comparison
[Port Code Retrieval Successful?]
The retrieval return status is evaluated → If successful, proceed with customs code comparison; if unsuccessful, increment tracer and continue loop
[Code Found?]
The code found flag is evaluated → If code was found, set segment counter to exit loop; if not found, increment segment counter to process next segment
[Retrieve MC Table Segment Using Code]
The system attempts to retrieve the MC table segment using the table code → The system either successfully retrieves the segment for port code comparison OR moves to the next entry if retrieval fails
[Retrieve SD Table Segment]
The system attempts to retrieve table segment data → The table segment count is obtained and used to determine the number of segments to search for port code validation
[Compare Input Port Code with SD Port Code]
The system compares the input port code with each SD table port code entry → If a match is found, the validation flag is set to successful, otherwise the search continues to the next entry
[Port Code Validation Successful / Port Code Not Found in SD Table]
The search process reaches completion → If the port code was found in any segment, validation is successful; if not found after searching all segments, the port code is considered invalid
[Reset Segment Number to Zero]
The system prepares segment tracking variables → The segment number is reset to zero
[Set Segment Counter to 1]
The system prepares for sequential segment processing → The segment counter is set to 1 to start from the first segment
[Retrieve Table Segment Count]
The system needs to determine search scope → The system should retrieve the segment count from the table root to establish search boundaries
[Set Segment Counter to 1]
The system prepares to search through table segments → The system should set the segment counter to 1 to start from the first segment
[Retrieve Table Dependent Segment]
The system needs to access a specific table segment → The system should retrieve the dependent segment data using the current segment counter
[Search Port Code in Current Segment]
The system searches for the port code within the segment → The system should compare the port code against entries in the current segment based on table type (MC or SD)
[Port Code Found?]
The port code comparison is performed → The system should determine if a matching port code exists in the current segment
[Set Found Flag to Yes]
The match is confirmed → The system should set the found flag to 'Y' to indicate successful validation
[Increment Segment Counter]
The system needs to continue searching → The system should increment the segment counter to move to the next segment
[More Segments to Search?]
If search continuation → The system should check if the segment counter is within the total segment count to determine if more segments exist
[Highlight Port Code Field]
The system prepares user interface feedback → The system should highlight the port code field with cursor highlighting attribute and set edit flag to invalid
[Display Function Processing]
The function is blank or display and a valid insertion point is found in the table → The system should display a continuation message indicating where the code would be inserted
[Valid Insertion Point Found?]
The system searches through table segments and finds a position where the entered code would be alphabetically positioned between existing codes → The system identifies this as a valid insertion point and sets the start position found flag to valid
[Set Display Continue Message]
The system processes the display request → The system sets a display continuation message and highlights the entered code field to show the valid position
[Return Valid Status]
The system successfully retrieves the table segment containing the code → The system returns a valid status to allow display of the existing table data
[Retrieve Carrier Table Root Segment]
The system attempts to retrieve the carrier table root segment → The table I/O service is called to get the root segment information
[Get Carrier Segment Count]
The system needs to determine how many segments to process → The carrier segment count is extracted from the root segment and stored for iteration control
[Retrieve Dependent Table Segment]
The system attempts to get the dependent table segment → The table I/O service is called with the segment number to retrieve the specific dependent segment
[Retrieve Carrier Root for Code]
The system needs to get detailed carrier information → The table I/O service is called to retrieve the root segment for the specific carrier code
[Extract Canadian CCRA Code]
The system needs to get the carrier code for comparison → The Canadian CCRA code is extracted from the carrier root segment
[Extract US USCS Code]
The system needs to get the carrier code for comparison → The US USCS code is extracted from the carrier root segment
[Increment Segment Counter]
The system needs to process the next segment → The segment number counter is incremented by 1
[More Segments to Process?]
The system checks if more segments exist → If segment counter is less than or equal to total segment count, the next segment is retrieved; otherwise, SCAC code is marked as not found
[Retrieve Root Carrier Segment]
The system attempts to retrieve the carrier root segment → A table I/O operation is performed to get the root segment using the carrier table identifier
[Get Segment Count from Root]
The system needs to determine how many dependent segments to process → The segment count from the root segment is extracted and stored for iteration control
[Retrieve Dependent Carrier Segment]
The system attempts to access the specific carrier dependent segment → A table I/O operation is performed using the segment counter as the dependency key to retrieve the target segment
[Extract Carrier Code from Segment]
The system needs to extract the relevant carrier code for comparison → If port code starts with 'C' then CCRA code is extracted for Canadian ports, otherwise USCS code is extracted for US ports
[Move to Next Segment Entry]
The system needs to continue searching within the current segment → The entry tracer is incremented to move to the next entry position within the current segment
[Reached Maximum Entries?]
The system checks if the entry limit has been reached → If the tracer exceeds 200 entries then processing of the current segment is terminated, otherwise processing continues with the next entry
[More Segments to Process?]
The system checks if more segments are available for processing → If the segment counter is less than or equal to the total segment count then processing continues with the next segment, otherwise the search is terminated as unsuccessful
[Check if Segment Entry is Empty]
The segment entry contains only spaces → The system marks processing as complete and stops further processing
[Extract Carrier Code from Segment Entry]
The segment entry is not empty → The system extracts the carrier code from the segment entry and prepares it for table lookup
[Retrieve Carrier Table Record]
The system needs to validate the carrier code → The system retrieves the corresponding carrier record from the carrier table
[Move to Next Segment Entry]
The system needs to continue validation with remaining entries → The system increments the tracer counter and prepares to process the next segment entry
[More Entries to Process?]
The tracer counter exceeds 200 entries or no more entries exist → The system stops processing and marks validation as complete
[Extract Carrier Code from Segment Entry]
The system processes the segment entry → The system moves the dependent carrier table code to the table root key value for further processing
[Retrieve Carrier Table Segment]
The system performs a table segment retrieval operation → The system attempts to retrieve the corresponding carrier table segment for validation
[Carrier Segment Retrieved Successfully?]
The retrieval operation fails (return flag is not successful) → The system increments the tracer to move to the next segment entry and stops processing if maximum entries reached
[Port Code Type?]
The system checks the first character of the port code → The system selects Canadian CCRA code if port code starts with 'C', otherwise selects US USCS code
[Extract Canadian CCRA Code]
The system processes the carrier information → The system moves the CCRA code from the carrier table segment to the comparison variable
[Extract US USCS Code]
The system processes the carrier information → The system moves the USCS code from the carrier table segment to the comparison variable
[Move to Next Segment Entry]
The system needs to continue processing → The system increments the tracer counter to move to the next segment entry
[Complete Processing - Code Not Found]
The system completes the validation process → The system exits the processing loop with unsuccessful validation status
[More Segments to Search?]
If continuation of search process → If segment counter is less than or equal to total segment count then continue to next segment, otherwise terminate search as not found
[Retrieve MC Table Segment Count]
The system retrieves the MC table root segment → Extract the segment count from GCSTBRT-MC-SEG-COUNT to determine processing scope
[Retrieve SD Table Segment Count]
The system retrieves the SD table root segment → Extract the segment count from GCSTBRT-SD-SEG-COUNT to determine processing scope
[Check if Current Segment Entry is Empty]
The current dependent data entry at the tracer position contains only spaces → The system sets the process completion flag and stops searching
[Retrieve Table Segment for Code]
The system needs to access the table segment for port code validation → The system calls the table retrieval service to get the segment data
[Table Type Check]
The system needs to compare port codes → If table type is Schedule D, compare with SD port code; if Manifest Station table, compare with Canadian customs code
[Retrieve Port Code Entry from Table]
The system calls the table I/O service to retrieve the port code segment → The system receives the port code entry data and a return status indicating success or failure
[Start Port Code Extraction]
The system begins port code extraction process → Process tracking variables are initialized to starting values and segment counter is set to 1
[Extract Table Code from Current Position]
The system extracts table code from dependent data at tracer position → The table code is moved to the root key value for subsequent table segment retrieval
[Retrieve Table Segment for Code]
The system calls table retrieval service with the extracted code → If retrieval is successful, proceed with port code comparison, otherwise increment tracer and continue
[Extract US Port Code from SD Table]
The system extracts port code from SD table segment → If extracted port code matches input port code, set found flag and mark process complete, otherwise increment tracer position
[Extract Canadian Port Code from MC Table]
The system extracts Canadian customs code from MC table segment → If extracted code matches converted port code, set found flag and mark process complete, otherwise increment tracer position
[Set Database Access Parameters]
The system prepares database access parameters → The second PCB flag is set to space and unqualified SSA flag is set to space
[Set Function Code to GU - Get Unique]
The system configures the database operation type → The user function code is set to GU (Get Unique)
[Set Segment Name to Root Segment]
The system sets the target segment for data retrieval → The working storage segment name is set to root segment name
[Set Table ID from Business Context]
The system configures the table identifier for database access → The working storage table root key ID is set to the current table ID from business context
[Call GCCTBIO Database Access Program]
The system needs to retrieve table segment data → The GCCTBIO program is called with communication area, PCB flags, function code, segment name, table key, dependent key, table segment buffer, and return flag parameters
[Set Database Access Parameters - Configure IMS database call parameters for table segment retrieval]
The system prepares to retrieve table segment data → Database access flags are cleared, function code is set to retrieve operation, segment name is configured as root segment, table identifier is set in key structure, entry code value is placed in key structure, and dependent key is initialized to zeros
[Call IMS Database Service GCCTBIO]
The system needs to retrieve table segment data → The GCCTBIO database service is called with communication area, database flags, function code, segment name, table key, dependent key, table segment buffer, and return status
[Set Database Access Parameters]
The system sets up database access parameters → The second PCB flag is set to space, unqualified SSA flag is set to space, and user function code is set to GU (Get Unique)
[Prepare Segment Name]
The system prepares the segment name for database access → The working storage segment name is set to the root segment name
[Prepare Table Root Key]
The system prepares the table root key → The table root key ID is set to the working storage table ID and the table root key value is set to the entered code
[Prepare Table Root Key]
The system initializes database keys → The working storage dependent key is set to zeros
[Call GCCTBIO Database Program]
The system calls the GCCTBIO database access program → The GCCTBIO program is invoked with all prepared parameters and returns a status flag indicating success or failure
[Compare Key with Current Segment Code]
The system compares the key with the segment code → The comparison determines if there is an exact match, if the key is less than the segment code, or if neither condition applies
[Set Match Found Flag to VALID]
The exact match condition is detected → The match found flag is set to VALID to indicate successful record location
[Set Start Position Found Flag to VALID]
The insertion point condition is detected → The start position found flag is set to VALID to indicate the correct position for new record insertion
[Increment Displacement Within Segment]
The system needs to continue searching within the segment → The displacement within segment counter is incremented by 1
[Reset Displacement to 1]
The current segment has been fully traversed → The displacement is reset to 1 and the segment number is incremented by 1
[Match Found OR Start Position Found OR End of Table?]
Checking whether to continue or terminate the search → The search stops if match is found OR start position is found OR table pointer exceeds end pointer, otherwise search continues
[Return Match Status and Position]
The search termination conditions are met → The system returns the match found status, start position found status, and current table pointer position

Structural Validations

[1:Field Entry Validation]
Entry code is blank and function is not blank → System sets error flag, highlights entry field, and displays blank code error message
[2:Function Code Validation]
Function code is not blank, ADD, MOD, DEL, or EXPAND → System sets error flag, highlights function field, and displays invalid function error message
[4:Administration Table Validation]
Admin ID != 'ADMINID' → System sets error flag, highlights Admin ID field, and displays invalid Admin ID message
[5:Destination Range Table Validation]
Destination ID equals error character → System sets error flag, highlights Destination ID field, and displays invalid Destination ID message
[6:Terminal Table Validation]
Terminal ID equals error character → System sets error flag, highlights Terminal ID field, and displays invalid Terminal ID message
[7:Manifest Station Table Validation]
Manifest ID equals error character → System sets error flag, highlights Manifest ID field, and displays invalid Manifest ID message
[8:Message Table Validation]
Message Number equals error character → System sets error flag, highlights Message Number field, and displays invalid Message ID message
[10:Station Selection Table Validation]
Station ID equals error character → System sets error flag, highlights Station ID field, and displays invalid Station ID message
[11:User Security Table Validation]
User Code equals error character → System sets error flag, highlights User Code field, and displays invalid User ID message
[12:Automotive Table Validation]
Auto ID equals error character → System sets error flag, highlights Auto ID field, and displays invalid Auto key message
[13:Amendment Table Validation]
Amendment Code is blank or Country Code is blank → System sets error flag, highlights appropriate fields, and displays invalid Amendment key message
[14:Broker Table Validation]
Broker Name is blank or starts with blank, or Port Code format is invalid (first character not C or 0-9, or positions 2-4 not numeric) → System sets error flag, highlights Broker Name and Port Code fields, and displays invalid Broker key message
[15:Carrier Table Validation]
Carrier SCAC Key is blank or starts with blank → System sets error flag, highlights Carrier SCAC field, and displays invalid Carrier key message
[16:Country Code Table Validation]
Country Name is blank or starts with blank → System sets error flag, highlights Country Name field, and displays invalid Country key message
[17:Bonded Sidings Table Validation]
Last 6 characters of Sequence Number are not numeric → System sets error flag, highlights Sequence Number field, and displays invalid Bonded Sidings key message
[18:Schedule D Table Validation]
US Port Name is blank or starts with blank → System sets error flag, highlights US Port Name field, and displays invalid Schedule D key message
[19:Schedule K Table Validation]
Foreign Port Name is blank or starts with blank → System sets error flag, highlights Foreign Port Name field, and displays invalid Schedule K key message
[20:Manifest Unit Table Validation]
Manifest Unit is blank or starts with blank → System sets error flag, highlights Manifest Unit field, and displays invalid Manifest Unit key message
[21:Disposition Code Table Validation]
Disposition Code is blank or starts with blank → System sets error flag, highlights Disposition Code field, and displays invalid Disposition Code key message
[22:SCAC Code Table Validation]
SCAC code is not found in Carrier table → System sets error flag, highlights SCAC field, and displays invalid SCAC data message
[22:SCAC Code Table Validation]
Port Code starting with 'C' is not found in Manifest Station table or numeric Port Code is not found in Schedule D table → System sets error flag, highlights Port field, and displays appropriate invalid port message
[22:SCAC Code Table Validation]
Combined SCAC and Port key is blank → System sets error flag, highlights SCAC and Port fields, and displays invalid SCAC key message
[24:Vehicle Type Table Validation]
Car Type is blank or error character → System sets error flag, highlights Car Type field, and displays invalid Vehicle Type key message
[25:Schedule K by Port Validation]
KS Code is blank or error character → System sets error flag, highlights KS Code field, and displays invalid KS key message
[26:Schedule D by Port Validation]
DS Code is blank or error character → System sets error flag, highlights DS Code field, and displays invalid DS key message
[27:CN0003 Disposition Code Validation]
Country Code is not 'CA' or 'US' → System sets error flag and displays invalid Status Code key message
[27:CN0003 Disposition Code Validation]
Country is blank or error character, or Status Code is blank or error character → System sets error flag, highlights appropriate fields, and displays invalid Status Code key message
[28:CN0004 Status Code Validation]
Code is blank or error character, or Qualifier is blank or error character, or Qualifier != 'ST' → System sets error flag, highlights appropriate fields, and displays invalid Status key message
[Set Field Error Highlighting]
System validates field entry → Field error highlighting is set and blank code error message is assigned
[Set blank code error and NOT-VALID flag]
Function field contains a specific operation (not blank) → System sets validation error flag, displays blank code error message, and highlights the code input field
[Set invalid function error and NOT-VALID flag]
Function field contains a value other than ADD, MOD, DEL, EXPAND, or blank → System sets validation error flag, highlights function field, and displays invalid function error message
[Destination ID Valid?]
The destination ID field contains error character → The system sets validation error, highlights the destination field, and displays invalid destination ID message
[Terminal ID is Error Character?]
The Terminal ID field contains an error character → The system should set validation error flag, highlight the Terminal ID field, and display invalid Terminal ID message
[Validate Manifest ID Field]
The manifest ID field contains an error character → The system should set validation error flag, highlight the manifest ID field, and display invalid manifest ID message
[Message Number Valid?]
The message number field contains error character or invalid data → The system should set validation error flag, highlight the message number field, and display invalid message ID error
[Train ID is Valid 6-digit Numeric?]
The system validates the Train ID format using right-justify zero-fill to 6 digits → If the Train ID is not valid numeric format, the system should set validation error flag AND highlight the Train ID field AND display invalid Train ID message
[Station ID Valid?]
The Station ID field contains an error character → The system should set validation error flag, highlight the Station ID field, and display invalid station ID message if no other system message exists
[User Code is Empty?]
The user code field is empty or contains error character → The system should set validation error flag, highlight the user code field, and display invalid user ID message if no other system message exists
[Validate Auto ID Field]
The Auto ID field contains an error character or is invalid → The system should set the edit flag to invalid, highlight the Auto ID field, and display an invalid auto key message if no other system message exists
[Set Error: Invalid AC Key]
No other system message has been set → The system sets 'Invalid AC Key' error message
[Validate Broker Name]
The broker name field is empty or the first character of broker name is a space → The system sets validation error flag, highlights the broker name field, and displays invalid broker key error message
[Validate Port Code Format]
The port code second character is not numeric or the port code third character is not numeric or the port code fourth character is not numeric or the port code first character is not 'C' and not '0' and not '1' and not '2' and not '3' and not '4' and not '5' and not '6' and not '7' and not '8' and not '9' → The system sets validation error flag, highlights both broker name and port code fields, and displays invalid broker key error message
[Check Broker Name Field]
The system validates the broker name field → The broker name must not be empty, not be spaces, and the first character must not be a space, otherwise set error highlighting and invalid edit flag
[Check Broker Name Field]
The system validates the port code field → The port code positions 2-4 must be numeric and position 1 must be 'C' or digits 0-9, otherwise set error character, highlighting and invalid edit flag
[Set Broker Name Error Message]
The system message number is currently blank → Set the system message number to invalid broker key message number
[Set Port Code Format Error]
The port code does not meet format requirements → The system sets edit flag to invalid, highlights the broker name and port code fields, and sets the invalid broker key message
[Check SCAC Key Not Empty]
The carrier SCAC key is blank or empty → The system sets validation error flag and displays invalid carrier key message
[Check First Character Not Space]
The first character of carrier SCAC key is a space → The system sets validation error flag and displays invalid carrier key message
[Country Name is Empty or Invalid?]
The country name field is blank:
the first character of country name is blank
→ The system sets validation error flag, highlights the country name field, and displays invalid country name message
[Validate Sequence Number Format]
The sequence number field positions 9 through 14 are not numeric → The system sets edit flag to invalid, highlights the sequence number field, and displays invalid RF key message
[US Port Name Valid?]
The US Port Name field is blank:
the first character of US Port Name is blank
→ The system should set validation error flag, highlight the US Port Name field, and set invalid SD key message if no other system message exists
[Foreign Port Name Valid?]
The foreign port name field is empty or the first character is a space → The system sets validation error, highlights the foreign port name field, and displays invalid SK key message
[Manifest Unit Field Empty?]
The manifest unit field is empty or contains only spaces → The system sets validation error flag, highlights the manifest unit field, and displays invalid manifest unit key message
[Validate Unit Field Content]
The manifest unit field is empty, contains only spaces, or the first character is a space → The system sets validation error flag, highlights the manifest unit field, and displays invalid manifest unit key message
[Validate Disposition Code Field]
The disposition code field is empty:
the first character of disposition code is empty
→ The system should set validation error flag, highlight the disposition code field, and set invalid disposition code message
[Validate SCAC Code Against CC Table - Cross-reference SCAC with Carrier table entries]
The system performs SCAC code validation by searching through all Carrier Code table segments → The SCAC code is marked as valid if found in the table, otherwise marked as invalid
[Compare with CCRA Code for Canadian Ports and Compare with USCS Code for US Ports]
The system compares the input SCAC code against the carrier code from the table segment → If the codes match exactly, the found flag is set to Yes and validation succeeds, otherwise continue searching remaining segments
[SCAC Code Valid - Continue Processing and SCAC Code Invalid - Set Error]
The validation process concludes → If the found flag is Yes then the SCAC code is valid and processing continues, otherwise the SCAC code is invalid and an error is set
[Reached Segment Limit?]
The tracer position exceeds 200 positions → The system marks the process as complete to prevent further iteration
[Extract SCAC Code Component]
The system performs SCAC code validation → The SCAC code must exist in the Carrier (CC) table, otherwise set validation error with invalid SCAC data message and highlight SCAC field
[Extract Port Code Component]
The system validates the port code against reference tables → The port code must exist in the Manifest Station (MC) table, otherwise set validation error with invalid port data message and highlight port field
[Extract Port Code Component]
The system validates the port code against reference tables → The port code must exist in the Schedule D (SD) table, otherwise set validation error with invalid port data message and highlight port field
[Set SCAC Code in ENTERED-CODE-SCAC]
The system validates the composite SCAC-Port key → The composite key (SCAC + Port) must not be blank, otherwise set validation error with invalid SS key message and highlight both SCAC and port fields
[SCAC Code Empty?]
The SCAC code field is empty or contains only spaces → The system should reject the operation with invalid SS key error message and highlight the SCAC field
[SCAC Code Empty?]
The port code field is empty or contains only spaces → The system should reject the operation with invalid SS key error message and highlight the port field
[SCAC Code Structure Valid?]
The SCAC code does not exist in the carrier table → The system should reject the operation with invalid SS data error message and highlight the SCAC field
[Check SCAC Length Requirements]
The port code does not exist in the manifest station table → The system should reject the operation with invalid SS data error message for Canadian port and highlight the port field
[Length Within Limits?]
The port code does not exist in the schedule D table → The system should reject the operation with invalid SS data error message for US port and highlight the port field
[Is Port Code Empty?]
The port code field is empty, contains only spaces, or contains low/high values → The system should mark the port code as invalid, set error highlighting, and prepare error message
[First Character Valid?]
The first character of the port code is not 'C' and not a digit between '0' and '9' → The system should mark the port code as invalid, set error highlighting, and prepare error message
[Characters 2-4 Numeric?]
Any of the characters in positions 2, 3, or 4 of the port code are not numeric → The system should mark the port code as invalid, set error highlighting, and prepare error message
[Is Port Code Empty?]
The broker name field is empty, contains only spaces, or the first character is a space → The system should mark the broker name as invalid, set error highlighting, and prepare error message
[Set Error Message]
No other system message has been set → The system should set the invalid broker key message number for display to user
[Code Position Empty?]
If whether the position contains data → If the position is empty (spaces), move to the next segment; otherwise, proceed with code validation
[Compare with MC Canadian Customs Code]
The system retrieves a carrier code from the dependent segment → The system should retrieve the corresponding MC table entry and compare the converted port code with the Canadian customs code from the MC table entry
[Compare with SD Port Code]
The system processes a port code entry from the dependent segment → The system should compare the input port code directly with the port code from the SD table entry
[Check if Current Entry is Empty]
The system checks the entry content → If the entry is empty (spaces), the search is completed with no match found
[Check Port Code Match -> Port Code Matches?]
The converted port code is compared against the Canadian customs code in the segment → The system should set found flag to 'Y' if port codes match, otherwise continue to next segment
[Check Port Code Match -> Port Code Matches?]
The port code is compared against the port code in the Schedule D segment → The system should set found flag to 'Y' if port codes match, otherwise continue to next segment
[Port Code Not Found Error]
No matching port code is found → The system should maintain found flag as 'N' and complete validation with failure status
[Compare with Schedule D Port Code]
The system compares the input port code with the Schedule D port code → The system determines if the port code exists in the Schedule D table
[Compare with Manifest Station Canadian Customs Code]
The system compares the converted port code with the Canadian customs code → The system determines if the port code exists in the Manifest Station table
[Port Code Found in Table?]
The system searches through all segments of the selected port registry table → If the port code matches an entry in the registry, the system marks it as valid, otherwise it sets a port code validation error
[Table Retrieved Successfully?]
The table retrieval operation completes → If the retrieval is successful, proceed with segment processing; otherwise, set port code validation error
[Segment Retrieved Successfully?]
The segment retrieval operation completes → If successful, proceed with code search in the segment; otherwise, increment to next segment
[Search Segment for Matching Code]
The system searches for the extracted Canadian port code digits → The system compares the port code digits against the Canadian customs codes in the segment
[Set Port Code Error]
No matching manifest station code is found after searching all segments → The system sets a port code validation error
[Set Error Message - Invalid Canadian Port]
The system needs to provide user feedback → The system sets an error message indicating the Canadian port code is invalid
[Car ID is Empty or Error?]
The Car ID field is empty or contains error characters → The system should set the Car ID field to error character, mark the validation as invalid, highlight the field, and display invalid Car ID error message
[Validate Car Type Field]
The car type field is empty or contains error characters → The system should set the car type field to error character, mark validation as invalid, highlight the car type field, and set invalid car type message if no other system message exists
[Validate KS Code Field]
The KS code field is empty or contains error characters → The system sets field error, highlights the KS code field, and displays invalid KS key message
[DS Code is Empty or Error?]
The DS Code field is empty or contains error character → The system should set DS Code to error character, mark edit flag as invalid, highlight the DS Code field, and display invalid DS key message
[Country Code Valid?]
The country code is not 'CA' and not 'US' → The system sets validation error flag and displays invalid S1 key error message
[Check Country Code Not Empty]
The country code field is blank or contains error character → The system highlights the country code field, sets error character in field, sets validation error flag, and displays invalid S1 key error message
[Check Status Code Not Empty]
The status code field is blank or contains error character → The system highlights the status code field, sets error character in field, sets validation error flag, and displays invalid S1 key error message
[Status Code Empty?]
The status code field is empty or contains error character → The system sets validation flag to invalid, moves error character to status code field, highlights the status code field, and sets invalid ST key message if no other system message exists
[Qualifier Empty?]
The qualifier field is empty or contains error character → The system sets validation flag to invalid, moves error character to qualifier field, highlights the qualifier field, and sets invalid ST key message if no other system message exists
[Qualifier equals 'ST'?]
The qualifier field does not equal 'ST' → The system sets validation flag to invalid, highlights the qualifier field, and sets invalid ST key message if no other system message exists
[Code Found in Table?]
The entered code already exists in the target table → The system must reject the addition and display an error message indicating the code already exists
[Input Fields Valid?]
The input validation flag is set to NOT-VALID → The system sets key invalid error message, highlights the function field, and returns invalid status
[Table Access Successful?]
The table I/O operation completes → The system checks if the return flag indicates successful access to determine next action
[Set Modify Invalid Error]
The specified code is not found in the table → The system sets modify invalid error message and highlights the function field
[Code Found in Table?]
The system searches for the code in the corresponding table → If the code is found, the system proceeds with deletion validation, otherwise it rejects the request with an invalid delete message
[Set Delete Invalid Message]
The code lookup fails to find a matching entry → The system sets the delete invalid message number for user notification
[Insertion Point Found? - No - End of Table]
The system cannot find a valid insertion point (reached end of table without finding appropriate position) → The system should set display invalid message, highlight the code field as invalid, and return invalid status
[Handle Retrieval Error]
The system encounters a table retrieval error → The system moves table root key to error root key, sets error message to retrieval failure message, and calls CERR error handling routine
[Check if Segment Data is Empty]
System checks segment data content → Segment data is examined to determine if it contains spaces or valid carrier information
[SCAC Code Not Found - Invalid]
System finalizes validation result → Found flag remains 'N' indicating SCAC code is invalid and not found in carrier table
[Root Segment Retrieved Successfully?]
The system checks the retrieval operation result → If the return flag indicates successful retrieval, processing continues; otherwise, the search terminates
[Segment Retrieved Successfully?]
The system checks the retrieval operation result → If the return flag indicates successful retrieval, segment processing begins; otherwise, move to the next segment
[Check if Code Position is Empty]
The code position content is evaluated → The dependent data at the current tracer position is checked for spaces to determine if it contains valid code data
[Return Error Status]
Table segment cannot be retrieved → Return error status to indicate failed table segment retrieval
[Blank Code Error]
The code field is blank AND a function is specified → The system sets blank code error message number and marks the operation as invalid
[Invalid Function Error]
The function is not blank, ADD, MOD, DEL, or EXPAND → The system sets invalid function error message, highlights the function field, and marks the operation as invalid
[Display Only Access Error]
The user attempts ADD, MOD, or DEL function → The system sets display-only access error message, highlights the function field, and marks the operation as invalid
[Invalid Field Format Error]
The entered data does not meet the required format (numeric, length, pattern, etc.) → The system sets field format error message, highlights the invalid field, and marks the operation as invalid
[Self-Reference Error]
The user attempts to ADD, MOD, or DEL their own user code → The system sets self-reference error message, highlights the user code field, and marks the operation as invalid
[Cross-Reference Validation Error]
The referenced record does not exist in the related table → The system sets cross-reference validation error message, highlights the invalid reference field, and marks the operation as invalid
[Code Already Exists Error]
A record with the same key already exists in the table → The system sets code already exists error message, highlights the function field, and marks the operation as invalid
[Code Not Found Error]
No record with the specified key exists in the table → The system sets code not found error message, highlights the function field, and marks the operation as invalid
[Error Message Already Set?]
An error message has already been set for the current validation cycle → The system skips setting a new error message and proceeds to field highlighting
[Set Return Flag to Invalid]
The edit flag indicates invalid status → Return flag is set to invalid and input message is copied to output message for error reporting
[Set Return Flag to Invalid]
Edit flag is invalid AND function != modify function → Return flag is set to invalid and input message is copied to output message
[Copy Input to Output Message]
Return flag indicates invalid status → Input message is copied to output message to provide error details to user
[MS - Message Table]
The system processes the error highlighting for the Message Number field → The Message Number attribute is set to cursor highlight and the Message Number field value is set to error character
[More Segments Available?]
Table pointer is greater than table end pointer → Search terminates indicating end of table reached without finding match or insertion point
[Check GCSTBRT-US-ERROR-ROUTING]
The user attempts to perform ADD, MOD, or DEL function on Terminal table → The system rejects the operation with error flag NOT-VALID, displays ALLOWED-DISPLAY-ONLY message, and highlights the function field
[Set error message: Blank Code]
System processes the validation error → System sets error message number to blank code message for user notification
[Check if Function Code is valid]
The entered code is blank but the function code is not blank → The system rejects the operation with a blank code error message and highlights the function field
[Current Entry Empty?]
The system examines the current dependent data entry → If entry contains only spaces, processing moves to next segment; otherwise, carrier code extraction proceeds
[Determine Segment Count from MC Table]
The system validates port code against cross-reference tables → For Canadian ports, the system searches MC table segments using converted numeric port code, and for US ports, searches SD table segments using the full port code
[Check if Car ID is blank or error]
The Car ID field is blank or contains error characters → The system should set error highlighting on the Car ID field, display invalid Car ID key message, mark the field with error character, and set validation flag to invalid
[Set validation error]
The validation service returns a failure status → The system should set validation flag to invalid, highlight the Car ID field with error indication, and display invalid Car ID key message
[Set error indicators]
The system processes the validation failure → The system sets NOT-VALID to EDIT-FLAG and assigns appropriate error message number to SYSTEM-MSG-NUM
[Check if Segment Data is Empty]
The system examines the segment content → If segment data is spaces, processing is marked complete; otherwise, carrier code extraction proceeds
[SCAC Code Matches?]
The system performs the comparison → If the input SCAC code equals the extracted carrier code, the found flag is set to 'Y' and processing completes; otherwise, the segment counter is incremented
[Counter Exceeds Maximum?]
If the counter value → If the counter exceeds 200, the process switch is set to 'Y' to terminate processing; otherwise, processing continues
[Check if Segment Entry Empty?]
The system examines the segment entry at current position → Processing stops if the entry is empty (spaces), otherwise continues to extract the carrier code
[Retrieval Successful?]
The system checks the retrieval result → Processing continues with code comparison if successful, otherwise moves to next segment entry
[Input SCAC Matches Retrieved Code?]
The system compares the input SCAC code to the retrieved carrier code → Sets success flag if codes match, otherwise continues to next segment entry
[Reached Maximum Entries?]
The tracer counter is checked against the maximum limit of 200 entries → Terminates processing if limit reached, otherwise continues with next entry
[MC Table Entry Empty?]
The system examines individual table entries within the segment → The system should skip empty entries and process only entries that contain data
[Set Error Message INV-SS-DATA-02]
No matching Canadian customs code is found in the MC table → The system should set the error message to INV-SS-DATA-02-MSG-NUM, highlight the port code field, and mark validation as failed
[Dependent Data Empty?]
The system checks the current tracer position for data → If dependent data at tracer position is empty, mark processing as complete; otherwise continue with port code lookup
[Compare Canadian Customs Code]
The system compares the converted port code with the Canadian customs code from the MC table record → The comparison result determines if a match is found
[Search MC Table for Canadian Port Match - Compare converted Canadian port code against manifest station table entries for validation]
The system processes each MC table entry to compare the converted port code against the MC Canadian Customs Code → The system sets match found flag if port codes match OR continues searching until all entries are processed OR stops when maximum entries reached
[Compare Converted Port Code with MC Canadian Customs Code]
The system compares the converted port code with the MC Canadian Customs Code → The system sets the match found flag and terminates search if codes match OR continues to next entry if codes do not match
[Table Retrieved Successfully?]
The table retrieval operation completes → The system should check if the retrieval was successful before proceeding with port code validation
[Segment Retrieved?]
The segment retrieval operation completes → The system should verify successful retrieval before proceeding to search within the segment
[Port Code Validation Failed]
All segments have been searched without finding the port code → The system should indicate port code validation failure and prepare error messaging
[Set Error Message for Canadian Port]
The system needs to provide error feedback → The system should set the error message number to INV-SS-DATA-02-MSG-NUM for Canadian port validation failure
[Set Error Message for US Port]
The system needs to provide error feedback → The system should set the error message number to INV-SS-DATA-08-MSG-NUM for US port validation failure
[ADD Function Processing]
The function is ADD and the code already exists in the table → The system should reject the operation with an error message indicating the code already exists
[MOD/EXPAND Function Processing]
The function is MOD or EXPAND and the code does not exist in the table → The system should reject the operation with an error message indicating the code was not found for modification
[DEL Function Processing]
The function is DEL and the code does not exist in the table → The system should reject the operation with an error message indicating the code was not found for deletion
[Display Function Processing]
The function is blank or display and no valid insertion point is found in the table → The system should reject the request with an error message indicating an invalid display request
[Set Display Invalid Message]
The system completes the table search without finding a valid position → The system sets a display invalid message and highlights the entered code field to indicate the error
[Handle Table Access Error]
The system encounters an error while attempting to retrieve table segment data → The system handles the table access error and prevents further processing
[Numeric Train ID Right-Justification]
The system validates the entered train ID value → If the train ID fails numeric justification validation, the system should reject the operation with an invalid train ID error message and highlight the train ID field
[Root Segment Retrieved Successfully?]
The system checks the retrieval status → If successful, processing continues to get segment count; if unsuccessful, SCAC code is marked as invalid
[Segment Retrieved Successfully?]
The system checks the retrieval status → If successful, code processing begins; if unsuccessful, the segment counter is incremented to try the next segment
[Current Code Position Empty?]
A specific code position is examined → If the position contains spaces, processing moves to the next segment; if not empty, the code is extracted for validation
[Tracer Exceeds Limit?]
The system checks if more positions exist in the current segment → If tracer exceeds 200, processing moves to the next segment; otherwise, the next code position is checked
[SCAC Code Not Found - Invalid]
The validation process completes without success → The SCAC code is marked as invalid and an appropriate error condition is set
[SCAC Code Matches Extracted Code?]
The system performs the comparison between the two codes → If the input SCAC code equals the extracted carrier code then the code is marked as found and processing stops, otherwise processing continues to the next entry
[Carrier Record Found?]
The carrier record is not found in the table → The system moves to the next segment entry without further processing
[Check if Segment Entry is Empty]
The system checks if the segment entry is empty (spaces) → The system marks processing as complete if entry is empty, otherwise continues to extract carrier code
[Extracted Code Matches Input Code?]
The system performs the comparison → The system marks the code as found and completes processing if codes match, otherwise continues to next entry
[Extract CCRA Code from CC Table]
The system extracts the CCRA code from the carrier table → Compare the input SCAC code with the extracted CCRA code for validation
[Extract USCS Code from CC Table]
The system extracts the USCS code from the carrier table → Compare the input SCAC code with the extracted USCS code for validation
[Search Port Code in Segment]
The system searches through the segment data → If port code matches Schedule D port code then mark as found, or if converted port code matches Manifest Station Canadian customs code then mark as found
[Compare Port Code with Schedule D Port Code]
The system performs port code validation → Compare the input port code with the Schedule D port code field from the retrieved segment
[Compare Port Code with Manifest Station Canadian Customs Code]
The system performs port code validation → Compare the converted port code with the Canadian customs code field from the Manifest Station segment

Module: GCX004LD 1 Consolidated Epic Story

Epic: GCX004LD Complete EDI Specification Extracted from Legacy

Contains 523 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004LD EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Root Retrieval Parameters]
The system begins root segment retrieval process → The system clears second PCB flag, unqualified SSA flag, sets function code to GU (Get Unique), and initializes segment name to ROOT-NAME
[Initialize dummy root segment]
The system needs to create a dummy root segment → The system should clear the root segment structure to spaces, set the root key from the work area, initialize segment count to zero, and copy the dummy root to the work segment
[Initialize DB-IDX to 1]
The system prepares to process table entries → The database index is set to 1 to start from the first entry

Core Acceptance Criteria

[2:Root Table Retrieval - Get root segment]
The system performs a root segment retrieval operation using the table ID → The system either successfully retrieves the existing root segment or determines that no root segment exists
[3:Dummy Root Creation - Create dummy root entry]
The system creates a dummy root entry with table key and zero segment count → If creation succeeds, proceed with dependent data loading, otherwise generate root creation error
[4:Dependent Data Loading - Load dependent segments]
The system retrieves dependent segments sequentially by incrementing the segment key → Continue loading segments until no more dependent data is available, then proceed to set end pointers
[5:AD Table Data Processing]
The system processes each entry where AD-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[6:DR Table Data Processing]
The system processes each entry where DR-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[7:LT Table Data Processing]
The system processes each entry where LT-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[8:MC Table Data Processing]
The system processes each entry where MC-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[9:MS Table Data Processing]
The system processes each entry where MS-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[10:SC Table Data Processing]
The system processes each entry where SC-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[11:SE Table Data Processing]
The system processes each entry where SE-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[12:US Table Data Processing]
The system processes each entry where US-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[13:AU Table Data Processing]
The system processes each entry where AU-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[14:AC Table Data Processing]
The system processes each entry where AC-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[15:BK Table Data Processing]
The system processes each entry where BK-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[16:CC Table Data Processing]
The system processes each entry where CC-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[17:CT Table Data Processing]
The system processes each entry where CT-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[18:RF Table Data Processing]
The system processes each entry where RF-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[19:SD Table Data Processing]
The system processes each entry where SD-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[20:SK Table Data Processing]
The system processes each entry where SK-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[21:MU Table Data Processing]
The system processes each entry where MU-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[22:DC Table Data Processing]
The system processes each entry where DC-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[23:SS Table Data Processing]
The system processes each entry where SS-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[24:ID Table Data Processing]
The system processes each entry where ID-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[25:VI Table Data Processing]
The system processes each entry where VI-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[26:KS Table Data Processing]
The system processes each entry where KS-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[27:DS Table Data Processing]
The system processes each entry where DS-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[28:S1 Table Data Processing]
The system processes each entry where S1-ID is not empty and manages segment displacement → Move valid entries to memory table with proper segment and displacement management, skipping empty entries
[29:ST Table Data Processing]
The system processes each entry and encounters ST-ID that is empty → Skip the empty entry and exit processing, otherwise move valid entries to memory table with segment management
[30:In-Memory Table Population - Set end pointers]
The system completes the table loading process → Set the end segment number and displacement within segment to mark the boundary of loaded data
[Set Root Segment Name and Table ID]
The system sets up table identification → The system moves TABLE-ID to WS-TABLE-ROOT-ID and clears WS-TABLE-ROOT-VALUE to spaces
[Root Segment Retrieved Successfully?]
If retrieval result → If RETURN-FLAG-GCCTBIO equals UNSUCCESSFUL, the system proceeds to create dummy root, otherwise retrieval is complete
[Clear Root Segment Area]
The system begins dummy root creation → The system clears GCSTBRT to spaces
[Set Root Key with Table ID]
The system configures the dummy root key → The system moves WS-TABLE-ROOT-KEY to GCSTBRT-KEY
[Set Segment Count to Zero]
The system initializes segment count → The system sets GCSTBRT-SEG-COUNT to zero
[Set Function Code to ISRT - Insert]
The system prepares for insertion → The system moves GCSTBRT to WS-TABLE-SEGMENT and sets USER-FUNC-CODE to ISRT
[Call Table Access to Retrieve New Root]
The system retrieves the new root → The system calls B110-TABLE-ACCESS procedure to get the newly created root segment
[Execute table access for insert]
The system executes the table access operation → The system should set the operation code to insert and call the table access module to store the dummy root segment
[Execute table access to retrieve inserted root]
The system needs to retrieve the inserted root → The system should set the operation code to get and execute table access to retrieve the newly inserted root segment
[B210-RETRIEVE-DEPENDENT: Get next dependent segment]
The system performs dependent segment retrieval → The next dependent segment is accessed using GNP function with incremented key
[Dependent segment found?]
The system checks the retrieval result → If retrieval was unsuccessful, the dependent flag is set to NOT-FOUND, otherwise processing continues
[Set DB-DEPENDENT-FLAG to NOT-FOUND]
No more dependent segments are found → The dependent flag is set to NOT-FOUND to terminate the loading loop
[Move segment data to GCSTBDP]
The segment data needs to be processed → The table segment data is moved to GCSTBDP work area
[Process table entries based on table type]
The system processes table entries → The appropriate table-specific processing routine is executed based on the table type until all entries in the segment are processed
[Continue loading next dependent segment]
More dependent segments may be available → The system returns to retrieve the next dependent segment
[Process AD Table Entries]
The TABLE-ID equals AD-TABLE-ID → The system should invoke AD table entry processing until all AD segment entries are processed
[Process DR Table Entries]
The TABLE-ID equals DR-TABLE-ID → The system should invoke DR table entry processing until all DR segment entries are processed
[Process LT Table Entries]
The TABLE-ID equals LT-TABLE-ID → The system should invoke LT table entry processing until all LT segment entries are processed
[Process MC Table Entries]
The TABLE-ID equals MC-TABLE-ID → The system should invoke MC table entry processing until all MC segment entries are processed
[Process MS Table Entries]
The TABLE-ID equals MS-TABLE-ID → The system should invoke MS table entry processing until all MS segment entries are processed
[Process SC Table Entries]
The TABLE-ID equals SC-TABLE-ID → The system should invoke SC table entry processing until all SC segment entries are processed
[Process SE Table Entries]
The TABLE-ID equals SE-TABLE-ID → The system should invoke SE table entry processing until all SE segment entries are processed
[Process US Table Entries]
The TABLE-ID equals US-TABLE-ID → The system should invoke US table entry processing until all US segment entries are processed
[Process AU Table Entries]
The TABLE-ID equals AU-TABLE-ID → The system should invoke AU table entry processing until all AU segment entries are processed
[Process AC Table Entries]
The TABLE-ID equals AC-TABLE-ID → The system should invoke AC table entry processing until all AC segment entries are processed
[Process BK Table Entries]
The TABLE-ID equals BK-TABLE-ID → The system should invoke BK table entry processing until all BK segment entries are processed
[Process CC Table Entries]
The TABLE-ID equals CC-TABLE-ID → The system should invoke CC table entry processing until all CC segment entries are processed
[Process CT Table Entries]
The TABLE-ID equals CT-TABLE-ID → The system should invoke CT table entry processing until all CT segment entries are processed
[Process RF Table Entries]
The TABLE-ID equals RF-TABLE-ID → The system should invoke RF table entry processing until all RF segment entries are processed
[Process SD Table Entries]
The TABLE-ID equals SD-TABLE-ID → The system should invoke SD table entry processing until all SD segment entries are processed
[Process SK Table Entries]
The TABLE-ID equals SK-TABLE-ID → The system should invoke SK table entry processing until all SK segment entries are processed
[Process MU Table Entries]
The TABLE-ID equals MU-TABLE-ID → The system should invoke MU table entry processing until all MU segment entries are processed
[Process DC Table Entries]
The TABLE-ID equals DC-TABLE-ID → The system should invoke DC table entry processing until all DC segment entries are processed
[Process SS Table Entries]
The TABLE-ID equals SS-TABLE-ID → The system should invoke SS table entry processing until all SS segment entries are processed
[Process ID Table Entries]
The TABLE-ID equals ID-TABLE-ID → The system should invoke ID table entry processing until all ID segment entries are processed
[Process VI Table Entries]
The TABLE-ID equals VI-TABLE-ID → The system should invoke VI table entry processing until all VI segment entries are processed
[Process KS Table Entries]
The TABLE-ID equals KS-TABLE-ID → The system should invoke KS table entry processing until all KS segment entries are processed
[Process DS Table Entries]
The TABLE-ID equals DS-TABLE-ID → The system should invoke DS table entry processing until all DS segment entries are processed
[Process S1 Table Entries]
The TABLE-ID equals S1-TABLE-ID → The system should invoke S1 table entry processing until all S1 segment entries are processed
[Process ST Table Entries]
The TABLE-ID equals ST-TABLE-ID → The system should invoke ST table entry processing until all ST segment entries are processed
[Increment Memory Position Counter]
The AD entry ID field contains valid data (not spaces) → The displacement within segment counter should be incremented by 1
[Current Segment Full?]
The displacement within segment exceeds the AD segment maximum limit → A new memory segment should be created
[Create New Memory Segment]
A new segment needs to be created → The displacement should be reset to 1 and the segment number should be incremented by 1
[Move AD Entry to Current Memory Position]
The entry needs to be loaded into memory → The AD table entry should be moved to the calculated memory position using segment number and displacement
[More Entries in Database Segment?]
The database index is within the segment maximum limit → Continue processing the next AD entry, otherwise complete the AD table processing
[Reset displacement to 1]
A new segment is required → The displacement pointer should be reset to 1 and the segment number should be incremented by 1
[Move AD table entry to new segment location]
The displacement has been reset to 1 and segment number incremented → The AD table entry should be moved to the new segment at the first displacement position and the database index should be incremented
[Move AD table entry to current segment location]
The displacement pointer is within the segment maximum → The AD table entry should be moved to the current segment at the displacement position and the database index should be incremented
[Increment displacement within segment]
The entry is ready to be loaded into memory → The system increments the displacement within segment counter by 1 to point to the next available memory position
[Does displacement exceed AD segment maximum?]
The displacement value exceeds the predefined AD segment maximum capacity → The system identifies that the current segment is full and overflow handling is required
[Reset displacement to 1]
A new memory segment needs to be created → The system resets the displacement within segment counter to 1 to start filling the new segment from the beginning
[Increment segment number]
A new segment is being created due to overflow → The system increments the segment number by 1 to identify the new memory segment
[Move AD table entry to new segment position]
An AD table entry needs to be stored after segment overflow → The system moves the AD table entry data to the new segment at the current displacement position
[Move AD table entry to current segment position]
An AD table entry needs to be stored and displacement is within segment limits → The system moves the AD table entry data to the current segment at the current displacement position
[Increment position within current segment]
The entry needs to be stored in memory → The displacement within the current segment should be incremented by 1
[Is current segment full?]
The displacement within segment exceeds the DR segment maximum capacity → A new segment should be created to accommodate the entry
[Create new segment]
A new DR table entry needs to be stored → The segment number should be incremented by 1 to create a new segment
[Reset position to beginning of new segment]
The segment position needs to be initialized → The displacement within segment should be set to 1
[Copy DR table entry to memory location]
The entry needs to be stored in memory → The DR table entry should be moved from the database segment to the memory table at the current segment number and displacement position
[More DR entries to process?]
The current database index is evaluated against the DR segment maximum → Processing should continue if the index is less than or equal to the DR segment maximum, otherwise processing should complete
[Increment Memory Displacement Pointer]
The system prepares to store the entry in memory → The system increments the memory displacement pointer by 1 to allocate the next available position within the current segment
[Memory Segment Full?]
The system checks the current segment capacity → If the displacement pointer exceeds the DR segment maximum capacity, the segment is considered full and requires a new segment
[Create New Memory Segment]
The system needs to store additional DR entries → The system resets the displacement pointer to 1 and increments the segment number by 1 to create a new memory segment
[Move DR Entry to New Segment Location]
The system stores the current valid DR entry → The system moves the DR table entry from the database segment to the new memory segment at the current segment number and displacement position
[Move DR Entry to Current Segment Location]
The system stores a valid DR entry → The system moves the DR table entry from the database segment to the current memory segment at the current segment number and displacement position
[Increment DB Index]
The system completes processing of the current entry → The system increments the database index by 1 to move to the next DR entry in the database segment
[Increment Memory Position Counter]
The entry validation passes → The system increments the displacement within segment counter by 1 to prepare the next available memory position
[Check if Memory Segment is Full]
The displacement within segment counter exceeds the DR segment maximum capacity → The system identifies that the current segment is full and requires overflow handling
[Reset Position to Start of New Segment]
A new segment needs to be created for additional entries → The system resets the displacement within segment counter to 1 to start at the beginning of the new segment
[Increment Segment Number, Increment segment number]
The displacement within segment has been reset to 1 → The system increments the segment number by 1 to identify the new segment
[Move DR Entry to New Segment Position]
A valid DR table entry needs to be stored → The system moves the DR table entry from the database segment to the memory table at the new segment and position coordinates
[Move DR Entry to Current Segment Position]
The displacement within segment counter is within the DR segment maximum limit → The system moves the DR table entry from the database segment to the memory table at the current segment and position coordinates
[Increment DISPL-WITHIN-SEG-END]
The entry contains valid data to be loaded → The displacement within segment counter should be incremented to prepare for data placement
[Segment overflow check - DISPL-WITHIN-SEG-END > LT-SEGMENT-MAX?]
The displacement within segment exceeds the maximum allowed entries for LT table segments → A new segment should be created by resetting displacement to 1 and incrementing the segment number
[Create new segment - Reset DISPL-WITHIN-SEG-END to 1]
A new segment needs to be created for additional entries → The displacement counter should be reset to 1 and the segment number should be incremented
[Move LT table entry to current segment position]
The entry needs to be loaded into the memory table → The LT table entry should be moved to the calculated segment and displacement position in the memory table
[More LT entries to process - DB-IDX <= LT-SEGMENT-MAX?]
The database index is within the maximum segment limit → The processing should continue with the next entry in the database segment
[Increment Memory Position Counter]
The system prepares to store the entry in memory → The displacement within the current memory segment is incremented by 1
[Memory Segment Full?]
The system checks if the segment can accommodate more entries → If the displacement exceeds the LT segment maximum capacity, the segment is considered full
[Reset Position to 1, Create New Memory Segment]
A new LT table entry needs to be stored → The displacement is reset to 1 and the segment number is incremented by 1 to create a new memory segment
[Copy LT Entry to New Segment Position]
The system stores the current LT table entry → The LT table entry is copied to the new segment at the current segment number and displacement position
[Copy LT Entry to Current Segment Position]
The system stores the current LT table entry → The LT table entry is copied to the current segment at the current segment number and displacement position
[Increment memory position counter]
The system prepares to store the entry in memory → The system increments the displacement within segment counter by 1 to point to the next available memory position
[Memory position exceeds LT segment maximum?]
The system checks if the displacement within segment exceeds the LT segment maximum capacity → The system identifies segment overflow if displacement is greater than LT-SEGMENT-MAX, or identifies available space if within limits
[Reset position to 1 in new segment]
The system needs to store additional LT table entries → The system resets displacement within segment to 1 and increments the segment number by 1 to create a new memory segment
[Move LT entry to new segment position]
The system stores the current LT table entry → The system moves the LT table entry from the database segment to the memory table at the new segment number and position 1
[Move LT entry to current segment position]
The system stores a valid LT table entry → The system moves the LT table entry from the database segment to the memory table at the current segment number and displacement position
[Increment Position in Current Segment]
The entry is ready to be loaded into memory → The displacement within the current segment should be incremented by 1 to point to the next available position
[Reset Position to 1]
Segment overflow is detected → The displacement within segment should be reset to 1 to start at the beginning of the new segment
[Create New Segment]
Additional MC entries need to be loaded → The segment number should be incremented by 1 to create a new segment for continued data loading
[Move MC Entry to Memory Location]
The entry is ready to be loaded into memory → The complete MC table entry should be moved from the database segment to the memory table at the specified segment and displacement position
[More MC Entries to Process?]
Checking for continuation of MC table processing → If the database index is less than or equal to the maximum MC segment entries, processing should continue with the next entry, otherwise processing should complete
[Memory Displacement > MC Segment Maximum?]
The displacement pointer exceeds the maximum allowed entries per MC segment → The system identifies that a new memory segment is required
[Create New Memory Segment]
A new MC table entry needs to be stored → The system resets displacement to position 1 and increments the segment number to create a new memory segment
[Move MC Entry to Current Segment Location]
The memory displacement is within the segment maximum capacity → The system moves the MC table entry to the current segment at the specified displacement position
[Move MC Entry to New Segment Location]
A new segment has been created with reset displacement and incremented segment number → The system moves the MC table entry to the new segment at the reset displacement position
[Increment Memory Position Counter]
The entry validation is successful → The displacement within segment counter is incremented by 1 to prepare for memory allocation
[Memory Segment Full?]
The displacement within segment counter exceeds the MC segment maximum capacity → The system identifies that a new memory segment is required for the entry
[Reset Position to Start of New Segment]
A new segment is required → The displacement within segment is reset to 1 and the segment number is incremented by 1
[Copy MC Table Entry to New Segment Position]
The entry needs to be stored in the new segment → The MC table entry from the database segment is copied to the MC table entries array at the new segment number and displacement position
[Copy MC Table Entry to Current Memory Position]
A valid MC table entry needs to be stored → The MC table entry from the database segment is copied to the MC table entries array at the current segment number and displacement position
[Move to Next Database Index]
The current entry processing is complete → The database index is incremented by 1 to point to the next MC table entry in the database segment
[Increment position within current segment]
The entry validation passes → The displacement within the current segment should be incremented by 1
[Will entry exceed current segment capacity?]
The displacement within segment exceeds the MS segment maximum capacity → The displacement should be reset to 1 and the segment number should be incremented by 1
[Move MS entry to new segment position]
The displacement has been reset to 1 and segment number incremented → The MS table entry should be moved from the database segment to the new memory segment position
[Move MS entry to current segment position]
The displacement within segment does not exceed the maximum capacity → The MS table entry should be moved from the database segment to the current memory segment position
[More MS entries to process?]
The database index is less than or equal to the MS segment maximum → The processing should continue with the next MS table entry
[Increment memory position counter, Increment Memory Displacement Pointer]
The system prepares to store the entry in memory → The displacement within segment counter is incremented by 1 to point to the next available memory position
[Reset position to 1 - start new segment]
The system needs to allocate space for the current MS table entry → The displacement within segment counter is reset to 1 to start at the beginning of a new segment
[Increment segment number]
The displacement within segment has been reset to 1 → The segment number counter is incremented by 1 to identify the new segment
[Move MS table entry to new segment position]
The system stores the current MS table entry → The MS table entry from the database is moved to the memory table at the new segment number and position 1
[Move MS table entry to current segment position]
The system stores the current MS table entry → The MS table entry from the database is moved to the memory table at the current segment number and displacement position
[Increment memory displacement pointer, Increment Memory Position Counter]
The entry is ready to be loaded into memory → The displacement within segment counter is incremented by 1 to point to the next available memory position
[Memory segment overflow check - displacement > MS-SEGMENT-MAX?]
The displacement within segment value is greater than MS-SEGMENT-MAX → A memory segment overflow condition is detected requiring creation of a new segment
[Reset displacement to 1, Reset position to 1]
A new memory segment needs to be created → The displacement within segment counter is reset to 1 to start at the beginning of the new segment
[Create new memory segment - increment segment number]
A new memory segment is required for MS table entries → The segment number counter is incremented by 1 to create the next available memory segment
[Move MS table entry to new segment position]
An MS table entry needs to be loaded after segment overflow → The MS table entry from the database segment is moved to the MS table entries array at the new segment number and displacement position
[Move MS table entry to current segment position]
An MS table entry needs to be loaded into memory → The MS table entry from the database segment is moved to the MS table entries array at the current segment number and displacement position
[Increment DB index to next entry]
The current entry processing is complete → The database index is incremented by 1 to point to the next MS table entry in the database segment
[Increment displacement within segment, Increment displacement within current segment]
The entry contains valid data → The displacement within the current segment should be incremented by 1 to prepare for data placement
[Does displacement exceed SC segment maximum?]
The displacement exceeds the SC segment maximum capacity → A new segment should be created by resetting displacement to 1 and incrementing the segment number by 1
[Move SC table entry to memory location]
The segment and displacement positions are set → The SC table entry should be moved from the database segment to the memory table at the specified segment and displacement position
[More SC entries to process?]
The current entry has been processed and the database index has been incremented → If the database index is still within the segment maximum range, processing should continue with the next entry, otherwise processing should complete
[Memory segment overflow?]
The system checks if the displacement exceeds the SC segment maximum limit → If displacement is greater than SC-SEGMENT-MAX, a segment overflow condition is detected
[Reset displacement to 1, Create new memory segment]
A segment overflow condition is detected → The displacement pointer is reset to 1 and the segment number is incremented by 1 to create a new memory segment
[Move SC table entry to new segment location]
The system needs to store the current SC table entry → The SC table entry is moved to the memory location using the new segment number and reset displacement position
[Move SC table entry to current segment location]
The system needs to store an SC table entry without segment overflow → The SC table entry is moved to the memory location using the current segment number and displacement position
[Memory Segment Full?]
The displacement within segment exceeds the SC segment maximum capacity → A segment overflow condition is identified requiring new segment allocation
[Reset Position to Start of New Segment]
A new SC table entry needs to be stored → The displacement within segment is reset to 1 and the segment number is incremented by 1
[Copy SC Entry to Current Memory Position]
The displacement within segment is within the maximum limit → The SC table entry is moved to the memory table at the current segment and displacement position
[Copy SC Entry to Current Memory Position]
An SC table entry needs to be stored → The SC table entry is moved to the memory table at the new segment number and position 1
[Increment displacement within current segment]
The entry needs to be placed in memory → The displacement within the current segment is incremented by 1 to point to the next available memory location
[Is current segment full?]
The displacement value exceeds the SE segment maximum capacity limit → A new segment must be created to accommodate additional entries
[Create new segment]
Additional SE table entries need to be stored → The segment number is incremented by 1 and the displacement is reset to 1 to start the new segment
[Move SE table entry to memory location]
The entry data needs to be loaded into memory → The SE table entry is moved from the database segment to the memory table at the specified segment and displacement position
[Increment entry index]
Processing moves to the next entry → The database index is incremented by 1 to point to the next SE table entry in the database segment
[Increment Memory Position Counter]
The entry needs to be loaded into memory → The displacement within segment counter is incremented by 1 to determine the next available memory position
[Memory Segment Full?]
The displacement within segment counter exceeds the SE segment maximum limit → The current memory segment is considered full and a new segment allocation is required
[Reset Position to 1 in Current Segment]
A new memory segment needs to be allocated → The displacement within segment counter is reset to 1 to start at the beginning of the new segment
[Allocate New Memory Segment]
A new memory segment is needed for SE table entries → The segment number counter is incremented by 1 to create a new memory segment
[Copy SE Entry to New Segment Position]
A valid SE table entry needs to be stored → The SE table entry from the database segment is copied to the SE memory table at the new segment number and position 1
[Copy SE Entry to Current Segment Position]
A valid SE table entry needs to be stored → The SE table entry from the database segment is copied to the SE memory table at the current segment number and displacement position
[Move to Next Database Index]
The current entry processing is complete → The database index counter is incremented by 1 to move to the next entry in the database segment
[Increment Memory Position Counter]
The entry is ready to be loaded into memory → The displacement within segment counter should be incremented by 1 to reserve the next available memory position
[Is Current Memory Segment Full?]
The displacement within segment exceeds the SE segment maximum capacity → The system should initiate new segment creation process
[Reset Position to Start of New Segment]
A new memory segment needs to be created → The displacement within segment should be reset to 1 and the segment number should be incremented by 1
[Copy SE Table Entry to Current Memory Position]
The entry is ready to be loaded into memory → The SE table entry should be moved from the database segment to the SE memory table at the current segment and displacement position
[Increment Position Within Current Segment]
The US table entry ID field contains valid data (not spaces) → Increment the displacement within the current segment by 1 to prepare for data placement
[Current Segment Full?]
The displacement within segment exceeds the US segment maximum capacity → Reset the displacement to 1 and increment the segment number to create a new segment
[Move US Table Entry to Memory Location]
The segment and displacement positions are set for data placement → Move the US table entry from the database segment to the US memory table at the specified segment and displacement position
[Memory Displacement > US Segment Maximum?]
The system checks if the displacement exceeds the US segment maximum capacity → If displacement is greater than US-SEGMENT-MAX, a segment overflow condition is identified
[Reset Displacement to 1, Create New Segment]
The system needs to allocate space for additional entries → The displacement counter is reset to 1 and the segment number is incremented by 1 to create a new segment
[Move US Table Entry to Memory Location]
The system performs the data storage operation → The US table entry is moved to the memory location specified by the current segment number and displacement within segment
[Increment displacement within current segment]
The entry ID field != SPACE → The system increments the displacement within the current segment by 1 to prepare for data placement
[Does displacement exceed US segment maximum?]
The displacement within segment exceeds the US segment maximum limit → The system triggers segment overflow handling to create a new segment
[Reset displacement to 1]
Segment overflow is detected → The system resets displacement to 1 and increments the segment number by 1
[Move US table entry to new segment position]
The displacement has been reset to 1 and segment number incremented → The system moves the US table entry to the new segment position using the current segment number and displacement
[Move US table entry to current segment position]
The displacement within segment does not exceed the US segment maximum → The system moves the US table entry to the current segment position using the current segment number and displacement
[Increment DB index to next entry]
The entry placement is complete → The system increments the database index by 1 to point to the next entry for processing
[Increment Position Counter]
The entry is ready to be processed for loading → The displacement within segment counter should be incremented by 1 to point to the next available position
[Segment Overflow Check - Position > AU Segment Max?]
The displacement within segment exceeds the AU segment maximum capacity → A new segment should be created by resetting the displacement to 1 and incrementing the segment number by 1
[Move AU Entry to New Segment Position]
An AU table entry needs to be loaded → The AU table entry should be moved to the new segment at the reset position (position 1)
[Move AU Entry to Current Segment Position]
An AU table entry needs to be loaded → The AU table entry should be moved to the current segment at the current displacement position
[Increment Memory Position Counter]
The system begins memory allocation for the entry → The displacement within segment counter is incremented by 1 to reserve the next available memory position
[Current Segment Has Space]
The displacement within segment is less than or equal to AU-SEGMENT-MAX → The AU entry is allocated to the current segment at the current position without creating a new segment
[Segment Full - Create New Segment]
The displacement within segment exceeds AU-SEGMENT-MAX → The system initiates creation of a new memory segment to accommodate the AU entry
[Reset Position to Start of New Segment]
The system needs to initialize the new segment → The displacement within segment counter is reset to 1 to start at the beginning of the new segment
[Increment Segment Counter]
The displacement has been reset for the new segment → The segment number counter is incremented by 1 to track the new segment
[Move AU Entry to Memory Location]
The system performs the data transfer operation → The AU table entry from the database index position is moved to the AU table entries array at the current segment number and displacement position
[Increment displacement within current segment]
The entry ID field != SPACE → The displacement within the current segment is incremented by 1
[Reset displacement to 1]
The displacement within segment exceeds the AU segment maximum → The displacement within segment is reset to 1
[Create new segment - increment segment number]
The AU table requires additional memory space → The segment number is incremented by 1 to create a new segment
[Move AU table entry to new segment position]
An AU table entry needs to be stored → The AU table entry is moved to the new segment at the current displacement position
[Move AU table entry to current segment position]
An AU table entry needs to be stored → The AU table entry is moved to the current segment at the current displacement position
[Does displacement exceed AC segment maximum?]
The displacement exceeds the AC segment maximum capacity → The displacement should be reset to 1 and a new segment should be created by incrementing the segment number
[Move AC table entry to new segment position]
An AC table entry needs to be loaded → The AC table entry should be moved to the new segment at the reset displacement position and the database index should be incremented
[Move AC table entry to current segment position]
An AC table entry needs to be loaded → The AC table entry should be moved to the current segment at the incremented displacement position and the database index should be incremented
[Increment displacement within segment]
The system begins processing the valid entry → The displacement within segment counter is incremented by 1 to prepare the next available memory position
[Reset displacement to 1]
The system needs to allocate a new segment for additional entries → The displacement within segment counter is reset to 1 to start at the beginning of the new segment
[Increment segment number]
The system allocates a new segment for AC table entries → The segment number counter is incremented by 1 to identify the new segment
[Move AC table entry to new segment position]
The system stores the current AC table entry → The AC table entry from the database is moved to the memory table at the new segment number and displacement position
[Move AC table entry to current segment position]
The system stores the current AC table entry → The AC table entry from the database is moved to the memory table at the current segment number and displacement position
[Increment database index to next entry]
The system completes the entry processing → The database index counter is incremented by 1 to point to the next AC table entry in the database
[Increment Memory Position Counter]
The AC entry ID at the current index position != SPACE → The displacement within segment counter is incremented by 1 to prepare for data placement
[Memory Segment Full?]
The displacement within segment counter exceeds the AC segment maximum limit → The system identifies that a new memory segment is required
[Reset Position to 1, Create New Memory Segment]
The displacement within segment counter is greater than AC segment maximum → The displacement counter is reset to 1 and the segment number is incremented by 1
[Move AC Entry to New Segment Position]
The displacement and segment counters have been reset for the new segment → The AC table entry from the database is moved to the new segment position using current segment number and displacement, and the database index is incremented
[Move AC Entry to Current Segment Position]
The displacement within segment counter is within the AC segment maximum limit → The AC table entry from the database is moved to the current segment position using current segment number and displacement, and the database index is incremented
[Move BK Entry to Memory Location]
The BK entry is being processed for loading → The complete BK table entry should be moved to the memory table at the current segment number and displacement position
[Current Segment Full?]
The segment overflow condition is detected → The displacement should be reset to 1 and the segment number should be incremented by 1 to create a new segment
[Increment Position in Current Segment]
The entry is being prepared for loading into memory → The displacement within the current segment should be incremented by 1
[Increment Memory Displacement Pointer, Increment displacement within segment]
The entry is ready to be stored in memory → The displacement within segment counter is incremented by 1
[Memory Segment Full?]
The displacement within segment exceeds the BK segment maximum capacity → The current memory segment is identified as full and requires overflow handling
[Reset Displacement to 1]
A new memory segment needs to be allocated → The displacement within segment counter is reset to 1
[Create New Memory Segment]
A new memory segment is required for BK table entries → The segment number counter is incremented by 1
[Move BK Entry to New Segment Location]
A valid BK table entry needs to be stored → The BK table entry from the database segment is moved to the BK table entries array at the new segment and displacement position
[Move BK Entry to Current Segment Location]
A valid BK table entry needs to be stored → The BK table entry from the database segment is moved to the BK table entries array at the current segment and displacement position
[Increment Memory Position Counter]
The system begins processing the valid entry → The displacement within segment counter is incremented by 1 to prepare for data placement
[Reset Position to 1 - Start New Segment]
The system prepares to create a new segment → The displacement within segment is reset to 1 to start at the beginning of the new segment
[Increment Segment Number]
The system creates a new memory segment → The segment number is incremented by 1 to identify the new segment
[Move BK Entry to New Segment Position]
The system processes the BK table entry data → The BK table entry from the database segment is moved to the BK table entries array at the new segment number and position 1
[Move BK Entry to Current Segment Position]
The system processes the BK table entry data → The BK table entry from the database segment is moved to the BK table entries array at the current segment number and displacement position
[Increment Database Index]
The system completes the current entry processing → The database index is incremented by 1 to advance to the next entry in the database segment
[Increment Position in Current Segment]
The entry has passed validation checks → The displacement within the current segment should be incremented by 1
[Current Segment Full?]
The current displacement within segment exceeds the CC segment maximum capacity → A new segment should be created to accommodate the entry
[Reset Position to 1, Reset position to 1]
A new segment needs to be created → The displacement within segment should be reset to 1 and the segment number should be incremented by 1
[Move CC Entry to Memory Location]
The entry is ready to be loaded into memory → The CC table entry should be moved from the database segment to the CC memory table at the specified segment and displacement position
[More CC Entries to Process?]
The current database index is less than or equal to the CC segment maximum → Processing should continue with the next entry
[CC Table Processing Complete]
The current database index exceeds the CC segment maximum → The CC table processing for this segment should be marked as complete
[Increment Memory Displacement Pointer]
The system prepares to store the entry in memory → The memory displacement pointer within the current segment is incremented by 1 to point to the next available position
[Create New Memory Segment - Reset Displacement to 1 - Increment Segment Number]
The system needs to allocate space for additional CC entries → A new segment is created by resetting the displacement pointer to 1 and incrementing the segment number by 1
[Move CC Table Entry to Memory Location SEG-NO-END, DISPL-WITHIN-SEG-END]
The system stores the CC table entry → The CC table entry from the database is moved to the memory table at the specified segment number and displacement position
[Memory segment overflow check - Position > CC-SEGMENT-MAX?]
The current displacement within segment exceeds the CC segment maximum limit → A memory segment overflow condition is detected requiring new segment allocation
[Create new memory segment - increment segment number]
A new segment allocation is required → The segment number counter is incremented by 1 to create the next available memory segment
[Move CC table entry to new segment position]
The CC table entry data needs to be stored → The CC table entry from database segment is moved to the CC memory table at the new segment number and position 1
[Move CC table entry to current segment position]
The displacement within segment is within the CC segment maximum limit → The CC table entry from database segment is moved to the CC memory table at current segment number and displacement position
[Increment database index]
The current entry processing is complete → The database index counter is incremented by 1 to move to the next CC table entry in the database segment
[Increment Position Counter]
The entry is ready to be processed for loading → The displacement within segment counter should be incremented by 1 to prepare for data placement
[Segment Overflow Check - Position > CT Max?]
The displacement within segment exceeds the CT segment maximum capacity → A new segment should be created by resetting the displacement to 1 and incrementing the segment number by 1
[Move CT Entry to New Segment Position]
The displacement has been reset to 1 and segment number incremented → The current CT table entry should be moved to the new segment at the reset position
[Move CT Entry to Current Segment Position]
The displacement within segment does not exceed the CT segment maximum → The CT table entry should be moved to the current segment at the current displacement position
[Increment Memory Displacement Pointer]
The entry is determined to be valid for loading → The system increments the memory displacement pointer to allocate the next available position within the current segment
[Memory Displacement > CT Segment Maximum?]
The displacement pointer exceeds the CT segment maximum capacity → The system identifies that a new memory segment is required to accommodate additional entries
[Reset Displacement to 1]
A new segment is required to store additional entries → The system resets the displacement pointer to 1 and increments the segment number to create a new memory segment
[Move CT Entry to New Segment Location]
The CT table entry needs to be stored → The system moves the CT table entry data to the new segment at the current segment number and displacement position
[Move CT Entry to Current Segment Location]
The displacement pointer is within the segment maximum capacity → The system moves the CT table entry data to the current segment at the current segment number and displacement position
[Increment Memory Position Counter]
The system processes the valid entry → The displacement within segment counter is incremented by 1 to prepare for data placement
[Reset Position to 1]
The system handles the overflow → The displacement within segment counter is reset to 1 for the new segment
[Create New Memory Segment]
The system allocates memory for CT table entries → The segment number counter is incremented by 1 to create a new memory segment
[Move CT Entry to New Segment Position]
The system stores the CT table entry data → The CT table entry from the database is moved to the CT table entries array at the new segment number and position 1
[Move CT Entry to Current Segment Position]
The system stores the CT table entry data → The CT table entry from the database is moved to the CT table entries array at the current segment number and displacement position
[Advance to Next Table Entry]
The system completes the data movement operation → The database index counter is incremented by 1 to advance to the next table entry
[Increment Memory Position Counter]
The entry has passed validation checks → The displacement within segment counter is incremented by 1 to point to the next memory position
[Memory Position Exceeds RF Segment Maximum?]
The current displacement within segment exceeds the RF segment maximum capacity → The displacement is reset to 1 and a new segment number is created by incrementing the segment counter
[Memory Position Exceeds RF Segment Maximum?]
The current displacement within segment does not exceed the RF segment maximum capacity → The RF entry is moved directly to the memory location at the current segment and position
[Move RF Entry to Memory Location at Current Segment and Position]
The displacement has been reset to 1 and segment number incremented → The RF table entry is moved to the memory location at the new segment number and position 1
[Move RF Entry to Memory Location at Current Segment and Position]
The displacement within segment is within the maximum limit → The RF table entry is moved to the memory location at the current segment and displacement position
[Increment Memory Position Counter]
The entry is ready to be loaded into memory → The displacement within segment counter is incremented by 1 to point to the next memory position
[Reset Position to Start of New Segment]
A new segment allocation is triggered → The displacement within segment is reset to 1 to start at the beginning of the new segment
[Increment Segment Counter]
A new RF memory segment is being allocated → The segment number counter is incremented by 1
[Copy RF Entry to New Segment Position, Copy RF Entry to Current Segment Position]
An RF table entry needs to be stored → The RF entry is copied from the database segment to the memory table at the current segment and position coordinates
[Move to Next Database Entry]
The current entry processing is complete → The database index is incremented by 1 to point to the next RF entry in the database segment
[Increment Memory Position Counter]
The entry is ready to be loaded into memory → The system increments the displacement within segment counter by 1 to point to the next memory position
[Memory Segment Full?]
The displacement counter exceeds the RF segment maximum capacity → The system identifies that memory segment overflow has occurred and new segment allocation is required
[Reset Position to Start of New Segment]
Memory segment overflow is detected → The system resets displacement to position 1, increments segment number by 1, and prepares new segment for RF entry storage
[Copy RF Entry to Current Memory Position]
The displacement counter is within segment capacity limits → The system copies the RF table entry to the current segment at the specified displacement position
[Copy RF Entry to New Segment Position]
New segment has been created and position counters have been reset → The system copies the RF table entry to the new segment at position 1
[Increment Position Within Current Segment]
The entry contains valid data that needs to be loaded into memory → Increment the displacement within the current segment by 1 to position for data placement
[Current Segment Full?]
The displacement within segment exceeds the SD segment maximum capacity → Reset the displacement to 1 and increment the segment number by 1 to create a new segment
[Move SD Entry to Memory Location]
The entry data is ready to be moved to memory → Move the SD table entry from the database segment to the SD memory table at the current segment number and displacement position, then increment the database index
[More SD Entries to Process?]
The database index is checked against the SD segment maximum → Continue processing if the database index is less than or equal to SD segment maximum, otherwise complete the SD table processing
[Increment Memory Position Counter]
The entry needs to be loaded into memory → The memory position counter (displacement within segment) is incremented by 1
[Reset Position to 1 - Start New Segment]
A new segment needs to be allocated → The displacement within segment is reset to 1 to start at the beginning of the new segment
[Increment Segment Number]
The segment allocation process continues → The segment number is incremented by 1 to identify the new segment
[Move SD Entry to New Segment Position]
The SD table entry needs to be stored → The SD table entry from the database segment is moved to the SD table entries array at the new segment number and position 1
[Move SD Entry to Current Segment Position]
The displacement within segment is within the SD segment maximum limit → The SD table entry from the database segment is moved to the SD table entries array at the current segment number and displacement position
[Increment Memory Position Counter, Increment memory displacement pointer]
The system begins processing the valid entry → The displacement within segment counter is incremented by 1 to prepare the next memory position
[Memory Segment Full?]
The system checks if the current segment can accommodate more entries → If the displacement within segment counter exceeds the SD segment maximum capacity, the segment is considered full
[Reset Position to 1, Create New Memory Segment]
The system needs to store additional SD table entries → The displacement within segment counter is reset to 1 and the segment number counter is incremented by 1 to create a new memory segment
[Move SD Entry to New Segment Position]
The system stores the current SD table entry → The SD table entry from the database segment is moved to the SD table entries array at the new segment number and position 1
[Move SD Entry to Current Segment Position]
The system stores the current SD table entry → The SD table entry from the database segment is moved to the SD table entries array at the current segment number and displacement position
[Increment Memory Position Counter]
The entry is ready to be processed for memory loading → The displacement within segment counter should be incremented by 1 to prepare for data placement
[Current Segment Full?]
The displacement within segment exceeds the SK segment maximum capacity → A new segment should be created by resetting displacement to 1 and incrementing the segment number by 1
[Move SK Entry to Current Memory Position]
The entry needs to be loaded into memory → The SK table entry should be moved to the SK memory table at the current segment number and displacement position
[More SK Entries to Process?]
The current entry processing is complete → If the database index is less than or equal to the SK segment maximum, processing should continue with the next entry, otherwise SK table processing should complete
[Increment memory displacement pointer]
The entry is ready to be stored in memory → The system increments the displacement within segment counter by 1 to prepare the next memory position
[Memory segment overflow? DISPL-WITHIN-SEG-END > SK-SEGMENT-MAX]
The displacement within segment end value exceeds the SK segment maximum limit → The system identifies that a segment overflow condition exists
[Reset displacement to 1 Create new segment]
The system needs to allocate space for the current SK entry → The system resets displacement within segment to 1 and increments the segment number by 1
[Move SK table entry to memory location SK-TBL-ENTRIES]
The system is ready to store the entry in memory → The system moves the SK table entry from the database segment to the SK-TBL-ENTRIES array at the current segment number and displacement position
[Memory Segment Overflow Check]
The displacement position counter is greater than the SK segment maximum capacity → A memory segment overflow condition is detected
[Reset Position to Start of New Segment]
A new memory segment needs to be created → The displacement position counter is reset to 1
[Increment Segment Number]
New segment initialization is in progress → The segment number counter is incremented by 1
[Move SK Entry to New Segment Position]
The SK table entry needs to be stored → The SK table entry from database segment is moved to the memory table at the new segment number and position 1
[Move SK Entry to Current Segment Position]
The SK table entry needs to be stored → The SK table entry from database segment is moved to the memory table at the current segment number and displacement position
[Copy MU Entry to Current Memory Position]
The entry contains valid data → The complete MU table entry should be copied to the current memory table position using the current segment number and displacement within segment
[Current Segment Full?]
The current displacement within segment exceeds the MU segment maximum capacity → A new memory segment should be created by resetting displacement to 1 and incrementing the segment number by 1
[Increment Position Counter]
The entry processing is complete → The displacement within segment counter should be incremented by 1 and the database index should be incremented by 1 to move to the next entry
[Memory Displacement > MU Segment Maximum?]
The displacement value exceeds the MU segment maximum capacity → The system triggers segment overflow handling to create a new memory segment
[Reset Displacement to 1, Create New Memory Segment]
The current segment cannot accommodate more entries → The system resets displacement to 1, increments segment number, and prepares new segment for data storage
[Move MU Entry to New Segment Location]
The MU table entry needs to be stored → The system moves the MU table entry from database segment to the new memory segment location using current segment number and displacement
[Move MU Entry to Current Segment Location]
The displacement is within segment maximum capacity → The system moves the MU table entry from database segment to current memory segment location using current segment number and displacement
[Increment memory position counter]
The entry is ready for memory allocation → The displacement within segment counter is incremented by 1
[Reset position to 1 in new segment, Reset position to 1 for new segment]
A new memory segment needs to be created → The displacement within segment counter is reset to 1
[Create new memory segment]
A new segment is required for MU table entries → The segment number counter is incremented by 1 to create a new segment
[Move MU table entry to new segment position]
The MU table entry needs to be stored → The MU table entry from database segment is moved to the new segment at the current position
[Move MU table entry to current segment position]
No segment overflow condition exists → The MU table entry from database segment is moved to the current segment at the current position
[Increment position within current segment]
The DC table entry ID field is not empty (contains valid data) → Increment the displacement within the current segment by 1 to prepare the next available position
[Current segment full?]
The displacement within the current segment exceeds the DC segment maximum capacity → Reset the displacement to 1 and increment the segment number by 1 to create a new segment
[Move DC table entry to memory location]
The entry needs to be loaded into memory → Move the DC table entry from the database segment to the memory table at the current segment number and displacement position
[Increment Memory Position Counter]
The entry is ready for memory allocation → The system increments the memory position counter within the current segment to prepare for data placement
[Memory Segment Full?]
The memory position exceeds the maximum allowed entries per DC segment → The system identifies that a new memory segment is required for data storage
[Reset Position to Start of New Segment]
A new segment is required for data storage → The system resets the memory position counter to 1 to start at the beginning of the new segment
[Increment Segment Number]
The position counter has been reset to start of new segment → The system increments the segment number by 1 to maintain sequential segment organization
[Copy DC Entry to New Segment Position]
A valid DC table entry needs to be stored → The system copies the DC table entry from database segment to the new memory segment at the current position
[Copy DC Entry to Current Position]
A valid DC table entry needs to be stored and segment is not full → The system copies the DC table entry from database segment to the current memory segment at the current position
[Increment memory position counter]
The DC table entry contains valid identification data → The displacement within segment counter is incremented by 1 to prepare for data placement
[Create new memory segment]
Current segment cannot accommodate more entries → Displacement within segment is reset to 1 and segment number is incremented by 1
[Move DC table entry to new segment position]
Segment overflow condition exists → DC table entry data is moved from database segment to new memory segment position using current segment number and displacement, and database index is incremented
[Move DC table entry to current segment position]
Displacement within segment does not exceed DC segment maximum capacity → DC table entry data is moved from database segment to current memory segment position using current segment number and displacement, and database index is incremented
[Increment displacement within segment]
The entry is ready to be processed for loading into memory → The displacement within the current segment should be incremented by 1
[Segment overflow - displacement > SS-SEGMENT-MAX?]
The displacement exceeds the maximum allowed entries per SS segment → Segment overflow processing should be initiated
[Create new segment]
Segment overflow is detected → A new segment should be created by resetting displacement to 1 and incrementing the segment number
[Move SS table entry to memory location]
The entry is ready to be loaded into memory → The SS table entry should be moved to the memory table at the current segment number and displacement position
[Increment Memory Displacement Pointer]
The entry validation confirms the entry contains data → The displacement within segment counter DISPL-WITHIN-SEG-END is incremented by 1
[Reset Displacement to 1]
A new memory segment needs to be allocated → The displacement counter DISPL-WITHIN-SEG-END is reset to 1
[Create New Memory Segment]
A new memory segment allocation is required → The segment number SEG-NO-END is incremented by 1 to create a new segment
[Move SS Table Entry to New Segment Location]
The SS table entry needs to be stored in memory → The SS table entry GCSTBDP-SS-TABLE-ENTRY at current DB-IDX is moved to SS-TBL-ENTRIES at the new segment and displacement position
[Move SS Table Entry to Current Segment Location]
The SS table entry needs to be stored in memory → The SS table entry GCSTBDP-SS-TABLE-ENTRY at current DB-IDX is moved to SS-TBL-ENTRIES at the current segment and displacement position
[Increment Table Index]
The entry processing is completed → The database index DB-IDX is incremented by 1 to proceed to the next table entry
[Increment memory position counter]
Memory space needs to be allocated for the entry → The displacement within segment counter is incremented by 1
[Create new memory segment - increment segment number]
A new memory segment is required for SS table entries → The segment number counter is incremented by 1 to create the new segment
[Move SS table entry to new segment position]
SS table entry data needs to be stored in memory → The SS table entry from database segment is moved to the SS memory table at the new segment number and position 1
[Move SS table entry to current segment position]
SS table entry data needs to be stored in memory → The SS table entry from database segment is moved to the SS memory table at current segment number and displacement position
[Is current ID entry empty?]
The ID field of the current entry does not contain SPACE → The entry should be processed for loading into the memory table and the displacement pointer should be incremented
[Increment displacement pointer]
The entry is ready to be loaded into memory → The displacement within segment counter should be incremented by 1
[Reset displacement to 1]
A segment overflow condition is detected → The displacement within segment should be reset to 1 and the segment number should be incremented by 1
[Move ID entry to new segment position]
The displacement has been reset to 1 and segment number incremented → The current ID table entry should be moved to the new segment at the first position
[Move ID entry to current segment position]
The displacement within segment does not exceed the maximum allowed entries → The ID table entry should be moved to the current segment at the current displacement position
[Increment database index]
The entry processing is complete → The database index should be incremented by 1 to move to the next entry in the database segment
[More ID entries to process?]
The database index is still less than or equal to the ID segment maximum → Processing should continue with the next ID table entry
[ID Table Processing Complete]
The database index exceeds the ID segment maximum → The ID table processing should be marked as complete and control should return to the calling process
[Increment memory position counter]
The entry is ready to be loaded into memory → The displacement within segment counter should be incremented by 1 to point to the next available memory position
[Memory segment full?]
The displacement within segment exceeds the ID segment maximum capacity → The system should initiate creation of a new memory segment
[Copy ID entry to new segment position]
The ID table entry needs to be stored → The entry should be copied to the ID table entries array at the new segment number and position 1
[Copy ID entry to current segment position]
A valid ID table entry needs to be stored → The entry should be copied to the ID table entries array at the current segment number and displacement position
[Move to next database entry]
The current entry processing is complete → The database index should be incremented by 1 to point to the next entry in the database segment
[Memory segment overflow check - position > ID-SEGMENT-MAX?]
The system checks if the displacement position is greater than ID-SEGMENT-MAX → The system determines whether current segment has overflowed and requires creation of a new segment
[Create new memory segment]
The system handles the overflow condition → The system resets displacement position to 1 and increments segment number by 1 to create new segment space
[Copy ID table entry to new segment position]
The system copies the ID table entry data → The system moves the ID table entry from database segment to the new memory segment at position 1 and increments database index by 1
[Copy ID table entry to current segment position]
The system copies the ID table entry data → The system moves the ID table entry from database segment to current memory segment at current displacement position and increments database index by 1
[Is DB-IDX > VI-SEGMENT-MAX?]
The database index exceeds the maximum number of entries allowed in a VI segment → The VI table processing should be marked as complete and exit the processing loop
[Move VI table entry to current segment position]
The displacement within the segment does not exceed the VI segment maximum capacity → The VI table entry should be moved to the current segment position and the database index should be incremented
[Does displacement exceed VI segment maximum?]
The displacement within the segment exceeds the maximum allowed entries for a VI segment → Segment overflow handling should be triggered to create a new segment
[Reset displacement to 1, Create new segment - Increment segment number, Move VI table entry to new segment position]
Segment overflow is detected during VI table entry processing → The displacement should be reset to 1, a new segment should be created by incrementing the segment number, the VI table entry should be moved to the new segment position, and the database index should be incremented
[Increment displacement within segment]
The entry is not empty and needs to be loaded into the current segment → The displacement within the current segment should be incremented to prepare for the next available position
[Increment Memory Position Counter]
The system prepares to store the VI entry in memory → The displacement within segment counter is incremented by 1 to allocate the next available memory position
[Reset Memory Position to 1]
The system needs to allocate space for a new VI table entry → The displacement within segment is reset to 1 to start positioning entries in the new segment
[Create New VI Memory Segment]
The system needs to allocate a new memory segment for VI table entries → The segment number counter is incremented by 1 to create a new VI memory segment
[Copy VI Entry to New Segment Position]
The system stores the current VI table entry from the database segment → The VI table entry is moved from the database segment to the VI memory table at the new segment number and displacement position
[Copy VI Entry to Current Segment Position]
The system stores the current VI table entry from the database segment → The VI table entry is moved from the database segment to the VI memory table at the current segment number and displacement position
[Memory Segment Overflow Check - Position > VI Segment Maximum?]
The current memory position exceeds the maximum VI segment capacity → The system detects segment overflow condition requiring new segment creation
[Reset Position to 1 in New Segment]
A new memory segment needs to be created for VI table data → The system resets the memory position to 1 and increments the segment number by 1
[Move VI Table Entry to New Segment Position]
VI table entry data needs to be stored in the new segment → The system moves the VI table entry from database segment to the new memory segment at position 1
[Move VI Table Entry to Current Segment Position]
The memory position is within the VI segment maximum limits → The system moves the VI table entry from database segment to current memory segment at the current position
[Move KS table entry to in-memory table structure]
The entry is ready to be loaded into memory → The KS table entry should be moved to the in-memory KS table structure at the calculated segment and displacement position, and the database index should be incremented
[Increment displacement within segment]
The entry needs to be positioned within the current segment → The displacement within segment counter should be incremented by 1 to determine the next available position
[Segment overflow check - displacement > KS-SEGMENT-MAX?]
The displacement within segment exceeds the KS segment maximum capacity → A new segment should be created by resetting displacement to 1 and incrementing the segment number by 1
[More entries to process - DB-IDX <= KS-SEGMENT-MAX?]
The database index is within the valid range of KS segment maximum → Processing should continue to the next entry, otherwise KS table processing should be completed
[Increment Memory Position Counter]
The system prepares to store the entry in memory → The displacement within segment counter is incremented by 1 to allocate the next available memory position
[Memory Segment Full?]
The system checks the current segment capacity → If the displacement within segment exceeds the KS segment maximum limit, the segment is considered full
[Reset Position to 1, Allocate New Memory Segment]
The system needs to store additional KS table entries → The displacement within segment is reset to 1 and the segment number is incremented by 1 to create a new memory segment
[Copy KS Entry to Current Memory Position]
The system performs data transfer operation → The complete KS table entry is moved from the database segment to the KS table entries array at the specified segment and displacement position
[Increment Database Index]
The system completes the current entry processing → The database index is incremented by 1 to point to the next KS table entry in the database segment
[Create new memory segment]
The system needs to allocate additional memory space → A new memory segment is created by resetting the displacement to 1 and incrementing the segment number by 1
[Move KS table entry to new segment position]
The system stores the current KS table entry → The KS table entry from the database is moved to the KS table entries array at the new segment number and displacement position
[Move KS table entry to current segment position]
The system stores the current KS table entry → The KS table entry from the database is moved to the KS table entries array at the current segment number and displacement position
[Increment Position in Current Segment]
The DS table entry ID field contains valid data (not spaces) → Increment the displacement within the current segment by 1 to prepare for data placement
[Current Segment Full?]
The displacement within segment exceeds the DS segment maximum capacity → Trigger segment overflow handling to create a new segment
[Reset Position to 1]
Segment overflow condition is detected → Reset displacement within segment to 1 and increment the segment number by 1 to create a new segment
[Move DS Table Entry to Memory Location]
The memory segment and position are available for data placement → Move the DS table entry from the database segment to the DS memory table at the specified segment and displacement position
[Increment Memory Displacement Pointer]
The entry needs to be stored in memory → The memory displacement pointer is incremented by 1 to allocate the next position within the current segment
[Memory Segment Full? DISPL-WITHIN-SEG-END > DS-SEGMENT-MAX]
The displacement within segment exceeds the DS segment maximum capacity → The system determines that a new memory segment must be created
[Create New Memory Segment Reset displacement to 1 Increment segment number]
A new DS table entry needs to be stored → The displacement pointer is reset to 1 and the segment number is incremented by 1 to create a new segment
[Move DS Table Entry to Memory Location DS-TBL-ENTRIES at current position]
The entry data needs to be transferred to memory → The DS table entry is moved to the DS-TBL-ENTRIES array at the position specified by current segment number and displacement
[Increment Memory Position Counter]
The system begins memory allocation for the entry → The displacement within segment counter is incremented by 1
[Check if Memory Segment is Full]
The displacement within segment value is greater than DS-SEGMENT-MAX → The current memory segment is identified as full and requires overflow handling
[Reset Position to 1 in New Segment]
A new segment needs to be created for additional entries → The displacement within segment counter is reset to 1
[Increment Segment Number]
The system creates a new memory segment for DS table entries → The segment number counter is incremented by 1
[Move DS Entry to New Segment Position]
The DS table entry needs to be stored in memory → The DS table entry from the database segment is moved to the DS memory table at the new segment and position coordinates
[Move DS Entry to Current Segment Position]
The DS table entry needs to be stored in memory → The DS table entry from the database segment is moved to the DS memory table at the current segment and position coordinates
[Increment displacement within segment]
The entry is ready to be processed and loaded into memory → The displacement within the current segment should be incremented by 1 to point to the next available memory position
[Does displacement exceed S1 segment maximum?]
The displacement position exceeds the predefined S1 segment maximum capacity → The system should reset the displacement to 1 and increment the segment number by 1 to create a new segment for continued data loading
[Move S1 table entry to memory location]
The entry needs to be loaded into memory → The system should move the S1 table entry from the database segment to the memory table at the position specified by the current segment number and displacement
[Increment Memory Position Counter]
The entry needs to be allocated to a memory position → The displacement within segment counter is incremented by 1 to reserve the next available position
[Reset Position to 1 in New Segment]
A new segment needs to be allocated for additional entries → The displacement within segment is reset to 1 to start at the beginning of the new segment
[Increment Segment Number]
A new segment is being allocated for S1 table overflow → The segment number is incremented by 1 to identify the new segment
[Move S1 Entry to New Segment Position]
An S1 table entry needs to be stored in memory → The S1 table entry is moved from the database segment to the new segment position using the current segment number and displacement coordinates
[Move S1 Entry to Current Segment Position]
An S1 table entry needs to be stored in memory → The S1 table entry is moved from the database segment to the current segment position using the existing segment number and displacement coordinates
[Increment Database Index]
The current entry processing is complete → The database index is incremented by 1 to point to the next S1 entry in the database segment
[Reset displacement to 1]
A new segment needs to be allocated → The displacement within segment is reset to 1
[Increment segment number]
A new segment is being allocated → The segment number is incremented by 1
[Move S1 table entry to new segment position]
An S1 table entry needs to be stored → The S1 table entry from database segment is moved to the memory table at the new segment and displacement position
[Move S1 table entry to current segment position]
An S1 table entry needs to be stored → The S1 table entry from database segment is moved to the memory table at the current segment and displacement position
[Increment DB index]
The entry processing is complete → The database index is incremented by 1 to proceed to the next entry
[Increment Memory Position Counter]
The entry is ready to be loaded into memory → Increment the displacement within segment counter by 1 to prepare the next memory position
[Memory Position Exceeds Segment Limit?]
The displacement within segment counter exceeds the ST segment maximum limit → Reset the displacement counter to 1 and increment the segment number by 1 to create a new memory segment
[Copy ST Table Entry to Memory Location]
The entry needs to be loaded into the application memory table → Copy the complete ST table entry from the database segment to the ST memory table at the current segment number and displacement position
[Move to Next Entry Index]
Processing of the current entry is complete → Increment the database index by 1 to move to the next ST table entry in the segment
[Increment Memory Position Counter]
The system prepares to store the entry in memory → The system increments the displacement within segment counter by 1
[Memory Position Exceeds ST Segment Maximum?]
The system checks if the displacement within segment exceeds the ST segment maximum capacity → The system determines whether to use the current segment or allocate a new segment
[Reset Memory Position to 1, Allocate New Memory Segment]
The system needs to store an ST table entry → The system resets the displacement within segment to 1 and increments the segment number by 1
[Copy ST Entry to Memory Location]
The system processes the ST table entry for storage → The system moves the ST table entry from the database segment to the ST memory table at the specified segment number and displacement position
[Valid ST entry found - increment memory position]
The system processes the valid entry → The system increments the displacement within segment counter by 1 to prepare for memory allocation
[Memory segment overflow check - position > ST-SEGMENT-MAX?]
The system checks if the displacement within segment exceeds the State table segment maximum capacity → The system determines whether a new memory segment needs to be created or the entry can fit in the current segment
[Create new memory segment - reset position to 1]
The system needs to allocate memory for the State table entry → The system resets the displacement within segment to 1 to start a new segment
[Move ST table entry to new segment position]
The system allocates memory for the State table entry → The system moves the State table entry from the database segment to the memory table at the new segment number and position 1
[Move ST table entry to current segment position]
The system allocates memory for the State table entry → The system moves the State table entry from the database segment to the memory table at the current segment number and displacement position
[Increment DB index to next entry]
The memory allocation is complete → The system increments the database index by 1 to point to the next State table entry for processing
[Set Initial End Pointers - SEG-NO-END = 1, DISPL-WITHIN-SEG-END = 0]
Setting up navigation control variables → Segment number is set to 1 and displacement within segment is set to 0
[Increment Displacement Pointer]
Preparing to place the entry in the in-memory table → The displacement within segment counter is incremented by 1
[Reset Displacement to 1]
Managing segment overflow → The displacement within segment is reset to 1
[Increment Segment Number]
Continuing segment overflow management → The segment number is incremented by 1
[Move Table Entry to New Segment Position in GCWTABLE]
Placing the table entry in memory → The table entry is moved to the position defined by the new segment number and displacement of 1
[Move Table Entry to Current Position in GCWTABLE]
Placing the table entry in memory → The table entry is moved to the position defined by current segment number and displacement
[Increment Database Index]
Continuing database segment traversal → The database index is incremented by 1
[More Entries to Process?]
Evaluating continuation of processing loop → If database index is less than or equal to the segment maximum for the table type, more entries exist to process
[Set Final End Pointers for Table Navigation]
Completing the table population for this segment → The final segment number and displacement values are preserved as end pointers for table navigation

Structural Validations

[Table ID Validation - Validates if the requested table ID is one of the supported table types]
The system checks if the table ID matches any of the supported table types (AD, DR, LT, MC, MS, SC, SE, US, AU, AC, BK, CC, CT, RF, SD, SK, MU, DC, SS, ID, VI, KS, DS, S1, ST) → If the table ID matches any supported type, proceed with table loading process, otherwise set error message and call error handler
[Dummy Root Creation Failed - Error]
The system processes the creation failure → The system moves TABLE-ID to ERROR-TABLE2, sets GCX004LD-ERROR-MSG2 to CC-ERROR-MESSAGE, and calls CERR error handler
[Report dummy root creation error]
The system detects the insertion was unsuccessful → The system should set the table identifier in the error field, set the appropriate error message, and call the error handling routine
[Invalid Table Type Error]
The TABLE-ID does not match any of the 25 supported table types (AD, DR, LT, MC, MS, SC, SE, US, AU, AC, BK, CC, CT, RF, SD, SK, MU, DC, SS, ID, VI, KS, DS, S1, ST) → The system should set the invalid table ID in error message field and invoke error handling routine
[Is AD Entry ID Empty?]
The AD entry ID field contains only spaces → The entry should be skipped and the processing index should move to the next entry
[Is AD Table Entry ID empty?]
The AD table entry ID field contains only spaces → The entry should be skipped and the database index should be incremented to move to the next entry
[Memory segment full?]
The displacement pointer exceeds the AD segment maximum capacity → The system should identify that a new memory segment is required
[Is AD Entry ID empty/space?]
The AD entry identifier is empty or contains only spaces → The system skips the entry and moves to the next database index position without loading any data to memory
[Is DR table entry ID empty?]
The DR table entry ID field contains only spaces → The entry should be skipped and the processing index should move to the next entry
[Is DR-ID empty/SPACE?]
The system checks the DR-ID field of the entry → If the DR-ID field is empty or contains spaces, the entry is considered invalid and should be skipped
[Is GCSTBDP-LT-ID empty?]
The LT-ID field of the current entry contains only spaces → The entry should be skipped and the database index should be incremented to move to the next entry
[Is LT Entry ID empty/space?]
The system checks the LT entry ID field for empty or space values → The system identifies the entry as invalid if ID equals SPACE and skips processing, or identifies as valid if ID contains data
[Is MC Entry ID Empty?]
The MC entry ID field contains only spaces (is empty) → The entry should be skipped and the processing index should advance to the next entry without loading any data
[Current Segment Full?]
The displacement exceeds the maximum allowed entries per MC segment → The system should recognize that the current segment is full and requires overflow handling
[Is MC Table Entry ID Empty?]
The MC table entry ID field equals SPACE → The entry is identified as empty and should be skipped without processing
[Is MS entry ID empty/space?]
The MS entry ID field contains only spaces or is empty → The entry should be skipped and the processing should advance to the next entry position
[Memory segment overflow check - position > MS-SEGMENT-MAX?]
The system checks the current displacement within segment value → If the displacement within segment exceeds the MS segment maximum capacity, a segment overflow condition exists
[Is MS Table Entry ID empty?]
The MS table entry ID at the current database index position equals SPACE → The entry is considered empty and should be skipped without loading into memory
[Is SC table entry ID empty?]
The SC table entry ID field contains only spaces → The entry should be skipped and the database index should be incremented to move to the next entry
[Is SC Table Entry ID empty?]
The system checks the SC table entry ID field → If the ID field is empty (SPACE), the entry is skipped and the database index is incremented to move to the next entry
[Is SC Table Entry Empty?]
The SC-ID field of the current entry contains only spaces → The entry is skipped and the processing index is incremented to move to the next entry
[Is SE table entry ID empty?]
The SE table entry ID field contains only spaces (is empty) → The entry processing is skipped and the database index is incremented to move to the next entry
[Is SE table entry ID empty?]
The SE table entry ID field contains valid data (is not empty spaces) → The entry is processed for loading into the appropriate memory segment location
[Is SE Table Entry ID Empty?]
The SE table entry ID field equals SPACE (empty) → The entry is considered invalid and should be skipped without loading into memory
[Is SE Table Entry Empty?]
The SE table entry ID field contains SPACE value → The entry should be skipped and the database index should be incremented to move to the next entry
[Is US Table Entry ID empty?]
The US table entry ID field contains only spaces (empty) → Skip processing this entry and move to the next entry index without loading any data
[Check Memory Segment Capacity]
The system checks if the displacement within segment exceeds the AU segment maximum capacity → If displacement is greater than AU-SEGMENT-MAX, the current segment is considered full and requires a new segment
[Does displacement exceed AU segment maximum?]
The displacement within segment exceeds the AU segment maximum limit → A segment overflow condition is detected
[Is AC-ID empty/space?]
The AC-ID field contains only spaces or is empty → The entry should be skipped and the database index should be incremented to move to the next entry
[Does displacement exceed AC segment maximum?]
The system checks the current displacement value against the AC segment maximum limit → If the displacement exceeds the AC segment maximum capacity, a new segment allocation is required
[Is BK Entry ID Empty?]
The BK entry ID field contains only spaces (empty) → The entry should be skipped and the processing index should advance to the next entry without loading any data
[Is BK Entry ID Empty?]
The system checks the BK entry ID field → If the BK entry ID equals SPACE, the entry is considered empty and should be skipped
[Memory Segment Overflow Check - Position > BK-SEGMENT-MAX?]
The system checks the current memory position against the segment limit → If the displacement within segment exceeds BK-SEGMENT-MAX, a segment overflow condition is detected
[Is CC Entry ID Empty?]
The CC entry ID field contains only spaces (is empty) → The entry should be skipped and the processing index should move to the next entry without loading any data
[Is CC Entry ID Empty?]
The CC entry ID field contains non-space characters (is not empty) → The entry should proceed to position increment and memory loading processing
[Memory Segment Full? Displacement > CC-SEGMENT-MAX]
The system checks the current segment capacity → If the displacement within segment exceeds the CC segment maximum limit, the current segment is considered full
[Is CC Table Entry ID empty?]
The CC table entry ID field equals SPACE → The entry is considered empty and should be skipped without loading into memory
[Memory Segment Overflow Check - Position > CT-SEGMENT-MAX?]
If the current memory position → If displacement within segment is greater than CT-SEGMENT-MAX, a segment overflow condition exists
[Is RF Entry ID Empty?]
The RF entry ID field contains only spaces → The entry is skipped and the database index is incremented to move to the next entry
[Memory Segment Full?]
The displacement within segment exceeds the RF segment maximum capacity → A new memory segment allocation is required
[Check if SD Entry ID is Empty]
The SD entry ID field equals SPACE → The entry is considered empty and should be skipped without loading into memory
[Check if Current Segment is Full]
The displacement within segment exceeds the SD segment maximum capacity → The current segment is considered full and a new segment must be allocated
[Is SK Entry ID Empty?]
The SK entry ID field contains only spaces (is empty) → The entry should be skipped and the processing index should advance to the next entry without loading any data
[Is SK-ID entry empty/SPACE?]
The SK-ID field at the current database index position equals SPACE → The system skips processing this entry and moves to the next database index position
[Is SK Entry ID Empty?]
The SK entry ID field equals SPACE → The entry is considered empty and should be skipped without processing
[Is MU Entry ID Empty?]
The MU entry ID field contains only spaces (is empty) → The entry should be skipped and the processing index should move to the next entry without loading any data
[Is MU Table Entry ID = SPACE?]
The MU table entry ID field contains only spaces → The system skips processing this entry and increments the database index to move to the next entry
[Is MU Table Entry ID empty?]
The MU table entry ID field equals SPACE → The entry is considered empty and should be skipped without processing
[Memory segment overflow check - Position > MU-SEGMENT-MAX?]
The displacement within segment counter exceeds MU-SEGMENT-MAX → A memory segment overflow condition is detected
[Is DC table entry ID empty?]
The DC table entry ID field contains only spaces (is empty) → Skip processing this entry and move to the next entry index without loading any data
[Is DC Entry ID Empty?]
The DC entry ID field is empty (contains spaces) → The system skips processing this entry and moves to the next database entry without allocating memory space
[Memory segment overflow check - Position > DC-SEGMENT-MAX?]
The displacement within segment counter exceeds the DC segment maximum capacity → Memory segment overflow condition is detected requiring new segment creation
[Is SS table entry ID empty?]
The SS table entry ID field contains only spaces → The entry should be skipped and the database index should be incremented to move to the next entry
[Memory Displacement > SS Segment Maximum?]
The displacement counter is compared against SS-SEGMENT-MAX → If displacement exceeds the segment maximum, segment overflow condition is identified
[Is SS Table Entry ID empty?]
The SS table entry ID field equals SPACE (empty) → The entry is considered invalid and should be skipped without processing
[Memory segment overflow check - Position > SS-SEGMENT-MAX?]
The displacement within segment counter is greater than SS-SEGMENT-MAX → A memory segment overflow condition is detected requiring new segment creation
[Is current ID entry empty?]
The ID field of the current entry contains SPACE → The entry should be skipped and the database index should be incremented to move to the next entry
[Segment overflow check - displacement > ID-SEGMENT-MAX?]
The displacement within segment exceeds the maximum allowed entries for ID segments → A segment overflow condition should be detected requiring creation of a new segment
[Is ID entry empty/space?]
The ID field of the current entry contains only spaces → The entry should be skipped and the database index should be incremented to move to the next entry
[Is ID entry empty/space?]
The system checks if the ID field of the entry equals SPACE → The system identifies the entry as empty and skips data processing while incrementing the database index to move to next entry
[Memory Position Exceeds VI Segment Limit?]
The system checks if the displacement within segment exceeds the VI segment maximum capacity → If displacement within segment is greater than VI-SEGMENT-MAX, a new memory segment is required
[Is VI Table Entry ID Empty?]
The VI table entry ID field contains only spaces → The system skips the empty entry and advances to the next database index without processing
[Is KS Entry ID Empty?]
The system checks the KS entry ID field → If the KS entry ID equals SPACE, the entry is considered empty and should be skipped
[Memory segment overflow check - displacement > KS-SEGMENT-MAX?]
If the current memory segment capacity → If the displacement within segment exceeds the KS segment maximum limit, a segment overflow condition is detected
[Is DS Table Entry ID empty?]
The DS table entry ID field contains only spaces (empty) → Skip processing this entry and move to the next entry index without loading any data
[Is DS-ID empty/SPACE?]
The DS-ID field of the current entry is empty or contains spaces → The entry is skipped and the database index is incremented to move to the next entry
[Check if S1 Entry ID is Empty]
The S1 entry ID field equals SPACE (empty) → The entry is marked as invalid and the database index is incremented to skip this empty entry
[Valid S1 Entry Found]
The S1 entry ID field contains actual data (not SPACE) → The entry is identified as valid and ready for memory position allocation
[Check if Current Segment is Full]
The displacement within segment exceeds the S1 segment maximum capacity → The current segment is identified as full and requires overflow to a new segment
[Is S1 table entry ID empty?]
The S1 table entry ID field equals SPACE → The entry is considered empty and should be skipped without processing
[Does displacement exceed S1 segment maximum?]
The displacement within segment exceeds the S1 segment maximum limit → A segment overflow condition is detected requiring new segment allocation
[Is ST Table Entry ID empty?]
The ST table entry ID field contains only spaces (is empty) → Skip processing this entry and move to the next entry index without loading any data
[Is Table Entry Empty?]
The system examines the entry's ID field → If the ID field equals SPACE, the entry is considered empty and should be skipped
[Segment Overflow Check - Displacement > Segment Maximum?]
Checking segment capacity constraints → If displacement exceeds the table-specific segment maximum, segment overflow condition is triggered

Module: GCX004UP 1 Consolidated Epic Story

Epic: GCX004UP Complete EDI Specification Extracted from Legacy

Contains 278 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX004UP EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Retrieval Parameters]
The system needs to set up retrieval parameters → The system clears flags, sets function code to GU (Get Unique), sets segment name to root, and determines key type based on U1 indicator (U1 if indicator is '9', otherwise uses table ID)
[Initialize X12 Settings for New Broker]
The broker table formatting process is initiated for BK table type → The system should set the function description to ADD and prepare empty X12 EDI configuration fields for user input
[Initialize Counterpart Code Processing]
The system begins counterpart code validation processing → The system sets the output select code to TABLE-DC-UPDATE-SCREEN, clears the screen message, and copies the disposition code key to the screen

Core Acceptance Criteria

[1:Main Control Routing - Extract table ID and function from input message]
If the table ID from the input message → The request is routed to the corresponding table-specific processing module or error handling if table ID is invalid
[3:Admin Table Maintenance - Format update screens for Admin table]
The system processes the function code for Admin table → Screen fields are formatted appropriately - ADD shows empty form, MOD populates editable fields, DEL/EXPAND populate protected fields with confirmation messages
[7:Message System Table Maintenance - Format update screens for Message System table]
The system processes the function code for Message System table → Screen fields for English text, error type, and notes are formatted based on function type with appropriate protection
[17:Broker Additional Info Retrieval - Retrieve additional broker segment information]
The system retrieves B1 segment data → Additional broker information including info fields and internet address are retrieved or initialized to spaces if segment not found
[24:Disposition Code Table Maintenance - Format update screens for Disposition Code table]
The system processes the function code for Disposition Code table → Screen fields for disposition description, quantity action, location, process type, Merlin messages, and 10 counterpart disposition codes with matching methods are formatted based on function type
[Extract Table ID from Input Message]
The system processes the input message → The table ID is extracted from the GCMTB-TABLE-ID field and stored in working storage for routing decisions
[Extract Function Code from Input Message]
The system processes the input message → The function code is extracted from the GCMTB-FUNCTION field and stored in working storage for operation type determination
[Copy Input Message to Output Message]
The system begins processing the request → The complete input message is copied to the output message structure to maintain data integrity
[Route to Message System Processing - MS]
The table ID equals MS-TABLE-ID → The system routes the request to D050-FORMAT-MS-UPDATE section for message system table processing
[Set Message Number as Key]
The system needs to retrieve message table data → The system uses GCM49-MESSAGE-NUM as the table root key value
[Call Database Retrieval Function]
The system needs to retrieve data from the database → The system calls 'GCCTBIO' with the communication area, flags, function code, segment name, table key, and retrieval parameters
[Move Retrieved Data to Working Storage]
The return flag indicates successful retrieval → The system moves the retrieved table segment to GCSTBRT working storage and clears the U1 indicator if it was set to '9'
[Set Screen Code to Admin Update Screen]
System processes admin table request → Screen code is set to admin update screen and screen message is cleared
[Apply Protection to All Fields]
DEL function is being processed → All admin fields are made non-editable and display current values only
[Set Confirmation Message]
DEL function processing is complete → System message is set to confirm delete operation
[Apply Protection to All Fields]
EXPAND function is being processed → All admin fields are made non-editable and display current values only
[Set Expand Message]
EXPAND function processing is complete → System message is set to view only mode
[Extract Admin ID from Input Message]
The system processes the admin table update request → The Admin ID is extracted from the input message and stored for database key construction
[Set Database Key with Admin ID]
The system prepares to retrieve admin table data from the database → The Admin ID is moved to the table root key value for database access
[Apply Field Protection to All Merlin Settings]
The system prepares the delete confirmation screen → All Merlin configuration fields are set to protected status to prevent editing
[Apply Protection to Timing Parameters]
The system sets up delete confirmation → All timing parameters including purge days, warning days, and escalation hours are protected from editing
[Apply Protection to Communication Flags]
The system sets up delete confirmation → All communication flags including auto FAX, system Merlin FAX, and X400 settings are protected from editing
[Set Confirmation Message]
The system completes delete preparation → The system message number is set to the confirm delete message number
[Set Expand Message]
The system completes expand view preparation → The system message number is set to the expand message number
[Load DC Processing Merlin ID 1 from Database]
The system retrieves the current DC record from the database → The system loads and displays DC processing Merlin ID 1 value in an editable format
[Load DC Processing Merlin ID 2 from Database]
The system retrieves the current DC record from the database → The system loads and displays DC processing Merlin ID 2 value in an editable format
[Load DC Processing Merlin ID 3 from Database]
The system retrieves the current DC record from the database → The system loads and displays DC processing Merlin ID 3 value in an editable format
[Load DC Processing Merlin ID 4 from Database]
The system retrieves the current DC record from the database → The system loads and displays DC processing Merlin ID 4 value in an editable format
[Load DC Processing Merlin ID 5 from Database]
The system retrieves the current DC record from the database → The system loads and displays DC processing Merlin ID 5 value in an editable format
[Display DC Processing Merlin ID 1 - Protected Mode]
The system retrieves the current DC record for deletion confirmation → The system displays DC processing Merlin ID 1 value in protected non-editable mode
[Display DC Processing Merlin ID 2 - Protected Mode]
The system retrieves the current DC record for deletion confirmation → The system displays DC processing Merlin ID 2 value in protected non-editable mode
[Display DC Processing Merlin ID 3 - Protected Mode]
The system retrieves the current DC record for deletion confirmation → The system displays DC processing Merlin ID 3 value in protected non-editable mode
[Display DC Processing Merlin ID 4 - Protected Mode]
The system retrieves the current DC record for deletion confirmation → The system displays DC processing Merlin ID 4 value in protected non-editable mode
[Display DC Processing Merlin ID 5 - Protected Mode]
The system retrieves the current DC record for deletion confirmation → The system displays DC processing Merlin ID 5 value in protected non-editable mode
[Set Confirmation Message for DC Processing Deletion]
The system completes the deletion preparation process → The system sets the confirmation delete message number to prompt user for deletion confirmation
[Set Expand View Message for DC Processing]
The system completes the expand preparation process → The system sets the expand message number to indicate detailed view mode
[Set DR Update Screen]
The system processes the DR table maintenance request → The output select code is set to TABLE-DR-UPDATE-SCREEN and screen message is cleared
[Extract Destination Range Name from Input]
The system processes the DR table maintenance request → The destination ID from input is moved to the range name field on the screen
[Set Confirmation Delete Message]
The system completes the deletion screen setup → The system message number is set to CONFIRM-DELETE-MSG-NUM
[Set Expand View Message]
The system completes the expansion screen setup → The system message number is set to EXPAND-MSG-NUM
[Set LTERM Update Screen]
The LTERM table maintenance process begins → The system sets the output screen code to LTERM update screen and clears any existing screen messages
[Move LTERM ID to Screen]
The LTERM maintenance screen is being prepared → The system displays the LTERM ID on the screen for user identification
[Set Function Description to DELETE]
Processing LTERM table maintenance request → The system sets the function description to DELETE, retrieves the existing LTERM record, populates the screen with current values, applies field protection to prevent editing, and sets a confirmation delete message
[Set Function Description to EXPAND]
Processing LTERM table maintenance request → The system sets the function description to EXPAND, retrieves the existing LTERM record, populates the screen with current values, applies field protection to prevent editing, and sets an expand message
[Apply Protection to Alternate LTERM Field]
Configuring screen field attributes → The system applies protection attributes to the alternate LTERM field to prevent user editing
[Apply Protection to Supervisor Merlin ID Field]
Configuring screen field attributes → The system applies protection attributes to the supervisor Merlin ID field to prevent user editing
[Set Confirm Delete Message]
Preparing the delete confirmation screen → The system sets the system message number to the confirm delete message to prompt user confirmation
[Set Expand Message]
Preparing the expand view screen → The system sets the system message number to the expand message to indicate view-only mode
[Copy Manifest ID to Screen]
The system initializes the screen fields → The manifest ID from input (GCM47-MANIF-ID) is copied to the screen field (GCM48-MANIF) and screen message is cleared
[Apply Protection to All Fields Make Fields Non-Editable]
The system applies field protection for DEL function → All screen fields are set to protected status (WS-NOCUR-PROTECT) making them non-editable: Canadian Customs Code, Sub-Location Code, US Station Exit, US Station Exit Code, Station Number, Merlin ID, Alternative Merlin ID, Import/Export Indicator, Print Batches Flag, Border Port, Call Letters, Vista Class SCAC, Vista Class FSAC, Set Clear Carload, and Set Clear Intermodal
[Set Confirmation Delete Message]
The system completes the delete screen setup → The system message number (SYSTEM-MSG-NUM) is set to CONFIRM-DELETE-MSG-NUM to prompt user confirmation
[Apply Protection to All Fields Make Fields Non-Editable]
The system applies field protection for EXPAND function → All screen fields are set to protected status (WS-NOCUR-PROTECT) making them non-editable: Canadian Customs Code, Sub-Location Code, US Station Exit, US Station Exit Code, Station Number, Merlin ID, Alternative Merlin ID, Import/Export Indicator, Print Batches Flag, Border Port, Call Letters, Vista Class SCAC, Vista Class FSAC, Set Clear Carload, and Set Clear Intermodal
[Set Expand Message for View-Only Mode]
The system completes the expand screen setup → The system message number (SYSTEM-MSG-NUM) is set to EXPAND-MSG-NUM to indicate view-only mode
[Start MC Record Retrieval]
The MC table format update process begins → The system should set the output screen code to MC update screen and clear any existing screen messages
[Extract Manifest ID from Input Message]
The system processes the MC table update request → The manifest ID should be extracted from the input message and assigned to the manifest field on the output screen
[Call Database Retrieval Function]
The function type is modify, delete, or expand → The system should call the database retrieval function to fetch the existing manifest code record
[Map All Retrieved Data to Screen Fields]
The function type is delete → All screen fields should be protected from user input and a delete confirmation message should be set
[Map All Retrieved Data to Screen Fields]
The function type is expand → All screen fields should be protected from user input and an expand message should be set
[Map SCAC to Screen Field]
The system processes the modify request for Vista Class parameters → The Vista Class SCAC value from the database is mapped to the corresponding screen field AND the Vista Class FSAC value from the database is mapped to the corresponding screen field AND both fields remain editable for modification
[Apply No-Cursor Protection to SCAC Field]
The system processes the delete request for Vista Class parameters → The Vista Class SCAC value from the database is displayed on screen AND the Vista Class FSAC value from the database is displayed on screen AND both SCAC and FSAC fields are protected with no-cursor protection AND a confirm delete message is set
[Apply Protection Attributes]
The system processes the expand request for Vista Class parameters → The Vista Class SCAC value from the database is displayed on screen AND the Vista Class FSAC value from the database is displayed on screen AND both SCAC and FSAC fields are protected with no-cursor protection AND an expand message is set
[Prepare Screen for New Entry]
The system processes the add request for Vista Class parameters → The Vista Class SCAC screen field is initialized as empty AND the Vista Class FSAC screen field is initialized as empty AND both fields remain editable for user input
[Set Protection Attributes for Vista Class Fields]
The existing record data is retrieved and populated to screen → Vista Class SCAC and Vista Class FSAC fields are set to protected mode to prevent editing
[Set MS Update Screen Code]
The system processes the table maintenance request → The system sets the output select code to TABLE-MS-UPDATE-SCREEN and clears any existing screen messages
[Extract Message Number from Input]
The system processes the input message → The system moves the message number from input field GCM49-MESSAGE-NUM to screen field GCM4A-MSG-ID
[Set Function Description to ADD]
The function code equals ADD-FUNCTION → The system sets the function description field GCM4A-FUNC-DESC to ADD-DESC
[Set Function Description to MOD]
The function code equals MOD-FUNCTION → The system sets the function description field GCM4A-FUNC-DESC to MOD-DESC
[Retrieve Message System Record from Database]
The function code equals MOD-FUNCTION → The system performs B110-RETRIEVE-ROOT to get the existing record data
[Populate English Text Field]
The record data is available from the database → The system moves GCSTBRT-MS-ENG-TEXT to screen field GCM4A-MSG-ENG-TEXT
[Populate Notes Field]
The record data is available from the database → The system moves GCSTBRT-MS-NOTES to screen field GCM4A-MSG-NOTES
[Set Function Description to DEL]
The function code equals DEL-FUNCTION → The system sets the function description field GCM4A-FUNC-DESC to DEL-DESC
[Retrieve Message System Record from Database]
The function code equals DEL-FUNCTION → The system performs B110-RETRIEVE-ROOT to get the existing record data
[Apply Field Protection - No Cursor Access]
The record data is populated on screen → The system moves WS-NOCUR-PROTECT to attribute fields GCM4A-MSG-ENG-TEXT-A, GCM4A-MSG-ERROR-TYPE-A, and GCM4A-MSG-NOTES-A
[Set Confirm Delete Message]
All delete preparation steps are completed → The system moves CONFIRM-DELETE-MSG-NUM to SYSTEM-MSG-NUM
[Set Function Description to EXPAND]
The function code equals EXPAND-FUNCTION → The system sets the function description field GCM4A-FUNC-DESC to EXP-DESC
[Retrieve Message System Record from Database]
The function code equals EXPAND-FUNCTION → The system performs B110-RETRIEVE-ROOT to get the existing record data
[Set Expand Message]
All expand preparation steps are completed → The system moves EXPAND-MSG-NUM to SYSTEM-MSG-NUM
[Set Station Code Update Screen]
The system processes the table maintenance request → The system sets the output screen code to Station Code update screen and clears any previous screen messages
[Copy Station ID to Screen]
The system initializes the screen fields → The station ID from the input message is copied to the station code field on the screen
[Set Function Description to DELETE]
The system processes the DEL function request → The system sets the function description to DELETE, retrieves existing data, populates all fields, applies field protection, and sets confirmation delete message
[Set Confirmation Delete Message]
The system finalizes the delete screen setup → The system message number is set to confirm delete message for user confirmation
[Set Function Description to EXPAND]
The system processes the EXPAND function request → The system sets the function description to EXPAND, retrieves existing data, populates all fields, applies field protection, and sets expand view message
[Set Expand View Message]
The system finalizes the expand screen setup → The system message number is set to expand message for user information
[Start Station Code Data Retrieval]
The system begins station code data retrieval processing → The system sets the output screen to TABLE-SC-UPDATE-SCREEN and clears the screen message area
[Extract Station Code ID from Input]
The system processes the station code update request → The system moves the station code ID to the screen field GCM4C-STATION-CODE for display
[Set Confirmation Message]
The system is finalizing the delete screen preparation → The system moves CONFIRM-DELETE-MSG-NUM to SYSTEM-MSG-NUM to display delete confirmation message
[Set Expand Message]
The system is finalizing the expand screen preparation → The system moves EXPAND-MSG-NUM to SYSTEM-MSG-NUM to display expand view message
[Set Confirmation Message for Delete]
The function type is DEL → The system should set CONFIRM-DELETE-MSG-NUM to SYSTEM-MSG-NUM to display deletion confirmation message
[Set Expand View Message]
The function type is EXPAND → The system should set EXPAND-MSG-NUM to SYSTEM-MSG-NUM to display expand view message
[Format for Modification - Enable All Fields]
The function type is MOD-FUNCTION → All fax fields remain editable without protection attributes applied
[Format for Delete - Protect All Fields]
The function type is DEL-FUNCTION → Protection attributes are applied to all fax fields to prevent editing
[Format for Expand - Protect All Fields]
The function type is EXPAND-FUNCTION → Protection attributes are applied to all fax fields to prevent editing
[Set Confirmation Message for Delete]
All field protections have been applied → CONFIRM-DELETE-MSG-NUM is moved to SYSTEM-MSG-NUM to display confirmation prompt
[Set Expand Message for View]
All field protections have been applied → EXPAND-MSG-NUM is moved to SYSTEM-MSG-NUM to display expand mode indicator
[Set Station Entry Update Screen]
The system begins formatting the station entry update screen → The output select code is set to TABLE-SE-UPDATE-SCREEN and the screen message area is cleared
[Copy Station ID to Screen]
The system processes the station entry screen formatting → The station ID from the input message is copied to the station name field on the screen
[Apply Protection to US Crossing Point Field]
The system processes field protection for non-editable display → The US crossing point implementation field attribute is set to WS-NOCUR-PROTECT
[Apply Protection to AEI Block Flag Field]
The system processes field protection for non-editable display → The AEI block flag field attribute is set to WS-NOCUR-PROTECT
[Set Confirm Delete Message]
The system completes delete function processing → The system message number is set to CONFIRM-DELETE-MSG-NUM
[Set Expand Message]
The system completes expand function processing → The system message number is set to EXPAND-MSG-NUM
[Set DEL Function Description]
The function code is DEL-FUNCTION → The system sets the function description to DEL-DESC, retrieves and displays current data, protects all screen fields from editing, and sets a confirmation delete message
[Set EXP Function Description]
The function code is EXPAND-FUNCTION → The system sets the function description to EXP-DESC, retrieves and displays current data, protects all screen fields from editing, and sets an expand message
[Map Table Access Permissions]
The system retrieves the record for MOD, DEL, or EXPAND functions → The system maps table access permissions including Amendment, Administration, Automotive, Broker, Carrier, Country, Disposition Code, Manifest Station, Message, Manifest Unit, Bonded Sidings, Station Entry, Schedule D, Station Selection, Schedule K, SCAC Code, User Security, Car Kind, Crossing Table, and Broker Name to corresponding screen fields
[Apply Screen Field Protection]
The function code is DEL-FUNCTION or EXPAND-FUNCTION → The system applies WS-NOCUR-PROTECT to all permission fields including cargo functions, train functions, SCAC access arrays, table access permissions, and department field to make them non-editable
[Set Confirm Delete Message]
The function code is DEL-FUNCTION and all data has been retrieved and protected → The system sets SYSTEM-MSG-NUM to CONFIRM-DELETE-MSG-NUM to display a confirmation prompt
[Set Expand Message]
The function code is EXPAND-FUNCTION and all data has been retrieved and protected → The system sets SYSTEM-MSG-NUM to EXPAND-MSG-NUM to indicate expand mode status
[Map Message Table Access]
The system processes user security field mapping for table access permissions → The message table access permission value is transferred from the database field to the corresponding screen field
[Map Department Information from US1 Segment]
The U1 indicator is set to '9' and a separate database retrieval is performed for the US1 segment → The department information is retrieved from the US1 segment and mapped to the corresponding screen field, and the U1 indicator is reset to space
[Map Message Table Access]
The system processes user security field mapping during MOD, DEL, or EXPAND functions → The message table access permission is mapped from the database field GCSTBRT-US-MESSAGE to the screen field GCM4G-MESSAGE
[Screen Fields Protected for Read-Only Access]
The system processes the request for user security data → All remaining user security fields (automotive, broker, carrier code, country, disposition code, manifest upon, DS by port, car ID, SK by port, error route, manifest station, message, manifest unit, bond siding, station entry, schedule D, station selection, schedule K, SCAC code, user security, car kind, crossing, broker name) must be set to protected status
[Retrieve Automotive Record from Database, Move Auto Type to Screen, Move Importer Name to Screen, Move Business Number to Screen, Protect Importer Field from Input, Protect Business Number Field from Input, Set Confirm Delete Message]
The system processes the DEL request → The system retrieves the automotive record, displays all field values, protects the importer and business number fields from input, and sets a confirmation delete message
[Retrieve Automotive Record from Database, Move Auto Type to Screen, Move Importer Name to Screen, Move Business Number to Screen, Protect Importer Field from Input, Protect Business Number Field from Input, Set Expand Message]
The system processes the EXPAND request → The system retrieves the automotive record, displays all field values, protects the importer and business number fields from input, and sets an expand message
[Set Amendment Code Update Screen]
The system processes the Amendment Code table maintenance request → The system sets the output screen code to Amendment Code update screen and clears any existing screen messages
[Extract Country Code and Amendment Code from Input]
The system processes the Amendment Code maintenance request → The system moves the Amendment Code from input to output screen and moves the Country Code from input to output screen
[DEL: Set Function Description to 'DEL', Retrieve Amendment Code Record from Database, Populate Amendment Description Field, Apply Field Protection - Make Amendment Description Read-Only, Set Confirmation Delete Message]
The function code equals DEL-FUNCTION → The system sets the function description to DEL-DESC, retrieves the Amendment Code record from database, populates the Amendment Description field, applies field protection to make Amendment Description read-only, and sets the system message to confirm delete message number
[EXPAND: Set Function Description to 'EXPAND', Retrieve Amendment Code Record from Database, Populate Amendment Description Field, Apply Field Protection - Make Amendment Description Read-Only, Set Expand Message]
The function code equals EXPAND-FUNCTION → The system sets the function description to EXP-DESC, retrieves the Amendment Code record from database, populates the Amendment Description field, applies field protection to make Amendment Description read-only, and sets the system message to expand message number
[Set Broker Update Screen]
The system begins broker table processing → The output select code is set to TABLE-BK-UPDATE-SCREEN and screen message is cleared
[Retrieve Additional Broker Segment B1]
Extended broker information is needed → D112-GET-B1-SEGMENT procedure is performed to retrieve B1 segment data
[Map Extended Broker Information Fields]
Extended information mapping occurs → GCSTBRT-B1-INFO-1 is moved to GCM4M-BROKER-INFO-1 and GCSTBRT-B1-INFO-2 is moved to GCM4M-BROKER-INFO-2
[Map Internet Address from B1 Segment]
Internet address mapping occurs → GCSTBRT-B1-INTERNET-ADDRESS is moved to GCM4M-BROKER-INTERNET
[Set All Fields to Protected Mode]
Field protection is applied → WS-NOCUR-PROTECT is moved to all broker field attribute variables to prevent editing
[Set Confirmation Delete Message]
Delete confirmation is required → CONFIRM-DELETE-MSG-NUM is moved to SYSTEM-MSG-NUM
[Set Expand Message]
Expand message is required → EXPAND-MSG-NUM is moved to SYSTEM-MSG-NUM
[Retrieve Additional B1 Segment]
The system needs to display complete broker information → The system retrieves the B1 segment using 'B1' as the table root key type and zeros as the DP key
[Map Extended Broker Information]
The system formats the complete broker display screen → The additional info 1 and info 2 fields from the B1 segment are mapped to their corresponding screen display fields
[Map Internet Address Information]
The system displays broker communication settings → The internet address from the B1 segment is mapped to the broker internet screen field
[Start Communication Settings Mapping]
The system begins formatting the broker communication settings screen → The output select code is set to TABLE-BK-UPDATE-SCREEN and the screen message area is cleared
[Map Office Code and Filer Code Settings]
The system retrieves broker communication configuration data → The broker office code is mapped to GCM4M-BROKER-OFFICE-CODE, the broker filer code is mapped to GCM4M-BROKER-FILER-CODE, and the Canadian filer code is mapped to GCM4M-BROKER-CA-FILER-CODE
[Configure FAX Communication Parameters]
The system processes FAX communication settings → The FAX number is mapped to GCM4M-BROKER-FAX-NUMBER and the FAX usage flag is mapped to GCM4M-BROKER-USE-FAX
[Set Merlin Communication Settings]
The system processes Merlin communication settings → The Merlin ID is mapped to GCM4M-BROKER-MERLIN and the Merlin usage flag is mapped to GCM4M-BROKER-USE-MERLIN
[Configure X12 EDI Protocol Settings]
The system processes X12 communication settings → The X12 header is mapped to GCM4M-BROKER-X12-HEADER and the X12 usage flag is mapped to GCM4M-BROKER-USE-X12
[Map Internet Communication Parameters]
The system processes internet communication settings → The internet usage flag is mapped to GCM4M-BROKER-USE-INTERNET
[Set Paper Delivery Method]
The system processes paper delivery settings → The paper usage flag is mapped to GCM4M-BROKER-USE-PAPER
[Configure Delivery Schedule Settings]
The system processes delivery schedule settings → The delivery schedule is mapped to GCM4M-BROKER-DELIVERY-SCH
[Map LTERM Communication Settings]
The system processes LTERM communication settings → The LTERM identifier is mapped to GCM4M-BROKER-LTERM
[Set Alternative US Code Configuration]
The system processes alternative US code settings → The alternative US code is mapped to GCM4M-BROKER-ALT-CODE
[Map Extended Broker Information Fields]
The system processes extended broker information → The full broker name is mapped to GCM4M-BROKER-NAME-FULL
[Retrieve Additional Communication Segment B1]
The system needs to retrieve B1 segment data → The system performs D112-GET-B1-SEGMENT to retrieve additional broker communication data
[Configure Internet Address Settings]
The system processes internet address settings from the B1 segment → The internet address is mapped to GCM4M-BROKER-INTERNET and additional info fields are mapped to GCM4M-BROKER-INFO-1 and GCM4M-BROKER-INFO-2
[Apply Communication Settings to Screen]
The system completes the delete function setup → The system message number is set to CONFIRM-DELETE-MSG-NUM
[Apply Communication Settings to Screen]
The system completes the expand function setup → The system message number is set to EXPAND-MSG-NUM
[Load Current X12 Configuration]
The broker modification function is initiated with MOD function type → The system should retrieve the broker record and populate X12 header, usage flags, and transmission settings on the screen
[Configure X12 Usage Flag]
The X12 usage flag is being set during broker maintenance → The system should move the X12 usage indicator from the broker record to the screen field for display and modification
[Set X12 Header Parameters]
X12 header parameters are being configured → The system should populate the X12 header field with the broker's EDI identification information
[Protect X12 Fields for View Only]
X12 EDI configuration fields are displayed → The system should set all X12 related fields to protected status preventing user modification
[Format X12 Configuration Screen]
The broker maintenance screen is being formatted → The system should set the output select code to broker update screen and populate all X12 related display fields
[Set Final Protocol Configuration]
The system completes field population and protection → The system sets CONFIRM-DELETE-MSG-NUM to require user confirmation before proceeding with deletion
[Set B1 Segment Type for Additional Broker Information]
The system prepares to retrieve B1 segment data → The system sets the table root key type to 'B1' and initializes the data pointer key to zeros
[Call Database Retrieval for B1 Segment]
The system calls the database retrieval function → The system executes C111-RETRIEVE-SEGMENT to access the B1 segment data
[B1 Segment Found?]
The system checks the retrieval result status → If the return flag indicates unsuccessful retrieval, the system treats the segment as not found, otherwise the segment is considered found
[Load Additional Broker Information]
The system processes the retrieved segment data → The system moves the table segment data to the GCSTBRT structure
[Set Broker Info Fields to Spaces]
The system handles the missing segment data → The system sets the GCSTBRT structure to spaces to ensure clean initialization
[Set Function Description to DEL]
The function type is DEL-FUNCTION → The system sets function description to DEL, retrieves and displays all carrier data, protects all fields from user input, and sets confirmation delete message
[Set Function Description to EXPAND]
The function type is EXPAND-FUNCTION and IRS number is not spaces → The system sets function description to EXPAND, retrieves and displays carrier data, masks IRS number with asterisks, protects all fields from user input, and sets expand message
[Apply Field Protection - Make ISO Country Code Non-Editable]
The system prepares the deletion confirmation screen → The ISO country code field is set to non-editable protection mode
[Set Confirmation Delete Message]
The system completes deletion screen setup → The system message number is set to confirm delete message number
[Apply Field Protection - Make ISO Country Code Non-Editable]
The system prepares the expansion view screen → The ISO country code field is set to non-editable protection mode
[Set Expand View Message]
The system completes expansion view screen setup → The system message number is set to expand message number
[Set RF Update Screen]
The system processes the RF table ID → The system sets the output screen to RF update screen and copies the sequence number from input to output message
[DEL: Protect Sub-Location Code Field from Changes]
The function code equals DEL-FUNCTION → The system sets function description to DEL, retrieves the existing record, loads sub-location code, protects the field from changes with cursor protection, and sets confirmation delete message
[EXP: Set Expand Message for View-Only Mode]
The function code equals EXPAND-FUNCTION → The system sets function description to EXP, retrieves the existing record, loads sub-location code, protects the field from changes with cursor protection, and sets expand message for view-only mode
[Set Function Description to DELETE]
The system processes the function type → The function description is set to DEL-DESC, existing data is retrieved and mapped to screen, all fields are protected with WS-NOCUR-PROTECT, and confirmation delete message is set
[Set Confirmation Delete Message]
The system completes delete screen formatting → The system message number is set to CONFIRM-DELETE-MSG-NUM to prompt user confirmation
[Set Function Description to EXPAND]
The system processes the function type → The function description is set to EXP-DESC, existing data is retrieved and mapped to screen, all fields are protected for display-only mode, and expand view message is set
[Set Expand View Message]
The system completes expand screen formatting → The system message number is set to EXPAND-MSG-NUM to indicate view-only mode
[Set Port Name as Key]
The system initiates port data retrieval for Schedule D table → The port name is set as the primary key for database lookup
[Set Confirmation Message for Delete]
The system prepares the delete confirmation screen → The system sets the confirm delete message number to prompt user for deletion confirmation
[Set Expand Message for View]
The system prepares the expand view screen → The system sets the expand message number to indicate the record is in view-only mode
[Set Function Description to DELETE]
The system processes the DEL function for foreign port table → The function description is set to DEL, existing record is retrieved, city code field is protected from editing, and confirmation delete message is set
[Set Function Description to EXPAND]
The system processes the EXPAND function for foreign port table → The function description is set to EXP, existing record is retrieved, city code field is protected from editing, and expand view message is set
[Copy Foreign Port Name to Display]
The system prepares the screen for foreign port maintenance → The foreign port name is copied from input to the display screen and screen message area is cleared
[Protect City Code Field from Editing]
The system displays foreign port data for deletion or viewing → The city code field is set to protected mode to prevent user modifications
[Set Confirmation Delete Message]
The system prepares the screen for foreign port deletion → The system message number is set to confirmation delete message to prompt user confirmation
[Set Expand View Message]
The system prepares the screen for foreign port viewing → The system message number is set to expand message to indicate view-only mode
[Set Output Screen to MU Update Screen]
The system prepares the output message structure → The screen message field is cleared to spaces
[Set Confirm Delete Message]
The system finalizes the delete confirmation display → The system message number is set to CONFIRM-DELETE-MSG-NUM
[Set Expand View Message]
The system finalizes the expand view display → The system message number is set to EXPAND-MSG-NUM
[Set Table DC Update Screen]
The system processes the request → The output select code is set to TABLE-DC-UPDATE-SCREEN and screen message is cleared
[Extract Disposition Code from Input]
The system processes the disposition code table request → The disposition code key is extracted from GCMWA-K-DISP-CODE and moved to GCMWB-DISP-CODE
[Map Description to Screen, Map Quantity Action to Screen, Map Location to Screen, Map Process Type to Screen, Map Merlin Messages 1 & 2 to Screen, Map Notify IM Flag to Screen, Map Post to DB Flag to Screen, Map 10 Counterpart Disposition Codes to Screen, Map 10 Counterpart Match Methods to Screen]
The system retrieves the record data → All disposition code fields including description, quantity action, location, process type, merlin messages, notify IM flag, post to DB flag, and all 10 counterpart codes with match methods are mapped to corresponding screen fields
[DEL: Set Function Description to DELETE]
The function code equals DEL-FUNCTION → The function description is set to DEL-DESC, existing record data is retrieved, mapped to screen, all fields are protected, and confirmation delete message is set
[Apply Protection Attributes to All Fields]
The delete function processes the record → All screen fields including description, quantity action, location, process type, merlin messages, notify IM flag, post to DB flag, and all counterpart codes with match methods are set to protected status using WS-NOCUR-PROTECT
[Set Confirmation Delete Message]
The delete function is processed → The system message number is set to CONFIRM-DELETE-MSG-NUM to prompt user confirmation
[EXPAND: Set Function Description to EXPAND]
The function code equals EXPAND-FUNCTION → The function description is set to EXP-DESC, existing record data is retrieved, mapped to screen, all fields are protected, and expand message is set
[Apply Protection Attributes to All Fields]
The expand function processes the record → All screen fields including description, quantity action, location, process type, merlin messages, notify IM flag, post to DB flag, and all counterpart codes with match methods are set to protected status using WS-NOCUR-PROTECT
[Set Expand Message]
The expand function is processed → The system message number is set to EXPAND-MSG-NUM to indicate view-only mode
[GCSTBRT-DC-MERLIN-MSG1 → GCMWB-MERLIN-MESSAGE1]
The system processes disposition code field mapping for screen display → The first Merlin message content from the database record is mapped to the screen first Merlin message field
[GCSTBRT-DC-MERLIN-MSG2 → GCMWB-MERLIN-MESSAGE2]
The system processes disposition code field mapping for screen display → The second Merlin message content from the database record is mapped to the screen second Merlin message field
[Apply Screen Protection Rules]
The system completes the screen field mapping process → The system applies protection attributes (WS-NOCUR-PROTECT) to all counterpart code screen fields (GCMWB-CTERPART-DC-01-A through GCMWB-CTERPART-DC-10-A) and all match method screen fields (GCMWB-CTP-MATCH-MTHD-01-A through GCMWB-CTP-MATCH-MTHD-10-A) to make them non-editable
[Retrieve Disposition Code Record]
The system needs to validate counterpart codes for the disposition code → The system retrieves the disposition code record using the B110-RETRIEVE-ROOT process
[Apply Business Rule Enforcement]
The system applies business rule enforcement → The system validates all disposition code attributes including description, quantity action, location, process type, Merlin messages, notification settings, and database posting requirements
[Extract SCAC Code and Port Code from Input]
The system processes the input message → The SCAC code and port code are extracted and assigned to the screen display fields
[Set Confirm Delete Message]
The system finalizes the deletion confirmation screen → The system message is set to confirm delete message number to prompt user confirmation
[Set Expand Message]
The system finalizes the view-only screen → The system message is set to expand message number to indicate view-only mode
[Set Car ID Update Screen]
The system processes the request → The Car ID update screen is selected and screen message is cleared
[Extract Car ID from Input]
The system processes the input message → The Car ID value is extracted and populated in the screen Car ID field
[Set Confirmation Delete Message]
The system prepares the delete confirmation screen → The system message number is set to confirm delete message
[Set Expand Message]
The system prepares the expand view screen → The system message number is set to expand message
[Set VI Update Screen]
The system processes the table maintenance request → The output select code is set to TABLE-VI-UPDATE-SCREEN and screen message is cleared
[Get Car Type from Input]
The system processes the input message → The car type from input (GCMWG-CAR-TYPE) is moved to the screen field (GCMWH-CARTYPE)
[Set All Fields to Protected/Non-Editable]
The system processes DEL function field protection → All screen fields (GCMWH-CONVEYING-A, GCMWH-APHIS-A, GCMWH-TRANSIT-A, GCMWH-EMPTY-A, GCMWH-LOADED-A, GCMWH-DESCRIPTION-A) are set to WS-NOCUR-PROTECT
[Display Confirmation Delete Message]
The system completes DEL function processing → The system message number is set to CONFIRM-DELETE-MSG-NUM
[Display Expand View Message]
The system completes EXPAND function processing → The system message number is set to EXPAND-MSG-NUM
[Set KS Update Screen]
The system processes the KS table update request → The system sets the output screen code to KS update screen and clears any previous screen messages
[Copy KS Code to Screen Display]
The system processes the screen setup → The KS code from the input message is copied to the screen display field
[Set Confirmation Delete Message]
The system prepares the deletion confirmation → The system sets the system message number to the confirm delete message number
[Set Expand View Message]
The system prepares the view-only screen → The system sets the system message number to the expand message number
[Set DS Update Screen as Output]
The system processes the DS table maintenance function → The output screen is set to DS Code update screen format and screen message area is cleared
[Set Function Description to DELETE]
The function type is DEL → The function description is set to DEL, existing data is displayed with field protection applied, and delete confirmation message is set
[Set Confirmation Delete Message]
The delete screen is prepared → A confirmation delete message is displayed to ensure user intent
[Set Function Description to EXPAND]
The function type is EXPAND → The function description is set to EXPAND, existing data is displayed with field protection applied, and expand view message is set
[Set Expand View Message]
The expand screen is prepared → An expand view message is displayed to indicate read-only mode
[Set S1 Update Screen]
The system processes the table maintenance request → The system sets the output select code to TABLE-S1-UPDATE-SCREEN and clears any existing screen messages
[Extract Country and Status Code from Input]
The system processes the input message → The system moves the country code to GCMWN-COUNTRY and the status code to GCMWN-STATUS-CD on the screen
[Set Confirmation Delete Message]
The system completes the deletion screen setup → The system sets CONFIRM-DELETE-MSG-NUM to SYSTEM-MSG-NUM to display the deletion confirmation message
[Set Expand Message]
The system completes the expanded view screen setup → The system sets EXPAND-MSG-NUM to SYSTEM-MSG-NUM to display the expansion message
[Set ST Update Screen]
The system processes the STCC table request → The system sets the output screen code to STCC update screen and clears any previous screen messages
[Move STCC Code and Qualifier to Screen]
The system formats the STCC maintenance screen → The system moves the STCC code to the screen code field and the qualifier to the screen qualifier field
[Set Function Description to DELETE]
The system processes the delete request → The system sets function description to DEL, retrieves existing record, populates screen fields, protects all fields from editing, and sets confirmation delete message
[Set Confirmation Delete Message]
The system needs to confirm the deletion operation → The system sets the system message number to confirm delete message
[Set Function Description to EXPAND]
The system processes the expand request → The system sets function description to EXP, retrieves existing record, populates screen fields, protects all fields from editing, and sets expand message
[Set Expand Message]
The system needs to indicate expand mode status → The system sets the system message number to expand message
[Map Message Table Access]
The system processes user security field mapping → The message table access permission value is copied to the corresponding screen field
[Set Confirmation Message for Delete]
Fields have been protected for delete function → System message number is set to CONFIRM-DELETE-MSG-NUM to prompt user confirmation
[Set Expand Message for Expand]
Fields have been protected for expand function → System message number is set to EXPAND-MSG-NUM to indicate view-only mode
[Disposition Code Fields Protected]
Function is DELETE or EXPAND → All disposition code fields including DISP-CODE-DESC, QUANITY-ACTION, LOCATION, PROCESS-TYPE, MERLIN-MESSAGE1, MERLIN-MESSAGE2, NOTIFY-IM, POST-TO-DB, and all counterpart disposition code arrays with match methods are protected
[Set B1 Segment Type for Additional Broker Information]
The system initiates broker additional segment retrieval → The segment type is set to 'B1' to identify the additional broker information segment
[Call Database Retrieval for B1 Segment]
Additional broker information retrieval is requested → The system calls the database retrieval service to fetch the B1 segment data
[B1 Segment Found?]
The system checks the retrieval result → If the retrieval was unsuccessful, the system clears broker additional information fields, otherwise it proceeds to load the segment data
[Clear Broker Additional Information Fields]
Additional broker information fields need to be initialized → All broker additional information fields are set to spaces
[Load B1 Segment Data into Memory]
The segment data needs to be processed → The retrieved segment data is moved to the working storage structure
[Set Field Protection Attributes]
The system formats the screen fields for display → The system should set the IRS number field attribute to protected (WS-NOCUR-PROTECT) to prevent user editing
[DEL: Set Function Description to DELETE]
The function code is DEL-FUNCTION → The system sets the function description to DEL, retrieves the port configuration data, displays all fields as protected (non-editable), and sets a confirmation message for the delete operation
[EXP: Set Function Description to EXPAND]
The function code is EXPAND-FUNCTION → The system sets the function description to EXP, retrieves the port configuration data, displays all fields as protected (read-only), and sets an expand message for the view operation
[Set US Port Name from Input]
The system begins processing the port configuration → The system sets the output select code to TABLE-SD-UPDATE-SCREEN, clears the screen message, and copies the US port name from input to the screen display field
[Delete Function Selected]
System processes delete function request → All STCC screen fields including description and all type code arrays (codes, countries, descriptions) for positions 01, 02, and 03 are protected from user input AND confirm delete message is set
[Expand Function Selected]
System processes expand function request → All STCC screen fields including description and all type code arrays (codes, countries, descriptions) for positions 01, 02, and 03 are protected from user input AND expand message is set
[Function Type?]
System evaluates the function type for STCC processing → IF function is DELETE then apply field protection and set confirm delete message OR IF function is EXPAND then apply field protection and set expand message OR IF function is ADD then initialize screen with no protection OR IF function is MODIFY then populate fields with no protection

Structural Validations

[Generate Invalid Table ID Error]
The table ID does not match any valid table identifier → The system moves the invalid table ID to error field, sets error message GCX004UP-ERROR-MSG2, and calls error handler CERR
[Handle Record Not Found]
A record is not found for a regular table operation → The system moves the table root key to error root key, sets error message GCX004UP-ERROR-MSG3, and calls 'CERR' error handling routine
[Call Error Handler]
Invalid function code is encountered → System calls CERR error handling routine with error message
[Invalid Function Error]
The system processes the admin table request → The invalid function is moved to error field, error message is set, and error routine is called
[Invalid Function Error]
The function code is not ADD, MOD, DEL, or EXPAND → The invalid function is moved to ERROR-FUNCTION, error message GCX004UP-ERROR-MSG1 is set to CC-ERROR-MESSAGE, and error handler CERR is called
[Invalid Function Error]
Processing LTERM table maintenance request → The system moves the invalid function code to error function field, sets the appropriate error message, and calls the error handling routine
[Invalid Function Error]
The system encounters a function code that is not ADD, MOD, DEL, or EXPAND → The system moves the invalid function to ERROR-FUNCTION, sets error message to GCX004UP-ERROR-MSG1, and calls the error handler 'CERR'
[Populate Error Type Field]
The record data is available from the database → The system moves GCSTBRT-MS-ERROR-TYPE to screen field GCM4A-MSG-ERROR-TYPE
[Invalid Function Error]
The function code is not ADD-FUNCTION, MOD-FUNCTION, DEL-FUNCTION, or EXPAND-FUNCTION → The system moves WS-IN-FUNCTION to ERROR-FUNCTION and moves GCX004UP-ERROR-MSG1 to CC-ERROR-MESSAGE
[Call Error Handler]
Error information is prepared → The system calls 'CERR' using CCCOM parameter
[Invalid Function Error]
If the function code and finds it is not ADD, MOD, DEL, or EXPAND → The system moves the invalid function to error function field, sets the appropriate error message, and calls the error handling routine
[Handle Record Not Found Error]
Processing a station code update request → The system moves WS-IN-FUNCTION to ERROR-FUNCTION, sets CC-ERROR-MESSAGE to GCX004UP-ERROR-MSG1, and calls 'CERR' error routine
[Invalid Function Error]
The system processes an unrecognized function code → The function code is moved to ERROR-FUNCTION, error message GCX004UP-ERROR-MSG1 is set, and CERR routine is called
[Invalid Function Error]
If the function type → The system moves the invalid function to error function field, sets the error message, and calls the error handling routine
[Invalid Function Error, Call Error Handler]
The function code does not match ADD, MOD, DEL, or EXPAND functions → The system moves the invalid function code to error function field, sets the error message to invalid function error message, and calls the error handling routine
[Invalid Function Error]
Function validation occurs → WS-IN-FUNCTION is moved to ERROR-FUNCTION, GCX004UP-ERROR-MSG1 is moved to CC-ERROR-MESSAGE, and CERR is called
[Retrieve Additional B1 Segment]
The system attempts to access extended broker information → The system initializes the GCSTBRT structure to spaces to ensure clean display
[Check INTERNET Protocol]
The system processes broker communication protocol settings → The system moves INTERNET usage flag and retrieves internet address from B1 segment to screen fields for validation and display
[Complete Carrier Code Screen Setup]
The function code is not ADD, MOD, DEL, or EXPAND → The system moves the invalid function to error field, sets error message, and calls error handling routine
[Invalid Function Error]
The system processes the country table maintenance request → The invalid function code is moved to error function field and error message is set
[Invalid Function Error]
The function code is not ADD, MOD, DEL, or EXPAND → The system moves the invalid function to error function field, sets error message, and calls error handling routine
[Invalid Function Error]
If the function type → The invalid function code is moved to ERROR-FUNCTION, error message GCX004UP-ERROR-MSG1 is set to CC-ERROR-MESSAGE, and error handler CERR is called
[Invalid Function Error]
If the function type → The invalid function code is moved to ERROR-FUNCTION and error message GCX004UP-ERROR-MSG1 is set to CC-ERROR-MESSAGE
[Invalid Function Error]
The function code is not ADD, MOD, DEL, or EXPAND → The invalid function code is moved to ERROR-FUNCTION, error message GCX004UP-ERROR-MSG1 is set, and error handler CERR is called
[Record Validation Error]
The system encounters a validation failure → The system calls the error handling routine 'CERR' with appropriate error messages
[Invalid Function Error]
If the function code and finds it invalid → The invalid function code is moved to error function field, error message is set, and error routine is called
[Invalid Function Error]
The function code does not match ADD, MOD, DEL, or EXPAND functions → The invalid function is moved to ERROR-FUNCTION and error message GCX004UP-ERROR-MSG1 is set
[Invalid Function Error]
If the function code and finds it invalid → The system moves the invalid function to error function field and sets the error message
[Invalid Function Error]
If the function type and finds it is not ADD, MOD, DEL, or EXPAND → The system moves WS-IN-FUNCTION to ERROR-FUNCTION and sets GCX004UP-ERROR-MSG1 to CC-ERROR-MESSAGE
[Call Error Handler]
The system needs to process the error condition → The system calls 'CERR' using CCCOM to handle the error
[Invalid Function Error]
If the function code → The system moves the invalid function to error function field, sets error message, and calls error handling routine
[Invalid Function Error]
The function code is not ADD-FUNCTION, MOD-FUNCTION, DEL-FUNCTION, or EXPAND-FUNCTION → The system moves the invalid function to the error function field, sets the appropriate error message, and calls the error handling routine

Module: GCX006 1 Consolidated Epic Story

Epic: GCX006 Complete EDI Specification Extracted from Legacy

Contains 84 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX006 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Message Source?]
The message ID equals GC-MENU-CARGO or starts with CST-CARGO-SCR1-MOD or CST-CARGO-SCR2-MOD or CST-CARGO-SCR3-MOD → Process as cargo menu entry, otherwise process as equipment-based cargo inquiry
[Equipment Field Blank?]
Input field is empty (spaces) → Clear cargo equipment field and saved input field, set blank equipment message, display cargo by equipment screen
[Find Equipment in Database]
Searching for equipment → Execute database lookup using equipment number as key in cargo report segment
[Handle Page Forward Navigation, Handle Page Backward Navigation]
Current input differs from saved input → Highlight input field, set equipment change message, display cargo by equipment screen
[Retrieve Next Cargo Records]
Navigating to next page → Position to last CCN on current screen, get next record, if found format waybill screen, if not found set no more CCN message
[Handle Up Level Navigation]
Processing up level navigation → Pop selection code from stack, clear message area, if output code is GC-MENU-CARGO-SPAWN then navigate to GC-MENU-CARGO and clear input, otherwise navigate to GC-MENU-SCREEN and clear input
[Entry from Cargo Menu]
The system receives a message with ID equal to GC-MENU-CARGO or starting with CST-CARGO-SCR1-MOD, CST-CARGO-SCR2-MOD, or CST-CARGO-SCR3-MOD → The system routes to cargo menu processing workflow
[Set Display Screen Code]
System needs to display the appropriate screen to user → System sets the output select code to cargo by equipment display screen
[Set Success Message Number]
No cargo records are found for the formatted equipment number → The system sets the user message to 'no CCN found' message number
[Set Invalid Equipment Message Number]
The GCCCARFM utility returns an unsuccessful result code → The system sets the user message to 'invalid equipment number' message number
[Set Equipment Not Found Status]
The system processes the failed search result → The invalid equipment number message is set, the input field is highlighted, and the cargo by equipment display is shown
[Clear Search Key and Segment]
The search preparation begins → The search key value and cargo report segment are cleared to spaces
[Set Field Highlighting]
User interface needs to indicate the problematic field → The equipment input field is highlighted with cursor highlight attribute
[Clear Key Value and Segment Data]
The system prepares for equipment number lookup → The key value field and cargo report segment data are cleared to ensure clean search parameters
[Execute IMS Database Call with Qualified SSA]
The system executes the database retrieval operation → The system calls the database with the equipment key using qualified search criteria to retrieve cargo report segment information
[Return Success Status]
The equipment information is successfully found and retrieved → The system maintains the retrieved cargo report segment data and continues with normal processing
[Equipment Format Valid?]
The system checks the equipment format validation result → If format validation was successful, prepare 'No Cargo Control Numbers Found' message, otherwise prepare 'Invalid Equipment Number' message
[Set 'No Cargo Control Numbers Found' Message]
The system sets the user message → The user message number is set to indicate no cargo control numbers were found for the valid equipment number
[Set 'Invalid Equipment Number' Message]
The system sets the user message for format validation failure → The user message number is set to indicate invalid equipment number format
[Set Invalid Equipment Message Number]
The GCCARFM format validation was not successful → The system assigns INV-EQP-NO-MSG-NUM to USER-MSG-NUM to display invalid equipment number message
[Return to Equipment Entry Screen]
All error handling steps have been completed → The system sets OUTPUT-SELECT-CODE to CARGO-BY-EQUIPMENT-DISPLAY to return to the equipment entry screen
[Call GCX006A1 Program]
The system needs to display cargo information for the equipment → The system calls GCX006A1 program with communication area, output message structure, and cargo report segment data to format the cargo information screen
[Execute GCX006A1 Program Call]
The system needs to format cargo information for screen display → The GCX006A1 program is called with control block, output message, and cargo report segment parameters to format the cargo information
[Display No More Records Message]
No additional cargo records are found in the database → Display a message indicating no more cargo control numbers are available
[Read Database Records Sequentially]
The system reads database records sequentially → Database records are retrieved using the cargo report segment structure with qualified search criteria
[No More Records Available]
The system encounters end of records condition → A 'no more CCN' message is set to inform the user that no additional records are available
[Execute Get Next Database Call]
System executes get next database operation → Next cargo record segment is retrieved from database or end of data is reached
[Last Screen Line Empty?]
The system checks if the 12th info line is empty → If the 12th line is empty, display 'Last Page' message and prevent further pagination
[No More Records]
No additional records are found in the database → Display 'No More Cargo Control Numbers' message to inform user
[Last Info Line Empty?]
The twelfth information line on the current display is empty → System displays a last page message and stops pagination process
[Display No More Records Message]
Database indicates no more records are available → System displays a no more Container Control Numbers message and shows the cargo by equipment screen
[Clear Cargo Report Segment]
The system prepares to get the next record from the database → The cargo report segment data structure is cleared to spaces
[Execute Database Get Next Call]
The system needs to retrieve the next matching cargo record → A database get next call is executed using the equipment search criteria
[Execute Database Get Next Call - Perform IMS get next operation with parameter setup and status code handling]
The system executes a database get next operation → The cargo report segment is cleared, the equipment number is set as the search key, and the database operation is performed to retrieve the next matching record
[Equipment Field Same as Saved?]
System compares current equipment input field with previously saved equipment field value → If equipment field is unchanged, process waybill display request, otherwise highlight equipment field and show equipment change error message
[Current Equipment Field = Saved Equipment Field?]
System compares current equipment input field value with the saved equipment field value → If values are equal, continue with page backward processing OR if values are different, highlight equipment field and display equipment change error message and return to cargo by equipment display
[Return to Cargo by Equipment Display]
System completes equipment change validation processing → Output select code is set to cargo by equipment display screen
[Set Screen Response Code]
The system completes error handling → Set the output select code to cargo by equipment display to return user to the main screen
[Move Selected CCN to Input Field]
The system prepares to pass data to the cargo detail transaction → The CCN corresponding to the selected item number is moved to the message input field
[Return to Cargo by Equipment Display]
The system completes error handling → Return the user to the cargo by equipment display screen
[Set Selected Cargo Control Number as Input]
The system prepares input parameters for the cargo detail transaction → The cargo control number corresponding to the selected item subscript is moved to the message input field
[Clear Message Area]
System processes the up level navigation → System clears the message area by setting it to spaces
[Call Stack Management Utility]
The stack management utility is called with the current and output selection codes → If the stack operation fails with invalid current selection code, the system terminates with an error message containing the invalid selection code
[Pop Selection Code from Stack]
The system processes the up-a-level navigation request → The system pops the previous selection code from the navigation stack and clears the message area
[Call Stack Management Utility]
The stack management utility is called to retrieve the previous selection code → If the stack operation fails with invalid current selection code, the system terminates with an error message containing the invalid selection code
[Call Stack Management Utility - Push]
A push operation is requested to save navigation context → The stack management utility is called with the communication area, message filler, output selection code, current selection code, and return code parameters
[Call Stack Management Utility - Pop]
A pop operation is requested to restore previous navigation context → The stack management utility is called with the communication area, message filler, output selection code, current selection code, and return code parameters

Structural Validations

[Display Equipment Not Found Error]
Equipment is not found and formatting was successful → Clear info lines, highlight input field, set no CCN message, display cargo by equipment screen
[Display Invalid Equipment Error]
Equipment is not found and formatting failed → Set invalid equipment number message, restore original input, highlight input field, display cargo by equipment screen
[Handle Invalid Function Key]
Processing invalid function key → Set invalid function key message, highlight item selection field, display cargo by equipment screen
[Set Blank Equipment Error Message]
System needs to provide user feedback → System sets the blank equipment message number to inform user that equipment field is required
[Set Invalid Equipment Number Message]
The formatting operation does not return a success status → If formatting was not successful, an invalid equipment number message is set, and the original input value is restored to the equipment number field
[Set Error Message for Invalid Equipment]
Error message needs to be displayed to user → The system sets invalid equipment number message for user notification
[Set Error Status]
The system needs to inform the user of the lookup failure → The system sets an invalid equipment number message, highlights the input field, and prepares to display the cargo by equipment screen
[Equipment Format Validation Failed]
The format validation fails (GCCARFM-RC-SUCCESS is false) and equipment lookup also fails (CC-STATUS-CODE is not SPACE) → The system sets invalid equipment number message, restores the original input field value, highlights the input field, and returns to cargo by equipment display screen
[First Info Line Empty?]
The first information line on the cargo display screen is empty → Display a message indicating no cargo control numbers are available and end the page forward process
[Last Info Line Empty?]
The twelfth information line on the cargo display screen is empty → Display a last page message indicating no more pages are available and end the page forward process
[Any Cargo Records Currently Displayed?]
The system checks if any cargo records are currently displayed on the first info line → If no records are displayed, show 'No Cargo Control Numbers' message and prevent pagination
[First Info Line Empty?]
The first information line on the current display is empty → System displays a no records message and stops pagination process
[Highlight Equipment Field]
System detects equipment field has been changed → System highlights equipment input field with cursor attribute and sets equipment change error message
[Display Equipment Change Error Message]
System needs to notify user about the equipment field modification → Equipment change message number is set as the user message
[Validate Selection is Numeric]
The item selection is not numeric:
the selection equals zero
the selection exceeds the maximum screen number
→ The system displays an invalid range error message and highlights the item selection field
[Get Selected Cargo Control Number]
The cargo control number at the selected position is empty or spaces → The system displays a no selection available error message and highlights the item selection field
[Selection is Numeric?]
The selection value is not numeric → The system displays an invalid range error message and highlights the selection field
[Selection is Zero?]
The selection value equals zero → The system displays an invalid range error message and highlights the selection field
[Selection > Maximum Range?]
The selection value is greater than the maximum screen number → The system displays an invalid range error message and highlights the selection field
[Display Invalid Range Error Message]
The validation fails → The system sets the invalid range message number, highlights the item selection field with error attributes, and returns to the cargo by equipment display
[Set Invalid Range Error Message Number]
The item selection is not numeric:
the item selection equals zero
the item selection is greater than the maximum screen number
→ Set invalid range message number, configure field display attributes to highlight the selection field, and return to cargo by equipment display screen
[Selection Numeric?]
The item selection is evaluated for numeric content → If the selection is not numeric, the system displays an invalid range error message
[Selection Equal Zero?]
The item selection equals zero → The system displays an invalid range error message
[Selection > Maximum Screen Number 12?]
The item selection is greater than the maximum screen number of 12 → The system displays an invalid range error message
[Check if CCN at Selected Position is Spaces]
The system checks the cargo control number at the selected position → If the cargo control number is empty or spaces, display 'No CCN Selected' error message and highlight the item selection field, otherwise allow the selection to proceed
[Item Number Numeric and Within Range 1-12?]
The item selection is not numeric:
equals zero
is greater than the maximum screen number (12)
→ The system displays an invalid range error message and highlights the item selection field
[Selected Cargo Control Number Exists?]
The cargo control number at the selected position is empty or contains only spaces → The system displays a no selection error message and highlights the item selection field
[Item Number Formatted]
The item selection is not numeric:
equals zero
is greater than the maximum screen number
→ The system displays an invalid range message and highlights the item selection field
[Push Operation Successful?, Pop Operation Successful?]
The stack management utility returns a status indicating invalid current selection code → The system generates an error message indicating stack operation failure and terminates the program
[Handle Stack Operation Error]
The stack management utility indicates operation failure → The system creates an error message containing the failure details and current selection code, then calls the error handling routine to terminate the program
[Generate Error Message for Invalid Selection Code]
The system detects the GCCSTACK failure → An error message is generated containing 'GCCSTACK FAILED WITH INVALIDE CUR-SEL-CODE:' followed by the current selection code value
[Terminate Program with Error]
The system cannot recover from the stack operation failure → The program is terminated through the error handling routine
[Build Error Message with Invalid Selection Code]
The system handles the error condition → An error message must be built containing the text 'GCCSTACK FAILED WITH INVALIDE CUR-SEL-CODE:' concatenated with the current selection code value and stored in the common control block error message field
[Terminate Program with Error]
The system needs to handle the critical error → The program must be terminated abnormally by performing the abend routine
[Handle Invalid Function Key - Displays error message for unsupported function key presses]
The user presses a function key that is not PAGE-BCK, PAGE-FWD, ENTER, or UP-A-LEVEL → The system sets an invalid function key message number, resets the item selection display attributes to normal protected alphabetic regular display, and returns to the cargo by equipment display screen

Module: GCX006A1 1 Consolidated Epic Story

Epic: GCX006A1 Complete EDI Specification Extracted from Legacy

Contains 14 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX006A1 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[13:Retrieve Next Cargo Record]
The system calls the database retrieval function → The system uses the saved input field as key value and calls CIMS with cargo report segment parameters
[Process Next Waybill Line]
The waybill line processing is invoked → The system formats the waybill line data and retrieves the corresponding cargo report segment
[Move Carrier Code to Display Field]
The system detects this is a new waybill entry → The carrier code from the cargo report segment is moved to the display field for the current screen line and saved as the previous carrier code for future comparison
[Move Origin Station Number to Display Field]
The waybill header information is being populated → The origin station number from the cargo report segment is moved to the display field for the current screen line and saved as the previous origin station number for future comparison
[Move Waybill Number to Display Field]
The complete waybill header information is being established → The waybill number from the cargo report segment is moved to the display field for the current screen line and saved as the previous waybill number for future comparison
[Clear Key Value Fields]
The system prepares to retrieve cargo records → All key value fields and cargo report segment data are cleared to spaces
[Execute Database Call to Get Next Cargo Record]
The system executes the database retrieval operation → A database call is made to retrieve the next cargo control report segment using the equipment ID search criteria
[Clear Database Key and Segment Areas]
The system prepares for database access → The database key value and cargo report segment are cleared to spaces
[Execute IMS Database Call]
The system executes the database retrieval operation → CIMS program is called with communication control, get-next operation, cargo report PCB, segment area, and qualified search criteria

Structural Validations

[Valid Record for Same Equipment?]
The system validates record continuation → Record is valid if status code is space AND equipment ID for index matches the saved input field
[Database Call Successful?]
The system checks the database call completion status → Processing continues only if the database call completed successfully with no errors
[Equipment ID Matches Input Equipment ID?]
The system compares the equipment ID from the retrieved record with the input equipment ID → The record is accepted for processing only if both equipment IDs match exactly
[Status Code = SPACE?]
The system checks the call completion status → If status code equals SPACE then proceed to equipment validation, otherwise mark processing as finished
[Equipment ID Matches Input?]
The system compares the equipment ID from cargo report with the saved input field → If equipment IDs match then reset first waybill line flag to YES, otherwise set finished flag to YES to stop processing

Module: GCX007 1 Consolidated Epic Story

Epic: GCX007 Complete EDI Specification Extracted from Legacy

Contains 48 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX007 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Message Source?]
The message ID number equals GC-MENU-CARGO:
the first 5 characters of message ID equal CST-CARGO-REPORT-SCR1-MOD
CST-CARGO-REPORT-SCR2-MOD
CST-CARGO-REPORT-SCR3-MOD
→ Route to GC Menu Cargo processing, otherwise route to Cargo by Waybill processing
[Handle Empty Waybill Input]
The waybill input field is empty (spaces) → Clear cargo by waybill data and saved input data, set blank waybill message number, and display Cargo by Waybill screen
[Records Found?]
No matching waybill records are found in the system → Clear info lines and saved input data, highlight input waybill field, set no CCN message number, and display Cargo by Waybill screen
[Navigate Forward Through Pages]
The first info line is empty → Set no CCN message and display screen, OR when 12th info line is empty, set last page message, OR when data exists, navigate to next set of records after the last displayed CCN
[Handle Menu Navigation]
Up level function key is pressed → Pop selection code from stack, clear rest of message, and if output code is GC-MENU-CARGO-SPAWN set to GC-MENU-CARGO, otherwise set to GC-MENU-SCREEN, and clear input field
[Process Function Key Commands]
The function key is not Enter, Page Forward, Page Backward, or Up Level → Set invalid PF key message number, highlight item select field, and display Cargo by Waybill screen
[Format Waybill Display Screen]
Screen formatting is required → Call external program 'GCX007A1' with communication area, output message, and cargo report segment parameters
[Format Complete Date/Time Display]
The cargo waybill screen is being prepared for display → The input waybill field from the message should be moved to the waybill input display field
[Execute Database Search]
The database search is executed → The system performs a database call to retrieve cargo report segments matching the search criteria
[Return No Results Found]
No matching waybill records are found in the database → The system clears the information lines, clears saved waybill data, sets invalid waybill number message, highlights the input field, and displays the cargo by waybill screen
[Call External Format Module GCX007A1]
The system needs to format the cargo control numbers list screen → The system calls external module GCX007A1 with communication control, output message, and cargo report segment to format the display
[Is Current Page Last Page?]
The system checks if the 12th information line is empty → If the 12th information line is empty, display 'Last Page Reached' message and end the process
[Read Next Record from Database]
The system requests the next cargo record → Read the next cargo record from the database using the cargo report segment
[Display 'No More Records' Message]
No more records are available in the database → Display 'No More Records' message and show the cargo by waybill display screen
[Clear Record Buffer]
The system prepares to retrieve the next cargo record → The cargo report segment buffer is cleared to spaces to ensure clean data retrieval
[Call Database to Get Next Record]
The system requests the next cargo record in sequence → The database is called to get the next cargo record segment using the qualified search parameters
[Highlight Waybill Input Field]
User attempts to navigate backward through pages → System highlights the waybill input field, sets waybill change error message, and returns to display screen
[Move Selected CCN to Input Field]
The system prepares to spawn the cargo detail transaction → The selected CCN is moved to the message input field for processing by the detail program
[Clear Message Area]
Navigation stack has been popped → System clears the rest of message area by setting it to spaces
[Return to Current Screen]
Error handling is complete → System sets output selection code to cargo by waybill display to return user to current screen
[Call External Formatting Module GCX007A1]
The format waybill screen process is initiated → The system calls external module GCX007A1 with communication control block, output message structure, and cargo report segment data to format and display the waybill information
[Call GCCSTACK Service]
The system calls the stack management service → The GCCSTACK service should be invoked with the common communication area, message filler, output selection code, current selection code, and return code parameters
[Trigger System Abend]
The system determines the error is critical → The system should Execute an abend operation to terminate processing in a controlled manner

Structural Validations

[Validate Waybill Input Format]
The CCN carrier field is not numeric:
the origin number field is not numeric
the waybill number field is not numeric
→ Clear info lines, highlight the input waybill field, set invalid waybill number message, and display Cargo by Waybill screen
[Validate Waybill Change Detection]
The current waybill input does not equal the previously saved waybill input → Highlight the input waybill field, set waybill change message number, and display Cargo by Waybill screen
[Validate Item Selection Range]
The item selection is not numeric:
equals zero
exceeds maximum screen number
→ Set invalid range message number, highlight item select field, and display Cargo by Waybill screen
[Valid Selection?]
The CCN at the selected position is empty (spaces) → Set no CCN selected message number, highlight item select field, and display Cargo by Waybill screen
[Set Invalid Waybill Message]
The validation process detects invalid format → The system should clear information display areas, set invalid waybill number message, highlight the input field, and display the cargo by waybill screen
[Clear Display Fields]
The system processes the failed search result → The system clears all information lines and saved waybill data, highlights the input waybill field, sets an invalid waybill number message, and displays the cargo by waybill screen
[Any Records Currently Displayed?]
The system checks if the first information line is empty → If the first information line is empty, display 'No Records Found' message and end the process
[Set Invalid Waybill Error Message]
System performs waybill format validation → System clears info lines, highlights waybill input field, sets invalid waybill number message, and returns to display screen
[Set No Records Found Error Message]
No matching waybill records are found → System clears info lines, highlights waybill input field, sets no CCN found message, and returns to display screen
[Selection is Numeric?]
The item selection is not numeric → The system displays an invalid range error message and highlights the item selection field
[Selection is Zero?]
The item selection equals zero → The system displays an invalid range error message and highlights the item selection field
[Selection > 12?]
The item selection is greater than the maximum screen number (12) → The system displays an invalid range error message and highlights the item selection field
[Cargo Control Number Exists at Selected Position?]
The cargo control number at the selected position is empty (spaces) → The system displays a no selection error message and highlights the item selection field
[Item Number Numeric and Within Range 1-12?]
The item selection is not numeric:
equals zero
exceeds the maximum screen number
→ Display invalid range error message and highlight the item selection field
[Selected Item Has Cargo Control Number?]
The cargo control number at the selected position is empty or spaces → Display no cargo control number selection error message and highlight the item selection field
[Compare Current Waybill Input with Saved Waybill Value]
User presses PAGE-BCK function key → System compares current waybill input with saved waybill value and either allows navigation if they match or displays error message if they differ
[Compare Current Waybill Input with Saved Waybill Value]
User presses PAGE-FWD function key → System compares current waybill input with saved waybill value and either allows navigation if they match or displays error message if they differ
[Display Waybill Change Error Message]
Waybill change validation fails → System displays waybill change error message to inform user of the issue
[Check Waybill Input Field]
The waybill input field is empty or contains only spaces → The system clears all cargo waybill data fields, clears information display lines, sets a blank waybill error message, and returns to the waybill display screen
[Stack Operation Successful?]
The stack management service returns an invalid current selection code status → The system generates an error message indicating stack operation failure AND terminates the program with an abend condition
[Build Error Message]
The system processes the error condition → An error message should be built containing the text 'GCCSTACK FAILED WITH INVALIDE CUR-SEL-CODE:' concatenated with the failed selection code value
[Display Waybill Change Error]
The current waybill input does not match the previously saved waybill input → System highlights the waybill input field, displays waybill change error message, and shows cargo by waybill display screen
[Display Invalid Function Key Error]
User presses a function key that is not PAGE-BCK, PAGE-FWD, ENTER-VALUE, or UP-A-LEVEL → System displays invalid function key error message, sets item select attribute for highlighting, and shows cargo by waybill display screen

Module: GCX007A1 1 Consolidated Epic Story

Epic: GCX007A1 Complete EDI Specification Extracted from Legacy

Contains 7 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX007A1 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[4:Retrieve Next Cargo Record]
The system needs cargo report segment data → The system calls CIMS to retrieve GCCC cargo report segment using unqualified SSA
[Retrieve Next Cargo Record]
The cargo report segment retrieval is initiated → The system calls CIMS with cargo report segment parameters to fetch the next record
[Clear Cargo Report Segment]
The system prepares to retrieve the next cargo record → The cargo report segment should be cleared to spaces to ensure no residual data remains
[Execute Database Call to Get Next Record]
The system executes the database call with CIMS program using GN function → The next cargo control record should be retrieved from GCSCCRT database using the unqualified SSA
[Move Release Date to TEMP-DATE]
The system processes the release date for formatting → The release date value is moved to TEMP-DATE field for component extraction
[Move Release Time to Temp Variable]
The system needs to format release time for display → The release time is moved to a temporary time variable

Structural Validations

[5:Validate Cargo Record Match]
The system validates the cargo record against input criteria → Processing continues only if status code is space AND CCN carrier matches input carrier AND origin station number matches input AND waybill number matches input, otherwise processing is marked as finished

Module: GCX008 1 Consolidated Epic Story

Epic: GCX008 Complete EDI Specification Extracted from Legacy

Contains 71 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX008 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Route Based on Source Screen]
The message ID equals GC-MENU-CARGO:
the first 5 characters equal CST-CARGO-SCR1-MOD
CST-CARGO-SCR2-MOD
CST-CARGO-SCR3-MOD
→ The system processes the request as coming from GC Menu Cargo, otherwise processes as coming from Cargo by Destination
[6:Handle Page Navigation - Page Back]
The user presses Page Back key AND the input field equals the saved input field value → The system displays cargo control numbers for the current destination, otherwise highlights the input field and shows destination change message
[6:Handle Page Navigation - Page Forward]
The user presses Page Forward key AND the input field equals the saved input field value → The system processes the page forward request, otherwise highlights the input field and shows destination change message
[11:Search Cargo Records by Destination]
The system searches for cargo records → The system retrieves cargo control records using the destination/station as the key value and if found formats the destination screen, otherwise shows no cargo control number message
[12:Handle Multiple Destination Search]
The first station has no cargo data → The system sequentially searches through remaining stations (up to 20) until cargo data is found or all stations are checked, and if no data found in any station shows no cargo control number message
[15:Navigate Through Cargo Pages]
Forward page navigation is requested → The system finds the current position in the cargo list, retrieves the next set of records, and if successful displays the next page, otherwise shows no more cargo control numbers message or searches next available station
[17:Process Cargo Control Number Selection]
The selected line contains cargo control number data → The system sets up spawning program context with the selected cargo control number and navigates to cargo spawn transaction, otherwise shows no cargo control number selected message
[Check Source Screen Message ID]
The system checks the message ID against known cargo screen identifiers → The message ID is evaluated to determine the source screen type for proper routing
[Message ID = GC-MENU-CARGO OR Message ID starts with CST-CARGO-SCR1-MOD CST-CARGO-SCR2-MOD CST-CARGO-SCR3-MOD?]
The message ID equals GC-MENU-CARGO:
the first 5 characters of the message ID match CST-CARGO-SCR1-MOD, CST-CARGO-SCR2-MOD
CST-CARGO-SCR3-MOD
→ The system routes the request to GC Menu Cargo processing (A100-FROM-GC-MENU-CARGO)
[Route to Cargo by Destination Processing A200-FROM-CARGO-BY-DESTIN]
The message ID does not equal GC-MENU-CARGO AND the first 5 characters of the message ID do not match CST-CARGO-SCR1-MOD, CST-CARGO-SCR2-MOD, or CST-CARGO-SCR3-MOD → The system routes the request to Cargo by Destination processing (A200-FROM-CARGO-BY-DESTIN)
[Set Cursor Highlight on Input Field]
The system detects the input field change → The system sets cursor highlight attribute on the input field, sets destination change message number for display, and returns to the cargo by destination display screen
[Check if Destination Changed]
User presses page backward key → If destination input equals saved destination value, proceed with cargo record retrieval, otherwise highlight input field and display destination change error message
[Search First Destination for Cargo Records]
System searches for cargo records → Query GCSCCRT segment using destination as key value to find matching cargo records
[Display No More Records Message]
No more cargo records are found in any remaining destinations in the range or single destination search yields no results → Display 'No More CCN' message and return cargo by destination display code
[Load Station 1 from Range Table]
The system needs to process multiple destinations from a range table → All 20 station numbers from positions 01 through 20 are loaded into the working destination table array
[Clear Message Area]
The navigation process begins → The system clears all message areas by setting the rest of message field to spaces
[Call Table Access Module X100-GET-TABLE-SEGMENT]
The system needs to retrieve the destination range table data → The X100-GET-TABLE-SEGMENT module is called to Execute the table access operation
[Move Retrieved Table Data to DR Segment]
The system receives the table data → The retrieved table segment data is moved to the destination range segment for further processing
[Clear DR Segment - No Data Found]
No matching table data is found for the destination → The destination range segment is cleared to indicate no data is available
[Search GCSCCRT with Destination Key]
The system searches for cargo control numbers → The system calls the cargo report segment lookup with the destination key and sets accept status to GEGB
[Search GCSCCRT with New Destination]
The system searches for cargo control numbers → The system calls the cargo report segment lookup with the new destination key and sets accept status to GEGB
[Display No Records Found Message]
The system completes the search process unsuccessfully → The system clears the info lines and input field saved value, sets NO-CCN-MSG-NUM to user message number, highlights the input field, and sets output select code to cargo by destination display
[Set No Records Found Message]
The search process completes unsuccessfully → The system clears the display lines, clears the saved input field, sets the 'No CCN' message number, highlights the input field, and displays the cargo by destination screen
[Load 20 Destination Station Numbers from Range Table]
The system needs to process multiple destinations for cargo search → All 20 station numbers from positions 01 through 20 are loaded into the working destination table array
[Display No Cargo Found Message]
No more destinations are available to search → The info lines are cleared, the input field is cleared, a 'No CCN' message is displayed, the input field is highlighted, and the cargo by destination display screen is shown
[Call GCX008A1 Formatting Module]
The format cargo display screen process is initiated → The system calls the GCX008A1 formatting module with common control block, output message structure, cargo report segment data, and destination table data to prepare the formatted screen display
[Search next destination in range?]
The system is using destination range table search method → If the table position is 20 or less and the next destination is not zero, continue searching; otherwise display 'No More Records' message
[Display 'No More Records' message]
No additional cargo records are found for forward page navigation → Display 'No More Records' message and remain on the current cargo by destination screen
[Display no more records message]
End of cargo data is reached for the destination → Display no more records message and remain on current screen
[Range Table Found?]
If the retrieval result → If return flag equals SUCCESSFUL, proceed to load station numbers, otherwise set empty range segment
[Load 20 Destination Station Numbers into Working Table]
The system processes the range table data → All 20 station numbers from positions 01 through 20 are moved from the range segment to the working destination table
[Search Cargo Records for First Destination]
The system searches for cargo records → The accept status is set to GEGB and cargo report segment lookup is performed
[More Destinations Available?]
The system checks for more destinations to process → If current station number is not '000000' and index is not greater than 20, continue processing, otherwise set no records message
[Set No Records Found Message]
No cargo records are found for any station → Info lines are cleared, input field is cleared, NO-CCN message number is set, input field is highlighted, and display code is set
[Load 20 Destination Station Numbers into Working Table]
The system processes the destination range data → All 20 station numbers are loaded sequentially into corresponding positions in the working destination table and the index is set to position 1 for processing
[Display 'No more cargo records' message]
No additional cargo records are found → Display 'No more cargo records' message and remain on current page
[Perform GN Operations Until Last CCN Found]
System performs GN (Get Next) operations on cargo report segments → System continues sequential search until current record key matches the last displayed CCN on screen or maximum iteration limit is reached
[Continue to Next Record for New Page]
System performs next GN operation to get subsequent cargo record → If next record exists, format and display new page with updated cargo information; if no next record exists, display no more CCN message
[Last Page of Results]
The user attempts to page forward but the 12th line of the display is empty (GCM81-INFO-LINE (12) = SPACE) → The system displays 'Last page' message and remains on the current cargo by destination display

Structural Validations

[5:Validate Destination Input]
The destination input field is blank (spaces) → The system clears the cargo destination field, sets blank destination message, and displays the cargo by destination screen
[14:Process Forward Page Request]
The first information line is blank → The system shows no cargo control number message, and when the 12th information line is blank shows last page message, otherwise processes the page forward navigation
[16:Validate Item Selection Range]
The selection is not numeric:
equals zero
exceeds maximum screen number
→ The system shows invalid range message and highlights the item select field, otherwise validates the selected line has cargo control number data
[Is Destination Field Blank?]
The destination input field is blank (SPACE) → Clear the cargo destination field, clear the saved input field, set blank destination message number, and set cargo by destination display code
[Display No Records Found Error]
No cargo records are found for any destination → Clear screen information, clear saved input field, set no CCN message number, highlight input field, and display cargo by destination screen
[Display Destination Change Error]
User presses page backward key → Highlight input field, set destination change message number, and display cargo by destination screen
[Check if Any Records Displayed]
The first information line on screen is empty or contains no cargo data → Display 'No CCN' message and remain on current screen without processing page forward
[Check if Last Record Shown]
The twelfth information line on screen is empty indicating no more records available → Display 'Last Page' message and remain on current screen without processing page forward
[Check Navigation Limit]
Search iteration counter exceeds 100 attempts or table position exceeds 20 destinations → Stop search process and display 'Maximum CCN' message to user
[Check if Selection is Numeric and Within Range 1-12]
The selection is not numeric:
equals zero
exceeds the maximum screen number
→ System displays invalid range error message and highlights the item selection field
[Check if Selected Item Has Cargo Control Number]
The cargo control number for the selected item position is empty or spaces → System displays no cargo control number selected error message and highlights the item selection field
[Check if any cargo records displayed]
The system checks the first information line on the display → If the first line is empty, display 'No Records' message and remain on current screen
[Check if on last page]
The system checks the twelfth information line on the display → If the twelfth line is empty, display 'Last Page' message and remain on current screen
[Check if records exist on current page]
The first information line on current page is empty → Display no records message and remain on current screen
[Check if on last page]
The twelfth information line on current page is empty → Display last page message and remain on current screen
[Exceeded maximum navigation limit?]
Navigation counter exceeds 100 attempts → Display maximum records reached message and stop navigation
[Check if any cargo records exist on current page]
The first information line on current page is empty → Display 'No cargo records' message and remain on current page
[Check if last record is displayed on current page]
The twelfth information line on current page is empty → Display 'Last page reached' message and remain on current page
[Check navigation limit reached]
Navigation counter exceeds 100 iterations → Display 'Maximum records exceeded' message and stop navigation
[Handle Position Not Found Error]
System detects positioning failure condition → System displays maximum CCN message to user and maintains current screen display without advancing to next page
[No more destinations available - display error]
No cargo records have been found for any destination in the range → A 'No more CCN' error message is displayed and the cargo by destination display screen is shown
[Is Selection Numeric?]
The item selection is checked for numeric content → If the selection is not numeric, system displays invalid range error message and returns to cargo display screen
[Is Selection Zero?]
The numeric item selection equals zero → System displays invalid range error message and returns to cargo display screen
[Is Selection > 12?]
The item selection number is greater than the maximum screen number (12) → System displays invalid range error message and returns to cargo display screen
[Set Invalid Range Error Message]
System needs to display validation error to user → System sets invalid range message number, configures screen attributes for error display, and returns to cargo display screen
[Validate Selection is Numeric and Within Range 1-12]
The selection is not numeric:
equals zero
exceeds the maximum screen number
→ The system displays an invalid range error message and highlights the selection field
[Check if Selected CCN Position Contains Data]
The selected line position contains no cargo control number data (is spaces) → The system displays a no cargo control number selected error message and highlights the selection field
[Handle Stack Error]
The stack management module returns an invalid current selection code error → The system creates an error message indicating the stack operation failed with the invalid selection code and performs system termination
[No Records Found Error]
The database operation fails to find any cargo records for the specified destination (CC-STATUS-CODE is not SPACE) → The system displays 'No CCN found' message, clears the display fields, highlights the input field, and returns to cargo by destination display
[Record Not Available Error]
The database operation indicates no more records are available (CC-STATUS-CODE is not SPACE during page forward operation) → The system displays 'No more CCN available' message and remains on the cargo by destination display
[Maximum Records Exceeded Error]
The number of database operations exceeds the maximum limit of 100 (MAX-GN > 100) → The system displays 'Maximum CCN reached' message and returns to cargo by destination display

Module: GCX008A1 1 Consolidated Epic Story

Epic: GCX008A1 Complete EDI Specification Extracted from Legacy

Contains 6 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX008A1 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Adjust Table Position for Screen Limit]
The system needs to set the final table position for subsequent processing → If screen line equals 12 OR index exceeds 20, then table position is set to current index minus 1, otherwise table position is set to current index
[Parse Car ID into Alpha and Numeric Components]
The system needs to prepare the car ID for equipment database lookup → The system separates the car ID into alphabetic portion (WS-CAR-ALPHA) and numeric portion (WS-CAR-NUM)
[Call Equipment Database with Car ID]
The system calls the equipment database with the car ID → The system invokes GEQUIP program to retrieve equipment details using the formatted car identification
[Retrieve Equipment Record from Database]
Equipment database lookup is performed using the car identification → Retrieve the equipment record and save the equipment information for further processing
[Parse Container ID for Flatcar Number]
The first two digits of the container number are '00' → Use digits 3-8 as the car number, otherwise use digits 2-7 as the car number
[Set Cargo Control Number from GCCC-CCN-KEY]
The system formats the display line data → The cargo control number from GCCC-CCN-KEY is assigned to the screen line position

Structural Validations

None explicitly identified in logic extraction.

Module: GCX009 1 Consolidated Epic Story

Epic: GCX009 Complete EDI Specification Extracted from Legacy

Contains 16 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX009 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Copy Input to Output]
The system processes the message → The input message content is copied to the output message
[8:Clear Input Fields for Non-Menu Screens]
The message ID != the menu screen identifier → The system clears the input field by setting it to spaces
[Transfer Complete Message Content to Output Structure]
The message transfer process is initiated → The complete input message content is copied to the output message structure
[Is Message ID = Cargo Menu ID?]
The system checks if the message ID equals the cargo menu identifier → The system determines if the message is from cargo menu screen or from another screen
[Message is from Cargo Menu Screen]
The message ID equals the cargo menu identifier (GC-MENU-CARGO) → The system proceeds to process the cargo menu specific logic and validations
[Message is NOT from Cargo Menu Screen]
The message ID does not equal the cargo menu identifier (GC-MENU-CARGO) → The system bypasses cargo menu specific validations and continues with general message processing
[Set Invalid Enter Message]
The validation rule determines Enter key is not allowed → The system moves ENTER-INVALID constant to SYSTEM-MSG-NUM field
[Set Function Unavailable Message]
The user presses a function key that corresponds to SEL-NOT-AVAILABLE → The system sets the system message number to FUNCTION-UNAVAILABLE to inform the user that the selected function is not available
[Clear Input Field by Setting to Spaces]
The message ID != the menu screen identifier (GC-MENU-SCREEN) → The input field (GCMSG-INPUT-FIELD) should be cleared by setting it to spaces

Structural Validations

[4:Validate Cargo Menu Input]
The system checks the message ID → If the message ID equals cargo menu identifier, proceed with cargo menu validation, otherwise proceed with general message processing
[5:Process Enter Key Validation]
The user presses the Enter key → The system sets the system message number to Enter Invalid
[6:Process Unavailable Function Selection]
The user selects a function that is not available → The system sets the system message number to Function Unavailable
[7:Process Invalid Function Key]
The user presses any other invalid function key → The system sets the system message number to PF Key Invalid
[Enter Key Pressed on Cargo Menu]
The PF-KEY equals ENTER-VALUE indicating user pressed Enter key → The system sets SYSTEM-MSG-NUM to ENTER-INVALID to indicate Enter key is not allowed
[Continue Processing]
The user presses a function key that is not ENTER-VALUE and not SEL-NOT-AVAILABLE → The system sets the system message number to PF-KEY-INVALID to inform the user that the pressed function key is not valid
[Set Invalid Function Key Message]
The function key pressed is not ENTER-VALUE and not SEL-NOT-AVAILABLE → The system message number is set to PF-KEY-INVALID to indicate an invalid function key was pressed

Module: GCX011 1 Consolidated Epic Story

Epic: GCX011 Complete EDI Specification Extracted from Legacy

Contains 417 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX011 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Error Collection Variables]
System begins error collection initialization → Error collection variables are reset to initial state and error found flag is set to false
[Initialize GCSCCS54 Record]
Error message collection process begins → A new GCSCCS54 record is initialized with default values and prepared for message storage

Core Acceptance Criteria

[25:Broker Notification Processing]
The broker has a valid delivery schedule (DEFAULT-DELIVERY or IMMEDIATE-DELIVERY) → The system sends notifications via X12 EDI, Merlin messaging, Internet, Fax, or Paper based on broker preferences
[Retrieve Shipment Minimum Data]
The system retrieves shipment minimum data → Attempt to obtain shipment minimum segment data from the waybill system
[Block Manifest Processing]
The system attempts to continue with manifest processing → All further manifest processing is blocked and the shipment is not processed
[Handle P-Prefix CCN Processing]
The system processes the P-prefix CCN → Convert the P-prefix CCN to standard 6105 format and set transmission flag to not transmitted
[Block Update - Train Reported]
An update attempt is made on the manifest → The system blocks the update operation and generates an appropriate error message indicating train reported restriction
[Block Update - Locked]
An automated update attempt is made → The system blocks the update operation and generates an error message indicating user changes restriction
[Block Update - Arrived]
Certain types of updates are attempted → The system blocks the update operation and generates an error message indicating arrived cargo restriction
[Generate Blocking Message]
The system needs to notify the user of the blocking condition → A specific multi-bill blocking message is generated explaining the manual processing requirement
[Reset Follower to Single Status]
The system prepares to create a follower manifest → Reset the follower status indicator to single car status before proceeding with follower creation
[Block Multi-Bill Changes]
The decision matrix identifies conditions that should block processing to prevent data integrity issues → The system blocks the processing action and generates appropriate error messages indicating why the change cannot be applied
[Validate Update Authorization]
The manifest is already reported on a train → The system should deny update authorization and generate error message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN'
[Validate Update Authorization]
The manifest has 309 lock status indicating user made manual changes → The system should deny update authorization and generate error message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST'
[Validate Update Authorization]
The 6105E manifest cargo has arrived status → The system should deny update authorization and generate error message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED'
[Validate Update Authorization]
The manifest has CSA delivered status → The system should deny update authorization and generate error message 'CHANGE NOT APPLIED - CSA MANIFEST ARRIVED'
[Reject - Duplicate Car in Manifest]
The system attempts to add the duplicate car → The system rejects the request with a duplicate car error message
[Reject - Invalid Sequence]
The system attempts to process the car assignment → The system rejects the request with an invalid sequence error message
[Reject - Invalid Relationship]
The system attempts to create the follower manifest → The system rejects the request with an invalid relationship error message
[Reject - Equipment Mismatch]
The system attempts to create the multi-car manifest → The system rejects the request with an equipment mismatch error message
[Train Already Reported?]
The manifest has already been reported on a train (manifest on train status is active) → The system blocks the update with message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN'
[309 User Lock Active?]
The manifest has an active 309 user lock indicating manual changes have been made → The system blocks the update with message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST'
[Cargo Already Arrived?]
The manifest is a 6105E type and the cargo has already arrived at the destination → The system blocks the update with message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED'
[CSA Delivery Status?]
The manifest has CSA delivery status indicating it has been delivered through the Canada-US Agreement process → The system blocks the update with message 'CHANGE NOT APPLIED - CSA MANIFEST ARRIVED'
[Release/Hold Status?]
The manifest has RELEASE status and the current CCN differs from the waybill CCN → The system blocks the update with message 'WB CCN UPDATE NOT APPLIED STATUS OF CARGO IS RELEASE'
[Release/Hold Status?]
The manifest has HOLD status and the current CCN differs from the waybill CCN → The system blocks the update with message 'WB CCN UPDATE NOT APPLIED STATUS OF CARGO IS HOLD'
[Release/Hold Status?]
The manifest has AGI-HOLD status and the current CCN differs from the waybill CCN → The system blocks the update with message 'WB CCN UPDATE NOT APPLIED STATUS OF CARGO IS HOLD-AG'
[Block Deletion - CSA Delivered Status]
A user attempts to delete the manifest → The system blocks the deletion and generates error message 'CHANGE NOT APPLIED - CSA MANIFEST ARRIVED'
[Block Deletion - Train Reported Protection]
A user attempts to delete the train-reported manifest → The system blocks the deletion and generates appropriate blocking message for train reported CCNs
[Block Deletion - Released Manifest Protection]
A user attempts to delete the released manifest → The system blocks the deletion and generates blocking message to protect released manifest integrity
[Block Deletion - Hold Status Protection]
A user attempts to delete the hold status manifest → The system blocks the deletion and generates blocking message to protect hold status manifest integrity
[Block Deletion - Broker Entry Protection]
A user attempts to delete the manifest with broker entry → The system blocks the deletion and generates blocking message to protect broker entry integrity
[Parse XQ Code Format]
The code format is 'XQ:' (with colon) → The broker name is extracted from positions 5-40 of the special handling text
[Parse CB Code Format]
The code format is 'CB:' (with colon) → The broker name is extracted from positions 5-40 of the special handling text
[Data Origin Classification]
The system determines the creation source type → The manifest is tagged with appropriate origin classification (Order Entry Manual, Order Entry EDI, Fastway Manual, or Fastway EDI)
[Manifest Status Assignment Logic]
If transmission requirements and CCN type → The manifest is assigned appropriate status (SENT, MANUAL, REJECT, etc.) based on business rules
[Set Origin: Order Entry EDI]
The system determines the data source type → The data origin is classified as Order Entry EDI
[Set Origin: Fastway EDI]
The system determines the data source type → The data origin is classified as Fastway EDI
[Set Local Status]
The system determines the manifest status based on transmission requirements → The manifest status is set to local processing
[Set Transit Status]
The system determines the manifest status based on transmission requirements → The manifest status is set to transit processing
[Set Origin to Order Entry EDI]
The data source is identified as EDI → The data origin is set to '_ORD EDI _' to indicate electronic order entry processing
[Set Origin to Fastway Manual with ACF2 Userid]
The data source is identified as Fastway → The data origin is set to the ACF2 userid to track the specific user performing manual Fastway entry
[Set Origin to Fastway EDI]
No other data source classification applies → The data origin is set to '_EDI _' to indicate electronic Fastway processing
[Inherit Status from Master]
The system processes the follower manifest configuration → The follower manifest inherits the status, transmission flags, and processing indicators from the master manifest
[Release/Hold Status?]
The manifest status is RELEASE, HOLD, or AGI-HOLD and the CCN differs from waybill CCN → The system blocks the update with status-specific restriction message
[Idler Shipment?]
Equipment changes are requested → The system processes equipment updates with message 'EQUIPMENT UPDATE, MANIFEST NOT UPDATED'
[Train Already Reported?]
The manifest has already been reported on a train (manifest-on-train status is active) → The system blocks the update with message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN'
[Manifest 309-Locked?]
The manifest is in 309-locked status indicating user has made manual changes → The system blocks the update with message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST'
[Cargo Already Arrived?]
The cargo status indicates the cargo has already arrived at destination → The system blocks the update with message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED'
[CSA Delivered Status?]
The manifest has CSA-DLV (CSA delivered) status → The system blocks the update with message 'CHANGE NOT APPLIED - CSA MANIFEST ARRIVED'
[Broker Entry Exists?]
For 6105E manifests, existing broker entry exists and waybill broker differs:
for non-6105E manifests, broker entry is populated and waybill CCN differs from manifest CCN
→ The system blocks the update with appropriate broker conflict message ('BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT' or 'WB CCN UPDATE NOT APPLIED BROKER ENTRY POPULATED')
[Release/Hold Status Conflict?]
The manifest is in RELEASE, HOLD, or AGI-HOLD status and the waybill CCN differs from the current manifest CCN → The system blocks the update with appropriate status-based message ('WB CCN UPDATE NOT APPLIED STATUS OF CARGO IS RELEASE', 'WB CCN UPDATE NOT APPLIED STATUS OF CARGO IS HOLD', or 'WB CCN UPDATE NOT APPLIED STATUS OF CARGO IS HOLD-AG')
[Idler Shipment?]
The shipment is identified as an idler shipment → The system processes the equipment update with message 'EQUIPMENT UPDATE, MANIFEST NOT UPDATED' and applies special idler shipment handling
[Update Equipment Information]
The system processes the equipment information update → Equipment data is updated with new equipment ID and related information before proceeding to idler shipment handling
[Train Already Reported?]
The manifest has already been reported on a train → The system blocks the update with message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN'
[Manifest Locked by User?]
The manifest is locked due to user changes (309 locked status) → The system blocks the update with message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST'
[Cargo Already Arrived?]
The cargo status indicates it has already arrived → The system blocks the update with message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED'
[CSA Delivered Status?]
The manifest has CSA delivered status → The system blocks the update with message 'CHANGE NOT APPLIED - CSA MANIFEST ARRIVED'
[Release/Hold Status?]
The manifest is in RELEASE, HOLD, or AGI-HOLD status and the CCN differs from waybill CCN → The system blocks the update with appropriate status protection message
[Idler Shipment?]
The shipment is identified as an idler shipment → The system processes equipment update with message 'EQUIPMENT UPDATE, MANIFEST NOT UPDATED'
[Multi-Bill Shipment?]
The manifest is part of a multi-bill shipment (has followers or is a follower) → Block the CCN change and return appropriate error message indicating multi-bill restriction
[Multi-Bill Shipment?]
The manifest is part of a multi-bill shipment (has master-follower relationships) → The CCN change is blocked and processing terminates with restriction message
[Log Transfer Required?]
If transfer log requirements → If historical log messages exist for the old CCN, transfer log processing is required
[Transfer Log Messages Between CCNs]
The system processes log message transfers → All historical log messages are transferred from the old CCN to the new CCN maintaining chronological order
[Skip Transmission - Carrier 999]
The CCN carrier code is '999' → The system skips customs transmission processing and does not generate 309 EDI transmission
[Skip Transmission - Released Carrier 105]
The CCN carrier code is '105' AND the manifest status is 'RELEASE' → The system skips customs transmission processing and does not generate 309 EDI transmission
[Set 309 Change Pending Flag]
The manifest is locked by a user (manual changes made) → The system sets the 309 change pending flag and skips immediate transmission processing
[Record Original Sent Date/Time]
This is the first time the manifest is being transmitted (309-NOT-SENT status) → The system records the original sent date and time before generating the 309 EDI transmission
[Generate 309 EDI Transmission]
The manifest is ready for customs transmission → The system generates a 309 EDI transmission containing the manifest data and sends it to customs authorities
[Set Pre-Emanifest Flag]
The manifest status indicates pre-emanifest processing → The system sets the pre-emanifest flag to indicate special handling requirements
[Update Manifest Status to Sent]
The transmission process completes without errors → The system updates the manifest status to 'SENT' to indicate successful customs transmission
[Skip Transmission - Released Carrier 105]
The CCN carrier code is '105' AND the manifest status is 'Release' → The system skips customs transmission processing and does not generate 309 EDI transmission
[Clear 309 Change Pending Flag]
The 309 change pending flag is set to true → The system clears the 309 change pending flag before proceeding with transmission
[Record Original Sent Date/Time]
The original sent date is empty (first time transmission) → The system records the current date and time as the original sent date
[Skip Original Date Recording]
The idler indicator is set to true → The system skips recording the original sent date and proceeds to set pre-emanifest status
[Set Pre-Emanifest Status Flag]
The system is preparing for customs transmission → The system sets the pre-emanifest status flag to indicate transmission readiness
[Generate 309 EDI Transmission to Customs]
All transmission prerequisites are met and no blocking conditions exist → The system generates a 309 EDI transmission and sends it to customs authorities
[Set Customs Notification Sent Flag]
The transmission process completes without errors → The system sets the customs notification sent flag to true to record successful transmission
[Check Delivery Schedule Requirements]
The system checks delivery schedule requirements → The system should evaluate if the broker has default delivery or immediate delivery schedule configured
[Default Delivery Schedule?]
The system checks for default delivery schedule configuration → If broker has default delivery schedule, proceed with notification methods determination, otherwise check for immediate delivery
[Immediate Delivery Schedule?]
The system checks for immediate delivery schedule configuration → If broker has immediate delivery schedule, proceed with notification methods determination, otherwise skip notification due to invalid schedule
[Determine Notification Methods]
The system determines available notification methods → The system should identify all configured delivery methods for the broker including EDI X12, Merlin, Internet, Fax, and Paper options
[EDI X12 Method Available?]
If EDI X12 method availability → If EDI X12 method is available for the broker, send EDI X12 notification, then proceed to check Merlin method
[Send EDI X12 Notification]
The system sends EDI X12 notification → The system should transmit the manifest notification to the broker using EDI X12 electronic format
[Merlin Method Available?]
If Merlin method availability → If Merlin method is available for the broker, send Merlin notification, then proceed to check Internet method
[Check Broker Delivery Schedule]
The system checks the broker's delivery schedule configuration → Proceed only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise skip notification
[Immediate Delivery Schedule?]
If the schedule is set to immediate delivery → If immediate delivery schedule is configured, proceed with broker notification methods determination, otherwise skip notification
[Determine Broker Notification Methods]
The system determines available notification methods → Evaluate broker preferences for EDI X12, Merlin, Internet, Fax, and Paper delivery methods in priority order
[EDI X12 Method Available?]
If EDI X12 capability for the broker → If EDI X12 method is available and configured for the broker, send EDI X12 notification, otherwise check next available method
[Send EDI X12 Notification]
The system sends EDI X12 notification → Transmit manifest data in EDI X12 format to broker's electronic system and continue checking other available notification methods
[Merlin Method Available?]
If Merlin messaging capability for the broker → If Merlin method is available and configured for the broker, send Merlin notification, otherwise check next available method
[Send Merlin Notification]
The system sends Merlin notification using GCT019 message format → Transmit manifest notification through Merlin messaging system and continue checking other available notification methods
[Skip Notification - Invalid Schedule]
The delivery schedule is neither DEFAULT-DELIVERY nor IMMEDIATE-DELIVERY → Skip all broker notification processing and complete the notification workflow without sending any notifications
[EDI X12 Method Available?]
The system checks broker delivery preferences for EDI X12 capability → The system should determine if EDI X12 transmission method is available and preferred
[Set EDI X12 Notification Method]
The system selects notification methods → The system should set EDI X12 as a notification method and continue checking for additional methods
[Fax Method Available?]
The system checks for fax transmission capability → The system should determine if fax method is available for the broker
[Set Fax Notification Method]
The system selects notification methods → The system should set fax transmission as a notification method and continue evaluating other options
[Set Default Delivery Method]
The system assigns delivery timing → The system should set default delivery method for broker notifications
[Set Immediate Delivery Method]
The system assigns delivery timing → The system should set immediate delivery method for broker notifications
[Assign Call Letters for Batch Print]
The system processes paper batch print notifications → The system should assign appropriate call letters for batch print processing
[Configure Notification Schedules]
The system processes notification schedule preferences → The system configures notification schedules (immediate delivery, default delivery) based on broker preferences and business requirements
[EDI Delivery Available?]
The system determines the delivery method for secondary broker → If EDI delivery is available for the secondary broker, send EDI X12 notification, otherwise check next delivery method
[Send EDI X12 Notification]
The system processes the notification transmission → Send EDI X12 formatted notification to the secondary broker and complete the notification process
[Merlin Delivery Available?]
If Merlin delivery availability → If Merlin delivery is available for the secondary broker, send Merlin notification, otherwise check next delivery method
[Internet Delivery Available?]
If internet delivery availability → If internet delivery is available for the secondary broker, send internet notification, otherwise check next delivery method
[Fax Delivery Available?]
If fax delivery availability → If fax delivery is available for the secondary broker, send fax notification, otherwise use paper batch print method
[Send Fax Notification]
The system processes the fax notification → Send notification through fax transmission to the secondary broker and complete the notification process
[Set Up Paper Batch Print]
The system sets up the final delivery method → Configure paper batch print notification for the secondary broker and complete the notification process
[Build Transfer Message]
Transfer message needs to be formatted → Build message containing 'LOG TRANSFERRED FROM [Old CCN]' and 'LOG TRANSFERRED TO [New CCN]' references
[Set Action Code ZZZ]
Action code assignment is required → Set action code to 'ZZZ' to identify this as a log transfer operation
[Create Audit Trail Entry]
Audit trail entry creation is triggered → Create audit record with transfer details, action code, and timestamp
[Original Sent Status?]
If the manifest's transmission history → If the manifest was previously sent to customs, proceed with pre-emanifest condition checks, otherwise skip transmission processing
[Send Customs Transmission?]
If customs transmission requirements → If customs needs cancellation notice, generate 309 EDI cancellation, otherwise proceed to update manifest record
[Generate 309 EDI Cancellation]
The 309 EDI cancellation generation process is executed → A 309 EDI cancellation message is created and queued for transmission to customs authorities
[Update Manifest Record]
The manifest record update process is executed → The manifest record is updated in the database with all cancellation changes committed
[Multi-Bill Shipment Block?]
The manifest is part of a multi-bill shipment configuration that requires manual intervention → The system blocks the automated change and creates a multi-bill block message
[Train-Reported Block?]
The manifest has already been reported on a train → The system blocks the change and creates a train-reported block message
[309-Locked Manifest Block?]
The manifest is locked by 309 transmission processing → The system blocks the change and creates a 309-locked block message
[Arrived Cargo Block?]
The cargo associated with the manifest has already arrived → The system blocks the modification and creates an arrived cargo block message
[CSA-DLV Status Block?]
The manifest has CSA-DLV (CSA delivered) status → The system blocks the change and creates a CSA-DLV block message
[Release/Hold Status Block?]
The manifest is in release or hold status and the change would violate business rules → The system blocks the modification and creates a status block message
[Delete Authorization Block?]
The deletion authorization fails due to business rule violations → The system blocks the deletion and creates a delete block message
[Send Email Alert]
The system sends the email alert → Transmit email to broker contact address and receive transmission confirmation
[Log Email Notification]
The system logs the email notification → Record email transmission details, timestamp, broker information, and manifest identifiers in notification log
[Build Message Content]
The system builds the message content with waybill information and error details → A complete message is constructed with proper formatting for user delivery
[CCN Available?]
The system checks if CARGO-CTL-NO is populated and not spaces → If CCN is available, use CCN-based routing; otherwise use default routing
[Set CCN-Based Routing]
The system sets up message routing parameters → Message routing is configured using the CCN to ensure proper delivery to the responsible party
[Set Default Routing]
The system sets up message routing parameters → Message routing is configured using default parameters for general delivery
[Multi-Bill Delete Function?]
The system checks if the operation involves multi-bill shipments with DELETE function → If multi-bill delete is detected, add special processing message; otherwise proceed with standard routing
[Add Multi-Bill Processing Message]
The system prepares the message content → Additional messaging is included to explain multi-bill processing requirements and manual deletion procedures
[Route to Merlin System]
The system submits the message to the Merlin messaging system → The message is queued for delivery through the Merlin system with proper routing
[7020: Resend Merlin Notification]
The system executes the resend process (7020) → The message is resubmitted to Merlin system with retry logic for delivery
[Update Message Status]
The system updates processing status → Message status is marked as completed and processing continues
[CSA-DLV Status?]
A delete function is requested for this manifest → The deletion is blocked with message 'Cannot Delete CSA Delivered Manifest'
[Multi-Bill Follower?]
A delete function is requested for this follower manifest → The deletion is blocked with message 'Cannot Delete Multi-Bill Follower' and manual deletion is required
[Train Reported?]
A delete function is requested for this manifest → The deletion is blocked with message 'Cannot Delete Train Reported Manifest'
[Released Status?]
A delete function is requested for this manifest → The deletion is blocked with message 'Cannot Delete Released Manifest'
[Hold Status?]
A delete function is requested for this manifest → The deletion is blocked with message 'Cannot Delete Hold Status Manifest'
[Broker Entry Exists?]
A delete function is requested for this manifest → The deletion is blocked with message 'Cannot Delete Manifest with Broker Entry'
[Send Customs Cancellation]
The system processes customs notification requirements → A customs cancellation message is sent to notify authorities of the manifest deletion
[Block: CSA Delivered Status]
A delete function is requested for the manifest → The deletion is blocked and an error message is generated indicating CSA delivered status prevents deletion
[Block: Multi-Bill Follower Deletion]
A delete function is requested for the follower manifest → The deletion is blocked and an error message is generated indicating multi-bill followers require manual deletion
[Block: Train Reported Manifest]
A delete function is requested for the manifest → The deletion is blocked and an error message is generated indicating train reported manifests cannot be deleted
[Block: Released Manifest]
A delete function is requested for the manifest → The deletion is blocked and an error message is generated indicating released manifests cannot be deleted
[Block: Hold/AGI-Hold Status]
A delete function is requested for the manifest → The deletion is blocked and an error message is generated indicating hold status manifests cannot be deleted
[Block: Broker Entry Present]
A delete function is requested for the manifest → The deletion is blocked and an error message is generated indicating broker entry prevents deletion
[Block Follower Deletion]
A delete request is processed for this follower manifest → The system blocks the deletion and generates an error message stating multi-bill follower cannot be deleted
[Log Success Message]
The spawn operation completes successfully → The system logs a success message indicating the customer report was generated and submitted
[Continue with Standard Manifest Processing]
The system continues processing the manifest → Standard manifest processing workflows are executed including transmission, broker notification, and status management
[Spawn GCX011 Update Transaction]
The system is ready to process the follower manifest update → A GCX011 update transaction message is spawned to the message queue for processing
[Generate Multi-Bill Block Message]
The system attempts to perform automatic updates or changes on the follower manifest → The system generates a blocking message indicating that multi-bill changes require manual processing
[Route Message to User]
The system needs to notify users of the blocking condition → The system routes the blocking message to the appropriate user interface or notification system
[Require Manual Intervention]
The system completes the blocking process → The system requires manual intervention before any changes can be made to multi-bill follower manifests
[Block: CSA Delivered Status]
A delete function is requested AND the manifest status is CSA-DLV → The deletion is blocked and an error message is generated indicating CSA delivered status prevents deletion
[Block: Multi-Bill Follower Deletion]
A delete function is requested AND the manifest is identified as a multi-bill follower manifest → The deletion is blocked and an error message is generated requiring manual deletion process
[Block: Train Reported Manifest]
A delete function is requested AND the manifest has been reported on a train → The deletion is blocked and an error message is generated indicating train reported status prevents deletion
[Block: Released Manifest]
A delete function is requested AND the manifest status is released → The deletion is blocked and an error message is generated indicating released status prevents deletion
[Block: Hold Status Manifest]
A delete function is requested AND the manifest status is hold:
AGI-hold
→ The deletion is blocked and an error message is generated indicating hold status prevents deletion
[Block: Broker Entry Present]
A delete function is requested AND a broker entry exists for the manifest → The deletion is blocked and an error message is generated indicating broker entry prevents deletion
[Process Each Follower Sequentially]
The master manifest deletion is processed → The system processes each follower manifest deletion sequentially, spawning delete transactions for each follower before proceeding to delete the master
[Send Customs Cancellation if Required]
The manifest requires customs notification based on transmission status and carrier requirements → The system sends appropriate customs cancellation notifications to relevant authorities
[Check Manifest Status]
A user attempts to delete the manifest using DELETE function → The system blocks the deletion and generates an error message indicating the manifest cannot be deleted because it has been reported on a train
[Check Train Status]
A user attempts to update the manifest information → The system blocks the update and generates an error message indicating the manifest cannot be updated because it is already on a train
[Generate Blocking Message]
A deletion attempt is blocked due to train-reported status → The system generates a specific error message indicating the manifest cannot be deleted because it has been reported on a train
[Generate Update Block Message]
An update attempt is blocked due to train assignment status → The system generates a specific error message indicating the manifest cannot be updated because it is already on a train
[Check Manifest Status]
The system checks the manifest status and finds the manifest has a release status → The system blocks the deletion operation and generates an error message indicating that released manifests cannot be deleted
[Block Deletion]
The deletion block action is triggered → The system prevents the deletion from proceeding and sets appropriate error flags
[Block Deletion - Hold Status Protection]
The manifest status is 'HOLD' → The deletion request must be blocked and an error message indicating hold status protection must be generated
[Block Deletion - AGI-Hold Status Protection]
The manifest status is 'AGI-HOLD' → The deletion request must be blocked and an error message indicating AGI-hold status protection must be generated
[Check Broker Entry Field]
The manifest has a populated broker entry field indicating customs filing has been initiated → The system blocks the deletion operation and generates an error message to preserve customs compliance
[Build Message Content]
The system prepares the final message content for transmission → Format messages with proper headers, CCN information, and routing details according to Merlin system requirements
[Multi-Bill Delete Function?]
If this is a multi-bill delete operation → If the function is DEL-FUNCTION and the manifest has multi-bill characteristics (master/follower relationships), add special blocking message, otherwise proceed with standard CCN-based addressing
[Add Multi-Bill Blocking Message]
The system needs to add protective messaging for multi-bill structures → Add blocking message indicating that multi-bill manifests with master/follower relationships require manual deletion process
[Set CCN-Based Addressing]
The system configures routing parameters for message delivery → Set up CCN-based addressing using CARGO-CTL-NO for proper message routing to Merlin system and other downstream applications
[Route to Merlin System]
The system initiates message transmission to Merlin → Route messages to Merlin system using established communication protocols and addressing schemes
[Spawn GCT1051E Transaction]
The system needs to create integration transaction records → Spawn GCT1051E transaction with appropriate message content and routing information for system integration tracking
[Update Message Status]
The system updates message tracking records → Update message status to reflect successful delivery and timestamp the completion for audit trail purposes
[Log Message Delivery]
The system performs audit logging for message delivery → Create detailed log entries with timestamp, recipient information, message content summary, and delivery confirmation for compliance and tracking purposes
[Resend Required?]
If message resend is required → If message delivery confirmation indicates failure or if business rules require duplicate delivery for critical messages, initiate resend process, otherwise complete message routing successfully
[7020-Resend Merlin Processing]
The system initiates resend processing through Merlin → Execute 7020-RESEND-MERLIN processing to retry message delivery with appropriate retry logic and error handling
[Set Action Code to ZZZ]
Creating the log transfer message → The action code is set to 'ZZZ' to distinguish transfer transactions from regular manifest operations
[Build Transfer Message Text]
Building the message text with old CCN and new CCN values → The message text is formatted as '_LOG TRANSFERRED FROM [OLD-CCN] TO [NEW-CCN]_' to provide clear audit trail information
[Record Old CCN in Log]
Recording the CCN change details → The old CCN value is recorded in the transfer log for historical reference
[Record New CCN in Log]
Recording the complete CCN change details → The new CCN value is recorded in the transfer log to show the final state after change
[Route to Customs Application]
The system needs to provide alternative processing path → The system routes the shipment to customs application for manual processing and review
[Generate Train Status Blocking Message]
An update attempt is made on the train-reported manifest → The system generates message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN' to inform the user of the blocking reason
[Log Blocking Reason]
The blocking flag is set and error message is generated → The system logs the blocking event with the specific reason and manifest details for audit purposes
[Train Already Reported?]
The manifest has already been reported on a train → The system blocks the update and generates a train reported blocking message
[Block Update - Train Reported]
The manifest status indicates it has been reported on a train → The system generates a blocking message to prevent the update
[Block Update - 309 Locked]
The manifest is locked due to user manual changes (309 locked status) → The system generates a blocking message indicating user made changes to manifest
[Block Update - Broker Entry Exists]
A conflicting broker entry already exists for the manifest → The system generates a blocking message indicating broker entry prevents the update
[Block Update - CSA Delivered]
The manifest has CSA delivered status → The system generates a blocking message indicating CSA manifest has arrived
[Generate Blocking Message]
The system needs to communicate the blocking reason → The system generates a specific blocking message and routes to manual processing
[Send Message to Customs Application]
The system needs to notify the customs application → The system notifies the user that manual intervention is required
[Convert Long Name to Short Name]
The system looks up the broker name in the GCST2RT broker name segment table → If the broker is found in the table, the long name is converted to the corresponding standardized short name
[Set Broker Name as UNKNOWN]
The broker name is not found in the GCST2RT broker name segment table → The broker name is set to 'UNKNOWN' as the standardized designation for unrecognized brokers
[Access Station Master Table - MC Segment]
The system accesses the MC segment of the station master table using the extracted station number → Station lookup is performed and availability status is determined for further processing
[Station Found in MC Table?]
If the lookup results → If station is found, station details are retrieved; if not found, system attempts lookup in CM segment
[Retrieve Station Details]
The system retrieves station details from the MC table → Station information is loaded and processing continues to station number format validation
[Access Station Master Table - CM Segment]
The system accesses the CM segment of the station master table using the same station number → Alternative station lookup is performed to check for station existence in CM segment
[Station Found in CM Table?]
If the CM segment lookup results → If station is found, port code information is retrieved; if not found, station not found error is generated
[Retrieve Port Code Information]
The system retrieves port code information from the CM table → Port code details are loaded and processing continues to station number format validation
[Set Status = SENT]
No validation errors exist AND transmission is required → Set manifest status to SENT
[Transmission Required?]
Transmission is not required based on business rules → Set manifest status to MANUAL
[Set 309 Change Pending Flag]
309 change is pending for the manifest → Set the 309 change pending flag to trigger customs update transmission
[Set Idler Indicator]
Idler processing is required for the shipment → Set the idler indicator flag for special customs handling
[Send Customs Transmission]
All flags and indicators are properly set → Send the customs transmission with manifest data to customs authorities
[Is First Time Send?]
The system checks the manifest transmission history → The system identifies whether this is a first-time send or a subsequent update based on previous transmission records
[Set Final Send Operation]
The system determines this is a first-time transmission → The system configures the operation as a final send and prepares to record the original sent date
[Set Update Operation]
The system determines this is a subsequent transmission → The system configures the operation as an update rather than a final send
[Pre-Emanifest Status?]
If the current manifest status → The system determines if the manifest is in pre-emanifest status and sets the corresponding flag accordingly
[Update Last Modified Timestamp]
The system completes the operation configuration and logging → The system updates the last modified timestamp to reflect the current processing time
[Block CCN Change - Multi-Bill Restriction]
The system attempts to change the CCN → The CCN change is blocked and processing terminates with multi-bill restriction message
[Set Up GCSCCS54 Record]
System sets up GCSCCS54 record for storage → GCSCCS54 record is initialized with proper structure, timestamps, and classification information for error storage
[Update Audit Trail]
System updates audit trail with error information → Audit trail is updated with error processing completion status, error counts, and processing timestamps
[Store GCSCCS54 Record for Audit Trail]
The error record needs to be persisted → The system stores the GCSCCS54 record to the audit trail database for tracking and compliance purposes
[Set Origin: Order Entry EDI]
Data source is identified as Order Entry system AND entry method is EDI entry → System sets data origin classification to Order Entry EDI
[Set Origin: Fastway EDI]
Data source is identified as Fastway system AND entry method is EDI entry → System sets data origin classification to Fastway EDI
[Schedule Type?]
If the schedule type → Schedule is classified as either DEFAULT-DELIVERY or IMMEDIATE-DELIVERY for further processing
[Set Delivery Method Flags]
The system configures delivery method flags → Appropriate flags are set for X12 transmission, Merlin messaging, internet delivery, fax transmission, or paper batch printing based on broker preferences
[Process Notification]
The system processes the broker notification → Notification is sent using the appropriate delivery method (X12 EDI, Merlin, Internet, Fax, or Paper) according to broker preferences
[EDI X12 Method Selected?]
If EDI X12 method selection → If EDI X12 method is selected, send EDI X12 transmission, otherwise check next delivery method
[Send EDI X12 Transmission]
The system processes the transmission → EDI X12 transmission is sent to the broker and processing continues to check other delivery methods
[Merlin Method Selected?]
If Merlin method selection → If Merlin method is selected, send Merlin notification, otherwise check next delivery method
[Fax Method Selected?]
If Fax method selection → If Fax method is selected, send Fax transmission, otherwise check next delivery method
[Send Fax Transmission]
The system processes the Fax transmission → Fax transmission is sent to the broker and processing continues to check other delivery methods
[Determine Notification Methods]
The system needs to send notifications to the broker → Available notification methods are determined based on broker preferences including X12 EDI, Merlin, Internet, Fax, and Paper batch print
[Send X12 EDI Notification]
The system sends broker notifications → An X12 EDI notification is transmitted to the broker with manifest information
[CCN Carrier Index = 999?]
The CCN carrier index equals 999 → The system skips customs transmission and proceeds to end processing
[CCN Carrier Index = 105 AND Specific Conditions?]
The CCN carrier index equals 105 AND specific bypass conditions are satisfied → The system skips customs transmission and proceeds to end processing
[Manifest Has Release Status?]
The manifest has release status → The system proceeds to evaluate change pending flag conditions
[309 Change Pending Flag Set?]
The 309 change pending flag is set (indicating manifest is locked) → The system sets change pending flag for locked manifests and ends processing without transmission
[Set Pre-Emanifest Status]
The manifest is being processed for first-time transmission → The system sets pre-emanifest status to prepare for customs transmission
[Record Original Sent Date/Time]
The system is preparing for customs transmission → The system records the original sent date and time for future reference
[Send 309 EDI Transmission to Customs]
All pre-transmission conditions are satisfied → The system sends 309 EDI transmission to customs and completes processing
[Is 309 Change Pending?]
The 309 change pending flag is set to 'Y' → The system sets the pre-emanifest flag to ON to enable customs transmission processing
[Is First Transmission?]
This is the first transmission attempt (original sent status is not set) → The system records the original sent date and marks the transmission as the initial send
[Finalize Pre-Emanifest Status]
The manifest has been evaluated against all business rules → The system finalizes the pre-emanifest status configuration and prepares for customs transmission
[Delay Notification Required?]
The system checks business conditions that may require notification delays → The system determines whether to delay the notification or proceed immediately
[Set Notification Delay Flag]
The system needs to configure delay processing parameters → The notification delay flag is set to prevent immediate customs notification
[Process Immediate Notification]
The system is ready to send customs notification → The immediate notification is processed and sent to customs authorities
[Check if First Transmission]
The system determines this is the first transmission attempt for this notification → The system should proceed to check if original sent date needs to be recorded
[Record Current Date and Time]
The system needs to record the transmission timestamp → The current system date and time should be captured for recording
[Set Original Sent Date]
The original sent date field needs to be populated → The captured current date should be stored in the original sent date field
[Skip Recording - Already Set]
The original sent date field already contains a value from a previous transmission → The system should skip the date and time recording process and continue with normal processing
[Is Manifest 309-Locked?]
The system checks the manifest's 309 lock status → The system identifies whether the manifest is locked for 309 processing and routes to appropriate change pending flag handling
[Check Current Manifest Status]
If the manifest's current processing status → The system determines the manifest's current state for change pending flag processing
[Set 309 Change Pending Flag ON]
The system processes the change pending flag requirement → The system sets the 309 change pending flag to ON to indicate future transmission is required
[Clear 309 Change Pending Flag]
The system determines no change pending flag is needed → The system clears or maintains the 309 change pending flag as OFF
[Is Pre-Emanifest Status Set?]
The system checks for pre-emanifest status on the manifest → If pre-emanifest status is set, the system maintains the change pending flag; otherwise, it proceeds to update the manifest record
[Maintain Change Pending Flag]
The system processes flag maintenance requirements → The system maintains the current change pending flag setting without modification
[Update Manifest Record]
The system updates the manifest record → The manifest record is updated with the correct 309 change pending flag status
[Future Transmission Required?]
If future transmission requirements → If future transmission is required, the system schedules 309 EDI transmission; otherwise, it completes the flag management process
[Schedule Future 309 EDI Transmission]
The system schedules future 309 EDI transmission → The manifest is queued for future 309 EDI transmission processing
[Default Delivery Schedule?]
If the delivery schedule is configured as default delivery → If default delivery schedule exists, validate default delivery requirements; otherwise check for immediate delivery schedule
[Immediate Delivery Schedule?]
If the delivery schedule is configured as immediate delivery → If immediate delivery schedule exists, validate immediate delivery requirements; otherwise set invalid schedule flag
[Determine Notification Method for Secondary Broker]
The system determines notification delivery method → The system evaluates available delivery methods in priority order: EDI, Merlin, Internet, Fax, then Paper
[EDI Delivery Available?]
EDI delivery capability is evaluated → If EDI delivery is available, send EDI X12 notification, otherwise check Merlin delivery availability
[Send EDI X12 Notification]
The system processes EDI notification → The system sends EDI X12 notification to the secondary broker and logs the notification
[Merlin Delivery Available?]
Merlin delivery capability is evaluated → If Merlin delivery is available, send Merlin notification, otherwise check Internet delivery availability
[Prepare Merlin Message for Unknown Broker]
The system prepares the Merlin notification message → The message is formatted specifically for unknown broker notifications with appropriate content
[Set Message Routing to Merlin System]
The system configures message routing parameters → The message routing is set to direct the notification through the Merlin messaging system
[Include Manifest CCN in Message]
The system includes tracking information in the message → The manifest CCN is included in the message for identification and tracking purposes
[Send Merlin Notification]
The system transmits the notification → The Merlin notification is sent through the messaging system for unknown broker processing
[Log Unknown Broker Notification]
The system creates audit trail entries → An audit log entry is created documenting the unknown broker notification transmission
[Validate Default/Immediate Schedule]
The schedule is checked against valid types → Only DEFAULT-DELIVERY and IMMEDIATE-DELIVERY schedules are processed for notification delivery
[X12 EDI Enabled?]
The system checks X12 EDI capability → X12 EDI notification is sent if enabled, otherwise processing continues to next delivery method
[Send X12 EDI Notification]
X12 EDI notification is triggered → Electronic notification is transmitted via X12 EDI format to the broker
[Merlin Delivery Enabled?]
The system checks Merlin delivery capability → Merlin notification is sent if enabled, otherwise processing continues to next delivery method
[Process Secondary Broker Notifications]
Secondary broker processing is triggered → Secondary broker notifications are processed using the same delivery method validation and transmission logic as primary broker
[Default Delivery Schedule?]
The system checks if the broker has default delivery schedule configured → If default delivery schedule is configured, the default delivery flag is set; otherwise, the system checks for immediate delivery requirements
[Immediate Delivery Required?]
The system checks for immediate delivery requirements → If immediate delivery is required, the immediate delivery flag is set; otherwise, the default delivery flag is set as fallback
[Set Default Delivery Flag]
The system sets the default delivery flag → The notification method determination process is initiated with default delivery timing parameters
[Set Immediate Delivery Flag]
The system sets the immediate delivery flag → The notification method determination process is initiated with immediate delivery timing parameters
[Determine Notification Method]
The system determines the appropriate notification method → Available communication methods are evaluated in priority order starting with EDI X12 capability
[EDI X12 Available?]
The system checks for EDI X12 availability for the broker → If EDI X12 is available, EDI X12 notification is sent; otherwise, the system checks for Merlin availability
[Merlin Available?]
The system checks for Merlin system availability → If Merlin is available, Merlin notification is sent; otherwise, the system checks for Internet availability
[Internet Available?]
The system checks for Internet delivery availability → If Internet delivery is available, Internet notification is sent; otherwise, the system checks for Fax availability
[Fax Available?]
The system checks for fax communication availability → If fax is available, fax notification is sent; otherwise, paper notification is queued as the final fallback method
[Send EDI X12 Notification]
The system sends EDI X12 notification → Arrival notification is transmitted electronically via EDI X12 protocol and the system proceeds to check for secondary broker existence
[Send Merlin Notification]
The system sends Merlin notification → Arrival notification is transmitted through Merlin messaging system and the system proceeds to check for secondary broker existence
[Send Customs Transmission for Cancellation]
The manifest cancellation process checks the original sent status → A customs transmission is generated to notify customs authorities of the manifest cancellation
[Generate 309 EDI Cancellation]
Pre-emanifest conditions are evaluated and found to be met → A 309 EDI cancellation message is generated for electronic transmission to trading partners
[Update Manifest Record]
The final manifest record update is performed → The manifest record is updated with the cancelled status and all related changes are committed to the database
[Preserve Audit Trail Data]
The system prepares for customs transmission evaluation → Audit trail data including original sent status and pre-emanifest flags are preserved for transmission decision making
[Original Sent Status = 'Y'?]
If the original sent status flag → If the original sent status equals 'Y', proceed to check pre-emanifest conditions, otherwise skip customs transmission
[Pre-Emanifest Flag Set?]
If the pre-emanifest flag → If the pre-emanifest flag is set, send customs transmission, otherwise skip customs transmission
[Send 309 EDI Customs Transmission]
The system determines customs notification is required → A 309 EDI customs transmission is sent to notify customs of the manifest cancellation
[Skip Customs Transmission]
Either the original sent status is not 'Y' or the pre-emanifest flag is not set → The customs transmission is skipped and the cancellation process continues without customs notification
[Spawn GCX011 Update Transaction]
The system is ready to process the follower update → A GCT0111E message is spawned to update the follower manifest with the new master CCN information
[Call Fastway Database Service]
The system calls the Fastway database service to retrieve SHIPMIN segment S/1 → The system should successfully retrieve and store the shipment minimum data
[Store Shipment Minimum Data]
Shipment minimum segment data is returned from the database → The system should store the retrieved shipment minimum data and set success flag
[Order Entry Source?]
If the data origin source → Processing branches to manual order entry classification if source is order entry system
[EDI Source?]
If the source is EDI → Processing branches to electronic EDI classification if source is EDI system
[Mark as 'ORD EDI' Electronic]
The system classifies the data origin for customer reporting → The data origin is marked as 'ORD EDI' indicating electronic EDI processing
[Fastway Manual?]
If the source is Fastway manual entry → Processing branches to user ID marking if source is Fastway manual system
[Mark as 'EDI' Electronic]
The system classifies the data origin for customer reporting → The data origin is marked as 'EDI' indicating electronic processing
[Include Processing Status]
The system completes populating the record with status information → Current processing status and any error messages are included in the customer report
[Call Fastway Database for SHIPMIN Segment]
The system calls the Fastway database to retrieve SHIPMIN segment information → The system should attempt to retrieve the shipment minimum data from the Fastway database
[Store SHIPMIN Data for Processing]
The retrieval operation completes without errors → The system should store the SHIPMIN data for use in waybill processing operations
[Lookup Broker in GCST2RT Table]
System searches the GCST2RT broker name segment table using the extracted broker name → Return broker found status and retrieve corresponding broker information if match exists
[Get Manifest Port Code]
Retrieving the port code for broker validation → Extract the port code from the manifest-to transmission code field
[Call Message Table Service]
The system calls the table service with table ID 'MS' and the error number as the lookup key → The table service attempts to locate the message segment corresponding to the error number
[Set Table Function Code]
The system prepares to access a configuration table → The table function code is set to 'GU' (Get Unique) to retrieve specific table segments
[Set Table Key Values]
The system configures table access parameters → The table ID, key values, and search criteria are set based on the requested data type (BK for brokers, MS for messages, AD for addresses, LT for locations, etc.)

Structural Validations

[8:Entry Station Verification]
The MANI-FROM-PORT field is empty or spaces → The system generates an error message and prevents further processing
[9:Country Code Validation]
The Canadian customs code is '00000' → The system generates an error message indicating invalid customs code
[24:Customs Transmission Processing]
The manifest status is not SENT AND not REJECTED AND carrier is not 999 or 105 AND waybill is completed → The system creates a customs transmission (309) and sets appropriate transmission flags
[Error: Missing Waybill]
Missing waybill error handling executes → Error condition is set and appropriate error message is generated
[Spawn Waybill Number Present?]
The system checks the spawn waybill number field → If the spawn waybill number is empty or contains only spaces, set error flag and message indicating missing waybill number
[Valid Action Code?]
The system validates the action code → If the action code is not ADD-FUNCTION, IIS-ADD-FUNCTION, or DEL-FUNCTION, set error flag and message indicating invalid action code
[Waybill Found in Fastway?]
The system checks if the waybill was found → If the waybill is not found in Fastway database, set error flag and message indicating waybill not found
[Waybill Found in Fastway?]
The system checks the lookup result → If the waybill is not found in the database, set error flag and message indicating waybill not found
[Check Carrier Code]
The carrier code is 974 or 990 AND the car type is TCSZ, CSRZ, or NERZ AND the junction symbol is 'X' → The system sets the road-railer rejection flag, generates a rejection message, and blocks manifest processing
[Generate Rejection Message]
The system processes the rejection → A rejection message is generated explaining the road-railer incompatibility
[Origin = 'CA' AND Destination = 'US'?]
The system validates the waybill for country code requirements → The waybill must have a manifest port populated, otherwise it should be rejected with an error message indicating Canada to US shipments require manifest port
[Generate Multi-Bill Error Message]
The system needs to inform the user of the deletion restriction → A multi-bill deletion error message is generated explaining the manual deletion requirement
[Generate Error Message]
Any validation check fails for skip, create follower, update, or delete actions → The system should generate an appropriate error message describing the business rule violation and continue to next process
[Broker Entry Exists?]
The manifest is 6105E type and has an existing broker entry that differs from the waybill broker information → The system blocks the update with message 'BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT'
[Broker Entry Exists?]
A broker entry exists and the current CCN differs from the waybill CCN → The system blocks the update with message 'WB CCN UPDATE NOT APPLIED BROKER ENTRY POPULATED'
[Format: 'CUSTOMS BROKER ' + name?]
The system parses the broker name format → The system extracts the broker name from positions 16-28 after the 'CUSTOMS BROKER ' prefix
[Format: 'CUSTOMS BROKER: ' + name?]
The system parses the broker name format → The system extracts the broker name from positions 17-27 after the 'CUSTOMS BROKER: ' prefix
[Format: 'BROKER ' + name?]
The system parses the broker name format → The system extracts the broker name from positions 8-36 after the 'BROKER ' prefix
[Format: 'BROKER: ' + name?]
The system parses the broker name format → The system extracts the broker name from positions 9-35 after the 'BROKER: ' prefix
[Format: 'CB ' + name?]
The system parses the broker name format → The system extracts the broker name from positions 4-41 after the 'CB ' prefix
[Format: 'CB: ' + name?]
The system parses the broker name format → The system extracts the broker name from positions 5-40 after the 'CB: ' prefix
[Format: 'XQ ' + name?]
The system parses the broker name format → The system extracts the broker name from positions 4-41 after the 'XQ ' prefix
[Format: 'XQ: ' + name?]
The system parses the broker name format → The system extracts the broker name from positions 5-40 after the 'XQ: ' prefix
[Error Message Collection and Storage]
The system encounters validation or processing errors → Error messages are collected, formatted, and stored for subsequent user notification
[Collect Error Messages from Multiple Sources]
The system processes manifest creation → All error messages from different sources are collected and consolidated
[Collect Error Messages from Multiple Sources]
Multiple system components may have generated error messages → All error messages are collected and consolidated for user notification and system logging
[Handle Copy Error]
Data validation fails or save operation encounters an error → The copy operation is rolled back, error is logged, and appropriate error message is generated for the user
[Train Already Reported?]
The manifest has already been reported on a train → The system blocks the update with message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN'
[Manifest 309 Locked?]
The manifest is locked due to user modifications (309 locked status) → The system blocks the update with message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST'
[Cargo Already Arrived?]
The cargo status indicates it has already arrived → The system blocks the update with message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED'
[CSA Delivered Status?]
The manifest has CSA delivered status → The system blocks the update with message 'CHANGE NOT APPLIED - CSA MANIFEST ARRIVED'
[Broker Entry Exists?]
An existing broker entry is present and the broker name differs from the waybill broker for 6105E manifests:
a broker entry exists with different CCN for non-6105E manifests
→ The system blocks the update with appropriate broker conflict message
[CCN Change Requested?]
The manifest is in RELEASE, HOLD, or AGI-HOLD status and the requested CCN differs from the waybill CCN → The system blocks the CCN update with appropriate status-specific message
[Consistent Routing?]
The system validates routing information across all waybills in the carload → The system confirms that origin, destination, and intermediate routing are consistent across all shipments, otherwise rejects due to inconsistent routing
[Broker Entry Exists?]
For 6105E manifests, existing broker entry exists and waybill broker differs:
for non-6105E manifests, broker entry is populated and CCN differs from waybill CCN
→ The system blocks the update with appropriate broker conflict message
[Handle Validation Errors]
The system handles validation errors → The system processes validation errors, generates appropriate error messages, and terminates bunch bill processing with proper error status
[Skip Transmission - Rejected Status]
The manifest status is 'REJECTED' → The system skips customs transmission processing and does not generate 309 EDI transmission
[Skip Transmission - Rejected Status]
The manifest status is 'Rejected' → The system skips customs transmission processing and does not generate 309 EDI transmission
[Skip Notification - Invalid Schedule]
The system encounters invalid delivery schedule configuration → The system should skip broker notification processing and complete without sending any notifications
[Immediate Delivery Schedule?]
The system checks for immediate delivery schedule preferences → The system should determine if immediate delivery schedule is configured for the broker
[Parse Broker Name Format]
The string matches one of the recognized patterns (CUSTOMS BROKER, BROKER, CB, XQ with or without colons) → The system extracts the broker name from the corresponding character positions based on the matched pattern format
[Validate Broker Name in GCST2RT Table]
The broker name is looked up in the GCST2RT broker reference table → The system determines if the broker name is valid and can be standardized to a recognized short name
[Check Pre-Emanifest Conditions]
The system checks pre-emanifest conditions → The CCN type and carrier conditions are validated to determine if customs transmission is required
[Broker Entry Block?]
A broker entry exists that conflicts with the proposed change → The system blocks the automated change and creates a broker entry block message requiring manual processing
[7250:Collect Error Messages]
The error collection process is invoked → All blocking condition messages are collected and prepared for storage
[Store Error in GCSCCS54 Record]
The error storage process is executed → The error information is stored in the GCSCCS54 record with appropriate blocking condition details
[7010:Send Error Messages to Merlin]
The Merlin transmission process is invoked → Error messages are sent to the Merlin system for user notification and the error reporting process is completed
[Error Messages Exist?]
If whether error messages exist in the message array → If error messages are present, proceed to collect them; otherwise skip message processing
[Collect Error Messages]
The system processes each error message number to retrieve corresponding message text → All error messages are collected and formatted for user notification
[Message Sent Successfully?]
The system checks the transmission status → If successful, update message status; if failed, attempt resend; if error occurs, handle appropriately
[Log Error Message]
The spawn operation encounters an error → The system logs an error message with details about the failure for troubleshooting and retry processing
[Reject Invalid Country Combination]
The waybill does not represent a valid Canada to US movement → The waybill is rejected and appropriate error messages are generated indicating invalid country combination for US in-transit processing
[Block Follower Deletion]
The manifest is identified as a multi-bill follower manifest → The system blocks the deletion and generates an error message indicating that multi-bill follower manifests cannot be deleted
[Generate Error Message]
The error message generation process is invoked → The system creates an error message indicating that manifests with release status cannot be deleted
[Set Processing Error Flag]
The system sets the processing error flag → The error flag is activated to indicate the deletion operation failed due to business rule violation
[Generate Hold Status Error Message]
The system needs to inform the user of the deletion restriction → An error message must be generated indicating that deletion is not allowed for manifests in hold status
[Generate AGI-Hold Status Error Message]
The system needs to inform the user of the deletion restriction → An error message must be generated indicating that deletion is not allowed for manifests in AGI-hold status
[Generate Error Message]
The system needs to communicate the reason for blocking the deletion → The system generates an error message indicating that manifests with broker entries cannot be deleted
[Error Messages Exist?]
If error messages were generated during validation or processing steps → If error messages exist in the message array, proceed to collect and format them for distribution, otherwise complete message routing successfully
[Collect Error Messages]
The system needs to prepare messages for distribution → Collect all error messages from WS-MSG-ERROR-NBR array and format them into a coherent message structure for transmission
[Message Send Successful?]
If the success of message transmission → If message transmission completed without errors, proceed to update message status, otherwise handle transmission failure
[Generate Error Message: Multi-Bill/Multi-Car Changes Require Manual Processing]
The system needs to inform users about the processing restriction → The system generates an error message indicating that multi-bill or multi-car changes require manual processing through customs application
[Check if Manifest is Train-Reported]
An update request is received for the manifest AND the manifest status indicates it has been reported on a train → The system blocks the update operation and generates a train status blocking message
[Create Error Log Entry]
The system needs to create an audit trail → The system sends a message to the customs application about the manual intervention requirement
[Parse Broker Name Formats]
The system parses the broker name from the special handling text → Broker names are extracted based on format: 'CUSTOMS BROKER ' (positions 16-28), 'CUSTOMS BROKER: ' (positions 17-27), 'BROKER ' (positions 8-36), 'BROKER: ' (positions 9-35), 'CB ' (positions 4-41), 'CB: ' (positions 5-40), 'XQ ' (positions 4-41), or 'XQ: ' (positions 5-40)
[Lookup Broker by Manifest Port]
The system validates the broker against the GCSTBRT broker master table using the specific manifest port code → The broker is validated using table ID 'BK', Canadian flag 'C', the specific broker name, and the manifest port transmission code
[Validate Station Number Format]
The system validates the station number format against business requirements → Station number format compliance is determined for final processing decision
[Station Not Found Error]
The system processes the station not found condition → Station not found error is generated and appropriate error handling is initiated
[Validation Errors?]
Validation errors are detected during processing → Set manifest status to REJECT
[Check Manifest Status]
The manifest status is 'REJECTED' → Skip customs notification and do not send transmission to customs authorities
[Has Original Sent Date?]
The system checks for an existing original sent date → The system determines if this is a final send operation or an update operation based on the presence of the original sent date
[Error Messages Found?]
System checks for presence of error messages from validation processes → System identifies whether error messages exist and routes to appropriate processing path
[Collect Error from Processing]
System processes waybill validation results → Waybill validation error messages are collected for storage including empty waybill errors and invalid action code errors
[Collect Error from Processing]
System processes CCN operation results → CCN processing error messages are collected including CCN generation failures and validation errors
[Collect Error from Processing]
System processes manifest operation results → Manifest processing error messages are collected including creation failures, update restrictions, and deletion prevention errors
[Collect Error from Processing]
System processes broker validation results → Broker validation error messages are collected including invalid broker names and broker table lookup failures
[Collect Error from Processing]
System processes country code validation results → Country code validation error messages are collected including empty manifest port errors and invalid customs code errors
[Collect Error from Processing]
System processes station verification results → Station verification error messages are collected including invalid entry stations and missing border call letters
[Format Error Message]
System formats the error message → Error message is formatted with proper structure and content for audit trail storage
[Add to Error Collection]
System adds error to collection array → Formatted error message is added to error collection array and error counter is incremented
[More Errors to Process?]
System checks for remaining errors to process → System identifies whether more errors exist and continues collection or proceeds to storage preparation
[Classify Error Origin]
System classifies error origin sources → Each error is classified as Order Entry Manual, Order Entry EDI, Fastway Manual, or Fastway EDI based on processing source
[Store Error Messages in GCSCCS54]
System stores error messages in audit trail → Error messages are permanently stored in GCSCCS54 records with proper audit information and timestamps
[Set Error Found Flag]
System sets error found indicator flag → Error found flag is set to true to indicate errors were processed and stored for audit trail
[Check for Validation Errors]
Error message collection routine is invoked → The system checks for the presence of validation errors from waybill processing, cargo validation, and business rule checks
[Validation Errors Found?]
Validation error status is evaluated → If validation errors are found, proceed to collect error messages; otherwise, skip error message collection and continue processing
[Collect Error Messages from Multiple Sources]
Error message collection is initiated → The system collects error messages from validation error sources, business rule violation sources, and system error message sources
[Move Error Messages to GCSCCS54-MSG-LABEL]
Error messages need to be stored in the audit record → The collected error messages are moved to the GCSCCS54-MSG-LABEL field for audit trail purposes
[Set Error Message Indicators]
Error message indicators need to be set → The system sets error message presence flags and error type indicators in the GCSCCS54 record
[No Error Messages to Store]
No validation errors are found → The system bypasses error message collection and continues with normal processing flow
[Validate Immediate Delivery Schedule]
The system validates the immediate delivery schedule → Schedule is confirmed as valid for immediate notification processing
[Default or Immediate Delivery?]
The system validates the broker delivery schedule → Processing continues only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise notification process terminates
[Manifest Status = Rejected?]
The manifest status is 'REJECTED' → The system skips customs transmission and proceeds to end processing
[Original Sent Date Exists?]
The original sent date exists (indicating previous transmission) → The system skips transmission as it was already sent and ends processing
[Set Pre-Emanifest Status Active]
The manifest is not rejected, not released, and meets carrier requirements → The system activates the pre-emanifest status to enable customs transmission
[Original Sent Date Empty?]
The original sent date field is checked for existing values → If the field is empty, proceed to record current timestamp; if already populated, skip the recording process
[Validate Immediate Delivery Requirements]
The system validates the immediate delivery requirements against business rules → The validation result determines if the schedule is valid for notification processing
[Delivery Schedule Valid?]
The system validates the delivery schedule → Processing continues only for DEFAULT-DELIVERY or IMMEDIATE-DELIVERY schedules, all other schedules are rejected
[Validate Delivery Schedule]
The system validates the delivery schedule configuration → The delivery schedule type is confirmed as either default delivery or immediate delivery based on broker preferences
[Clear SHIPMINS Data]
Shipment minimum segment data cannot be retrieved from the database → The system should clear the SHIPMINS data to spaces and set error flag
[Collect Error Messages]
The system prepares customer report data → All error messages from processing are collected for inclusion in the customer report
[Clear SHIPMIN Data]
The retrieval operation fails or returns no data → The system should clear all SHIPMIN data fields to spaces to ensure no invalid data is used in processing
[Set Error Status]
The system cannot obtain the required SHIPMIN information → The system should set an error status to indicate the retrieval failure
[Parse Broker Name from Code]
Code format matches predefined patterns (CUSTOMS BROKER, BROKER, CB, XQ with or without colons) → Extract broker name from specific character positions based on the matched format pattern
[Convert to Short Broker Name]
Long broker name is validated and exists in the system → Convert the long broker name to its corresponding short broker name format
[Set Broker Name to UNKNOWN]
Broker is not found in name segment table:
broker name validation fails
→ Set broker name to 'UNKNOWN' for further processing
[Error Message Retrieval from Message Table - Retrieve standardized error messages from message table using error numbers for user notification]
The system attempts to retrieve the corresponding error message from the message table using table ID 'MS' → If the message is found in the table, the English text is retrieved and moved to MSG-LABEL for display; if not found, the message is set to spaces as default
[Set Default Error Message]
The table lookup returns a not-found status → The system sets the message to spaces as a default fallback value
[Retrieve Error Message Text]
The message segment contains valid error message text → The system moves the English text portion to MSG-LABEL for user display formatting

Module: GCX012 1 Consolidated Epic Story

Epic: GCX012 Complete EDI Specification Extracted from Legacy

Contains 24 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX012 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Copy Input to Output]
The system processes the message → The input message content is copied to the output message
[3:Set Default Menu Selection]
The system initializes output parameters → The output selection code is set to cargo menu default value
[Set Enter Invalid Message]
The system validates the key usage → The system message number is set to Enter Invalid status
[Set Function Unavailable Message]
The system validates function availability → The system message number is set to Function Unavailable status
[7:Process Invalid PF Key]
The system validates the function key → The system message number is set to PF Key Invalid status
[Clear Input Field]
The system processes the input field → The input field is cleared by setting it to spaces
[9:Restore Program Control]
The system prepares to end the session → The original program name is restored to the program control
[Transfer Complete Message Content]
The message transfer process is initiated → The complete input message content is copied to the output message
[Set Default Menu Selection - Set output select code to US Cargo Menu]
The system initializes the output response → The output select code is set to US Cargo Menu as the default selection
[Check Message ID]
The system checks if the message ID equals the US Cargo Menu Module ID constant → The system routes to cargo menu processing if message ID matches US Cargo Menu Module ID, otherwise routes to non-cargo menu processing

Structural Validations

[4:Validate Cargo Menu Input]
The system checks the message source → The message is identified as either from US Cargo Menu or from another source
[5:Process Enter Key Validation]
The system checks the function key pressed → The Enter key is identified and processed according to cargo menu rules
[6:Process Function Availability Check]
The system validates function availability → The function is identified as either available or unavailable
[8:Clear Input Field for Non-Main Menu]
The system checks if the message is also not from US Main Menu → The system determines whether to clear the input field or leave it unchanged
[Input from US Cargo Menu - Continue Processing]
The function key pressed is Enter → The system sets error message to Enter Invalid
[Input from US Cargo Menu - Continue Processing]
The function key indicates selection not available → The system sets error message to Function Unavailable
[Input from US Cargo Menu - Continue Processing]
Any other function key is pressed → The system sets error message to PF Key Invalid
[Input Not from US Cargo Menu - Skip Cargo Menu Processing]
The message ID is also not from US Main Menu Module → The system clears the input field by setting it to spaces
[Set Enter Invalid Message]
The function key pressed is Enter (ENTER-VALUE) → The system message number is set to Enter Invalid (ENTER-INVALID) to indicate the operation is not allowed
[Check if Function is Available]
The user presses a function key that corresponds to SEL-NOT-AVAILABLE → The system sets the message to FUNCTION-UNAVAILABLE to inform the user that the selected function is not available
[Set PF Key Invalid Message]
The user presses a function key that is not ENTER-VALUE and not SEL-NOT-AVAILABLE → The system sets the message to PF-KEY-INVALID to inform the user that the pressed function key is invalid
[Function Key Pressed on US Cargo Menu]
The user presses the ENTER key (GCMSG-PF-KEY equals ENTER-VALUE) → The system sets the message to ENTER-INVALID to inform the user that Enter is not a valid function
[Process Invalid PF Key - Handle invalid function key press]
The function key is not ENTER and not SEL-NOT-AVAILABLE (any other function key) → The system message number is set to PF-KEY-INVALID to indicate an invalid function key was pressed
[Clear Input Field for Non-Main Menu]
The message ID is also not equal to the main menu module ID → The input field should be cleared by setting it to spaces

Module: GCX013 1 Consolidated Epic Story

Epic: GCX013 Complete EDI Specification Extracted from Legacy

Contains 76 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX013 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program Control - Message ID Check]
The system checks the message ID to determine the source → If message ID is not CARGO-BY-BOND-MOD, route to menu cargo processing, otherwise route to cargo by bond processing

Core Acceptance Criteria

[3:Handle Return from Cargo by Bond Module]
The input field is empty (SPACE) → Clear cargo bond number, clear saved input field, and set blank bond message
[5:Search Bond Number in Database]
The search is initiated → Clear cargo report segment, move input field to key value, and call database search function
[4:Validate Bond Number Input]
Status code is not SPACE:
bond number index does not equal saved input field
→ Clear info lines and saved input field, highlight input field, and display no CCN found message
[7:Handle Page Forward Navigation]
First info line is not empty AND twelfth info line is not empty → Navigate to next records, search until last CCN on current page, get next record, and if valid record found with matching bond number, set time and format screen, otherwise show no more CCN message
[11:Format Screen Display]
Screen formatting is required → Call external program GCX013A with communication area, output message, and cargo report segment
[13:Retrieve First Cargo Record - Record Found?]
Database retrieval is performed → Clear cargo report segment, move input field to key value, and call database with GU function to get first record
[14:Retrieve Next Cargo Record]
Database retrieval is performed → Clear cargo report segment, move input field to key value, and call database with GN function to get next record
[16:Manage Program Stack]
Program needs to terminate or transfer control → Call GCCSTACK with communication area, message filler, output select code, current program return ID, and user message number
[Check Message ID]
If the message ID to determine processing route → If the message ID is not equal to CARGO-BY-BOND-MOD, route to GC Menu Cargo processing, otherwise route to Cargo by Bond processing
[Route to GC Menu Cargo Processing]
The system routes the request for processing → The GC Menu Cargo processing routine is executed
[Route to Cargo by Bond Processing]
The system routes the request for processing → The Cargo by Bond processing routine is executed
[Entry from GC Menu]
The message ID != CARGO-BY-BOND-MOD → The system routes processing to handle entry from GC menu cargo
[Clear Bond Number and Set Blank Message]
The input field is empty (contains spaces) → The system clears the cargo bond number, clears the saved input field, and sets a blank bond message
[Call GCX013A Formatting Module]
The format waybill screen process is invoked → The system calls the GCX013A formatting module with common control block, output message structure, and cargo report segment data to format and populate the screen display
[Check if Last Page Reached]
The system checks if the twelfth information line is empty (indicating last page) → The system sets item selection attributes and displays a 'last page' message
[Display No More Records Message]
No valid records are found or the retrieved record does not match the current bond number → The system displays a 'no more CCN found' message to inform the user
[Prepare CCN for Detail Display]
The system prepares the CCN data for the detail transaction → The system moves the selected CCN value to the message input field for processing by the detail transaction
[Clear Cargo Report Segment]
The system prepares to query the database → The cargo report segment is cleared to ensure clean data retrieval
[Call IMS Database with GU Command]
The system executes the database query → An IMS database call is made using GU command with cargo report segment and qualified search criteria
[Call Format Module GCX013A]
The system needs to display the list of cargo control numbers associated with the bond → The system calls the external formatting module GCX013A with the cargo report segment data to format the display
[Check if last line is empty]
The twelfth information line is empty indicating no more records on current page → Set item selection display attributes and display 'Last page reached' message
[Display 'No more CCN records' message]
No valid next record is found or the retrieved record does not match the bond number being searched → Display 'No more CCN records available' message to inform user that end of records has been reached
[Retrieve next cargo record from database - Execute IMS GN call with bond number qualification]
The system needs to retrieve the next cargo record matching the bond number → The system clears the cargo report segment, sets the bond number as search key, executes database retrieval operation, and returns the next matching cargo record
[Handle Page Backward Navigation - Navigate to previous page of CCN results]
User presses page backward key → System checks if input field matches saved value and either processes display request for unchanged input or highlights field with bond change message for modified input
[Set CCN as Input Field]
The system prepares the input for the detailed view → The system moves the selected CCN to the message input field
[Format Cargo Information for Display]
The system needs to format waybill screen information → The system calls the GCX013A formatting module with control communication block, output message structure, and cargo report segment data to format the cargo information for proper screen display
[Call Database Interface CIMS]
The system executes the database retrieval operation → The CIMS database interface is called with Get Unique operation, cargo segment, and qualified search criteria
[Clear Cargo Report Segment]
The system prepares to retrieve bond number information → The cargo report segment is cleared to spaces to ensure no residual data
[Execute Database Query with GU Operation]
The system executes the database query → A GU (Get Unique) database operation is performed using the bond number key with SSA qualification to retrieve matching cargo records
[Check if Last Page Reached]
The system checks if the twelfth information line is empty → Display last page message and set item selection attributes if the last displayable line is empty
[Display No More Records Message]
No valid record is found:
the record does not match the bond number filter
→ Display a message indicating no more cargo records are available
[Execute IMS GN operation for pagination]
The system executes a database get-next operation to retrieve the subsequent cargo record → The next cargo record is retrieved from the database and the operation status is returned
[Clear Cargo Report Segment]
The system prepares to retrieve cargo data → The cargo report segment is cleared to ensure clean data retrieval
[Call Stack Management Module]
Stack management operation is required → The GCCSTACK module is called with communication control, message filler, output select code, program return identifier, and user message number parameters

Structural Validations

[3:Handle Return from Cargo by Bond Module]
The input field does not equal the saved input field value → Highlight the input field and display bond change message
[4:Validate Bond Number Input]
The input field is empty (SPACE) → Clear info lines and saved input field, highlight input field, and display invalid bond message
[7:Handle Page Forward Navigation]
The first info line is empty (SPACE) → Display no CCN found message
[7:Handle Page Forward Navigation]
The twelfth info line is empty (SPACE) → Set item selection attributes and display last page message
[9:Validate CCN Selection]
The selection is validated → If selection is not numeric OR equals ZERO OR exceeds LAST-LINE, highlight selection field and display invalid range message
[9:Validate CCN Selection]
The selected CCN position is checked → If CCN at selected position is empty (SPACE), highlight selection field and display no CCN selected message
[15:Handle Invalid Function Key]
The function key is not recognized or valid → Set item selection field attributes and display invalid function key message
[Highlight Input Field and Show Change Message]
User presses the page backward function key → The system highlights the input field and displays a bond change message
[Highlight Input Field and Show Change Message]
User presses the page forward function key → The system highlights the input field and displays a bond change message
[Set Invalid PF Key Message]
User presses a function key other than page backward, page forward, or enter → The system sets item selection attributes and displays an invalid function key message
[Bond Number Empty?]
The bond number input field is empty or contains only spaces → The system clears all display areas, highlights the input field, and shows an invalid bond message
[Set Error Message: Invalid Bond]
The system validates the input → The system highlights the input field and displays an invalid bond message
[Set Error Message: No CCN Found]
No valid bond record is found or the bond number does not match → The system highlights the input field and displays a 'no CCN found' message
[Check if Any Records Displayed]
The system checks if the first information line is empty (no records currently displayed) → The system displays a 'no CCN found' message and prevents page forward navigation
[Selection Within Valid Range?]
The selection value is compared against the maximum allowed line number → The system accepts selections within the valid range and rejects values exceeding the last line with an invalid range error
[Display Invalid Range Error]
The range validation fails → The system highlights the item selection field and displays an invalid range error message
[Display No CCN Selected Error]
The selected line does not contain a CCN (is empty) → The system highlights the item selection field and displays a no CCN selected error message
[Display Invalid Selection Error]
The selection is not numeric or equals zero → The system highlights the item selection field and displays an invalid selection error message
[Selection is Numeric?]
The selection is checked for numeric content → If the selection is not numeric, the system highlights the selection field and displays an invalid range message
[Selection is Zero?]
The selection value equals zero → The system highlights the selection field and displays an invalid range message
[Selection Exceeds Maximum Range?]
The selection value is greater than the last line number (LAST-LINE) → The system highlights the selection field and displays an invalid range message
[Selected CCN Position Empty?]
The CCN at the selected line position is empty (space) → The system highlights the selection field and displays a no CCN selected message
[Set Invalid Bond Message]
The system needs to inform the user about the invalid input → An invalid bond number message should be displayed to the user
[Check if any CCN records displayed]
The first information line is empty indicating no CCN records are currently displayed → Display 'No CCN records found' message to inform user that no records are available
[Set Bond Change Error Message]
System detects input field change during page backward navigation → System sets bond change message to inform user about the field modification
[Is Selection Numeric?]
The selection contains non-numeric characters → The system highlights the item selection field and displays an invalid range message
[Is Selection Zero?]
The selection value equals zero → The system highlights the item selection field and displays an invalid range message
[Is Selection Within Valid Range?]
The selection value is greater than the last available line number → The system highlights the item selection field and displays an invalid range message
[Does Selected CCN Position Have Data?]
The selected line position contains no CCN data (is empty) → The system highlights the item selection field and displays a no CCN selected message
[Is Selection Numeric and Valid Range?]
The selection is not numeric:
equals zero
exceeds the maximum line number
→ An invalid range error message should be displayed and the item selection field should be highlighted
[Is Selected CCN Available?]
The CCN at the selected line position is empty (space) → A 'no CCN selected' error message should be displayed and the item selection field should be highlighted
[Selection is Numeric?]
The selection input is evaluated for numeric content → If the selection is not numeric, the system highlights the selection field and displays an invalid range message
[Selection Exceeds Maximum Range?]
The selection value is greater than the last line number (maximum range) → The system highlights the selection field and displays an invalid range message
[Selected CCN Position is Empty?]
The CCN (Cargo Control Number) at the selected line position is empty → The system highlights the selection field and displays a message indicating no CCN is available for selection
[Display Invalid Range Error]
The item selection is not numeric:
equals zero
exceeds the maximum range
→ The system highlights the item selection field and displays an invalid range message
[Display No CCN Selected Error]
No CCN exists at the selected line position → The system highlights the item selection field and displays a no CCN selected message
[Check if Any Records Displayed]
The system checks if the first information line is empty → Display no records message if no cargo records are currently displayed
[Invalid PF Key Detected]
The user presses a function key that is not SPACE, PAGE-BCK, PAGE-FWD, or ENTER-VALUE → The system sets the item selection field display attributes to normal protected alphabetic regular display mode and displays an invalid function key error message
[Set Invalid PF Key Error Message]
The system needs to inform the user about the invalid action → The system sets the user message to display an invalid function key error message

Module: GCX013A 1 Consolidated Epic Story

Epic: GCX013A Complete EDI Specification Extracted from Legacy

Contains 21 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX013A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[9:Retrieve Next Cargo Report Segment]
The system retrieves cargo report segment → Cargo report segment is cleared AND input field value is moved to key value AND external CIMS system is called with cargo report parameters
[End Loop - Maximum Lines Reached]
The screen line count equals 12 → Terminate the processing loop to prevent exceeding display capacity
[Move Carrier Code from Cargo Report to Screen Display]
The system processes waybill details for display → The carrier code from the cargo report road index is moved to the screen display carrier field for the current line
[Move Station Number from Cargo Report to Screen Display]
The system processes waybill details for display → The station number from the cargo report station index is moved to the screen display origin station field for the current line
[Move Waybill Number from Cargo Report to Screen Display]
The system processes waybill details for display → The waybill number from the cargo report waybill index is moved to the screen display waybill number field for the current line
[Move US CCN Key to Screen Display Line]
The system processes the cargo report segment to extract display information → The US CCN key value is moved to the CCN field of the current screen display line
[Extract CPRS Cargo Status Description]
The system processes the cargo status information → The CP cargo status description is extracted and moved to the CPRS status field
[Extract USCS Cargo Status Description]
The system processes the cargo status information → The US cargo status description is extracted and moved to the USCS status field
[Clear Cargo Report Segment Area]
The system prepares to retrieve cargo report data → The cargo report segment area is cleared to spaces
[Set Search Key from Input Field]
The system prepares the database search parameters → The search key value is set from the saved input field value
[Set Database Access Status]
Database access parameters are being configured → The accept status is set to get-next-in-parent (GEGB) operation
[Call Database System with Qualified Search]
The system executes the database retrieval operation → The CIMS database system is called with communication control, get-next operation, cargo PCB, segment area, and qualified search parameters
[Bond Number = Input Field?]
The system compares the bond number index from the cargo report with the saved input field value → Processing continues if bond numbers match, otherwise processing is marked as finished
[Bond Number from Record = Input Bond Number?]
The bond number index from the record is compared with the saved input field value → Processing continues if the bond number index equals the input field value, otherwise processing is marked as finished
[Continue Processing Current Record]
Both the database call status code is space AND the bond number index matches the input field value → Continue processing the current record without setting the finished flag
[Set Processing Finished Flag]
Either the database call status code is not space:
the bond number index does not match the input field value
→ Set the finished flag to 'YES' to terminate further processing

Structural Validations

[Bond Number Match?]
The system validates bond number match → If status code equals space AND bond number index equals input field saved value, then processing continues, otherwise finished flag is set to 'YES'
[Status Code = Space?]
The system checks the status code field of the cargo report segment → Processing continues to bond number validation if status code is blank, otherwise processing is terminated
[CC-STATUS-CODE = SPACE?]
The system checks the database retrieval status code → Processing continues only if the status code is blank (indicating successful retrieval), otherwise processing is marked as finished
[Bond Number Index = Input Field?]
The system compares the bond number index from the cargo report with the saved input field value → Processing continues only if the bond number index matches the input field value, otherwise processing is marked as finished
[Database Call Successful?]
The database call returns with a status code → Processing continues only if the status code is space (indicating success), otherwise processing is marked as finished

Module: GCX014 1 Consolidated Epic Story

Epic: GCX014 Complete EDI Specification Extracted from Legacy

Contains 21 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX014 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Copy Input to Output]
The system processes the message → The input message content is copied to the output message
[3:Set Menu Selection Code]
The system prepares the output → The menu training code is set in the output select code field
[6:Handle Unavailable Function]
The system processes the unavailable selection → The system message number is set to Function Unavailable
[8:Clear Input Field for Non-Main Menu]
The system processes the non-menu message → The input field is cleared by setting it to space
[9:Restore Program Control]
The system prepares to end processing → The saved program name is restored to the current program field
[Transfer Complete Message Content to Output]
The message transfer process is initiated → The complete input message content is copied to the output message
[Assign US Train Menu selection code to output]
The system initializes the output response → The output select code is set to the US Train Menu selection code (GC-US-MENU-TRAIN)
[Check Message Source]
The system checks the message ID → The system determines if the message comes from the US Training Menu module by comparing the message ID to the training menu module identifier
[Clear Input Field]
The message ID also does not equal the main menu module ID → The input field should be cleared by setting it to spaces

Structural Validations

[4:Validate Train Menu Input - Check if input from US Train Menu?]
The system checks the message ID → The system determines if the message ID equals the US Training Menu module ID
[Handle Enter Key Press - Is PF Key Enter?]
The PF key pressed is Enter → The system sets an Enter Invalid error message
[5:Handle Enter Key Press]
The system processes the invalid key press → The system message number is set to Enter Invalid
[Handle Function Selection - Is PF Key Selection Not Available?]
The PF key indicates selection not available → The system identifies the function as unavailable
[7:Handle Invalid PF Key]
The system processes the invalid PF key → The system message number is set to PF Key Invalid
[8:Clear Input Field - Is request NOT from Main Menu?]
The system checks if the message ID != Main Menu module ID → The system determines the message is from neither Training Menu nor Main Menu
[Set Enter Invalid Message]
The user presses the Enter key → The system sets an Enter Invalid error message
[Set Function Unavailable Message]
The user selects a function that is marked as not available → The system sets a Function Unavailable error message
[Set Invalid PF Key Message]
The user presses a function key that is neither Enter nor Selection Not Available → The system sets an Invalid PF Key error message
[Set Invalid Enter Message]
The user presses the Enter key (PF-KEY equals ENTER-VALUE) → The system sets an invalid enter message (ENTER-INVALID) to inform the user that Enter is not allowed
[Set Function Unavailable Message]
The user presses a function key that corresponds to an unavailable selection (SEL-NOT-AVAILABLE) → The system sets the system message number to indicate function unavailable (FUNCTION-UNAVAILABLE)
[Handle Invalid PF Key - Set invalid PF key message for unsupported function key presses]
The system processes the function key input → The system sets the invalid PF key message number to indicate an unsupported function key was pressed

Module: GCX017 1 Consolidated Epic Story

Epic: GCX017 Complete EDI Specification Extracted from Legacy

Contains 56 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX017 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Cargo Search Parameters]
The cargo search process begins → The cargo search segment is initialized to empty state

Core Acceptance Criteria

[Get Message Source ID]
The system reads the message ID from GCMSG-MSG-ID → The message ID is stored in WS-MOD-NAME for evaluation
[GCF12 - Cargo Selection Menu]
WS-CARGO-SEL-MENU-MOD condition is true → Load current input field data from GCMSG-INPUT-FIELD-DATA to WS-INPUT-FIELD and clear WS-INPUT-FIELD-SV, GCM017-LAYOUT, and GCMSG-PF-KEY
[Other Message Source]
The OTHER condition is true in the EVALUATE statement → Restore saved station number from WS-STATION-NUM-SV to WS-STATION-NUM, restore saved station type from WS-STATION-TYP-SV to WS-STATION-TYP, load saved input field data from GCMSG-SPA-FILLER to WS-INPUT-FIELD-SV, and clear WS-INPUT-FIELD, WS-INPUT-FIELD-SV, GCM017-LAYOUT, and GCMSG-PF-KEY
[Station Number Required]
The current module is not US Error Cargo Display Module → The system should display error message 5306 indicating station number is required
[Save Current Screen Data to Stack]
The navigation process begins → The current message area data is saved to the stack's message area field
[Call Stack Management Service]
Stack management is required for navigation → The GCCSTACK service is called with the prepared parameters and return code is initialized
[Update Message Area with Stack Data]
Updating communication context → The message area is updated with the stack's message area data
[Cargo Found?]
No cargo error records are found for the station → System displays no cargo found error message and clears the cargo display table
[Set Station as Valid]
The system processes the successful lookup → The system moves the table segment to DR segment and sets page index to current position for forward paging or to start position for other operations
[Station Found in DR Table?]
The lookup is successful and station data is found → The system moves the table segment data to DR segment and proceeds with index setting based on page navigation type
[Search DR Table for Station]
The system searches the DR table using the station number as the search key → The system retrieves the station data segment if the station exists in the DR table
[Station Found in DR Table?]
The lookup operation is successful → The system extracts the station data from the DR table segment for further processing
[Access cargo secondary database GCSUSS07]
The system needs to retrieve shipper and consignee data → The GCCUSIO program is called to access the GCSUSS07 segment with the specified search criteria
[More cargo records found?]
No additional cargo records with errors are found for the current station → System displays 'Last Page' error message and maintains current page display
[Display No Cargo Found Message]
System attempts to load cargo records for display → System clears cargo table, displays no cargo found message, and highlights station number field for correction

Structural Validations

[2:Validate PF Key Selection]
The system checks if the PF key is invalid or not available for selection → The system displays appropriate error message for invalid PF key or unavailable selection
[3:Validate Station Input]
The station number field is empty or contains only spaces → The system highlights the station number field and displays error message 5302 for US Error Cargo Display module or 5306 for other modules
[3:Validate Station Input]
The station type is empty or not one of Border, Destination, or Origin station types → The system highlights the station type field and displays error message 5307
[4:Validate Input Conflicts]
The station number:
station type has changed from saved values
an input line is selected
→ The system displays error message 5301 to indicate data conflicts
[5:Validate Page Navigation]
User tries to page backward from first page:
page forward when last displayed line has no cargo data
→ The system displays appropriate boundary error message (first page or last page)
[7:Validate Selected Line Number]
The line number is not numeric:
is less than 1
greater than the last screen line (20)
→ The system displays invalid item error message
[8:Check Selected Line Has Cargo]
The selected line does not contain any cargo CCN (Customer Control Number) data → The system displays error message 5304 indicating no cargo data at selected line
[11:Validate Station Number]
The station number does not exist in the GCSTBRT station table → The system attempts numeric validation and if that fails, highlights station number field and displays error message 5302
[10:Load Error Cargo List]
No cargo error records are found for the specified station → The system highlights station number field, clears cargo table, and displays error message 5305 for normal cases or last page message for forward paging
[GCF017 - US Error Cargo Display]
WS-US-ERROR-CARGO-DIS-MOD condition is true → Load current input field data from GCMSG-INPUT-FIELD-DATA to WS-INPUT-FIELD and load previous input field data from GCMSG-INPUT-FIELD-SV to WS-INPUT-FIELD-SV
[Is PF Key = Invalid Selection?]
The pressed function key is identified as an invalid selection → The system sets an error message indicating the PF key is invalid
[Is PF Key = Selection Not Available?]
The pressed function key is identified as selection not available → The system sets an error message indicating the PF key is not available
[Station Number Provided?]
The station number field is empty or contains only spaces → The system should highlight the station number field and display an appropriate error message based on the current module context
[Coming from Error Cargo Display?]
The current module is US Error Cargo Display Module → The system should display error message 5302 indicating station number is required for error display
[Valid Station Type?]
The station type is not Border Station, Destination Station, or Origin Station → The system should highlight the station type field and display error message 5307 for invalid station type
[Is Paging Request? PAGE-BCK or PAGE-FWD]
User attempts to page forward:
backward AND (station number has changed from saved value
station type has changed from saved value
line selection input is not empty)
→ System displays conflict error message and prevents page navigation
[Line Selection Made?]
User makes a line selection AND (station number has changed from saved value:
station type has changed from saved value)
→ System displays conflict error message 5301 and prevents line selection processing
[Currently on First Page?]
User attempts to navigate to previous page using page backward function key → System displays first page error message and blocks the navigation request
[Last Line Empty?]
User attempts to navigate to next page using page forward function key → System displays last page error message and blocks the navigation request
[Set Invalid Item Error Message]
The JSTNUM utility validation fails to convert input to numeric format → The system must set invalid item error message
[Set Invalid Item Error Message]
The line number is less than 1:
greater than the last screen line
→ The system must set invalid item error message
[Check if Cargo Control Number Exists]
The system checks the cargo control number at the selected line position in the cargo table → If the cargo control number is spaces or empty, set error message 5304 indicating no cargo exists at selected line, otherwise allow processing to continue
[Display Stack Error Message]
Processing the failure condition → An error message is constructed with failure details and current selection code, and the system performs abnormal termination
[Validate Station Number/Type]
Station number field is empty or spaces → System displays station number required error message and highlights station number field
[Validate Station Number/Type]
Station type field is empty or not Border, Destination, or Origin station type → System displays invalid station type error message and highlights station type field
[Mark Station as Invalid]
The JSTNUM utility returns unsuccessful validation → The system sets high intensity display attribute for station number field and assigns error message 5302
[Look up Station Number in DR Table]
The system looks up the station number in the GCSTBRT DR table → The system determines if the station exists in the table and sets the appropriate segment data
[Set Station Number Error Message]
The JSTNUM utility returns unsuccessful validation → The system sets station number attribute to highlight the field and assigns error message 5302
[Is user at last page?]
The last line of the current screen display does not contain any cargo control number (CCN) → System displays 'Last Page' error message and prevents forward paging
[Any station/input changes made?]
Current station number differs from saved station number:
current station type differs from saved station type
input line field contains data
→ System displays input conflict error message (5301) and prevents paging operation
[Check if Last Page - Last line cargo empty?]
User requests to page forward AND the last displayed line contains no cargo data → System displays last page error message and prevents forward navigation
[Check for Input Changes - Station number changed?]
User requests page forward AND current station number differs from saved station number AND input line selection exists → System sets input conflict error message and prevents navigation
[Station type changed?]
User requests page forward AND current station type differs from saved station type AND input line selection exists → System sets input conflict error message and prevents navigation
[Line selection made?]
User requests page forward AND input line selection is not empty AND (station number changed:
station type changed)
→ System sets input conflict error message and prevents navigation
[Currently on First Page?]
User requests to page backward → System displays first page error message and prevents navigation
[Station or Input Changed?]
User attempts to navigate pages backward or forward → System displays input conflict error message and prevents navigation
[Set First Page Error Message]
User presses the page backward function key AND the system is currently displaying the first page → System displays first page error message and prevents the backward navigation
[Set Input Conflict Error Message]
User presses the page forward function key AND there is no cargo data on the last displayed line → System displays last page error message and prevents the forward navigation
[Set Input Conflict Error Message]
User attempts to page forward:
backward AND (station number has changed
station type has changed
a line selection has been made)
→ System displays input conflict error message and prevents the paging operation
[Set Input Conflict Error Message]
User attempts any paging operation AND (station number has changed:
station type has changed)
→ System displays input conflict error message and prevents the paging operation

Module: GCX018 1 Consolidated Epic Story

Epic: GCX018 Complete EDI Specification Extracted from Legacy

Contains 52 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX018 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Message Source?]
The message ID is evaluated → If message ID is train menu module, process train menu input; if train selection module, process train selection; if train display module, process train display; otherwise redirect to main menu with unknown spawn error
[4:Read Train Records by Port Index]
Train records are requested using the port index → Execute database read with '>' operator, validate the train ID, and if no trains found, set train not found message and highlight input field
[6:Process Train Selection Screen]
A user action is performed → If invalid PF key, set invalid key message; if selection not available, set not available message; if input field is empty, clear train lines and set message 0501; if input field changed, clear lines and validate new train ID; if page back, validate train ID and set first page message; if page forward, process forward pagination; if line selection made, process selected line
[7:Process Page Forward Navigation]
Page forward action is processed → If last train ID on screen is empty, set last page message and exit; otherwise use last displayed train's date, ID and time as starting point, calculate time complement, read next set of trains, and if valid records found, display new page, else set last page message
[10:Navigate to Train Display]
Navigation to train display is initiated → Set output select code to train display spawn, clear rest of message, push the selection code to stack for proper navigation flow
[18:Process Database Navigation]
Navigation operation is executed → Clear train segment, call database service with 'get next' operation using qualified search, if successful and port matches key port, continue; otherwise set status to 'GE' to indicate end of records
[Store Index Switch Value]
System prepares search parameters → System stores index switch value in message index number field
[Execute Initial Database Search]
The system executes the initial database search using greater-than operator → The database search is performed against the train root segment using the port index qualifier
[Set No Records Found Status]
The system determines no valid train record exists → The system sets train not found message and highlights the input field for user attention
[Execute Database Get Next Call]
The system executes the database get next operation → A database call is made using GN operation with the train root segment and qualified search criteria
[Set Train Not Found Status]
The system determines that no valid train data exists for the search criteria → The status is set to indicate train not found and an appropriate error message is prepared
[Train Arrived AND Message Sent/Acknowledged?]
The train has arrived status AND the message has been sent:
acknowledged
→ The system sets the train status to ARRIVED and proceeds to check enroute reporting
[Manual Arrival AND Message Sent/Acknowledged?]
The train has manual arrival status AND the message has been sent:
acknowledged
→ The system sets the train status to MANUAL ARRIVAL and proceeds to check enroute reporting
[Clear Train Lines Display]
Input field is empty (spaces) → System clears train lines display, displays message 0501, and sets cursor to input field
[Process Port Input and Show First Page]
User presses page back key → System validates and reads train ID and displays first page message
[Process Page Forward Navigation]
User presses page forward key → System checks if last train ID on screen is empty and either displays last page message or processes next page of train data
[Display 'Last Page' Message]
The system determines forward pagination is not possible → The system should set the last page message and terminate the page forward process
[Show 'Last Page' Message]
The system determines that the current position represents the end of available data → The system should set the last page message to inform the user
[Parse Hour from Time Display]
Extracting time components for database search → Move characters 7-8 from the split line to the work hour field
[Parse Minutes from Time Display]
Extracting time components for database search → Move characters 10-11 from the split line to the work minutes field
[Parse Hour Component from Position 7-8]
The system needs to parse the time components for database key construction → The system extracts characters 7-8 from the split line as the hour component and moves it to the time work hour field
[Parse Minute Component from Position 10-11]
The system needs to parse the time components for database key construction → The system extracts characters 10-11 from the split line as the minute component and moves it to the time work minute field
[Transfer to Train Display Screen]
User selects a train line with valid train data → Move selected train ID to input field, clear rest of message, set train display spawn code, and push selection code to stack
[Set Selected Train ID as Input]
The system processes the train selection → Move the train ID from the selected line to the input field and clear the rest of message area
[Index Number Available?]
The system checks for available index number in the message → If index number exists in GCMSG-GCX018-INDEX-NUM, use it; otherwise set default index to '3'
[Parse Month and Day from EDA]
The system formats date components → The month component (TL-MM) is moved to EDA-MONTH and the day component (TL-DD) is moved to EDA-DAY
[Parse Hour and Minutes from ETA]
The system formats time components → The hour component (TL-HH) is moved to ETA-HOUR and the minute component (TL-MN) is moved to ETA-MINUTE
[Create Display Time Line]
The system completes time formatting → The formatted time line is moved to the train display times field for the current line
[Read Train Record from Database by Port Index]
The system attempts to read train record from database using the port index → The system executes database call to retrieve train root segment with qualified search criteria
[Display Train Not Found Message]
The system needs to inform user of the failure → The system sets system message number to train not found constant
[Last Page Reached]
User attempts to navigate forward AND current page is the last page (last train ID on screen is empty) → System displays 'Last Page' message and prevents forward navigation
[First Page Reached]
User navigates backward to the first page → System displays 'First Page' message and processes the train data display
[Unknown Message Source]
Message ID does not match any known module types (train menu, train selection, or train display) → System redirects to main menu screen, displays 'Unknown Spawn' error message, and clears input field

Structural Validations

[8:Process Line Selection]
The line selection is processed → If input is not numeric, set invalid item message and highlight field; if line number is outside valid range (1 to maximum screen lines), set invalid item message and highlight field; if selected line contains valid train ID, move train ID to input field and navigate to train display; if selected line is empty, set invalid item message and highlight field
[20:Handle Error Conditions]
Error handling is executed → Set appropriate system message number based on error type: train not found, invalid PF key, PF not available, invalid item, first page, last page, or unknown spawn error; highlight input fields as needed for user correction
[Return to Menu with Error Highlighting]
System encounters search error or validation failure → System sets train not found message and highlights input field with high intensity cursor
[Set Train Not Found Error]
The system encounters an invalid train retrieval condition → Train not found error message is set to inform user of unsuccessful search
[Display Invalid PF Key Message]
User presses an invalid PF key → System displays invalid PF key message
[Display PF Key Not Available Message]
User presses a PF key that is not available for current selection → System displays PF key not available message
[Process Selected Train Line]
User enters a line selection in input line field → System validates line number is numeric, within valid range, corresponds to displayed train, and either processes selection or displays invalid item message
[Last Screen Line Has Train ID?]
The train ID field of the maximum screen line is checked → If the train ID is empty (spaces), set last page message and exit; otherwise continue with pagination
[Is Input Alphabetic?]
The input contains alphabetic characters → The system sets invalid item error message and applies high intensity display to the input field
[Justification Successful?]
The justification process returns unsuccessful status → The system sets invalid item error message and applies high intensity display to the input field
[Line Number Within Valid Range?]
The line number is less than first page value or greater than maximum screen number → The system sets invalid item error message and applies high intensity display to the input field
[Display Error - Invalid Item]
The system detects the invalid selection → Set system message number to invalid item error code
[Log Stack Operation Error]
The system detects the operation failure → An error message is constructed containing the failure reason and invalid selection code, and logged to the error handling system
[Show Error Message]
CC-STATUS-CODE is populated (indicating no records found) → The system does not Execute train display processing and maintains current state
[Invalid PF Key Pressed]
User presses an invalid function key → System displays 'PF Key Invalid' error message
[PF Key Not Available]
User presses a function key that is not available in current context → System displays 'PF Not Available' error message
[Empty Input Field]
Input field is empty or contains only spaces → System clears train display lines, sets message 0501, and highlights input field for user entry
[Train Not Found]
System cannot find the specified train in the database → System displays 'Train Not Found' error message and highlights input field
[Invalid Line Selection]
User enters non-numeric characters:
line number is outside valid range (1 to maximum screen lines)
selected line has no train data
→ System displays 'Item Invalid' error message and highlights line input field

Module: GCX020 1 Consolidated Epic Story

Epic: GCX020 Complete EDI Specification Extracted from Legacy

Contains 22 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX020 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Status Code and Train Root Segment]
Database operation is being prepared → The status code and train root segment data structure should be cleared to ensure clean data retrieval
[Initialize Equipment Dependency Segment]
The system begins reading equipment dependencies for the train → The equipment dependency data segment is initialized to empty state
[Initialize Equipment Dependency Segment]
The equipment dependency reading process begins → The equipment dependency segment data structure is initialized to empty values
[Initialize Train Root Segment]
The system prepares for the database operation → The train root segment data area is initialized and the database status codes are cleared

Core Acceptance Criteria

[Write Train Root Data to History]
Train root data needs to be archived → Initialize history record with train key and root segment data, then write to history file
[Write Equipment Dependencies to History]
Equipment dependency needs to be archived → Write equipment dependency segment data to history file using the same train key
[Execute Get Next Call on GCSUTRT Database]
The system executes a Get Next operation on the GCSUTRT database → The database call should be made using the CIMS interface with GN operation to retrieve the next train root segment
[Process Current Train Record]
The system processes the current train record → The train root segment is written to history file and all dependent equipment segments are processed and written to history file
[Extract Train Key from Current Record]
The system processes the train record → The train key is extracted from the root segment and stored in the history record key field
[Copy Train Root Data to History Buffer]
The system processes the train record for archiving → The complete train root segment data is copied to the history data buffer
[Copy Equipment Data to History Buffer]
The system processes the equipment dependency → The equipment dependency segment data is copied to the history data buffer
[Move Train Root Segment to History Data Field]
The system creates a history record for the train → The entire train root segment data is copied to the history data field
[Write Complete Record to History File]
The system finalizes the history record creation process → The complete history record is written to the history file
[Read First Equipment Dependency Record]
The system executes the first equipment dependency read operation → The system attempts to retrieve the first dependent equipment record for the train
[Equipment Dependency Retrieved]
The system processes the equipment dependency data → The equipment dependency segment data is written to the history file
[Clear Equipment Dependency Data Area]
The data area needs to be prepared for new data → The system initializes the equipment dependency segment data area to blank state
[Call Database to Get Next Parent Equipment Dependency]
A database call is made to get the next parent equipment dependency → The system calls CIMS with GNP operation to retrieve the next equipment dependency segment using the equipment dependency selection criteria
[Move Equipment Dependency Data to History Record]
The system needs to prepare the data for history file writing → The system moves the equipment dependency segment data to the history record data area
[Execute Database Get Unique Call]
The system needs to retrieve a specific train record from the database → A Get Unique database call is executed using the train search criteria to retrieve the train root segment data
[Clear Train Root Segment Buffer]
The data buffer preparation occurs → The system initializes the train root segment buffer to blank values
[Execute Get Next Train Record Call]
The database call is executed with Get Next operation type → The system calls the database interface using the train database control block and train root segment buffer with the appropriate selection criteria
[IMS Shutdown Condition Detected?]
The system detects an IMS shutdown condition is active → The system should identify this as a shutdown scenario requiring immediate termination

Structural Validations

None explicitly identified in logic extraction.

Module: GCX020A 1 Consolidated Epic Story

Epic: GCX020A Complete EDI Specification Extracted from Legacy

Contains 24 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX020A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Train Root Segment Data Area]
The database call is being initialized → The train root segment data area is cleared of any previous data

Core Acceptance Criteria

[9:Write Equipment Dependency Records]
Equipment dependency archival is performed → Each equipment dependency segment is written to the history file using the same key as the train root, and the next dependency record is retrieved until no more dependencies exist
[IMS Shutdown Request?]
The checkpoint status is evaluated → If an IMS shutdown request is detected, the program terminates with an error message, otherwise processing continues normally
[15:Handle Program Termination]
Program termination is handled → The history and checkpoint files are closed, an error message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX020A' is set, and the error handling routine is called
[Call IMS Database to Get Next Train Report Record]
The database retrieval is requested → The system calls IMS with Get Next command using the train root segment structure and qualified SSA
[Execute Checkpoint Operation]
Executing the checkpoint operation → Execute checkpoint processing and if IMS shutdown is requested, terminate with error message
[Move Train Root Data to History Data]
The system prepares the history record for archival → The entire train root segment data must be copied to the history data field
[Move Equipment Data to History Data]
The system processes the equipment dependency → The complete equipment dependency segment data must be copied to the history data field
[Copy Train Root Data to History Data Field]
The system archives the train record to history → The entire train root segment data must be copied to the history record's data field
[Move Equipment Data to History Record]
The system processes the equipment dependency data → The system moves the train equipment dependency segment data to the history record data area
[Process Equipment Dependency Record]
The equipment dependency record is processed → The equipment dependency segment data is moved to the history record structure and written to the history file
[Move Equipment Dependency Data to History Record]
The system processes the equipment dependency record → The equipment dependency segment data is moved to the history record data area
[Trigger Program Termination]
The system needs to terminate processing → The program termination procedure must be invoked to ensure proper cleanup
[IMS Shutdown Request Received?]
The checkpoint status indicates an IMS shutdown request has been received → The system must set an appropriate shutdown error message and trigger program termination procedures
[Trigger Program Termination]
The system needs to terminate processing → The program termination procedure must be invoked to ensure proper cleanup and shutdown
[Close History File]
The system initiates emergency shutdown procedures → The system should close the history file to ensure data integrity
[Execute Database Get Unique Command]
The system executes a database get unique command → The system calls the database interface to retrieve the train root segment using the specified key
[Retrieve Current Train Record]
The system prepares to retrieve train record data → The system initializes the database status codes and train root segment data structure
[Clear Train Root Segment Buffer]
The data buffer needs to be prepared → The system initializes the train root segment buffer to blank/zero state
[Call IMS Database to Get Next Train Record]
The system requests the next train record from the Canadian train database → The system calls the database interface with get-next command, database control block, train root segment buffer, and Canadian train selection criteria

Structural Validations

[Set Shutdown Error Message]
The system prepares to terminate processing → A descriptive error message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX020A' must be set to inform about the shutdown reason
[Set Shutdown Error Message]
The system needs to communicate the shutdown reason → The error message must be set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX020A' to clearly indicate the shutdown source and program
[Set Shutdown Error Message]
The system needs to prepare error information for logging → The system should set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX020A'
[Set Error Message: 'IMS SHUTDOWN REQUEST RECEIVED']
An IMS shutdown request is received (WS-IMS-SHUTDOWN condition is true) → The system sets the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX020A'

Module: GCX020B 1 Consolidated Epic Story

Epic: GCX020B Complete EDI Specification Extracted from Legacy

Contains 3 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX020B EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Equipment Counter to Zero]
The system begins equipment processing → Equipment counter is set to zero to track processing positions

Core Acceptance Criteria

[Load Train Data into Canadian Structure]
The system processes the Canadian train record → The historical data must be moved into the Canadian train root segment structure (GCB4R-TRAIN-ROOT-SEGMENT)
[Load Train Equipment Departure Segment]
The system processes the equipment departure record → Historical data is moved to the train equipment departure segment structure

Structural Validations

None explicitly identified in logic extraction.

Module: GCX020C 1 Consolidated Epic Story

Epic: GCX020C Complete EDI Specification Extracted from Legacy

Contains 1 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX020C EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Store Record in Work Area]
Record data is available for processing → Car record is stored in the work area buffer for immediate use

Structural Validations

None explicitly identified in logic extraction.

Module: GCX020J 1 Consolidated Epic Story

Epic: GCX020J Complete EDI Specification Extracted from Legacy

Contains 3 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX020J EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Equipment Counter]
Equipment data is moved to the train equipment departure segment → The departure counter is set to zero to begin equipment item processing

Core Acceptance Criteria

[Move History Data to Canadian Train Structure]
Processing a Canadian train record → The historical data must be moved to the Canadian train root segment structure
[Extract Equipment ID from Train Record]
The system processes each equipment position in the train consist → The equipment ID is extracted from the GCUTD-EQUIPMENT-ID field for the current equipment position

Structural Validations

None explicitly identified in logic extraction.

Module: GCX021 1 Consolidated Epic Story

Epic: GCX021 Complete EDI Specification Extracted from Legacy

Contains 75 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX021 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Dependent Segment Counter]
The system prepares to retrieve dependent segments → The dependent segment counter is set to zero to indicate no segments have been found yet
[Initialize dependent segment counter to 0]
The system begins dependent segment retrieval process → The dependent segment flag is set to 0 to indicate no dependent segments found initially

Core Acceptance Criteria

[6:Checkpoint Processing - Perform checkpoint operations at specified intervals]
The number of processed calls exceeds the checkpoint number threshold → The system initiates checkpoint processing to save current position
[7:Update Processing - Process UPDATE action by retrieving dependent segments and marking root for deletion]
The root segment is retrieved successfully → The system retrieves all dependent segments, marks the root record with 'R' flag, and displays a warning if no dependent segments are found
[13:Delete Processing - Process DELETE action by removing transmission segments from IMS database]
The root segment is evaluated for deletion eligibility → The system deletes the record only if it has the 'R' (read and delete) flag set
[9:Report Classification and Writing - Classify transmission data and write to appropriate output file]
The sequence number type is evaluated → The system routes numeric sequence numbers to GCX121 file, TRAIN or CCTRN sequence numbers to train file, and all other sequence numbers to cargo file
[10:Train Report Generation - Write transmission data to train file when sequence number is TRAIN or CCTRN]
The data is processed for output → The system writes the transmission record to the train output file
[11:Cargo Report Generation - Write transmission data to cargo file when sequence number is not train-related]
The data is processed for output → The system writes the transmission record to the cargo output file
[12:GCX121 Report Generation - Write transmission data to GCX121 file when sequence number is numeric]
The data is processed for output → The system writes the transmission record to the GCX121 output file
[8:Dependent Segment Retrieval - Get next dependent segments associated with current transmission]
Dependent segments are retrieved from the database → The system continues processing until no more dependent segments are available and marks that dependent segments were found
[Set default checkpoint frequency to 500]
Default checkpoint frequency needs to be established → The checkpoint number is set to 500 and system displays invalid checkpoint message
[Set Database Access Status for Retrieval]
Database access is being configured for retrieval operation → The system sets the database access status to 'GB' to enable Get Next operation
[Execute GHN Call to Retrieve Next Transmission Segment from IMS Database]
The system executes a GHN (Get Hold Next) database call → The system attempts to retrieve the next transmission segment from the GCTM database
[Save Current Transmission Key for Reference]
The system processes the retrieved transmission segment → The system saves the transmission key from the current segment for later reference
[Increment Checkpoint Counter]
The system continues processing the transmission segment → The system increments the checkpoint call counter by 1
[Set End-of-File Flag - No More Segments Available]
The database operation indicates no segment was retrieved (non-blank status code) → The system sets the end-of-file flag to 1 to indicate no more segments are available
[Handle IMS Shutdown - Display shutdown message]
The system processes the shutdown request → The system displays 'IMS SHUTDOWN REQUEST RECIEVED BY GCX021' message and logs the shutdown event
[Reposition to current transmission segment]
The system needs to continue processing from the current position → The system repositions to the saved transmission segment key using GHU function to maintain processing continuity
[Increment Checkpoint Counter by 1]
The system processes a root transmission record or retrieves a dependent segment → The checkpoint counter is incremented by 1
[Store Transmission Number for Processing]
The system begins update processing → The transmission number from the current record is stored for processing identification
[Retrieve Next Dependent Segment]
The system requests the next dependent segment → The next dependent segment for the transmission is retrieved from the database
[More Dependent Segments Available?]
The system checks the operation status → If the status code is blank, more segments are available; otherwise, no more segments exist
[Process and Write Dependent Segment Data to Reports]
The system processes the segment data → The dependent segment counter is incremented, the checkpoint call counter is incremented, and the segment data is written to the appropriate output file based on sequence number classification
[Reposition to Current Root Segment]
The system needs to update the root segment → The system repositions to the saved root segment key using the GHU operation
[Mark Root Segment for Deletion]
The root segment needs to be marked for deletion → The read-and-delete flag is set to 'R' to mark the segment as read
[Update Root Segment with Deletion Flag]
The system updates the database → The root segment is updated in the database using the REPL operation with the deletion flag
[Any Dependent Segments Found?]
The system checks the dependent segment counter → If the counter equals zero, no dependent segments were found; otherwise, dependent segments were processed
[Display Warning: No Dependent Segments Found]
No dependent segments were found (counter equals zero) → A warning message is displayed showing 'NO DEPENDENT SEGMENT FOR ROOT:' followed by the transmission key
[Request Next Dependent Segment from IMS Database]
The system requests the next dependent segment for the current transmission → The system calls the database to get the next dependent segment using the transmission context
[Dependent Segment Found?]
The system checks the database response status → If the status code is blank spaces, a dependent segment was found, otherwise no more segments are available
[Mark Dependent Segment as Found]
The system processes the found dependent segment → The dependent segment indicator is set to 1 to mark that dependent segments exist for this transmission
[Increment Processing Counter]
The system completes processing of the dependent segment → The checkpoint call counter is incremented by 1 to track the number of processed segments
[Classify and Route Transmission Data to Appropriate Report File]
If the sequence number type → If sequence number is numeric, write to GCX121 file; if sequence number is 'TRAIN' or 'CCTRN', write to TRAIN file; otherwise write to CARGO file
[Call IMS to get next dependent segment TMDP]
The system calls the database to get the next dependent segment → The system attempts to retrieve the next TMDP dependent segment for the current transmission
[Dependent segment found?]
The system checks the response status from the database call → If status code is blank, a dependent segment was found; otherwise no more dependent segments exist
[Increment checkpoint call counter]
The system processes the dependent segment → The checkpoint call counter is incremented by 1 to track the number of processed segments
[Set dependent segment flag to 1]
The system processes the dependent segment → The dependent segment flag is set to 1 to indicate dependent segments exist for this transmission
[Classify and write transmission data to appropriate output file]
The system needs to output the dependent segment data → The system calls the write function to classify and write the data to the appropriate output file based on sequence number type
[Continue to next dependent segment]
The system needs to check for additional dependent segments → The system loops back to retrieve the next dependent segment for the same transmission
[End - Return to main processing]
No more dependent segments are available (status code is not blank) → The system exits the dependent segment processing loop and returns to main processing
[Extract Sequence Number from Transmission Data]
The system needs to classify the report for output file routing → The sequence number is extracted from the transmission segment and stored for classification
[Extract Report Data from Transmission]
The system prepares to write report data to output files → The report data is extracted from the transmission segment and stored for output writing
[Is Sequence Number Numeric?]
If the sequence number for numeric content → If the sequence number is numeric, the report is classified for GCX121 file output
[Write to GCX121 Report File]
The system writes the report to output files → The report data is written to the GCX121 file using the prepared output record
[Write to Train Report File]
The system writes the report to output files → The report data is written to the train file using the prepared output record
[Write to Cargo Report File]
The system writes the report to output files → The report data is written to the cargo file using the prepared output record
[Is Sequence Number Numeric?]
The sequence number is evaluated for its format type → The system routes the record to GCX121 file if sequence number is numeric, otherwise continues to next classification check
[Is Sequence Number 'TRAIN' or 'CCTRN'?]
The sequence number equals 'TRAIN' or 'CCTRN' → The system routes the record to the Train Report File
[Route to Cargo Report File]
No other classification criteria are met → The system routes the record to the Cargo Report File as the default destination
[Extract Sequence Number from Transmission Data]
The system processes the transmission for output routing → The sequence number and report data are extracted and prepared for classification analysis
[Extract Sequence Number from Transmission Segment]
The system processes the transmission segment for output preparation → The sequence number is extracted to WS-SEQUENCE-NUMBER and report data is extracted to WS-TRANSMISSION-DATA
[Is Sequence Number = 'TRAIN' or 'CCTRN'?]
The sequence number equals 'TRAIN' or 'CCTRN' → The transmission data is written to the train file
[Write Transmission Data to Train File]
The system writes the output record → The transmission data is written from WS-OUT-RCD to TRAIN-RCD in the train file
[Write Transmission Data to Cargo File]
The sequence number is not numeric AND the sequence number is not 'TRAIN' AND the sequence number is not 'CCTRN' → The transmission data should be written to the cargo file
[Is Sequence Number Numeric?]
The sequence number is numeric → The transmission data should not be written to the cargo file
[Is Sequence Number TRAIN or CCTRN?]
The sequence number equals 'TRAIN':
the sequence number equals 'CCTRN'
→ The transmission data should not be written to the cargo file
[Extract Sequence Number from Transmission Segment]
Processing the segment for output → The sequence number should be moved to workspace AND the report data should be moved to workspace
[Is Sequence Number Numeric?]
The sequence number extracted from the transmission segment is numeric → The system writes the formatted record containing transmission number, sequence number, and report data to the GCX121 file
[Extract Sequence Number from Transmission Segment]
The system processes the transmission segment → The sequence number is extracted and moved to working storage for evaluation
[Extract Report Data from Transmission Segment]
The system processes the transmission segment for output → The report data is extracted and moved to working storage for output record formatting
[Format Output Record with Transmission Number and Report Data]
The sequence number is determined to be numeric → The system formats an output record containing the transmission number, sequence number, and report data
[Remove Transmission Segment from IMS Database]
The system executes the DELETE action → The system removes the transmission segment from the database
[Display Shutdown Message to Console]
The system processes the shutdown condition → The message 'IMS SHUTDOWN REQUEST RECIEVED BY GCX021' must be displayed on the operations console
[Close Train Report File]
The main processing loop terminates normally → The train report file must be closed to finalize all written records
[Close Cargo Report File]
The file closure sequence continues → The cargo report file must be closed to finalize all written records
[Close GCX121 Report File]
The file closure sequence continues → The GCX121 report file must be closed to finalize all written records
[Close Train Report File]
The shutdown handling process begins → The train report file must be immediately closed to preserve data integrity
[Terminate Program Execution]
The emergency shutdown process continues → The program must immediately terminate execution without closing the GCX121 file to expedite shutdown

Structural Validations

[2:Control Card Validation - Read and validate action code from input file]
The action code is evaluated for validity → The system accepts only UPDATE or DELETE action codes and rejects all other values with an error message
[Control Card Found?]
The system attempts to read the first record from the input file → If no control card is found, display error message 'NO CONTROL CARD FOUND', set error message to 'NO CONTROL CARD', close input file, call error handler and exit program
[Action Code = 'UPDATE' or 'DELETE'?]
The system extracts the action code from the control card → If the action code equals 'UPDATE' or 'DELETE', set the action code for processing, otherwise display error messages 'INVALID CONTROL CARD FOUND' and the invalid action code value, set error message to 'INVALID CONTROL CARD', close input file, call error handler and exit program
[Transmission Segment Retrieved Successfully?]
The system checks the database operation result → If the status code is blank spaces, the segment was retrieved successfully, otherwise no more segments are available
[Check if Transmission Segment is Marked for Deletion]
The system processes a DELETE action for the transmission segment → The system checks if the read-and-delete flag equals 'R' to determine if deletion is allowed
[Set Error Message for Shutdown]
The system prepares error information for logging → The error message field must be set to 'IMS SHUTDOWN REQUEST RECIEVED BY GCX021'
[Log Error Information]
The system needs to record the shutdown event → The error handling program 'CERR' must be called with the error information

Module: GCX021A 1 Consolidated Epic Story

Epic: GCX021A Complete EDI Specification Extracted from Legacy

Contains 45 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX021A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Input File Reading]
A read operation is performed → The next transmission record is loaded into memory or end-of-file flag is set if no more records exist
[3:Shipper Change Detection]
The current transmission shipper is compared with the previously saved shipper → A shipper change is detected if the current shipper differs from the saved shipper
[5:Country Code Determination]
The sequence number is 'CCRGO' or 'CCTRN' → The transaction is classified as Canadian with record type 'CA', otherwise it is classified as American with record type 'US'
[7:Advice Type Processing]
The sequence number is evaluated → If sequence is 'CCRGO' then advice type is set to 'CARGO', if sequence is 'CCTRN' then advice type is set to 'TRAIN', otherwise the sequence number itself is used as the advice type
[8:Border Destination Change Detection]
The current transmission border or destination is compared with saved values → A border/destination change is detected if either the border differs from saved border OR the destination differs from saved destination
[11:Detail Line Formatting]
The detail formatting process is executed → Car number, bond number, bond type, and broker information are moved to the detail line structure and the report line counter is incremented
[12:Bond Owner Processing]
The record is processed for Canadian transactions → CCN is moved to the Canadian CCN field, otherwise for American transactions CCN is moved to the US CCN field and bond owner information is also populated
[13:Train Information Processing]
The train information is processed → Train number and train date are moved to the second detail line structure and the report line counter is incremented
[14:Ocean Bill of Lading Processing]
The OBL information is processed → The OBL value is moved to the second detail line structure
[16:Final Report Processing]
The report counter is greater than 1 → All accumulated report lines are written to the output file
[Execute READ Statement]
The system executes a read operation on the input file → The transmission record is loaded into the TRANSM-RECORD structure for processing
[End of File Reached?]
There are no more records available in the input file → The EOF flag is set to 'Y' to indicate end of file processing
[Set EOF Flag to 'Y']
No more transmission records are available for processing → The EOF flag is set to 'Y' to control the main processing loop termination
[Current Shipper = Previously Saved Shipper?]
The system compares the current transaction shipper with the previously saved shipper → The system determines if the shipper has changed and branches to either same-shipper processing or shipper-change processing
[Notify Party Changed?]
The system compares the current transmission notify party with the previously saved notify party → The system triggers bond report output regardless of whether notify party changed or remained the same
[Update Saved Notify Party with Current Notify Party]
The current transmission notify party is different from the saved notify party → The system updates the saved notify party with the current transmission notify party value
[Sequence Number = 'CCRGO' or 'CCTRN'?]
The transmission sequence number equals 'CCRGO' or 'CCTRN' → The system sets the country type as CANADIAN and record type as 'CA'
[Sequence Number = 'CCRGO' or 'CCTRN'?]
The transmission sequence number does not equal 'CCRGO' or 'CCTRN' → The system sets the country type as AMERICAN and record type as 'US'
[Check Transmission Type]
The transmission sequence number is 'CCRGO' or 'CCTRN' → Set the country type as Canadian and record type as 'CA', otherwise set country type as American and record type as 'US'
[Determine Advice Type]
The sequence number is 'CCRGO' then set advice type as 'CARGO', when sequence number is 'CCTRN' then set advice type as 'TRAIN', otherwise use the sequence number itself as advice type → The advice type is properly assigned for report formatting
[Check Transmission Type]
The transmission sequence number is 'CCRGO' or 'CCTRN' → The country type is classified as Canadian and record type is set to 'CA', otherwise it is classified as American and record type is set to 'US'
[Set Country Type as 'CA' for Canadian]
The system determines the transaction is Canadian → The Canadian flag is set to true and the record type is set to 'CA'
[Set Country Type as 'US' for American]
The system determines the transaction is American → The American flag is set to true and the record type is set to 'US'
[Move Notify Party to Header Line 1]
The system processes header line 1 data population → The notify party information is moved to the header line 1 notify field
[Move Shipper to Header Line 1]
The system processes header line 1 data population → The shipper information is moved to the header line 1 shipper field
[Check Transmission Type - Evaluate sequence number to determine if transmission is CCRGO, CCTRN, or other type]
The sequence number is 'CCRGO' or 'CCTRN' → The transmission is classified as Canadian and record type is set to 'CA'
[Check Transmission Type - Evaluate sequence number to determine if transmission is CCRGO, CCTRN, or other type]
The sequence number is not 'CCRGO' and not 'CCTRN' → The transmission is classified as American and record type is set to 'US'
[Border Different from Previously Saved?]
The transmission border value is different from the saved border value → The system triggers destination header formatting and updates the saved border value with the current transmission border value
[Destination Different from Previously Saved?]
The transmission destination value is different from the saved destination value → The system triggers destination header formatting and updates the saved destination value with the current transmission destination value
[Update Saved Border Value]
The formatting process completes → The system moves the current transmission border value to the saved border storage
[Update Saved Destination Value]
The saved border value has been updated → The system moves the current transmission destination value to the saved destination storage
[Increment Shipper Continuation Count]
The system begins creating a new report page for the same shipper → The shipper continuation count in the first header record is incremented by 1
[Format CCN for Canadian Transmission]
Formatting the CCN field → The transaction CCN is moved to the Canadian CCN field in the detail line
[Format CCN for US Transmission]
Formatting the CCN field → The transaction CCN is moved to the US CCN field in the detail line
[Is Transmission Canadian?]
If the country classification flag that was previously set during shipper line formatting → The system checks the CANADIAN flag to determine CCN field placement
[Move CCN to CA-CCN Field]
The system processes the CCN field assignment → The transmission CCN value is moved to the Canadian CCN field (BOND-DTL1-CA-CCN)
[Move CCN to US-CCN Field]
The system processes the CCN field assignment → The transmission CCN value is moved to the US CCN field (BOND-DTL1-US-CCN) and the transmission bond owner value is moved to the bond owner field (BOND-DTL1-BOND-OWNER)
[Check Country Type]
The system processes the transmission for CCN formatting → The system should classify the transmission as Canadian if sequence number is 'CCRGO' or 'CCTRN', otherwise classify as American
[Format CCN for Canadian]
The system formats the detail lines for the bond report → The system should move the transmission CCN to the Canadian CCN field in the bond detail record
[Format CCN for US]
The system formats the detail lines for the bond report → The system should move the transmission CCN to the US CCN field and move the transmission bond owner to the bond owner field in the bond detail record
[Include Bond Owner Information in Detail Line]
The transmission is classified as US (not Canadian) → The bond owner information from the transmission should be moved to the detail line bond owner field
[Skip Bond Owner Information]
The transmission is classified as Canadian → The bond owner information should not be included in the detail line
[Move Ocean Bill of Lading Number from Transmission Record]
The system processes the Ocean Bill of Lading information → The OBL number from the transmission record is moved to the bond detail line 2 OBL field
[Store OBL in Bond Detail Line 2]
The system processes the train information → The train number from the transmission record is moved to the bond detail line 2 train field
[Complete OBL Processing]
The system processes the train date information → The train date from the transmission record is moved to the bond detail line 2 train date field

Structural Validations

None explicitly identified in logic extraction.

Module: GCX021B 1 Consolidated Epic Story

Epic: GCX021B Complete EDI Specification Extracted from Legacy

Contains 92 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX021B EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[14:Handle Invalid Merlin IDs]
EMI-RETURN-STATUS-FLAG is not SUCCESSFUL after EMCSEND2 call → Capture the failed Merlin ID, reroute message to 'OM01247', and send error notification with 'INVALID MERLIN ID' message and broker name
[15:Format Internet Addresses]
The Internet address format is evaluated → If WS-HOLD-INTERNET starts with 'FAX:' or 'fax:', format as FAX message with phone number from position 5, otherwise use the Internet address as-is
[Set Report Counter to 1]
Message counter initialization is performed → The message line counter SUB-M is set to 1
[Search for Administrative Table 'AD' with 'ADMINID']
Performing table segment retrieval → The system should call the table I/O service to retrieve the administrative segment data
[Store Administrative Segment Data]
Processing the retrieved table segment → The system should move the table segment data to the administrative segment structure
[Display Invalid Checkpoint Message]
The system sets default checkpoint values → A message 'INVALID CHECKPOINT - DEFAULT TO 500' should be displayed to the console
[Display Checkpoint Number Being Used]
The checkpoint configuration is finalized → A message showing 'GCX021B CHECKPOINTING AT [number]' should be displayed to the console
[Retrieve Broker Communication Settings]
The system processes the broker table response → The system stores the broker segment data for further processing
[Look up Additional Broker Details Table B1]
The system performs a lookup on the B1 table using the same table key → The system attempts to retrieve additional broker details from the B1 segment
[Store Additional Broker Information]
The system processes the B1 table response → The system stores the B1 segment data for further processing
[Set Invalid Broker Keywords]
No broker record is found for the given notification ID → The system sets the EMI keywords to 'INVBK=' concatenated with the notification ID and clears the broker segment
[Retrieve Broker Configuration Data]
The system processes the successful broker lookup → The broker segment data is moved to GCSTBRT-BK-SEGMENT for further processing
[Load Extended Broker Information]
The system processes the successful B1 lookup → The B1 segment data is moved to GCSTBRT-B1-SEGMENT
[Load Extended Broker Information]
The B1 table lookup is unsuccessful → The system sets GCSTBRT-B1-SEGMENT to spaces
[Set Invalid Broker Keyword]
The broker lookup is unsuccessful → The system sets GCSTBRT-BK-SEGMENT to spaces
[Retrieve Broker Segment Data]
The system processes the successful search result → The table segment data is moved to the broker segment structure for further processing
[Search Related Table 'B1']
The system searches for related B1 table information → The table ID is changed to 'B1' and another table search is performed using the same search parameters
[Retrieve B1 Segment Data]
The system processes the successful B1 search result → The table segment data is moved to the B1 segment structure
[Retrieve B1 Segment Data]
The system processes the unsuccessful B1 search result → The B1 segment structure is cleared to spaces
[Search Extended Broker Table B1]
The system searches for extended broker information in table B1 using the same broker identifier → If the B1 table entry is found, the extended broker segment data is stored for use, otherwise the B1 segment data is cleared to spaces
[B1 Table Found?]
The table lookup operation completes → If the lookup is successful, the retrieved B1 segment data is stored, otherwise the B1 segment is set to spaces
[Store Broker Merlin ID]
System processes broker communication settings → The broker's Merlin ID is stored for message delivery
[Store Broker FAX Number]
The system processes the broker's FAX configuration → The system stores the broker's FAX number for message delivery
[Get Internet Address from B1 Table]
The system needs to obtain the broker's internet delivery address → The system extracts the internet address from the B1 table segment
[Format Internet Address String]
The system prepares the internet address for message delivery → The system formats the address by concatenating 'INTERNET: ' prefix with the B1 internet address
[Broker Uses Merlin?]
The broker's Merlin usage flag is set to 'Y' → Merlin communication is enabled and the broker's Merlin ID and name are stored for message delivery
[Broker Uses FAX?]
The broker's FAX usage flag is set to 'Y' → FAX communication is enabled and the broker's FAX number is stored for message delivery
[Broker Uses Internet?]
The broker's Internet usage flag is set to 'Y' → Internet communication is enabled and the broker's Internet address is stored for message delivery
[All Communication Methods Disabled?]
FAX, Merlin, and Internet communication are all disabled for the broker → The system adds a distribution keyword with the broker notification ID to enable default message routing
[Reset Report Count to Zero]
The report count equals 1 → The report count is reset to zero
[Set Report Count for Numbering]
The report count has been determined → The report count value is moved to the subject report number field
[Set Country Flag to Canadian]
The Canadian flag needs to be set → The CANADIAN flag is set to TRUE for proper message formatting
[Set Country Flag to American]
The country flag needs to be set → The AMERICAN flag is set to TRUE for proper message formatting
[Format FAX Number in Message Text]
The system prepares the FAX message → The system formats the first line of the message text with the FAX number enclosed in parentheses followed by ' -NAK'
[Set FAX Service ID as Primary Recipient]
The system configures message recipients → The system sets the FAX service ID as the primary recipient in the TO field
[Set Merlin ID as Copy Recipient]
The system configures message recipients → The system sets the broker's Merlin ID as the first copy recipient and keeps the default admin copy recipient as the second copy recipient
[Keep Default Copy Recipient]
The system configures message recipients → The system keeps the default administrative copy recipient without adding the broker's Merlin ID
[Call Email Service to Send FAX]
The system initiates FAX transmission → The system calls the EMCSEND2 service with all message parameters including sender, recipients, subject, and message text
[Call Email Service EMCSEND2]
The system calls the email service AND (Merlin is enabled:
FAX is enabled)
→ EMCSEND2 service is invoked with sender, recipients, subject, keywords, and message text
[Continue Processing]
The email transmission is successful → Processing continues without error handling
[Capture Failed Merlin ID]
The system processes the failure AND FAX communication was enabled → Failed Merlin ID is captured from copy recipients
[Capture Failed Merlin ID]
The system processes the failure AND FAX communication was not enabled → Failed Merlin ID is captured from primary recipients
[Reset Recipients to OM01247]
The system prepares error notification → Primary recipient field is cleared AND copy recipient field is cleared AND OM01247 is set as primary recipient
[Generate Invalid ID Message]
The system generates error notification content → Error message is formatted as 'INVALID MERLIN ID - [failed ID] - REPORT REROUTE TO OM01247'
[Send Broker Change Request]
The system creates the error notification subject → Subject line is formatted as 'CHANGE MERLIN ID FOR BROKER: [broker name]'
[Send Broker Change Request]
The system sends the error notification → Error notification is sent to OM01247 via Z700-RESEND-MERLIN process
[Combine Title + Shipper + Count into Subject Line]
Constructing the final subject line → The subject line combines the title with shipper name and report count into a formatted message subject
[Set FAX Recipient and Format]
FAX delivery method is selected → The system sets the FAX ID as the primary recipient and formats the first line of the message with the FAX number in parentheses followed by '-NAK'
[Call EMCSEND2 Service]
The system is ready to send the email → The system calls EMCSEND2 service with all email parameters
[Set FAX Parameters]
The system prepares FAX parameters → The FAX ID is set as the primary recipient, the message includes the formatted phone number with '-NAK' suffix, and if Merlin is also configured, the Merlin ID is added as a copy recipient
[Set Internet Parameters]
The system prepares Internet parameters → If the Internet address starts with 'FAX:' or 'fax:', use the FAX ID as recipient and format message with phone number; otherwise use the Internet ID as recipient, and set the administrative Merlin ID as copy recipient
[Call EMCSEND2 Service]
The system calls the EMCSEND2 service → The service is invoked with from user code, destination filename, recipient codes, copy codes, subject, keywords, message text, and return status parameters
[Reroute to Default Recipient]
The system performs rerouting → The original message is resent to 'OM01247' as the primary recipient with cleared copy recipients
[Using FAX?]
The system checks if FAX communication method is being used → If FAX is used, get the failed Merlin ID from the copy user field, otherwise get it from the to user field
[Set Default Recipient OM01247]
The system needs to reroute the original message → Set OM01247 as the primary recipient in the to user codes field
[Send Original Report to Default]
The system needs to ensure the original report is delivered → Send the original bond report message to the default recipient using the Merlin communication system
[Clear Message Fields]
The system needs to prepare an error notification message → Clear both the subject and text content fields to prepare for new error message content
[Create Broker Change Request Subject]
The system creates the subject line for the error notification → Create a subject stating 'CHANGE MERLIN ID FOR BROKER: [broker_name]' using the stored broker name
[Set Default Recipient as Target]
The system assigns a default recipient → The administrative public Merlin ID is set as the target recipient for the message
[Set Administrative Sender ID]
The system sets up the message sender information → The system should assign the administrative public Merlin ID as the copy recipient
[Call Email Service]
The system needs to send the message via Internet → The system should call the external email service with message details
[Transmission Successful?]
If the transmission return status → If transmission failed (status not SUCCESSFUL), initiate error handling process, otherwise continue normal processing
[Identify Bad Merlin ID]
The system needs to identify the problematic Merlin ID → If FAX was used, capture the copy recipient Merlin ID as the bad ID, otherwise capture the primary recipient Merlin ID as the bad ID
[Reset Email Recipients]
The system prepares to reroute the message → Clear all primary recipients and copy recipients from the email distribution list
[Set Default Recipient to OM01247]
The system needs to set a fallback recipient → Set OM01247 as the primary recipient for the rerouted message
[Resend Original Report to Default]
The system performs the rerouting of failed transmission → Send the original report content to OM01247 using the resend Merlin function
[Check Address Format]
The internet address starts with 'FAX:' or 'fax:' prefix → Extract the FAX number from position 5 onwards, format it with parentheses and add '-NAK' suffix to the message text
[Format as Email Address]
The internet address does not start with 'FAX:' or 'fax:' prefix → Use the complete internet address without any modifications in the message text
[Display Shutdown Message]
The shutdown condition is identified → The system displays 'IMS SHUTDOWN REQUEST RECIEVED BY GCX021B' message to the console
[Route to Administrative Public Merlin ID]
The system assigns a recipient for message delivery → The system should set the administrative public Merlin ID as the primary recipient
[Reset Report Count to Zero]
The report count from the bond data equals 1 → The report count is reset to zero to maintain proper sequential numbering
[Keep Original Report Count]
The report count from the bond data != 1 → The original report count value is maintained without modification
[Extract Report Count from Bond Data]
Processing a message for transmission → The report count is extracted from the bond shipper count field
[Set Report Number for Subject Line]
Preparing the message subject line → The report count is moved to the subject report number field for inclusion in the message subject

Structural Validations

[2:Read Control File Configuration]
The control file is accessed → If the control file is missing, the system must terminate with error message 'MISSING CONTROL CARD - DDC FILE'
[7:Retrieve Broker Configuration]
The broker table is queried using BOND-BK-NOTIFY → If broker is found, retrieve broker and B1 segments, otherwise set segments to spaces and add 'INVBK=' plus broker ID to keywords
[Control File Found?]
The control file record is not found or end of file is reached → The system displays 'MISSING CONTROL CARD - DDC FILE' error message and terminates processing
[Administrative Table Found?]
Checking the return status of the table lookup → If the return flag indicates success, proceed to store the administrative segment data, otherwise handle the missing table error
[Handle Missing Administrative Table Error]
The table lookup return status indicates failure → The system should set error message to 'CAN NOT FIND ADMIN TABLE' and call error handling routine
[Set Invalid Broker Keywords]
The system processes the unsuccessful broker search → The broker segment is cleared to spaces and keywords are set to 'INVBK=' concatenated with the notification ID
[FAX Transmission Successful?]
The system checks the transmission result → The system evaluates if the return status flag indicates successful transmission
[Handle FAX Transmission Error]
The system handles the transmission error → The system identifies the failed recipient ID, reroutes the original message to the default administrative recipient, and sends an error notification about the invalid Merlin ID with broker details
[Send Error Notification]
The system resends the message → Original message is sent to OM01247 via Z700-RESEND-MERLIN process
[Send Error Notification]
Error notification process is initiated → The system creates an error message stating 'INVALID MERLIN ID - [failed ID] - REPORT REROUTE TO OM01247', sets subject as 'CHANGE MERLIN ID FOR BROKER: [broker name]', and sends notification to OM01247
[Send Error Notification]
The system sends error notification → An error message is sent to 'OM01247' with subject containing the broker name and message text indicating the invalid Merlin ID and rerouting action
[Create Invalid Merlin ID Error Message]
The system creates an error notification message → Create a message stating 'INVALID MERLIN ID - [failed_id] - REPORT REROUTE TO OM01247' in the first text line
[Send Error Notification to Default]
The system sends the error notification → Send the error notification message to the default recipient using the Merlin communication system
[Log Error Message]
The system processes the delivery failure → The system should log an error message with the failure details and terminate processing
[Create Error Notification Message]
The system creates an error notification → Generate message text stating 'INVALID MERLIN ID - [bad_merlin_id] - REPORT REROUTE TO OM01247' and clear previous subject and message content
[Set Error Subject with Broker Name]
The system sets the subject for the error notification → Set subject line to 'CHANGE MERLIN ID FOR BROKER: [broker_name]'
[Send Error Notification to Default]
The system sends the error notification → Transmit the error notification to OM01247 using the resend Merlin function
[Terminate Program with Error]
The shutdown processing continues → The system calls the error handler with the shutdown message and terminates the program

Module: GCX023 1 Consolidated Epic Story

Epic: GCX023 Complete EDI Specification Extracted from Legacy

Contains 19 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX023 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Return Code Message Pointer]
The system initializes the call parameters → The return code message pointer must be set to NULL

Core Acceptance Criteria

[3:Release Data Processing]
The release data is processed → The GCW123 message ID is set, auto-release flag is enabled, CCN is mapped from release record, release quantity is cleared, transaction details are copied to comments, and release time is mapped to message time
[5:Message Preparation]
The message is prepared for transaction spawning → The GCX123 input message is moved to the transaction message area and the accept status is cleared
[6:Transaction Spawning]
The transaction spawning process is executed → The GCT1231E transaction is invoked in the external system with the prepared message data through CSIEXCI interface
[7:Database Commit]
The system is ready to spawn the external transaction → A database commit operation is performed to ensure all changes are persisted
[Extract CCN from Release Record]
The system processes the release record data → The CCN from the release record is extracted and moved to the GCW123 message CCN key field
[Clear Release Quantity Field]
The system initializes the message fields → The release quantity field is cleared by moving spaces to it
[Extract Transaction Details as Comments]
The system processes the release record for message creation → The transaction details from the release record are moved to the GCW123 comments field
[Set Message ID to GCW123]
The system prepares the message for transaction processing → The message ID flag should be set to GCW123 type
[Set Auto Release Flag]
The system configures the message properties → The auto release flag should be set to true to enable automatic processing
[Move CCN from Release Record to Message CCN Key]
The system prepares the GCW123 message → The CCN from the release record should be copied to the message CCN key field
[Clear Release Quantity Field]
The system initializes the message fields → The release quantity field should be cleared to spaces
[Move Transaction Details to Message Comments]
The system prepares the GCW123 message → The transaction details should be copied to the message comments field
[Move Release Date to Message Date Field]
The system prepares the GCW123 message → The release date should be copied to positions 3-6 of the message date field
[Move Release Time to Message Time Field]
The system prepares the GCW123 message → The release time should be copied to the message time field
[Prepare Final GCT1231E Message]
The system finalizes the message preparation → The complete GCX123 input should be moved to the GCT1231E message structure
[Calculate Communication Area Length]
The system calculates the communication area length → The length must be computed as the message length plus 4 bytes
[Prepare Message Data for Transaction]
The system prepares the message data for external call → The message content must be moved to the communication data area using the calculated message length
[Calculate Total Call Data Length]
The system calculates the total call data length → The length must be computed as the sum of communication area header length and message length

Structural Validations

None explicitly identified in logic extraction.

Module: GCX025 1 Consolidated Epic Story

Epic: GCX025 Complete EDI Specification Extracted from Legacy

Contains 23 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX025 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Cargo Report Data Retrieval]
Requesting the next cargo report segment → The system should call CIMS with GBGE status to get the next cargo report segment
[3:Cargo Report Data Retrieval]
The status code returned is not blank → The end-of-file switch should be set to 1 to terminate processing
[3:Cargo Report Data Retrieval]
Processing continues after data retrieval → The checkpoint call counter should be incremented by 1
[7:System Shutdown Handling]
The system returns status code 'XD' indicating shutdown request → The program should display shutdown message, log error, close files and terminate immediately
[5:Cargo Report Status Update]
Preparing to update the cargo report → The error or release status index should be cleared to blank space
[5:Cargo Report Status Update]
Updating the cargo report in the database → The system should call CIMS with REPL function to replace the cargo report segment
[Display Final Checkpoint Number]
The checkpoint validation process is complete → The system displays message 'GCX025 CHECKPOINTING AT [checkpoint_number]' to inform user of the checkpoint frequency
[Request Cargo Report Segment from Database]
The system requests cargo report data from the database → The system calls the database interface to retrieve cargo report segments with 'GBGE' acceptance status
[Cargo Report Data Ready for Processing]
The database returns a blank status code indicating successful data retrieval → The cargo report segment data is ready for processing and the system continues with the next processing steps
[Log Shutdown Message]
The shutdown handling process is initiated → A shutdown message is displayed to the console and logged as an error message
[Terminate Program]
The emergency shutdown sequence is completed → The program terminates immediately using GOBACK
[Continue Processing]
Normal processing is to be resumed → The system retrieves the next cargo report segment using 'GBGE' status to continue the processing loop
[Update Cargo Report Segment in Database]
The system executes the database update operation → The cargo report segment must be replaced in the database with the updated information
[Increment Processing Counter]
The status update operation is completed → The checkpoint processing counter must be incremented by 1
[Extract Cargo Control Number from Cargo Report]
Creating a manual release record → The cargo control number from the cargo report is copied to the manual release record
[Display Shutdown Message]
The shutdown condition is detected → Display message 'IMS SHUTDOWN REQUEST RECIEVED BY GCX025' to the console
[Terminate Program]
The emergency shutdown process is complete → Immediately terminate the program and return control to the operating system

Structural Validations

[2:Checkpoint Parameter Validation]
The checkpoint file is empty or cannot be read → The checkpoint number should be set to 500 and an invalid checkpoint message should be displayed
[2:Checkpoint Parameter Validation]
The checkpoint parameter is not numeric → The checkpoint number should be set to 500 and an invalid checkpoint message should be displayed
[File Has Data?]
The system reads the checkpoint file and encounters end-of-file condition → The checkpoint number is set to default value 500, invalid checkpoint flag is set to 'Y', and user is notified with message 'INVALID CHECKPOINT - DEFAULT TO 500'
[Is Checkpoint Value Numeric?]
The checkpoint value from file is evaluated for numeric format → If the checkpoint value is numeric, it is assigned as the checkpoint number; otherwise checkpoint number is set to default value 500 and user is notified with message 'INVALID CHECKPOINT - DEFAULT TO 500'
[Clear Error/Release Status Indicator]
The system prepares to update the cargo report segment → The error or release status indicator field must be cleared to blank space
[Log Error Message]
The shutdown message has been shown to operators → Log the shutdown message 'IMS SHUTDOWN REQUEST RECIEVED BY GCX025' through the error handling system

Module: GCX026A1 1 Consolidated Epic Story

Epic: GCX026A1 Complete EDI Specification Extracted from Legacy

Contains 67 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX026A1 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize MST Report Transmission]
The system begins report transmission → The system calls 'GCSTONLY' service with destination terminal, communication area, PCB, call letters, and MST header
[Initialize GCT1051E Input Message]
The system initializes the GCT1051E input message → The input message structure is cleared to spaces and high-value security byte is set

Core Acceptance Criteria

[5:Process Transit Cargo]
GCCC-IN-TRANSIT-STATUS equals 'T' → The system calls program 'GCX026A2' with cargo report segment and gets the next cargo to print
[6:Process MERLIN Flagged Cargo]
MERLIN-FLAG equals 'Y' → The system decrements MERLIN-IDX, calls program 'GCX026A3' with MERLIN table line and cargo segment, clears batch print call letters, marks form as printed, sets print date, and replaces cargo report
[15:Process Additional Cargo Information]
CIMS call with segment ID '52' and sequence '0001' returns successfully (status code is spaces) → GCSCCS52 data is available for processing, otherwise GCSCCS52 is cleared to spaces, and N9 reference data is processed into work lines
[26:Create Audit Log Entries]
Audit logging is triggered → GCX105-INPUT is populated with security byte, sending transaction 'GCX026A1', cargo action code, current date/time, action code 'ZZZ', CCN, and message 'BATCH PRINTED TO : [destination]'
[28:Spawn External Logging Transaction]
External logging is initiated → CSIEXCI is called with transaction name GCT1051E and audit message, and return code indicates success (EXCI-RC-RESP = ZERO AND EXCI-RC-RESP2 = ZERO AND EXCI-RC-ABCODE = SPACE AND EXCI-RC-MSGLEN = ZERO) or failure
[31:Update Cargo Database Record]
Database update is performed → CIMS is called with REPL function to update GCCC-CARGO-REPORT-SEGMENT in the database
[Set Print Header Name from Work Segment]
MST table initialization begins → The MST print header name is set from the work segment print title
[Check Cargo In-Transit Status]
The cargo in-transit status is 'T' (Transit) → The system calls GCX026A2 program with communication area and cargo report segment, then retrieves the next cargo to print
[Call GCX026A3 for Special MERLIN Processing]
The system needs to perform special MERLIN processing → The system calls program GCX026A3 with CCCOM, MERLIN table line data, and cargo report segment
[Process Additional Cargo Information - Extract and format additional cargo details from N9 segments with reference qualifiers]
Processing additional cargo information for manifest generation → Extract valid N9 reference qualifier and number pairs, format them into additional information lines, and add non-empty lines to the work collection for inclusion in the cargo manifest
[Parse Date into Components]
Date parsing is required → The date is separated into WS-YY (year), WS-MM (month), and WS-DD (day) components
[Process Additional N9 Segment Data]
The system processes N9 data in pairs → For each pair of N9 segments, if reference number qualifier is not spaces, high-values, or low-values, assign qualifier and reference number to cargo additional info fields, otherwise assign spaces. If both qualifiers in a pair are spaces, skip the line, else add the line to work lines and increment line count
[Parse Date into Components]
The system needs to format the date for display → The date is parsed into separate year (WS-YY), month (WS-MM), and day (WS-DD) components
[Format Date with Separators]
The system needs to create a formatted date string for display → The date is formatted as YY/MM/DD with forward slash separators between components
[Retrieve Station Number from Table]
The system processes the retrieved station information → The table segment is moved to the station master segment structure and the station number is extracted from the retrieved data
[Calculate Report Size - Determine total report size based on cargo count multiplied by 66 lines minus 4]
The system needs to determine the total report size for transmission → The system initializes the print size counter to zero, multiplies the cargo count by 66 lines per report, subtracts 4 lines for header/footer overhead, and sets the result as the maximum print size for transmission
[Skip Transmission - Destination is '****']
The destination terminal (DEST-LTERM) equals '****' → The system skips the transmission process and proceeds to end the batch process
[Set Transaction Code to 'GCT026']
The destination terminal is valid → The system sets the transaction code to 'GCT026'
[Calculate Total Report Size]
The system prepares for transmission → The system calculates the maximum print lines as ((cargo index * 66) - 4)
[Send Report Lines Sequentially]
The system processes report lines → The system performs Z300-SEND-MST-LINE for each MST index from 1 to the maximum print lines
[Send 'WRAP' Command]
The system completes the transmission process → The system sets the user function code to 'WRAP' and calls 'GCSTONLY' service with destination terminal, communication area, PCB, call letters, and MST header
[Set Transaction Code to GCT026]
Setting transaction identification → The transaction code is set to 'GCT026'
[Call GCSTONLY to Send Header]
Initiating report transmission → Call GCSTONLY service with destination terminal, communication area, PCB, call letters, and header information
[Calculate Total Report Size]
The system prepares for report transmission → The maximum print lines are calculated as cargo count multiplied by 66 lines per cargo minus 4 adjustment lines
[Send Report Header via GCSTONLY]
The system begins report transmission → The report header with call letters and manifest header information is sent to the destination terminal using GCSTONLY service
[Send WRAP Command to Complete Transmission]
The line transmission loop is completed → A WRAP command is sent to the destination terminal using GCSTONLY service to complete the transmission session
[Calculate Report Size for Transmission]
The system prepares to transmit the report to a valid destination → The maximum print lines are calculated as ((number of cargo items × 66) - 4) to determine the transmission size
[Send Report to Destination Terminal]
The system begins report transmission → The GCSTONLY program is called with the destination terminal, communication area, and report header to initiate transmission
[Send Report Lines to Terminal]
The system processes each report line from index 1 to the maximum calculated print lines → Each report line is sent individually using the GCSTONLY program until all lines are transmitted
[Complete Report Transmission with WRAP]
The line transmission loop completes → The GCSTONLY program is called with 'WRAP' function code to complete and finalize the report transmission
[Complete Report Transmission - Send 'WRAP' command to finalize report transmission]
The report transmission process needs to be finalized → The system sets the function code to 'WRAP' and sends the WRAP command to the destination terminal to complete the transmission
[Create Log Entry with CCN]
The system creates an audit log entry for the batch printing activity → The system populates log entry with security byte, sending transaction 'GCX026A1', cargo action type, user ID, current date and time, action code 'ZZZ', extracted CCN, and batch destination message
[Build Batch Destination Message]
The system builds the audit message → The system concatenates 'BATCH PRINTED TO : ' with the destination terminal name into the message field
[Log Success]
The call returns with response code zero, response2 zero, no abend code, and message length zero → The system sets return code to success status
[Build Batch Destination Message]
The distribution needs to be logged for audit purposes → A message is constructed containing 'BATCH PRINTED TO : ' followed by the destination terminal identifier
[Complete Log Entry Structure]
The log entry needs to be prepared for external logging → The complete log entry structure is moved to the external logging message format
[Extract CCN from Report Line]
The system extracts the cargo control number → Characters 38 through 62 from the report line are moved to the train or US CCN field in the audit message
[Build Batch Destination Message]
The system builds the batch destination message → The message is constructed by concatenating 'BATCH PRINTED TO : ' with the destination terminal identifier
[Call External Transaction GCT1051E]
The system calls the external transaction GCT1051E → Transaction name is set to GCT1051E, communication length is calculated as message length plus 4, message data is moved to communication area, and CSIEXCI is called with all required parameters
[Set Success Return Code]
Setting the transaction completion status → Set return code to success status
[Build 'BATCH PRINTED TO' Message]
An audit message needs to be created for the printing activity → The system concatenates 'BATCH PRINTED TO : ' with the destination terminal identifier to create the audit message
[Prepare External Log Transaction]
The log entry needs to be prepared for external transmission → The system moves the complete log input structure to the transaction message, sets transaction name to 'GCT1051E', calculates communication length, and prepares EXCI parameters
[Logging Successful?]
The success or failure of the logging operation needs to be determined → The system checks if EXCI response code is zero, response2 is zero, abend code is space, and message length is zero to determine success
[Record Failure Status]
The failure needs to be recorded and reported → The system sets return code to failure status, displays EXCI error with response codes and abend code, and if error message pointer exists, displays the error message content
[Build Batch Destination Message]
Audit message creation is required → The message should be formatted as 'BATCH PRINTED TO : ' followed by the destination terminal identifier
[Prepare EXCI Communication Area]
Communication area preparation is required → The transaction name should be set to GCT1051E and communication length should be calculated based on message length plus 4
[Replace Cargo Report Segment in Database]
All cargo processing rules have been applied and data updates are complete → The cargo report segment is replaced in the database with the updated information using the REPL function

Structural Validations

[Set Destination Terminal from Call Letters]
The destination terminal is not invalid → The system sets the destination terminal to the previous call letters (WS-CALL-LETTERS-PREV) and sets the originating terminal to the same value
[Check Destination Terminal]
Validating the destination for report transmission → If destination terminal equals '****' then skip report processing, otherwise proceed with report generation
[Check if destination terminal is valid or marked as non-printable (****)]
The system checks the destination terminal value → If the destination terminal equals '****' then skip report transmission, otherwise continue with normal report transmission process
[Skip Transmission - Destination is ****]
The destination terminal equals '****' → The report transmission is skipped and the process ends without sending the report
[Skip All Printing Operations]
The destination terminal is set to '****' (invalid destination marker) → All printing operations are skipped and processing continues to the end without sending any report data
[Log Error Message]
The call returns with non-zero response codes, abend code, or message length greater than zero → The system displays error information including response codes and abend code, displays error message if available, and sets return code to failure status
[Transaction Call Successful?]
The system validates the transaction response → Success is confirmed when EXCI response code equals zero AND EXCI response2 equals zero AND EXCI abend code equals space AND EXCI message length equals zero
[Display Error Information]
The system displays error information → Error message is displayed showing program name, EXCI response codes, response2 codes, and abend code, and if error message pointer is not null, the detailed error message is also displayed
[Check Abend Code = SPACE?]
The EXCI abend code is evaluated → If abend code equals space, proceed to check message length, otherwise display error and set failure status
[Check Message Length = 0?]
The EXCI message length is evaluated → If message length equals zero, set success return code, otherwise display error and set failure status
[Display EXCI Error with Response Codes]
Handling the transaction error → Display error message with EXCI response codes, response2 codes, and abend code details
[Error Message Pointer Available?]
Checking for additional error message details → If error message pointer is not null, display detailed error message, otherwise proceed to set failure status
[Display Detailed Error Message]
Displaying detailed error information → Display the detailed error message content using the message pointer and message length
[Error Message Available?]
The system checks if EXCI-RC-MSGPTR != NULL → Additional error message processing is performed if message pointer is available
[Extract Error Message Pointer]
EXCI-RC-MSGPTR is not NULL → The system sets the address of EXCI-ERROR-MSG to EXCI-RC-MSGPTR to access the detailed error message
[Display Detailed Error Message]
Error message pointer has been successfully extracted → The system displays the error message content using the message length to system error output
[EXCI Call Successful?]
Success validation is performed → The transaction is successful if response code is zero AND response2 is zero AND abend code is space AND message length is zero
[Display Error Messages]
Error reporting is required → Error details including response codes and abend code should be displayed, and if error message pointer is not null, the error message should also be displayed

Module: GCX026A2 1 Consolidated Epic Story

Epic: GCX026A2 Complete EDI Specification Extracted from Legacy

Contains 44 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX026A2 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize N9 Counter]
The system prepares to process N9 reference qualifiers → The work line counter should be set to 1, N9 counter should be set to zero, and work line should be cleared to spaces
[Initialize Outward Report Transmission]
The outward report processing begins → The MST table is cleared to spaces and the MST index is reset to 1
[Initialize Log Entry Fields]
The log entry initialization process begins → All input fields are cleared to spaces and security byte is set to high-value
[Initialize Line Counter to 1]
The system begins to send report lines to destination terminal → The line counter is initialized to position 1 to track the first line to be processed

Core Acceptance Criteria

[Parse Date Components]
The system needs to format the date for display → The date is parsed into separate year, month, and day components
[Format Date as MM/DD/YY]
The system formats the date for display → The date is formatted as YY/MM/DD with slash separators
[Parse Date Components - Year, Month, Day]
The system needs to format the date for display → The date is parsed into separate year, month, and day components in working storage variables
[Extract Destination Station Name from Cargo Report]
The system processes station information setup → The destination station name from the cargo report is copied to the print format destination station name field
[Extract Destination State/Province Code from Cargo Report]
The system processes station information setup → The destination state/province code from the cargo report is copied to the print format destination province code field
[Extract Origin Station Name from Cargo Report]
The system processes station information setup → The origin station name from the cargo report is copied to the print format origin station name field
[Extract Origin State/Province Code from Cargo Report]
The system processes station information setup → The origin state/province code from the cargo report is copied to the print format origin province code field
[Extract US Exit Port]
The system processes the lookup results → The US exit port is extracted from the station segment data
[Extract Exit Code]
The system extracts station details → The US station exit code is extracted from the station segment
[Extract Call Letters]
The system extracts station details → The call letters are extracted from the station segment and assigned to origin call letters
[Set CCN Key for Segment 52]
The system needs to retrieve additional cargo information → The CCN key should be set for segment 52 with sequence number 0001 and segment ID 52
[Call Database to Get N9 Segment]
The system executes the database retrieval call → The system should attempt to retrieve the N9 segment data using the CIMS database interface
[Database Call Successful?]
The database call status is evaluated → If the status code is spaces (successful), keep the retrieved data; otherwise, clear the N9 segment data to spaces
[Extract Call Letters from Results]
The lookup return flag equals '0' → The call letters are extracted from the station master segment and assigned to destination call letters
[Set Form Printed Flag to 'Y']
The system updates the cargo report segment → The form printed flag is set to 'Y' to indicate the form has been printed
[Call Database Replace Function]
The system executes the database update operation → The cargo report segment is replaced in the database using the CIMS database interface
[Set Train ID Number for Inward Report]
Processing an inward report → The train ID number from the cargo data is assigned to the inward train number
[Set Train Day for Inward Report]
Processing an inward report → The train day from the cargo data is assigned to the inward train day
[Set Origin Terminal as Destination]
Setting up inward report transmission → The origin call letters are assigned to both the communication origin terminal and destination terminal
[Send Report Header to Origin Terminal]
Sending the report → The MST report is transmitted to the destination terminal using the GCSTONLY program
[Complete Report Transmission with Wrap Command]
Completing the report transmission → A wrap command is sent to the terminal using GCSTONLY to finalize the transmission
[Send Outward Report]
The system sends the manifest report → The MST report transmission procedure is performed to deliver the outward cargo manifest
[Log Report Activity]
The system completes the report transmission → A log entry is created documenting the outward report activity
[Set Transaction Code GCT026]
The transaction code needs to be set for the transmission → The transaction code 'GCT026' is moved to the CCCOM transaction code field and the user function code is cleared
[Send Report Header to Destination]
The header transmission is initiated → The GCSTONLY program is called with destination terminal, CCCOM, ALT-PCB, MST call letters, and MST header to transmit the header information
[Send Individual Report Lines]
Individual report lines need to be transmitted → Each MST entry line is sent to the destination terminal by calling GCSTONLY with the destination terminal, CCCOM, ALT-PCB, MST call letters, and the specific MST entry, varying the MST index from 1 to the maximum print count
[Send Wrap Command to Complete Transmission]
The transmission needs to be properly completed → The user function code is set to 'WRAP' and GCSTONLY is called with destination terminal, CCCOM, ALT-PCB, MST call letters, and MST header to complete the transmission
[Create Batch Print Message]
An audit message needs to be created for logging → The message is formatted as 'BATCH PRINTED TO : ' followed by the destination terminal identifier
[Submit Log Entry]
The log entry needs to be submitted to the external logging system → The log entry is formatted as a transaction message and submitted to the external logging system via CSIEXCI call
[Format Log Message with Destination]
The transaction log message needs to be formatted → The message is formatted as 'BATCH PRINTED TO : ' followed by the destination terminal identifier
[Format Batch Print Message]
The system logs the transaction → A message is formatted as 'BATCH PRINTED TO : ' followed by the destination terminal identifier
[Determine CCN for Message]
CCN determination is performed → If master manifest CCN exists then use master manifest CCN, otherwise use the regular CCN key
[Format Batch Print Message]
Message formatting is performed → The message is formatted as 'BATCH PRINTED TO : ' followed by the destination terminal identifier
[Complete Message Format]
Message structure completion is performed → The complete message structure is assembled and prepared for logging
[Line Counter <= Maximum Print Lines?]
The system checks if the current line counter is less than or equal to the maximum print lines → Processing continues if more lines remain, otherwise transmission is completed
[Get Current Manifest Line from Table]
The system needs to retrieve the manifest line data for transmission → The manifest entry at the current counter position is selected from the MST table
[Call Communication Module to Send Line]
The system calls the GCSTONLY communication module → The communication module is invoked with destination terminal, communication control, PCB, call letters, and manifest line data
[Transmit Line to Destination Terminal]
The transmission process executes → The manifest line is delivered to the destination terminal specified in DEST-LTERM
[Wrap Report Transmission - Complete report transmission with wrap command]
The report transmission needs to be completed → The system sets the user function code to 'WRAP' and calls the report transmission service to properly terminate the session

Structural Validations

[Check Log Submission Result]
The submission result needs to be validated → If response code is zero, response2 is zero, abend code is space, and message length is zero, then log submission is successful, otherwise log submission has failed

Module: GCX026A3 1 Consolidated Epic Story

Epic: GCX026A3 Complete EDI Specification Extracted from Legacy

Contains 42 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX026A3 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize GCX019-INPUT structure]
The system begins configuring primary message parameters → The GCX019-INPUT structure is initialized to clear any previous data
[Initialize Response Message Pointer]
The system prepares for potential response messages → The response message pointer should be set to NULL
[Initialize Message Input Structure]
The system begins secondary message setup → The message input structure is initialized to clear state
[Initialize Message Pointer]
The system initializes the message pointer → The message pointer is set to null

Core Acceptance Criteria

[3:Configure Primary Message Parameters]
A fax number is provided (TABLE-FAX-NUMBER is populated) → Clear the Merlin ID and use fax communication with the provided fax number, otherwise use the table send-to value as Merlin ID
[4:Send Primary Cargo Report Message]
The cargo report transmission is initiated → Send the message using the external transaction processor with the configured parameters
[5:Handle Primary Message Response - Success, 9:Handle Secondary Message Response - Success]
The transmission is successful (response codes are zero, no abend code, and no error message) → Set the return code to success status
[5:Handle Primary Message Response - Failure, 9:Handle Secondary Message Response - Failure]
The transmission fails (non-zero response codes, abend code present, or error message exists) → Set the return code to failure status
[Destination File Required?]
A destination file is specified (TABLE-DESTINATION-FILE is populated) → Proceed with secondary file message processing
[7:Configure Secondary Message Parameters]
Secondary message parameters need to be configured → Use the same CCN selection logic as primary message, set Merlin ID to 'OM01247', clear fax number, and set the destination file name
[8:Send Secondary File Message]
The secondary file message transmission is initiated → Send the message using the external transaction processor with file-specific parameters
[Check Master Manifest CCN]
The system checks if GCCC-MASTER-MFST-CCN contains data (is not is empty) → If GCCC-MASTER-MFST-CCN is empty (equals SPACES), use GCCC-CCN-KEY as the CCN for message processing, otherwise use GCCC-MASTER-MFST-CCN as the CCN for message processing
[Set security byte to HIGH-VALUE]
Security parameters need to be configured → The security byte is set to HIGH-VALUE for maximum security level
[Set CCN in message structure]
If available CCN sources → If master manifest CCN is empty, use the CCN key; otherwise use the master manifest CCN
[Set Merlin ID from TABLE-SEND-TO]
The communication method needs to be established → The Merlin ID is set from the TABLE-SEND-TO configuration value
[Keep Merlin ID configuration]
TABLE-FAX-NUMBER is empty → Keep the existing Merlin ID configuration for message delivery
[Copy configured input to message structure]
The configuration is complete → Copy the GCX019-INPUT structure to the GCT0191E-MSG for message processing
[Prepare Message Structure]
The system needs to prepare message for transmission → The input data should be moved to GCT0191E-MSG message structure
[Calculate Communication Area Length]
The system needs to determine communication area size → The communication length should be calculated as message length plus 4 bytes
[Move Message Data to Communication Area]
The system prepares data for external transmission → The message content should be moved to EXCI-COMM-DATA area using the message length
[Calculate Total Call Data Length]
The system needs to determine total call data size → The call data length should be calculated as header length plus message length
[Check Response Status]
Any response code is not zero:
response code 2 is not zero
abend code is not space
message length is not zero
→ Process the transmission as failed and log error details
[Set Failure Status]
Error processing is complete → Set the return status to failure
[Check Destination File Requirement]
The system checks if TABLE-DESTINATION-FILE contains a configured destination file path → If TABLE-DESTINATION-FILE is not empty, file-based message processing is required; otherwise, no file-based message is needed
[Master Manifest CCN Available?]
If which CCN to use for the secondary message → If master manifest CCN is not spaces, use master manifest CCN; otherwise use regular CCN key
[Set Merlin ID to 'OM01247']
The communication method needs to be established → The Merlin ID is set to 'OM01247' for file-based processing
[Clear FAX Number Field]
Communication parameters are being set → The FAX number field is cleared to spaces to disable FAX communication
[Set Destination File Name from Table]
File destination parameters need to be set → The file name from the table destination file is assigned to the message file name
[Set Transaction Name to GCT0191E]
The system prepares the transaction for file-based cargo report delivery → The transaction name is set to GCT0191E
[Calculate Communication Area Length]
The system calculates the communication area length → The communication area length equals the message length plus 4 bytes
[Prepare Message Data for Transmission]
The system prepares the message data for transmission → The message content is moved to the communication data area
[Calculate Total Call Data Length]
The system calculates the total call data length → The total call data length equals the communication area header length plus the message length
[Execute EXCI Transaction Call]
The system executes the EXCI transaction call → The CSIEXCI program is called with the prepared parameters to transmit the secondary file message
[Set Success Status]
All response validation criteria are met for successful transmission → Set the return code to success status (RC-SUCS)
[Set Failure Status]
Any response validation criteria indicate transmission failure → Set the return code to failure status (RC-FAIL)

Structural Validations

[Check Response Status]
All response codes equal zero AND response code 2 equals zero AND abend code is space AND message length is zero → Set the return status to success
[Error Message Available?]
The error message pointer is not null → Display the detailed error message content
[Set Security Parameters]
Security parameters need to be established → The security byte is set to high value for proper authentication
[Check Response Status]
All response codes equal zero (EXCI-RC-RESP = ZERO AND EXCI-RC-RESP2 = ZERO) AND the abend code is empty (EXCI-RC-ABCODE = SPACE) AND the message length is zero (EXCI-RC-MSGLEN = ZERO) → The transmission is considered successful
[Check Response Status]
Any response code is not zero (EXCI-RC-RESP ≠ ZERO:
EXCI-RC-RESP2 ≠ ZERO)
the abend code is not empty (EXCI-RC-ABCODE ≠ SPACE)
the message length is not zero (EXCI-RC-MSGLEN ≠ ZERO)
→ The transmission is considered failed

Module: GCX028 1 Consolidated Epic Story

Epic: GCX028 Complete EDI Specification Extracted from Legacy

Contains 10 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX028 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Report Subject Line Creation]
Preparing the report for sending → Set proper subject line with report type (Cargo/Train), format hours with correct singular/plural grammar, and prepare transmission parameters
[Email Report Transmission]
Sending the report → Send report to supervisor user ID and send copy to operations user 'OM01247' using the email communication system
[Clear Email Parameters]
The email transmission process begins → All email parameters (recipient usercode, copy usercode, keywords, and return status flag) must be cleared to spaces
[Set Supervisor Merlin ID as Recipient]
Setting up email recipients → The supervisor Merlin ID from the previous processing cycle must be set as the primary recipient in the first position of the recipient list
[Send Report to Supervisor via Email System]
Initiating report transmission → The system must call the email communication service to send the report with all configured parameters including sender, destination, recipient, subject, and report content
[Send Notification to Fallback User OM01247]
Completing the email transmission process → The system must send a notification to user OM01247 using the original recipient information as keywords and OM01247 as the new recipient
[Set Supervisor ID as Primary Recipient]
Setting up email recipients for error report transmission → The supervisor ID must be assigned as the first recipient in the email distribution list
[Complete Fallback Notification Process]
The email transmission is completed → The communication interface is finalized by calling the ISCCCOM program
[Create New Report Header]
The system needs to continue processing more error records → The system creates a new report header for the next page

Structural Validations

None explicitly identified in logic extraction.

Module: GCX029 1 Consolidated Epic Story

Epic: GCX029 Complete EDI Specification Extracted from Legacy

Contains 25 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX029 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Main Processing Loop]
Processing records from the message table → The program should continue processing until EOF flag is set to 'Y'
[3:Database Table Access]
A database call is made to CIMS → The system should retrieve table segment data with 'GB' browse status and increment the checkpoint call counter
[9:Shutdown Handling Required?]
The checkpoint response is evaluated → If status code equals 'XD', shutdown message should be displayed and program should terminate gracefully
[10:File Closure]
End of data condition is reached → The output file should be closed and program should terminate normally
[Set Checkpoint Counter Threshold to 1500]
The initialization occurs → The checkpoint threshold is set to 1500 calls to manage system resources and enable restart capability
[Call Database to Get Next Station Record]
The system calls the CIMS database interface → The next table segment record should be retrieved and made available for processing
[Save Current Table Key]
The database operation completes without error → The current message table key should be saved to enable restart capability
[Execute CIMS Call to Retrieve Station Record]
A request is made to retrieve station records from the message table → The system calls CIMS interface with the message table parameters to retrieve the next available station record
[Save Current Record Key]
The record retrieval is successful → The system saves the current message table key to enable recovery positioning if needed
[Extract Manifest ID as Border Name]
The system processes the record for output generation → The manifest ID from the message table record is extracted and assigned as the border name
[Extract Station Number as Border Station]
The system processes the record for output generation → The station number from the message table record is extracted and assigned as the border station
[Write Border Station Record to Output File]
The system completes the record preparation → The border station record containing the border name and station information is written to the output file
[Check Call Counter Against Threshold]
The checkpoint call counter is compared against the threshold value of 1500 → The system determines whether checkpoint processing should be initiated
[Display Shutdown Message]
The system processes the shutdown request → The system displays 'IMS SHUTDOWN REQUEST RECIEVED BY GCX029' message to the console
[Terminate Program]
The system processes the shutdown request → The program terminates execution and returns control to the calling system
[Save Current Database Position]
The system needs to resume processing from the saved position → The system repositions to the previously saved message table key and continues processing
[Retrieve Saved Database Key]
The system needs to reposition the database cursor to continue processing → The saved table key should be retrieved and used to reposition the cursor
[Set Key Value for Positioning]
The system prepares to reposition the database cursor → The saved key value should be moved to the database key structure
[Call Database to Reposition Cursor]
The system executes the database repositioning operation → A database call should be made with GHU function, PCB, table segment, and positioning qualifier
[Display Shutdown Message]
The shutdown processing begins → The system should display 'IMS SHUTDOWN REQUEST RECIEVED BY GCX029' to the console

Structural Validations

[4:Border Crossing Validation]
The record is evaluated for border crossing criteria → The record should be processed only if table ID equals 'MC' AND manifest ID is not spaces AND border port flag equals 'Y'
[Check Table ID = 'MC'?]
The system checks the table identification field → The record should only proceed to manifest validation if the table ID equals 'MC'
[Check Manifest ID exists?]
The system validates the manifest ID field → The record should only proceed to border port validation if the manifest ID field is not blank
[Check Border Port Flag = 'Y'?]
The system checks the border port designation flag → The station should only qualify as a border crossing if the border port flag equals 'Y'
[Log Error Message]
Error logging is required → The system should move the shutdown message 'IMS SHUTDOWN REQUEST RECIEVED BY GCX029' to the error message field and call the error handling routine

Module: GCX030 1 Consolidated Epic Story

Epic: GCX030 Complete EDI Specification Extracted from Legacy

Contains 101 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX030 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize System Parameters]
The checkpoint file is read and the checkpoint value is either missing, invalid, or non-numeric → The system sets the checkpoint number to 500 as the default value and displays an invalid checkpoint message
[1:Initialize System Parameters]
The checkpoint value is not numeric → The system defaults to checkpoint number 500 and displays an invalid checkpoint message

Core Acceptance Criteria

[Special Equipment Record?]
The carrier index is 974 or 990 AND the origin station number is 000001 or 000002 AND the equipment car initial is TCSZ or CSRZ or NERZ → The system classifies the record as a special equipment record requiring immediate purging
[Extract Warning Days from Admin Table]
The table segment is retrieved with successful status → The system extracts warning days value from the administration table segment and assigns it to EMI-DAYS
[Get Warning Days from Administration Table]
The administration table is accessed with table ID 'AD' and sequence ID 'ADMINID' → The warning days value is retrieved from the administration table segment
[Set IFS-MERLIN-ID to MERLIN-2 or MERLIN-1]
DC-P-MERLIN-2 is provided and not spaces, validate it in EMTZ segment → If DC-P-MERLIN-2 is found, set IFS-MERLIN-ID to DC-P-MERLIN-2, if not found display error 'MERLIN ID 2 NOT FOUND' and call error handling, if DC-P-MERLIN-2 is not provided set IFS-MERLIN-ID to DC-P-MERLIN-1
[Set HHS-MERLIN-ID to MERLIN-3 or MERLIN-1]
DC-P-MERLIN-3 is provided and not spaces, validate it in EMTZ segment → If DC-P-MERLIN-3 is found, set HHS-MERLIN-ID to DC-P-MERLIN-3, if not found display error 'MERLIN ID 3 NOT FOUND' and call error handling, if DC-P-MERLIN-3 is not provided set HHS-MERLIN-ID to DC-P-MERLIN-1
[Set IM-MERLIN-ID to MERLIN-4 or MERLIN-1]
DC-P-MERLIN-4 is provided and not spaces, validate it in EMTZ segment → If DC-P-MERLIN-4 is found, set IM-MERLIN-ID to DC-P-MERLIN-4, if not found display error 'MERLIN ID 4 NOT FOUND' and call error handling, if DC-P-MERLIN-4 is not provided set IM-MERLIN-ID to DC-P-MERLIN-1
[Set COPY-MERLIN-ID to MERLIN-5 or Spaces]
DC-P-MERLIN-5 is provided and not spaces, validate it in EMTZ segment → If DC-P-MERLIN-5 is found, set COPY-MERLIN-ID to DC-P-MERLIN-5, if not found display error 'MERLIN ID 5 NOT FOUND' and call error handling, if DC-P-MERLIN-5 is not provided set COPY-MERLIN-ID to spaces
[Retrieve Associated A2 Records]
The system needs to process complete cargo information → The system should retrieve associated A2 records using the cargo CCN key with segment ID '52' and sequence '0001'
[Call Database to Get Next Cargo Report]
A request is made to get the next cargo report → The system should call the database interface to retrieve the next cargo report segment using the specified query criteria
[Get Associated A2 Records]
The system needs to process the complete cargo information → The system should retrieve associated A2 records using the cargo CCN key with segment ID '52' and sequence '0001', and set the A2 found flag based on whether records exist
[Display Shutdown Message]
The system processes the shutdown request → A shutdown notification message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX030' is displayed to the console and error handling is invoked
[Close All Files]
The system prepares for shutdown → All open files including checkpoint file, release file, cargo current file, and cargo history file are closed
[Call Database System with GN Function]
The system executes a database call with GN function → The database system is called using CIMS with GN function, PCB7, cargo report segment, and qualified SSA
[Configure SSA Keys]
Database key parameters are being established → The cargo record key should be properly configured in the SSA (Segment Search Argument) structure
[Retrieve Associated A2 Records for Follower]
The system needs to process associated A2 records → The system should retrieve A2 records using the follower CCN key with segment ID '52' and sequence '0001'
[Process A2 Type 54 Record]
The system processes A2 type 54 records → Set cargo key, segment ID to 54, sequence to 0001, and Execute retrieval operation
[Set Segment Sequence Number from Counter]
The system sets up the record key for retrieval → The segment sequence number is set to the current loop counter value
[Set Segment ID to '54']
Configuring the segment identifier → The segment ID should be set to '54' to identify it as a Type 54 record
[Set Segment Sequence to '0001']
Setting the segment sequence number → The segment sequence should be set to '0001' as the default sequence
[Retrieve Associated A2 Records]
The system needs to archive all related data → The system retrieves A2 records using the cargo CCN key with segment ID 52 and sequence 0001
[Copy Main Cargo Record to History File]
The archive process is executed → Copy the complete cargo report segment to the history file with the timestamp
[Copy Cargo Report Segment to Current File]
The appropriate timestamp has been determined for the record → The cargo report segment should be copied to the current file record structure
[Extract Cargo Information]
The system extracts cargo information for the warning report → Move cargo CCN key to message CCN field and manifest destination transport code to message port field
[Use Last Modify Info]
The system processes last activity information → Move last modify date, time, terminal, and user ID to corresponding message fields
[Use Creation Info]
The system processes last activity information → Move creation date, time, terminal, and user ID to corresponding message fields
[Calculate Cargo Age in Days]
The system calculates cargo age → Call TIMEDIFF program using creation date/time and current machine date/time to determine day difference and move result to message age field
[Look Up Station Configuration]
The system looks up station configuration → Execute table lookup using 'MC' table ID and manifest destination station name to retrieve station segment information
[Write Warning Report Record]
The system writes the warning report → Write release information record using the message line detail format to the release file
[Extract Last Modify Date]
The system processes last activity details using modification data → The last modify date is extracted and assigned to the message last activity date field
[Convert Time to Hours/Minutes]
The system processes time for message output → Hours component is extracted to message last activity hours and minutes component is extracted to message last activity minutes
[Extract Last Modify Terminal]
The system processes last activity details using modification data → The last modify terminal is extracted and assigned to the message terminal field
[Extract Last Modify User ID]
The system processes last activity details using modification data → The last modify user ID is extracted and assigned to the message user field
[Extract Creation Date]
The system processes last activity details using creation data → The creation date is extracted and assigned to the message last activity date field
[Extract Creation Terminal]
The system processes last activity details using creation data → The creation terminal is extracted and assigned to the message terminal field
[Extract Creation User ID]
The system processes last activity details using creation data → The creation user ID is extracted and assigned to the message user field
[Format Last Activity Information]
The system needs to create a warning report message → Format the activity information into message fields including CCN key, last activity date, time components, terminal, and user ID
[Use Last Modify Date/Time]
The system needs to format last activity information for reporting → The system should use the last modify date as the message last activity date, extract hours and minutes from last modify time for message last activity time, use last modify terminal as message terminal, and use last modify user ID as message user ID
[Use Creation Date/Time]
The system needs to format last activity information for reporting → The system should use the creation date as the message last activity date, extract hours and minutes from creation time for message last activity time, use creation terminal as message terminal, and use creation user ID as message user ID
[Format Time to Hours/Minutes]
The system processes the time for message formatting → The system should extract the hours component and assign it to message last activity hours, and extract the minutes component and assign it to message last activity minutes
[Last Modify Date Available?]
The cargo record has last modify information that is not empty spaces → Extract last modify date, time, terminal ID, and user ID from the cargo record for message formatting
[Extract Creation Date]
The cargo record has no last modify information or last modify information is empty spaces → Extract creation date, time, terminal ID, and user ID from the cargo record for message formatting
[Format Time Components]
Time formatting is required for message display → Extract hour and minute components from the time field and format them appropriately for message output
[Set Message Fields with Extracted Information]
Warning message needs to be populated with cargo activity details → Set message fields with last activity date, formatted time components, terminal ID, and user ID for the warning report
[Use Last Modify Time]
The system processes the cargo for warning report generation → The system uses the last modify date, last modify time, last modify terminal, and last modify user ID for the warning message
[Use Creation Time]
The system processes the cargo for warning report generation → The system uses the creation date, creation time, creation terminal, and creation user ID for the warning message
[Extract Hours from Time]
The system formats the time for warning message display → The system extracts the hours component from the time field and moves it to the working storage time structure
[Extract Minutes from Time]
The system formats the time for warning message display → The system extracts the minutes component from the time field and moves it to the working storage time structure
[Format Hours for Message]
The system prepares the warning message → The system moves the hours component to the message last activity hours field
[Format Minutes for Message]
The system prepares the warning message → The system moves the minutes component to the message last activity minutes field
[Set Terminal Information]
The system prepares the warning message → The system moves the terminal identification to the message terminal field
[Set User ID Information]
The system prepares the warning message → The system moves the user ID to the message user identification field
[Search MC Table by Station Name]
The system performs a table lookup for station configuration → The MC table is searched using the station name as the key and table segment data is retrieved
[Load MC Segment Data]
The table data needs to be processed → The table segment should be moved to the MC segment data structure
[Clear MC Segment Data]
The MC segment data needs to be handled → The MC segment should be cleared to spaces
[Get MC Table Segment for Station]
The system needs to determine station-specific Merlin configuration → The system retrieves the MC table segment for the station or sets empty configuration if not found
[MC Record Found?]
The MC table lookup is completed → If MC record is found successfully, use the MC record's Merlin ID; otherwise use the default DCP Merlin ID
[Call Table Segment Retrieval]
The table segment retrieval operation is executed → The system calls the table I/O module to retrieve the matching MC table record and returns a success or failure indicator
[Move Table Segment to MC Segment Structure]
The table lookup operation returns a successful status → The retrieved table segment data is moved to the MC segment working storage structure for subsequent processing
[Call TIMEDIFF to Calculate Date Difference]
The system needs to calculate the age difference in days → TIMEDIFF program is called with date parameters and returns the difference in WS-RESULT-DIFF
[Store Age in Days for Warning Report]
The age value needs to be included in the warning report message → The calculated age in days (WS-DAY-DIFF) is moved to the message age field (MSG-AGE)
[Load MC Table Segment Data]
The system processes the lookup result → The table segment data is moved to the MC segment working storage area
[Set Default Empty Configuration]
The system handles the missing configuration → The MC segment is set to spaces indicating no station-specific configuration available
[Call GCCTBIO Table Access Program]
The system executes the table lookup → The GCCTBIO program is called with communication area, flags, function code, table literal, key values, data parameters, table segment buffer, and return flag
[Return Table Segment Data]
The system processes the lookup result → The table segment data from the workspace is moved to the appropriate table segment structure for use by the calling program
[Load MC Table Segment Data]
The system processes the retrieved data → The table segment data is moved to the MC segment structure for further processing
[Call GCCTBIO Table Service]
The table lookup needs to be performed → The GCCTBIO service should be called with communication control, flags, function code, key values, and table segment parameters
[Move Table Data to Segment]
The return flag indicates successful data retrieval → The retrieved table data should be moved from the working storage table segment to the appropriate target segment structure
[Return to Calling Process]
All lookup processing is complete → Control should be returned to the calling process with the appropriate data or default values in the target segment
[Is Cargo in Transit or Return Status?]
The cargo in-transit status is either RETURN-STATUS or TRANSIT-STATUS → The manual release processing should be skipped and exit immediately
[Is Release Type Manual 'M'?]
The cargo release type != 'M' (Manual) → The manual release processing should be skipped and exit immediately
[Extract Cargo Control Number]
The system needs to identify the cargo for release tracking → The cargo control number is extracted from the cargo record and assigned to the message structure
[Use Last Modify Date/Time/User Info]
The system processes cargo activity information → The last modification date is assigned to message last activity date, modification time hours and minutes are extracted and assigned to message, modification terminal is assigned to message terminal, and modification user ID is assigned to message user field
[Use Creation Date/Time/User Info]
The system processes cargo activity information → The creation date is assigned to message last activity date, creation time hours and minutes are extracted and assigned to message, creation terminal is assigned to message terminal, and creation user ID is assigned to message user field
[Set Port from Manifest Code]
The system processes release information → The manifest destination transportation code is assigned to the message port field
[Calculate Cargo Age in Days]
The system calculates cargo age for release processing → The system calls time difference calculation using creation date/time and current date/time, and assigns the calculated day difference to the message age field
[Write Primary Release Record]
The system outputs release tracking information → A release record is written to the release file containing the message details
[Load Station Configuration Data]
The system processes the lookup result → The table segment data is moved to the MC segment structure for further processing
[Set Configuration to Default Values]
The system processes the failed lookup result → Spaces are moved to the MC segment structure to establish default configuration values
[Extract Merlin ID from Configuration]
The system processes communication routing requirements → The Merlin ID from the station configuration is extracted for use in message distribution
[Extract Alternative Merlin ID from Configuration]
The system processes communication requirements for the station → The alternative Merlin ID is extracted from configuration for potential secondary message routing
[Move Table Data to Segment]
The return flag indicates SUCCESSFUL lookup → The retrieved table segment data should be moved to the appropriate target segment structure
[Set Spaces to Segment]
The return flag does not indicate SUCCESSFUL lookup → The target segment should be set to spaces to indicate no valid data was retrieved
[Is Cargo In Transit or Return Status?]
The cargo in-transit status is either RETURN-STATUS or TRANSIT-STATUS → Manual release processing should be skipped and exit immediately
[Is Release Type Manual 'M'?]
The cargo release type != 'M' (Manual) → Manual release processing should be skipped and exit immediately
[Extract Merlin ID from Configuration]
The system processes the configuration data → The system should extract the Merlin ID, IM indicator, alternative Merlin ID, and station number from the configuration segment
[Use Default Configuration]
The system needs to proceed with cargo processing → The system should assign spaces (empty values) to the MC segment configuration to use default processing parameters
[Call GCCTBIO Table Access Function]
The system executes the table access operation → The GCCTBIO function should be called with communication area, PCB flag, SSA flag, function code, table literal, key values, data parameters, table segment, and return flag
[Move Table Segment to Working Storage]
The return flag indicates SUCCESSFUL completion → The retrieved table segment should be moved to the appropriate working storage structure
[Leave Table Segment as Spaces]
The return flag does not indicate SUCCESSFUL completion → The table segment should remain as spaces indicating no data was retrieved

Structural Validations

[Use Default Checkpoint Value 500]
The checkpoint file cannot be read (end of file condition):
the checkpoint value in the file is not numeric
→ The system sets checkpoint number to 500 and displays invalid checkpoint message
[Display Error - AD Table Not Found]
The administration table with ID 'AD' and sequence 'ADMINID' cannot be found or accessed → The system displays 'AD TABLE NOT FOUND' error message and calls error handling routine
[Validate FROM Merlin User ID]
The system attempts to validate the FROM Merlin user ID in the EMTZ segment → If the FROM Merlin ID is not found, display error message 'FROM MERLIN ID NOT FOUND' and call error handling routine
[Validate DC-P-MERLIN-1 ID]
The system validates the DC-P-MERLIN-1 ID in the EMTZ segment → If the Merlin ID 1 is not found, display error message 'MERLIN ID 1 NOT FOUND' and call error handling routine, otherwise set it as the DCP-MERLIN-ID
[Read Administration Table for Purge/Warning Days]
The administration table is not found or cannot be accessed → An error message 'AD TABLE NOT FOUND' is displayed and the error handling routine is called
[Set MC Segment to Spaces - No Record Found]
No matching MC table record is found for the specified station name → The MC segment structure is initialized to spaces to indicate no station configuration data is available
[Return Empty/Error Status]
The system processes the failed lookup result → The system maintains the unsuccessful return status and may initialize empty table segment data
[Set Default Empty Configuration]
The system handles the missing configuration → The MC segment is set to spaces to indicate no specific configuration exists
[Set Spaces to Segment]
The return flag indicates unsuccessful data retrieval or table not found → The target segment should be initialized with spaces to indicate no data found
[Is Release Date Within Valid Range?]
The release date is greater than the high test date:
less than the low test date
→ Manual release processing should be skipped and exit immediately

Module: GCX030A 1 Consolidated Epic Story

Epic: GCX030A Complete EDI Specification Extracted from Legacy

Contains 69 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX030A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The initialization process begins → The compilation date is displayed, previous MERLIN ID is cleared, input files are opened, message text is cleared, and MERLIN counter is set to 3
[11:Initialize Report Headers]
Message initialization is requested → Clear all message fields including usercode and text areas, set standard message libel as first line and separator as second line
[Initialize Message Text Area]
Message environment initialization occurs → EMI-TEXT message area is cleared to spaces AND MERLIN-CNT counter is set to 3 to establish the starting position for message line processing
[Initialize New Report]
The system initializes the report structure → Clear all message fields, set message line libel to position 1, set message line separator to position 2, set Merlin counter to 3, and set sequence number to 0
[Initialize New Report]
The system initializes a new report structure → The system clears all message fields, sets standard message headers with libel and separator lines, and resets the line counter to 3
[Initialize New Report Structure]
The system needs to prepare for a new user's report → The system clears all message fields and sets up standard message headers with libel and separator lines
[Initialize New Report Destination]
The system initializes the new report destination → The system clears all message fields and sets standard message headers including libel and separator lines
[Initialize Communication Interface]
The system is ready to send the message → Initialize the communication interface using CCISCOM
[Initialize Communication Interface]
The destination queue has been determined → The communication interface is initialized

Core Acceptance Criteria

[3:Get Purge Days Configuration]
The AD table is accessed with ADMINID key → If the table is found, extract warning days configuration, otherwise display error message and invoke error handler
[7:Generate Warning Report Content]
The record content is processed for report generation → If MERLIN ID changed from previous record, send existing message if present and initialize new message destination with current MERLIN ID, then add record line to message buffer and increment line counter
[8:Manage Report Pagination]
The message line counter exceeds 699 lines → Send the current message, reset line counter to 3, initialize new message destination, and set previous MERLIN ID as recipient
[9:Send Merlin Messages]
The message transmission process is initiated → If MERLIN ID is 'OM01247' route to 'UNREL' destination and clear copy usercode, otherwise route to 'IN' destination, then send message via EMCSEND and handle any transmission errors
[12:Handle Program Shutdown]
The shutdown processing is initiated → Display shutdown message, log error message, close all open files, and terminate the program
[Display 'Invalid Checkpoint - Default to 500']
The checkpoint value validation fails (not numeric) → Display message 'INVALID CHECKPOINT - DEFAULT TO 500' to the console
[Display Final Checkpoint Number]
Checkpoint processing is complete → Display message 'GCX030A CHECKPOINTING AT' followed by the checkpoint number to the console
[Extract AD table segment data]
Processing the retrieved table segment → The table segment data is moved to the administrative segment structure for further processing
[Generate Warning Report for Release Record]
The system processes the release record for warning notification → The system performs warning report generation including MERLIN ID validation and message formatting
[Send Current Report]
The system needs to add another line to the report → Send the current Merlin report to prevent exceeding capacity limits
[Send Current Report]
The system needs to process a new Merlin user or the report has reached capacity → The system sends the current report via the Merlin messaging system
[Add Release Record Line to Report]
The system adds the record to the report → The system moves the release line data to the message text lines at the current Merlin counter position
[Merlin ID Different from Previous?]
The system compares the current record's Merlin User ID with the previous Merlin User ID → If the Merlin User IDs are different, proceed with validation; if they are the same, continue with message processing using the existing validated ID
[Query System Database for Merlin User ID]
The system queries the EMTZ segment using the Merlin User ID as the search key → The system retrieves the user information if the ID exists or returns a not found status if the ID does not exist
[Use Validated Merlin User ID for Message Routing]
The validation is successful → The system uses the validated Merlin User ID for message routing and stores it as the current Merlin ID
[Display User ID Not Found Message]
The database query returns a not found status → The system displays a console message indicating the Merlin ID was not found along with the specific ID value
[Use Default User ID 'OM01247' for Message Routing]
The validation fails → The system assigns the default user ID 'OM01247' for message routing purposes
[Clear Status Code]
The system prepares to query the EMTZ segment → The system clears the status code to ensure clean query execution
[Set New User as Report Recipient]
The system needs to designate the recipient for the new report → The system assigns the previous user ID (either validated current user or default user) as the primary recipient in the message structure
[Reset Report Line Counter to 3]
The system needs to set the starting position for report content → The system sets the message line counter to 3 and resets the sequence number to 0
[Is User ID = Default User 'OM01247'?]
The recipient user code is 'OM01247' (default user) → Set the destination filename to 'UNREL' for unreleased reports
[Clear Copy User Code]
The destination is set to 'UNREL' → Clear the copy user code to prevent duplicate notifications
[Set Destination to 'IN']
The recipient user code is not 'OM01247' (specific user) → Set the destination filename to 'IN' for internal routing
[Increment Message Sequence Number]
A message is about to be sent → Increment the message sequence number by 1
[Send Message via EMCSEND]
The sequence number has been incremented → Send the message using EMCSEND with all message parameters
[Increment Checkpoint Counter]
All message processing is finished → Increment the checkpoint call counter by 1
[Set Destination to 'IN' for Specific User]
The Merlin user ID != 'OM01247' → The system sets the destination filename to 'IN'
[Send Message to Merlin System]
The message sending process is initiated → The system calls the EMCSEND service to deliver the message to the specified destination and recipient
[Increment Message Sequence Number]
The message routing process is executed → The system increments the EMI sequence number by 1 and increments the checkpoint call counter by 1
[Is Recipient Default User OM01247?]
The recipient user code is 'OM01247' → The message destination is set to 'UNREL' queue and copy user code is cleared
[Set Destination to IN Queue]
The recipient user code is not 'OM01247' → The message destination is set to 'IN' queue
[Increment Message Sequence Number]
A message is about to be sent → The message sequence number is incremented by 1
[Send Message via EMCSEND]
All message parameters are prepared → The message is sent via EMCSEND service with all required parameters
[Message Send Successful?]
The message send operation fails → The error status is logged and error handler is called
[Increment Checkpoint Counter]
The message processing is finished → The checkpoint call counter is incremented by 1
[Display Shutdown Message]
The shutdown condition is detected → Display message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX030A' to console
[Display Shutdown Message]
The system processes the shutdown request → The system displays shutdown message to console, logs error message, closes all files, and terminates the program
[Clear Message Fields]
The message initialization process is triggered → All message fields including destination, copy usercode, text content, and return status are cleared to spaces
[Clear User Codes]
User codes are being cleared → Both primary usercode and copy usercode fields are set to spaces
[Clear Text Areas]
Text areas are being cleared → All message text content is set to spaces
[Clear Status Flags]
Status flags are being cleared → Message return status flag is set to spaces
[Set Column Header Labels]
Message headers are being set → The first text line is populated with the standard message line label
[Set Column Separators]
Header separators are being added → The second text line is populated with the standard message separator
[Log Shutdown Message]
The system processes the shutdown condition → A shutdown message is displayed to console and logged as an error message

Structural Validations

[6:Validate Merlin User ID]
The MERLIN ID is different from the previous one processed → If the MERLIN ID is not found in EMTZ segment, assign default MERLIN ID 'OM01247' and display error message, otherwise use the validated MERLIN ID
[Display 'Invalid Checkpoint - Default to 500']
The invalid checkpoint flag is set to 'Y' due to file not found → Display message 'INVALID CHECKPOINT - DEFAULT TO 500' to the console
[Display error message: AD TABLE NOT FOUND]
Handling the table not found error → Display 'AD TABLE NOT FOUND' message to console and call error handler with appropriate error message
[Merlin User ID Valid?]
The system performs a lookup for the Merlin ID in the EMTZ segment → If the status code is not space (indicating user not found), the user ID is invalid, otherwise the user ID is valid
[Validate New Merlin User ID]
The system attempts to validate the new Merlin user ID by looking up the EMTZ segment → The system determines if the Merlin user ID is valid or invalid based on the lookup result
[Report Line Count > 699?]
The system checks the current line count before adding a new record → The system determines if the Merlin counter exceeds 699 lines indicating the report is at capacity
[Query EMTZ Segment in Database]
The system queries the EMTZ segment in the database using the Merlin User ID as search key → The system determines if the User ID exists based on the database response status
[Display User Not Found Message]
The system encounters an invalid User ID → The system displays 'FROM MERLIN ID NOT FOUND' message along with the invalid User ID
[Switch to New User Report]
The system attempts to validate the Merlin user ID against the EMTZ segment → If the user ID is not found, the system uses the default user ID 'OM01247' for unreleased cargo notifications, otherwise it uses the validated user ID for report routing
[User ID Found in System?]
The system performs a lookup in the EMTZ segment using the user ID as key → The system determines if the user ID is valid based on whether it exists in the database
[Message Send Successful?]
The message send operation fails (return status not successful) → Log the error status and invoke the error handler
[Log Error Message]
The failure is detected → Move the error status code to the error message field
[Call Error Handler]
Error logging is complete → Call the CERR error handler with the error details
[Set Destination to 'UNREL' for Default User]
The Merlin user ID equals 'OM01247' (default user for invalid IDs) → The system sets the destination filename to 'UNREL' and clears the copy user code
[Log Error Message]
The message send operation returns a status other than successful → The system moves the error status to the error message code, sets the error message, and calls the CERR error handling routine
[Log Error Message]
The system needs to log the shutdown event → Set error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX030A' and call error handler 'CERR'

Module: GCX030B 1 Consolidated Epic Story

Epic: GCX030B Complete EDI Specification Extracted from Legacy

Contains 68 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX030B EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The program begins initialization → The system displays the program name with compilation date on console, initializes previous user identifier to low values, clears message text areas, and sets message counter to 3
[3:Initialize Message Structure]
The system initializes message structure → The system clears all user codes and message text, sets standard message label as first line, and sets message separator as second line
[Initialize Previous Merlin User ID]
User tracking variables need to be initialized → The previous Merlin user ID is set to low-values to ensure proper user change detection
[Initialize New Message Structure]
New message initialization is required → The system clears message fields and sets standard header lines
[Initialize New Message Structure]
The system initializes the message structure → The message fields are cleared and standard headers (MSG-LINE-LIBEL, MSG-LINE-SEP) are set in positions 1 and 2
[Initialize Communication Interface]
The communication interface needs to be initialized → The system calls CCISCOM using CCCOM and ISCOM parameters

Core Acceptance Criteria

[4:Read Manual Release Records]
The system reads release records sequentially → The system processes each record for checkpoint validation, user validation, and message generation until end of file is reached
[6:Handle User ID Changes]
The system cannot find the user identifier in the database → The system assigns default user identifier 'OM01247', displays user not found message on console, sends any existing message batch, and initializes new message destination with default user
[6:Handle User ID Changes]
The system finds a valid new user identifier → The system updates previous user identifier to current user, sends any existing message batch, and initializes new message destination with the valid user identifier
[7:Check Message Capacity]
The message line counter exceeds 699 lines → The system sends the current message batch, resets message counter to 3, initializes new message destination, and continues with the same user identifier
[8:Add Release Record to Message]
The system adds the record to the message batch → The system copies the manual release record to the current message line position and increments the message line counter by 1
[9:Send Merlin Message]
The recipient user identifier is 'OM01247' → The system routes message to 'MANREL' destination with no copy user code
[9:Send Merlin Message]
The recipient user identifier is not 'OM01247' → The system routes message to 'IN' destination
[9:Send Merlin Message]
The system calls external messaging service EMCSEND → The system sends the message and logs any delivery failures as error messages, then increments checkpoint call counter
[11:Handle Shutdown Requests]
The checkpoint service returns shutdown status code 'XD' → The system displays shutdown message on console, logs shutdown error message, closes all files, and terminates program execution
[12:Send Final Message]
The third message line contains content → The system sends the final message batch through the messaging system
[Clear Email Message Text Area]
Message storage areas need to be initialized → The email message text area is cleared to spaces
[Set Initial Message Line Counter to 3]
Message line counting needs to be initialized → The Merlin message line counter is set to 3 to account for header and separator lines
[Clear Email Header Fields]
The message structure initialization process begins → The email recipient usercode field, copy usercode field, message text area, and return status flag are all cleared to spaces
[Set Message Title Line]
The message content area is being prepared → The first line of the message text is set to the standard message title from MSG-LINE-LIBEL
[Set Message Separator Line]
The message formatting is being completed → The second line of the message text is set to the standard separator line from MSG-LINE-SEP
[Is User ID Different from Previous?]
The system compares the current notification user ID against the previous user ID → The system identifies whether the user ID has changed and triggers appropriate message batching logic
[Query Merlin Database for User ID]
The system sets the user ID as search key and queries the EMTZ segment in the Merlin database → The system performs a database lookup to verify if the user ID exists in the system
[Use Valid User ID for Message Destination]
The database query returns a successful status indicating the user ID exists → The system accepts the notification user ID as valid and uses it as the previous user ID for subsequent message processing
[Set Default User ID to OM01247]
The user ID is not found in the EMTZ segment → The system sets the previous user ID to OM01247 as default
[Set User ID to Current Notification User]
The user ID is found in the EMTZ segment → The system sets the previous user ID to the current notification user
[Existing Message Has Content?]
The system checks if message text line 3 contains data → The system determines whether existing messages need to be sent first
[Send Existing Message]
Message text line 3 is not empty → The system sends the existing message via MERLIN before proceeding
[Set New User as Message Recipient]
Setting up message routing information → The system assigns the previous user ID to the first message recipient field
[Reset Message Counter and Sequence]
Setting up message tracking counters → The system sets message counter to 3 and sequence number to 0
[Query Merlin Database for User ID]
The system queries the Merlin database using the user ID as the search key → The system retrieves the user record from the EMTZ segment to verify user existence
[Line Count > 699?]
The message line counter (MERLIN-CNT) exceeds 699 lines → The system triggers message sending and batch reset process
[Send Current Message via Email System]
The system needs to send the current message → The message is transmitted via the MERLIN email system (X200-SEND-MERLIN)
[Reset Line Counter to 3]
The system prepares for a new message batch → The message line counter (MERLIN-CNT) is reset to 3
[Set Recipient to Previous Merlin User]
The system sets the recipient for the new batch → The previous MERLIN user (PREV-MERLIN) is assigned as the recipient (EMI-TO-USERCODES)
[Add Record to Message Text Lines]
The system needs to add the release record to the message content → The complete manual release record is added to the message text at the current line position
[Increment Message Line Counter]
The record addition is complete → The message line counter is incremented by 1 to reflect the new record count
[Set Destination to MANREL for Default User]
The recipient user ID is OM01247 (default user) → The message destination is set to MANREL and copy recipient is cleared
[Set Destination to IN for Valid User]
The recipient user ID is not OM01247 (valid user) → The message destination is set to IN
[Set Message Date Range]
Setting up message parameters → The message TO date is set to manual release high date and FROM date is set to manual release low date
[Call Email Communication Service]
Preparing to send email message → The communication service interface is initialized with system communication parameters
[Increment Message Sequence Number]
Preparing to send a message → The message sequence number is incremented by 1
[Send Email Message]
Executing message transmission → The email service is called with sender, destination, recipient, copy recipient, subject, keywords, content, and status parameters
[Update Checkpoint Counter]
Completing message transmission processing → The checkpoint call counter is incremented by 1
[Set Destination to MANREL File]
The recipient user code is OM01247 → The system sets the destination filename to MANREL and clears any copy user code
[Set Destination to IN File]
The recipient user code is not OM01247 → The system sets the destination filename to IN
[Set Message Date Range]
The message date range needs to be established → The system sets the TO date from manual release high date and FROM date from manual release low date
[Call EMCSEND Email Service]
The email needs to be transmitted → The system calls EMCSEND with sender code, destination filename, recipient code, copy code, subject, keywords, message text, and return status parameters
[Increment Sequence Counter]
The email processing is complete → The system increments the EMI sequence counter by 1 and increments the checkpoint call counter by 1
[Display Shutdown Message]
The system processes the shutdown request → The system displays 'IMS SHUTDOWN REQUEST RECEIVED BY GCX030B' message
[Log Shutdown Request]
The system processes the shutdown logging → The system moves shutdown message to error message field and calls 'CERR' program for logging
[Display Shutdown Message]
The system processes the shutdown request → A shutdown notification message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX030B' is displayed to the console
[Log Shutdown Request]
The system processes the shutdown notification → The shutdown message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX030B' is logged as an error message through the error handling system
[Log Shutdown Message]
The system processes the shutdown request → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX030B' is displayed on the console
[Close Checkpoint File]
The system prepares for shutdown → The checkpoint file is closed
[Send Final Message via Email System]
There is remaining message content in the third message line that has not been sent → The system sends the final message via the email system before program termination

Structural Validations

[2:Process Checkpoint File]
The system reads the checkpoint file and the file is empty or the checkpoint value is not numeric → The system sets checkpoint number to default value 500 and displays invalid checkpoint message on console
[5:Validate Merlin User ID]
The user identifier differs from the previous user identifier → The system looks up the user identifier in EMTEXT segment and determines if the user is valid or invalid
[File Empty?]
The checkpoint file is empty or cannot be read → The checkpoint number is set to 500 and an invalid checkpoint message is displayed
[Checkpoint Value Numeric?]
The checkpoint value is evaluated for numeric content → If the value is numeric, it is used as the checkpoint number; if not numeric, the checkpoint number defaults to 500 with an invalid checkpoint message displayed
[User ID Found in Database?]
The database query returns a status indicating the user ID was not found → The system displays 'FROM MERLIN ID NOT FOUND' message with the invalid user ID and sets the default system user ID 'OM01247' as the message recipient
[Validate New User ID in Merlin Database]
The system looks up the user ID in the EMTZ segment → The system determines if the user ID is valid based on database lookup results
[Set Default User ID 'OM01247']
The user ID is not found in the database (status code is not space) → The system assigns 'OM01247' as the default user ID and displays a user not found message
[Accept Valid User ID]
The user ID is found in the database (status code is space) → The system accepts the user ID as valid and uses it for message routing
[Check Current Message Line Count]
The system checks the current message line counter (MERLIN-CNT) → The line count value is evaluated against the maximum threshold
[Log Error Message]
The email transmission status indicates failure → The error status is logged as an error message in the system
[Log Error Message]
The email return status flag indicates failure (not SUCCESSFUL) → The system moves the return status to error message code, sets the error message, and calls CERR error handling service
[Record Error Message]
The system records the shutdown event → The shutdown message is stored in the error message field and the error handling program is called

Module: GCX031 1 Consolidated Epic Story

Epic: GCX031 Complete EDI Specification Extracted from Legacy

Contains 24 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX031 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Retrieve Purge Criteria]
Administrative table lookup is performed with table ID 'AD' and sequence ID 'ADMINID' → The system retrieves purge days value from the administrative segment
[4:Process Train Records]
Processing train records with accept status 'GEGB' → The system retrieves train segments matching the specified status criteria
[7:Archive Train Record]
Creating historical train record → The system uses last modification date if available, otherwise uses creation date, sets record type as 'R' for root, and writes train segment to history file
[8:Archive Equipment Records]
Processing equipment segments with accept status 'GEGBGAGK' → The system sets record type as 'E' for equipment, copies equipment segment information, and writes each equipment record to history file
[11:Handle System Shutdown]
IMS shutdown request with status code 'XD' is received → The system displays shutdown message, closes all files, and terminates processing gracefully
[Load Purge Days Configuration]
The table data retrieval is successful → The system loads the administration segment containing purge days configuration
[Call Table Access Routine]
Executing table access routine → System calls GCCTBIO routine with all required parameters to retrieve the administration table segment
[Store Purge Days Configuration]
Processing the retrieved table segment → System moves the table segment data to the administration segment structure for purge days configuration
[Get Next Train Record from Database]
The system attempts to retrieve the next train record with status 'GEGB' → The system should call the database interface to get the next train segment
[IMS Shutdown Request Received?]
IMS returns status code 'XD' indicating a shutdown request → The system displays shutdown message, closes all files (CHKP-FILE and TRAIN-HIST-FILE), and terminates the program
[Calculate Date Difference Between Current Date and Creation Date]
The system needs to determine the age of the train record in days → The TIMEDIFF program is called with current date (WS-DATE-2) and creation date (WS-DATE-1) to calculate the difference
[Store Age Calculation Result]
The TIMEDIFF program returns the age calculation result → The age difference result is stored in WS-RESULT-DIFF variable for further processing
[Copy Train Segment Data to History Record]
The system copies train data to history format → Move the entire train segment data to the history root section of the history record
[Copy Train ID to History Record]
The system prepares the equipment history record → The train ID from the current train segment should be copied to the history record to maintain the train-equipment relationship
[Copy Equipment Information to History]
The system prepares the complete history record → All equipment segment information should be copied to the history equipment information area and equipment area should be initialized to spaces
[Display Shutdown Message]
The system needs to notify operations of the shutdown condition → The system should display 'IMS SHUTDOWN REQUEST RECIEVED BY GCX031' message to console and error handling
[Close All Files]
The system needs to prepare for graceful termination → The system should close checkpoint file and train history file to ensure data integrity
[Display Shutdown Message to Console]
The shutdown processing begins → Display 'IMS SHUTDOWN REQUEST RECIEVED BY GCX031' message to the console

Structural Validations

[2:Read Checkpoint Configuration]
The checkpoint file is empty or cannot be read → The system sets checkpoint number to default value of 500 and displays invalid checkpoint message
[2:Read Checkpoint Configuration]
The checkpoint value is not numeric → The system sets checkpoint number to default value of 500 and displays invalid checkpoint message
[Set Default Interval to 500]
The checkpoint file cannot be read successfully or contains no data → The system sets the checkpoint processing interval to 500 and displays an invalid checkpoint message
[Use Checkpoint Number from File]
The system validates the checkpoint number format → If the checkpoint number is numeric, it is accepted as the processing interval, otherwise the system defaults to 500 and displays an invalid checkpoint message
[Call Error Processing]
Processing the failed table access → System sets error message to CERR-MSG1 and calls CERR error processing routine
[Log Shutdown Request to Error Handler]
Error logging is initiated → Call error handler with shutdown request message

Module: GCX031A 1 Consolidated Epic Story

Epic: GCX031A Complete EDI Specification Extracted from Legacy

Contains 20 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX031A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[5:Train Record Retrieval]
Train root segment retrieval is performed → Use the keys root to retrieve the corresponding train root segment from GCSB4RT and set root found indicator based on retrieval status
[Train Record Found?]
The retrieval result is evaluated → If root found indicator shows success, proceed with deletion, otherwise skip deletion and continue to checkpoint check
[6:Train Record Deletion]
Deletion is performed → The train root segment is deleted from GCSB4RT database
[7:Deletion Counter Update]
The deletion is completed → Increment the deletion counter by 1
[9:Shutdown Detection]
Shutdown handling is initiated → Display shutdown message to console, set error message, and Execute abnormal termination
[Call Database to Retrieve CDN Train Record]
The system executes the database retrieval operation → The CIMS database system is called with GHU operation to retrieve the train root segment
[Execute Delete Command for Train Record]
The delete command is executed using the train root segment → The system calls the database interface to delete the train record and all its dependent records
[IMS Shutdown Detected]
The system detects IMS shutdown request → The system should display shutdown message, set error message, close files, and call error handling routine to terminate the program
[Handle Checkpoint Failure]
The status indicates an IMS shutdown request has been received → Display shutdown message, set error message, and initiate abnormal program termination
[IMS Shutdown Request Detected?]
The system detects an IMS shutdown request indicated by the shutdown status → The system should identify this as a shutdown condition requiring immediate attention
[Display Shutdown Message]
The system needs to communicate the shutdown event → The system should display a shutdown notification message on the console and set an appropriate error message for logging
[Initiate Program Termination]
The system needs to terminate the program due to the shutdown request → The system should Execute abnormal termination procedures to ensure proper cleanup
[Display Total Count of Deleted CDN Train Records]
The system reaches the end of processing all train deletion operations → The system displays a formatted message 'NUMBER OF CA TRAINS DELETED : ' followed by the deletion count on the console
[Display Shutdown Message to Console]
The system processes the shutdown condition → A shutdown notification message is displayed to the console
[Close CHKP-FILE]
The system initiates cleanup procedures → The checkpoint file is closed

Structural Validations

[3:Checkpoint Configuration]
The checkpoint file is read → If file is empty, use default checkpoint value and display invalid checkpoint message, otherwise if checkpoint number is not numeric or less than 1, use default checkpoint value and display invalid checkpoint message, otherwise use the checkpoint number from file and display checkpoint information
[Display Invalid Checkpoint Message]
The system determines the checkpoint is invalid → The system displays a message indicating invalid checkpoint and shows the default value being used
[File Has Data?]
The checkpoint file contains no data (AT END condition) → The system sets the checkpoint frequency to the default value and displays a message indicating the use of default checkpoint
[Checkpoint Value Valid?]
The checkpoint frequency value is not numeric:
the checkpoint frequency value is less than 1
→ The system sets the checkpoint frequency to the default value and displays a message indicating the use of default checkpoint due to invalid value
[Set Error Message in Common Area]
The system prepares for error handling → The shutdown message is stored in the common error message field

Module: GCX031Z 1 Consolidated Epic Story

Epic: GCX031Z Complete EDI Specification Extracted from Legacy

Contains 27 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX031Z EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[12:Handle System Shutdown]
System shutdown request is received → Display shutdown message, set error message, and terminate processing
[Clear Train Report Segment Buffer]
The system prepares to retrieve the next train record → The train root segment buffer is cleared to ensure no residual data from previous operations
[Execute IMS Database Call]
The system needs to retrieve the next Canadian train report record → The system executes a Get Hold Next database call using the Canadian train report segment and qualified selection criteria
[Copy Train Report Root Segment to History Data]
The system creates a history record for the train report → The complete train report root segment is copied to the history record data area
[Set Read Flag to TRUE on Train Report Root Segment]
The system processes the record for deletion → The read flag is set to TRUE on the train report root segment
[Update Train Report Root Segment in Database]
The system needs to persist the deletion marker → The train report root segment is updated in the database with the new flag status
[Start Processing Dependent Records]
The system begins dependent records processing → The system should initiate the dependent segment reading process
[Read First Dependent Segment]
The system needs to read the first dependent equipment segment → The system should retrieve the first dependent segment from the train equipment dependency database
[More Dependent Segments?]
A dependent segment read operation is completed → The system should check the database status to determine if more dependent segments exist for processing
[Copy Dependent Segment Data to History Record]
The segment data needs to be prepared for archival → The system should copy the dependent segment data to the history record data area
[Write Dependent Segment to History File]
The data is ready for archival → The system should write the history record containing the dependent segment data to the history file
[Read Next Dependent Segment]
The system needs to continue processing dependent segments → The system should read the next dependent equipment segment from the database
[Complete Dependent Records Processing]
No more dependent segments exist for the current train → The system should complete the dependent records processing and return control to the main processing flow
[Display Shutdown Message]
The shutdown condition is identified → The system displays a shutdown notification message to the console and sets error message for proper termination handling
[Terminate Processing]
The shutdown message has been displayed → The system invokes the abnormal termination procedure to stop all processing
[Display Shutdown Message]
The system processes the shutdown condition → A shutdown message is displayed to the console indicating that GCX031Z received the shutdown request
[Terminate Program Gracefully]
The system initiates graceful termination → The abnormal termination procedure is executed to safely end the program
[Display Count of Train Reports Marked for Deletion]
The system reaches the ending phase of processing → The system displays a message showing the number of CDN train records to delete along with the actual count to the console

Structural Validations

[2:Read Checkpoint Configuration]
The checkpoint file cannot be read:
the checkpoint number is not numeric
the checkpoint number is less than 1
→ Use the default checkpoint value and display invalid checkpoint message
[2:Read Checkpoint Configuration]
The checkpoint number is numeric AND the checkpoint number is greater than or equal to 1 → Use the checkpoint number from file and display checkpoint confirmation message
[Checkpoint File Valid?]
The file cannot be read:
the checkpoint number is not numeric
the checkpoint number is less than 1
→ The system uses the default checkpoint value and displays an invalid checkpoint message on the console
[Use File Checkpoint Value]
The checkpoint validation is performed → The system uses the checkpoint number from the file and displays the checkpoint setting message on the console
[File Found?]
The checkpoint file cannot be read or is empty (AT END condition) → The system sets the checkpoint interval to the default value and displays a message indicating the use of default checkpoint
[Checkpoint Value Valid?]
The checkpoint interval value is either not numeric:
is less than 1
→ The system sets the checkpoint interval to the default value and displays a message indicating the use of default checkpoint due to invalid value
[Display Error: Configuration Table Not Found]
The GCCTBIO operation was not successful → An error message should be constructed indicating that the CCN sequence number table CW was not found along with the return code
[Terminate Program with Error]
The configuration table access has failed → The program should be terminated with an error condition
[Set Error Message]
The system prepares for graceful termination → The shutdown message is assigned to the error message field in the communication area

Module: GCX032 1 Consolidated Epic Story

Epic: GCX032 Complete EDI Specification Extracted from Legacy

Contains 27 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX032 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[18:Perform Checkpoint]
The checkpoint operation is performed → If an IMS shutdown request is received, the program terminates with message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX032', otherwise checkpoint processing completes normally
[Set Record Type to '03']
Shipper information needs to be retrieved → The record type is set to '03' to identify shipper data segments
[Access Additional Record Segment]
The system attempts to access the shipper additional record segment → A database call is made to retrieve the shipper record segment
[Set Database Access Parameters]
The system prepares to access the database → The accept status must be set to 'GE' to indicate the type of database operation
[Call Database Access Function]
The system needs to retrieve an additional record segment → A database call must be executed using GU command with GCSA2RT additional record segment and A2RT-SSAQ search key
[Set Consignee Sequence Number to 0002]
The system prepares to access consignee data from additional segments → The sequence number is set to 0002 to identify the consignee record
[Access Additional Record Segment for Consignee]
The system accesses the additional record segment for consignee data → The system attempts to retrieve the consignee record from the additional segments
[Consignee Record Found?]
The system checks the retrieval status → If the status code is spaces, consignee record is found and processing continues, otherwise consignee information is skipped
[Extract Consignee Name]
The system processes the consignee information → The consignee name is extracted from field N102-NAME and stored in the report work record
[Extract Address Line 1]
The system processes the consignee address information → The first address line is extracted from field N301-ADDRESS-INFO-1 and stored in the report work record
[Extract Address Line 2]
The system processes the consignee address information → The second address line is extracted from field N302-ADDRESS-INFO-2 and stored in the report work record
[Extract City Name]
The system processes the consignee location information → The city name is extracted from field N401-CITY-NAME and stored in the report work record
[Extract State/Province Code]
The system processes the consignee location information → The state or province code is extracted from field N402-STATE-PROV-CDE and stored in the report work record
[Extract Postal Code]
The system processes the consignee location information → The postal code is extracted from field N403-POSTAL-CDE and stored in the report work record
[Extract Country Code]
The system processes the consignee location information → The country code is extracted from field N404-COUNTRY-CDE and stored in the report work record
[Set Up Consignee Record Access]
The system prepares to access consignee data from additional record segments → The record type is set to '03' and sequence number is set to '0002' to identify the consignee record
[Access Additional Record Segment]
The system attempts to access the additional record segment → A database call is made to retrieve the consignee record from GCSA2RT using the specified parameters
[Extract Consignee Name, Extract Address Line 1, Extract Address Line 2, Extract City Name, Extract State/Province Code, Extract Postal Code, Extract Country Code]
The system processes the consignee information → The consignee name, address line 1, address line 2, city name, state/province code, postal code, and country code are extracted and moved to the output record
[Set Consignee Sequence Number to 0002]
The system needs to retrieve consignee details from additional segments → The sequence number must be set to 0002 to identify the consignee record
[Retrieve Consignee Record from Additional Segments]
The system executes the database retrieval operation → The consignee record should be fetched from the additional segments database

Structural Validations

[5:Read BOL Type Selection Criteria]
The BOL type file is read → If the file is empty or at end, the program terminates with error message 'NO MANIFEST TYPE (BOL TYPE) SPECIFIED'
[Any Brokers Found?]
The broker index is checked → If the broker index equals 1 (no brokers added), the program terminates with error message 'NO BROKER SPECIFIED'
[7:Create Broker Header Records]
The current broker index is checked against the maximum limit → If the broker index exceeds the maximum broker entries limit, the program terminates with error message 'BROKER TABLE LIMIT EXCEEDED'
[BOL Type Found?]
The file reaches end of file condition → The system sets error message 'NO MANIFEST TYPE (BOL TYPE) SPECIFIED' and terminates processing
[Broker Table Full?]
The broker index exceeds the maximum allowed broker entries limit → The system generates an error message 'BROKER TABLE LIMIT EXCEEDED' and terminates processing
[Set Shutdown Error Message]
The system needs to communicate the shutdown condition → The error message is set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX032'
[Terminate Program with Error]
The system needs to handle the shutdown condition → The program termination procedure is executed

Module: GCX032A 1 Consolidated Epic Story

Epic: GCX032A Complete EDI Specification Extracted from Legacy

Contains 7 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX032A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Handle Empty Extract File]
The first read operation indicates the file is empty → Clear broker and BOL type fields, set report date to current system date, generate report headers, and write empty extract report message
[10:Handle No Data Condition]
End of file is reached:
next record is a header type (indicating no data records)
→ Write blank lines and no data to report message
[Clear Broker Information]
The system detects end of file condition immediately after opening → The broker field and BOL type field are cleared to spaces
[Write Blank Lines for Formatting]
The system writes the empty extract report → Two blank lines are written after the headers to provide proper spacing before the error message
[Write 'No Data to Report' Message]
The extract file reaches end of file:
the next record is a header record type
→ Write two blank lines followed by a 'no data to report' message
[Process Detail Records]
The extract file has not reached end of file AND the next record is not a header record type → Continue processing the detail records without writing any no-data message

Structural Validations

[Write Empty Extract Error Message]
The system completes the empty extract report generation → An empty extract report message is written to inform users that no data was available for processing

Module: GCX033 1 Consolidated Epic Story

Epic: GCX033 Complete EDI Specification Extracted from Legacy

Contains 14 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX033 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[11:IMS Shutdown Handling]
The system receives an IMS shutdown status code 'XD' → The system displays shutdown message, logs error, closes files, and terminates the program
[Display Invalid Message]
The default checkpoint number of 500 is assigned → A message 'INVALID CHECKPOINT - DEFAULT TO 500' is displayed to the console
[Display Final Checkpoint Number]
The validation process ends → A message showing 'GCX033 CHECKPOINTING AT' followed by the checkpoint number is displayed to the console
[Display Shutdown Message]
The system needs to inform operators of the shutdown → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX033' should be displayed on the console
[Display Shutdown Message]
The system processes the shutdown request → The system must display the message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX033' to the console
[Display Shutdown Message to Console]
The system processes the shutdown request → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX033' is displayed to the console
[Terminate Program Gracefully]
The system has closed necessary files and logged messages → The program terminates gracefully using GOBACK
[Terminate Program Immediately]
Emergency shutdown sequence is complete → The program should terminate immediately and return control to the calling system

Structural Validations

[3:Checkpoint Number Validation]
The system attempts to read the checkpoint number → The system assigns default checkpoint number 500 and displays invalid checkpoint message
[Process Checkpoint File]
The system attempts to read the checkpoint file → If the file is empty or at end, set checkpoint number to 500 and mark as invalid, display 'INVALID CHECKPOINT - DEFAULT TO 500'. If file contains data and the checkpoint value is numeric, use that value as checkpoint number. If file contains data but checkpoint value is not numeric, set checkpoint number to 500 and display 'INVALID CHECKPOINT - DEFAULT TO 500'. Display the final checkpoint number with message 'GCX033 CHECKPOINTING AT [number]'
[Set Checkpoint Number to 500]
The checkpoint validation process determines the data is invalid → The checkpoint number is set to 500 and an invalid checkpoint message is displayed
[Log Error Message]
The system needs to log the shutdown event → The shutdown message should be moved to the error message area and logged via CERR service
[Log Error Message]
The system continues shutdown processing → The system must move the shutdown message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX033' to the error message field and call the error logging service 'CERR'
[Log Error Message to System]
The system processes the shutdown notification → The shutdown message is logged to the error handling system via CERR program

Module: GCX034 1 Consolidated Epic Story

Epic: GCX034 Complete EDI Specification Extracted from Legacy

Contains 12 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX034 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Read First US Route Record]
First record retrieval is requested → First USRT record is read using GU operation with SSAU-USRT segment
[Execute Database Query for First US Route Record]
The system executes a Get Unique (GU) database call with SSAU-USRT segment search argument → The database query is executed to retrieve the first US route record into GCSUSRT data structure
[Execute IMS Database Call with GU Command]
The system executes a database call using GU command with GCUS-PCB, GCSUSRT segment, and SSAU-USRT search criteria → The database call should be executed to retrieve US Route record data
[Trigger System Abend Process]
The system determines that the database failure is critical and cannot be recovered → The system abend process should be triggered to handle the failure condition
[Call Database to Get Next A2 Record]
The database call is executed to get the next A2 record → The CIMS interface is called with GN operation to retrieve the next A2 record into GCSUSS00 structure using SSAU-A2RT segment
[Close Output File]
The system initiates error handling procedures → The system should close the USCARGO output file to ensure proper resource cleanup

Structural Validations

[15:Handle Database Errors]
Database access error occurs during first US Route record read → Error message is set and abend processing is performed
[Set Error Message for Database Access Failure]
The system detects a database access error → The system sets the error message to 'ERROR EXECUTING GU SSAU ON GCSUSRT' to indicate the specific database operation failure
[Trigger Error Handling Process]
The system needs to handle the database failure → The system performs the Z9999-ABEND procedure to handle the error condition
[Set Error Message for Database Query Failure]
The system detects the database query failure → An error message 'ERROR EXECUTING GU SSAU ON GCSUSRT' should be set to indicate the specific database operation failure
[Database Error Detected?]
The database operation returns a non-space status code indicating an error condition → The system should set an appropriate error message and initiate error handling procedures
[Set Error Message]
The system needs to document the error condition → The system should set the error message to 'ERROR EXECUTING GU SSAU ON GCSUSRT' to identify the failed operation

Module: GCX035 1 Consolidated Epic Story

Epic: GCX035 Complete EDI Specification Extracted from Legacy

Contains 78 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX035 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[7:Equipment Information Retrieval]
Equipment information is retrieved using equipment car ID → Call FWUTC210 to convert old car ID to new car ID, then call GEQUIP to get equipment information, and set car ID in message
[12:Suspect Report Generation]
Suspect report is generated → Set message fields with cargo key, from/to transaction codes, new indicator if not previously suspected, current status, and if status is 'RELEASE' and released by 'S.A.R.' set status to 'S.A.R.' else if released by 'EXPORT' set status to 'EXPORT'
[15:Checkpoint Management]
Checkpoint counter exceeds checkpoint number → Save current cargo key, Execute system checkpoint, if shutdown request received display message and terminate program, else reset checkpoint counter and reposition to saved cargo key
[Setup Merlin System Configuration]
Administrative table lookup is performed with table ID 'AD' and sequence ID 'ADMINID' → If the table is found successfully, load the administrative segment data, otherwise display error message and terminate processing
[Get Merlin ID from Admin Table]
The system attempts to retrieve the administrative table with table ID 'AD' and sequence ID 'ADMINID' → The administrative table segment is retrieved and made available for Merlin ID extraction
[Merlin ID exists in system?]
The system performs authorization validation for the Merlin ID → If the status code is not spaces (indicating error), an error message 'MERLIN ID 1 NOT FOUND' is displayed and error handler is called, otherwise the ID is assigned to DCP-MERLIN-ID
[Merlin ID exists in system?]
The system performs authorization validation for the secondary Merlin ID → If the status code is not spaces (indicating error), an error message 'MERLIN ID 2 NOT FOUND' is displayed and error handler is called, otherwise the ID is assigned to IFS-MERLIN-ID
[Merlin ID exists in system?]
The system performs authorization validation for the third Merlin ID → If the status code is not spaces (indicating error), an error message 'MERLIN ID 3 NOT FOUND' is displayed and error handler is called, otherwise the ID is assigned to HHS-MERLIN-ID
[Merlin ID exists in system?]
The system performs authorization validation for the fourth Merlin ID → If the status code is not spaces (indicating error), an error message 'MERLIN ID 4 NOT FOUND' is displayed and error handler is called, otherwise the ID is assigned to IM-MERLIN-ID
[Merlin ID exists in system?]
The system performs authorization validation for the fifth Merlin ID → If the status code is not spaces (indicating error), an error message 'MERLIN ID 5 NOT FOUND' is displayed and error handler is called, otherwise the ID is assigned to COPY-MERLIN-ID
[Read Administration Table with ID 'ADMINID']
The system attempts to read the administration table with table ID 'AD' and sequence ID 'ADMINID' → The administration table segment is retrieved for Merlin ID extraction
[Extract DC&P Merlin ID 1]
The system processes the table data → The first DC&P Merlin ID is extracted from the administration table segment
[Get DC&P Merlin ID 1 from Admin Table]
The system accesses the administrative table with table ID 'AD' and sequence ID 'ADMINID' → The system retrieves the administrative segment containing DC&P Merlin ID configurations
[Calculate Date Difference Between Original Sent Date and Current Date]
The system needs to determine cargo age → The system calls TIMEDIFF program using the original sent date/time and current machine date/time to calculate the difference in days
[Clear Message Details]
Message preparation begins → The system clears the message line details to spaces and sets message location to zeros
[Equipment Type: Container or Car?]
If the conveying car initial field → If conveying car initial is spaces, process as car equipment; otherwise process as container equipment
[Calculate Time Difference Between Dates]
The system needs to determine the age of the cargo record → The time difference should be calculated using the TIMEDIFF program to determine the number of days
[Extract Event Code from Equipment]
Event code is needed to determine processing logic → Event code is extracted from equipment record and stored in message report field
[Build Warning Message]
The system builds a warning message → The message contains the cargo control number, manifest origin station code, and manifest destination station code
[Mark as New with '>']
The cargo suspected in Canada field is blank → Mark the message with '>' indicator to show it is newly suspected
[Mark as Existing]
The cargo suspected in Canada field is not blank → Mark the message with blank indicator to show it was previously suspected
[Retrieve Station Configuration]
The system retrieves station configuration for the manifest origin station → The station's Merlin ID configuration is loaded or set to blank if not found
[Set Cargo Control Number in Message]
The warning message is being constructed → The cargo control number from the cargo record is copied to the message CCN field
[Set Origin Station Code]
Building the suspect cargo warning message → The manifest origin transaction code is copied to the message FROM field
[Mark as New Suspect with '>']
Building the warning message for this cargo → The message new indicator field is set to '>' to mark it as newly identified suspect cargo
[Mark as Previously Suspected]
Building the warning message for this cargo → The message new indicator field is set to blank space to indicate it was previously identified
[Set Destination Station Code]
Building the suspect cargo warning message → The manifest destination transaction code is copied to the message TO field
[Set Current Cargo Status]
Building the suspect cargo warning message → The current status is copied to the message status field
[Set Status to 'S.A.R.']
Building the suspect cargo warning message → The message status field is set to 'S.A.R.' instead of 'RELEASE'
[Set Status to 'EXPORT']
Building the suspect cargo warning message → The message status field is set to 'EXPORT' instead of 'RELEASE'
[Lookup Station Configuration]
Building warning message routing information → The system looks up the MC table using the origin station name to retrieve station-specific Merlin configuration
[Load Station Merlin Configuration]
Processing station Merlin routing information → The retrieved table segment is loaded into the station MC segment structure
[Clear Station Configuration]
Processing station Merlin routing information → The station MC segment structure is cleared to spaces
[Write Report to Primary Merlin]
Routing suspect cargo warning messages → A warning record is written with the primary Merlin ID as the destination and release Merlin field cleared
[Write Report to Alternate Merlin]
Routing suspect cargo warning messages → A warning record is written with the alternate Merlin ID as the destination and release Merlin field cleared
[Route to HHS Merlin System]
Determining regional Merlin system routing → The HHS Merlin ID is used as the destination for the warning message
[Route to IFS Merlin System]
Determining regional Merlin system routing → The IFS Merlin ID is used as the destination for the warning message
[Write Report to Regional System]
Writing warning messages to regional systems → A warning record is written with the regional Merlin ID as destination and release Merlin field cleared
[Write Report to Copy System]
Routing suspect cargo warning messages → A warning record is written with the copy Merlin ID as the destination and release Merlin field cleared
[Write Report to OM01247 System]
Completing warning message routing → A warning record is written with 'OM01247' as the destination Merlin ID and release Merlin field cleared
[Get Current Cargo Status]
If the cargo status for classification → The cargo current status is moved to the message status field for further processing
[Classify as S.A.R. Release]
The release authority equals 'S.A.R. ' (with trailing space) → The message status is set to 'S.A.R.' for S.A.R. release classification
[Classify as Export Release]
The release authority equals 'EXPORT ' (with trailing space) → The message status is set to 'EXPORT' for export release classification
[Keep Original Release Status]
The release authority is neither 'S.A.R. ' nor 'EXPORT ' → The message status retains the original current status value without modification
[Use Current Status as Classification]
The current status != 'RELEASE' → The message status is set to the current status value without further release authority evaluation
[Released by 'S.A.R.'?]
The system determines the final status for reporting → The system should set the message status to 'S.A.R.'
[Released by 'EXPORT'?]
The system determines the final status for reporting → The system should set the message status to 'EXPORT'
[Get Station Configuration from MC Table]
The system needs to determine report distribution for suspect cargo → The system retrieves the MC table segment using the manifest from station name as the port key
[Store Station Configuration Information]
The lookup return flag indicates 'SUCCESSFUL' → The retrieved station configuration data is stored in the station segment for further processing
[Retrieve Station Configuration from MC Table]
The system needs to distribute suspect cargo reports → The system retrieves the MC table segment for the station or sets empty configuration if station not found
[Display Shutdown Message]
The system processes the shutdown request → A shutdown message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035' is displayed to the console and logged as an error
[Close All Files]
The system prepares for shutdown → Both the checkpoint file and suspect file are closed

Structural Validations

[2:Checkpoint File Processing]
The checkpoint file is read → If checkpoint file is empty or at end, set checkpoint to 500 and display invalid checkpoint message, else if checkpoint value is numeric use that value, else set checkpoint to 500 and display invalid checkpoint message
[File Empty?]
The checkpoint file read operation encounters an end-of-file condition → The checkpoint number is set to 500 and the invalid checkpoint flag is set to 'Y' and an invalid checkpoint message is displayed
[Checkpoint Value Numeric?]
The checkpoint value from the file is not numeric → The checkpoint number is set to 500 and an invalid checkpoint message is displayed
[Admin Table Found?]
The system checks if the table retrieval was successful → If successful, the table segment is stored for processing, otherwise an error is displayed and error handling is invoked
[Validate DC&P Merlin ID 1]
The system validates the Merlin ID by performing a user segment lookup → If validation fails, an error message is displayed and error handling is invoked, otherwise the ID is confirmed as valid
[Validate DC&P Merlin ID 2]
The system validates the second Merlin ID by performing a user segment lookup → The validation result determines whether the ID can be used for IFS system or if default assignment is needed
[Validate DC&P Merlin ID 3]
The system validates the third Merlin ID by performing a user segment lookup → The validation result determines whether the ID can be used for HHS system or if default assignment is needed
[Validate DC&P Merlin ID 4]
The system validates the fourth Merlin ID by performing a user segment lookup → The validation result determines whether the ID can be used for IM system or if default assignment is needed
[Validate DC&P Merlin ID 5]
The system validates the fifth Merlin ID by performing a user segment lookup → The validation result determines whether the ID can be used for COPY system or if it should remain empty
[Table Found Successfully?]
The table retrieval function is called → If the table is found successfully, store the administration segment data, otherwise display error message and call error handler
[Merlin ID 1 Valid?]
The system validates Merlin ID 1 through EMTZ segment lookup → If Merlin ID 1 is valid, assign it as DCP Merlin ID, otherwise display error message
[Merlin ID exists in system?]
The table retrieval operation completes → If the return flag indicates successful retrieval, the table segment is stored for use, otherwise an error condition is triggered
[Display Error Message]
The system detects the table is not found → An error message 'AD TABLE NOT FOUND' is displayed to the console
[Call Error Handler]
The error condition is detected → The system sets the error message and calls the 'CERR' error handling routine
[Display Error: AD TABLE NOT FOUND]
The administration table is not found or cannot be accessed → The system displays 'AD TABLE NOT FOUND' error message and terminates processing
[Display Error: MERLIN ID 1 NOT FOUND]
The Merlin ID validation fails or the ID cannot be accessed → The system displays 'MERLIN ID 1 NOT FOUND' error message and continues processing
[Merlin ID 1 Valid?]
The system attempts to validate the Merlin ID 1 by performing a lookup → If the Merlin ID 1 is not found or invalid, the system displays an error message and terminates processing
[ID 2 Valid?]
The system performs a lookup to validate Merlin ID 2 → If the validation fails, display error message and use Merlin ID 1 for IFS system, otherwise assign Merlin ID 2 to IFS system
[ID 3 Valid?]
The system performs a lookup to validate Merlin ID 3 → If the validation fails, display error message and use Merlin ID 1 for HHS system, otherwise assign Merlin ID 3 to HHS system
[ID 4 Valid?]
The system performs a lookup to validate Merlin ID 4 → If the validation fails, display error message and use Merlin ID 1 for IM system, otherwise assign Merlin ID 4 to IM system
[ID 5 Valid?]
The system performs a lookup to validate Merlin ID 5 → If the validation fails, display error message and leave COPY system unassigned, otherwise assign Merlin ID 5 to COPY system
[Display Error: Merlin ID 1 Not Found]
The administrative table is not found or cannot be accessed → The system displays 'AD TABLE NOT FOUND' error message and calls error handling routine
[Display Error: Merlin ID 2 Not Found]
The Merlin ID validation returns an error status → The system displays 'MERLIN ID 2 NOT FOUND' error message and calls error handling routine
[Display Error: Merlin ID 3 Not Found]
The Merlin ID validation returns an error status → The system displays 'MERLIN ID 3 NOT FOUND' error message and calls error handling routine
[Display Error: Merlin ID 4 Not Found]
The Merlin ID validation returns an error status → The system displays 'MERLIN ID 4 NOT FOUND' error message and calls error handling routine
[Display Error: Merlin ID 5 Not Found]
The Merlin ID validation returns an error status → The system displays 'MERLIN ID 5 NOT FOUND' error message and calls error handling routine

Module: GCX035B 1 Consolidated Epic Story

Epic: GCX035B Complete EDI Specification Extracted from Legacy

Contains 116 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX035B EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[8:Initialize New Destination]
The current record's notification destination (MAN-NOTIFY) is different from the previous record's destination → The system sends any pending messages for the previous destination, initializes new destination setup, and resets message counters
[Initialize Previous Merlin ID to Empty]
System needs to track message counts → Set Merlin message counter to 3 as starting value
[Initialize New Message Structure]
The system prepares for the new recipient after handling previous messages → The message structure is initialized with spaces for user codes, copy codes, text, and return status, and standard header lines are set
[Initialize Communication Interface]
The send message process is initiated → The communication interface is initialized using CCISCOM
[Initialize New Message Structure]
The system needs to prepare for new message content → The system calls the initialization function to set up a new message destination structure
[Initialize Return Code Message Pointer]
The call parameters are being initialized → The return code message pointer must be set to NULL to ensure proper error message handling
[Initialize Communication Interface]
The send Merlin message process is initiated → The system calls CCISCOM to initialize communication interface and increments the message sequence number by 1
[Initialize Communication Interface]
The message transmission process begins → The system calls CCISCOM to initialize communication interface and increments the message sequence number by 1

Core Acceptance Criteria

[9:Check Message Capacity]
The message line count exceeds 699 lines → The system sends the current message batch, resets the counter to 3, and initializes a new destination setup
[12:Log Cargo Suspect Entry]
The message type is new (MSG-NEW equals '>') AND the notification destination is 'OM01247' → The system performs special cargo suspect logging with message 'CARGO SUSPECTED IN CANADA'
[14:Send Merlin Message]
The destination user code is 'OM01247' → The system assigns 'SUSPECT' as the destination filename, otherwise it assigns 'IN' as the destination filename
[15:Handle Invalid Merlin ID]
The message sending fails (return status is not successful) → The system captures the failed destination ID, reroutes the message to 'OM01247', and sends an error notification stating 'GCX035B INVALID MERLIN ID - [failed-id] - REPORT REROUTE TO OM01247'
[16:Perform Checkpoint Processing]
The checkpoint call counter exceeds the configured checkpoint number → The system performs checkpoint processing and resets the checkpoint call counter to zero
[17:Send Final Report]
There are remaining message lines in the current batch (EMI-TEXT-LINES(3) is not spaces) → The system sends the final message batch before closing files and terminating
[Set Default Checkpoint Number to 500]
The checkpoint file read operation reaches end of file or fails → The checkpoint number is set to default value 500 and an invalid checkpoint message is displayed
[Clear Email Header Fields]
The system begins message structure initialization → All email header fields are cleared to spaces
[Clear Recipient User Code]
The message structure initialization process is executed → The recipient user code field is cleared to spaces
[Clear Copy Recipient Code]
The system performs message field clearing operations → The copy recipient code field is cleared to spaces
[Clear Message Text Area]
The message clearing process is performed → The message text area is cleared to spaces
[Clear Return Status Flag]
The system initializes message structure fields → The return status flag is cleared to spaces
[Set Message Header Line]
The system sets up message formatting → The first message line is populated with the standard message header label
[Set Message Separator Line]
The system completes message formatting setup → The second message line is populated with the standard separator format
[Current Merlin ID ≠ Previous Merlin ID?]
The current record's Merlin ID is different from the previous Merlin ID → The system identifies this as a recipient change requiring message batch processing
[Send Accumulated Message to Previous Recipient]
The system needs to process the recipient change → The accumulated message is sent to the previous recipient via the Merlin messaging system
[Set New Recipient as Current Merlin ID]
The system sets up the recipient information → The current Merlin ID (PREV-MERLIN) is assigned to the first recipient position (EMI-TO-USERCODES (1))
[Reset Message Counter to 3]
The system sets up the message counters → The message counter (MERLIN-CNT) is set to 3 to reserve positions 1 and 2 for header information
[Reset Message Sequence to 0]
The system sets up the message sequencing → The message sequence number (EMI-SEQ) is set to 0 to start fresh numbering for the new batch
[Increment Message Sequence Number]
The message sequence processing begins → The message sequence number is incremented by 1
[Set Subject: 'Cargo Suspected in Canada']
The message subject is being set → The subject is set to 'Cargo Suspected in Canada'
[Recipient is OM01247?]
The recipient is OM01247 → The destination filename is set to 'SUSPECT' and copy usercode is cleared
[Set Destination: 'IN']
The recipient is not OM01247 → The destination filename is set to 'IN'
[Send Message via EMCSEND]
The message transmission is initiated → EMCSEND is called with sender, destination, recipient, copy recipient, subject, keywords, text, and status parameters
[Store Failed Recipient ID]
The failure handling process begins → The failed recipient ID is stored in WS-BAD-MERLIN-ID
[Resend to Default Recipient OM01247]
The rerouting process is initiated → The message is resent to recipient OM01247 using destination 'IN'
[Increment Checkpoint Counter]
The message processing is complete → The checkpoint call counter is incremented by 1
[Checkpoint Threshold Reached?]
The checkpoint call counter exceeds the configured checkpoint number → Checkpoint processing is performed
[Set Report Subject: 'Cargo Suspected in Canada']
The system sets the message subject → The subject is set to 'Cargo Suspected in Canada'
[Recipient is OM01247?]
The recipient user code is OM01247 → The destination filename is set to 'SUSPECT', otherwise it is set to 'IN'
[Call EMCSEND to Send Report]
The system calls the external messaging service EMCSEND → The report is transmitted with all required parameters including recipient, subject, and message content
[Send Successful?]
The system checks the return status from the messaging service → If the status is not successful, the system initiates error handling procedures, otherwise it proceeds normally
[Reroute to Default Recipient OM01247]
The system processes the delivery failure → The recipient is changed to OM01247 and the destination filename is set to 'IN'
[Update Checkpoint Counter]
The system updates the checkpoint counter → The counter is incremented by 1, and if it exceeds the configured checkpoint number, a checkpoint operation is performed
[Set Email Subject to 'Cargo Suspected in Canada']
The system prepares the email message → The email subject is set to 'Cargo Suspected in Canada'
[Call EMCSEND to Send Email Report]
The system needs to send the cargo suspect report → EMCSEND service is called with all email parameters to deliver the message
[Resend to Default Recipient OM01247]
The system needs to ensure message delivery → The message is rerouted to default recipient OM01247 using destination filename 'IN'
[Clear Message Recipients]
The system needs to prepare message structure for a new recipient → All existing message recipient codes should be cleared to spaces
[Clear Copy Recipients]
The system needs to prepare message structure for a new recipient → All existing copy recipient codes should be cleared to spaces
[Clear Message Text Content]
The system needs to prepare message structure for a new recipient → All existing message text content should be cleared to spaces
[Clear Return Status Flags]
The system needs to prepare message structure for a new recipient → All return status flags should be cleared to spaces
[Set Message Header Line]
The system needs to set up message structure formatting → The first message line should be set to the standard message header label
[Set Message Separator Line]
The system needs to set up message structure formatting → The second message line should be set to the standard message separator
[Check Current Message Line Count]
The system checks the current message line count → The system retrieves the current MERLIN-CNT value for capacity evaluation
[Send Current Message to Recipient]
The system needs to send the full message batch → The system calls the message sending function to transmit the batch to the recipient
[Reset Line Counter to 3]
The system needs to prepare for the next message batch → The system sets the message line counter (MERLIN-CNT) to 3 to account for header lines
[Set Recipient for New Message]
The system needs to set the recipient for the new message batch → The system assigns the previous MERLIN identifier (PREV-MERLIN) to the first recipient position in the new message
[Continue Processing]
The system has either sent a full batch or determined there is available capacity → The system proceeds to add the current suspect data to the message and increment the line counter
[Store Formatted Line in Message Buffer]
The system needs to add the suspect information to the message batch → The suspect data is stored in the current message line position within the message buffer and the message counter is incremented
[Move Suspect Data to Message Line]
The system processes the suspect record for message preparation → The suspect data is moved to the next available message line in the current message text
[Increment Message Line Counter]
The record addition is complete → The message line counter is incremented by 1 to reflect the new line count
[Extract Train/CCN Number from Message]
Container identification is required → The CCN (Container Control Number) is extracted from the message and stored in the log entry
[Set Message Text: 'CARGO SUSPECTED IN CANADA']
The log message text must be set → The message is set to 'CARGO SUSPECTED IN CANADA' to clearly identify the event type
[Execute via BPE Environment]
The log transaction is initiated → Set transaction name to GCT1051E, prepare communication area with message data, calculate data lengths, and call CSIEXCI program
[Execute via IMS Environment]
The log transaction is initiated → Use IMS CIMS calls to change message destination, write message using WRITMSGL, and purge the message queue
[Prepare Log Message Data]
Log transaction preparation begins → Set security byte to high-value, sending transaction to GCX035B, copy user ID and machine date/time, set action code to ZZZ, copy train/container number, and set message to 'CARGO SUSPECTED IN CANADA'
[Calculate Communication Area Length]
The communication area is being prepared → The communication area length must be calculated as message length plus 4 bytes for header information
[Move Message Data to Communication Area]
The message data transfer is initiated → The message data must be moved to the external communication data area using the calculated message length
[Set Call Data Length]
The external call parameters are being finalized → The call data length must be computed as the sum of communication area header length and message length
[Call CIMS for Transaction Setup]
The system needs to establish transaction context for log message processing → The system calls CIMS with CHNG function to set up the transaction using ALT-PCB2 and GCT1051E transaction data
[Call WRITMSGL to Send Log Message]
The system needs to send the cargo suspect log message → The system calls WRITMSGL with ALT-PCB2, message code, message content, message length, and module name to transmit the log entry
[Call CIMS to Purge Transaction]
The system needs to clean up the transaction context → The system calls CIMS with PURG function using ALT-PCB2 to purge the transaction and complete the processing
[Set Subject: 'Cargo Suspected in Canada']
The message subject needs to be set → The system sets the subject line to 'Cargo Suspected in Canada'
[Recipient is OM01247?]
The recipient is OM01247 → The system sets destination filename to 'SUSPECT' and clears copy usercode to spaces
[Set Destination: 'IN']
The recipient is not OM01247 → The system sets destination filename to 'IN'
[Call EMCSEND to Transmit Message]
The message transmission is requested → The system calls EMCSEND with from usercode, destination filename, to usercode, copy usercode, subject, keywords, text, and return status flag
[Resend to Default Recipient OM01247]
The resend procedure is initiated → The system sets recipient to 'OM01247', destination filename to 'IN', and calls EMCSEND to resend the message
[Set Message Subject to 'Cargo Suspected in Canada']
The message subject needs to be set → The system sets the message subject to 'Cargo Suspected in Canada'
[Recipient is OM01247?]
The recipient user code is OM01247 → The system sets the destination filename to 'SUSPECT' and clears the copy recipient field
[Set Destination Filename to 'IN']
The recipient user code is not OM01247 → The system sets the destination filename to 'IN'
[Call EMCSEND to Send Message]
The message is ready for transmission → The system calls EMCSEND with sender usercode, destination filename, recipient usercode, copy usercode, subject, keywords, message text, and return status flag
[Message Sent Successfully?]
The message transmission fails (return status is not successful) → The system stores the failed recipient ID and performs resend operations to default recipient OM01247
[Resend to Default Recipient OM01247]
Message rerouting is required → The system changes the recipient to OM01247, sets destination filename to 'IN', and calls EMCSEND again
[Increment Checkpoint Counter]
Message processing is complete → The system increments the checkpoint call counter by 1
[Checkpoint Threshold Reached?]
The checkpoint call counter exceeds the configured checkpoint number → The system performs checkpoint operations by calling section 2100-CHKP-CALL
[Set Default Recipient to OM01247]
The system needs to reroute the failed message → The recipient is set to the default value OM01247 for message rerouting
[Set Destination Filename to IN]
The system sets the destination filename for the rerouted message → The destination filename is set to 'IN' (standard filename) rather than 'SUSPECT'
[Send Message to Default Recipient]
The system sends the error notification message → The message is sent using the messaging service with the prepared recipient, destination, subject, and message content
[Send Successful?]
If the send operation result → If the return status flag indicates the send was not successful, additional error handling is triggered
[Set Default Recipient to OM01247]
The system needs to reroute the message to a default recipient → The recipient is set to OM01247 as the default destination
[Set Destination Filename to IN]
The system sets the destination filename for message routing → The destination filename is set to 'IN'
[Send Message via EMCSEND]
The system invokes the message sending process → The EMCSEND service is called with sender code, destination filename, recipient code, copy recipient code, subject, keywords, message text, and return status flag
[Display Shutdown Message]
The system processes the shutdown request → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035B' is displayed to the console
[Log Shutdown Request]
The system processes the shutdown logging → The shutdown request message is logged using the error handling service
[Send Final Report - Send any remaining accumulated suspect records in final message before program termination]
The message buffer contains accumulated suspect cargo records (EMI-TEXT-LINES at position 3 is not empty) → The system sends the final suspect cargo report containing all remaining accumulated records
[System Shutdown Request?]
An IMS shutdown request is received (status code 'XD') → The system displays shutdown message on console, logs error message, closes checkpoint file, closes release file, and terminates program execution

Structural Validations

[Set Default Checkpoint Number to 500]
The checkpoint data from the file is not numeric → The checkpoint number is set to default value 500 and an invalid checkpoint message is displayed
[Existing Message Has Content?]
The system checks the third message line for content → If EMI-TEXT-LINES (3) is not spaces, the system identifies pending message content that must be sent
[Send Successful?]
The return status flag is not SUCCESSFUL → The system initiates failure handling procedures
[Create Error Notification Message]
Error notification is being created → An error message is created containing 'GCX035B INVALID MERLIN ID - [failed-id] - REPORT REROUTE TO OM01247'
[Create Error Notification Message]
The system creates an error notification → The error message includes 'GCX035B INVALID MERLIN ID - [failed recipient ID] - REPORT REROUTE TO OM01247' and is set as both subject and message content
[Create Error Notification Message]
The system needs to notify about the delivery failure → An error message is created with format 'GCX035B INVALID MERLIN ID - [failed-recipient-id] - REPORT REROUTE TO OM01247'
[Line Count > 699?]
The message line count exceeds 699 lines → The system triggers the message sending process to prevent batch overflow
[Transaction Successful?]
The transaction execution completes → If EXCI response code is zero AND response2 is zero AND abend code is space AND message length is zero, then transaction is successful
[Display Error Message]
Error status is recorded → Display EXCI error details including response codes and abend code, and if error message pointer is not null, display the error message content
[EXCI Call Successful?]
The call response is received → The call is considered successful only if response code equals zero AND response2 equals zero AND abend code is space AND message length equals zero
[Error Message Available?]
Additional error details are being retrieved → The system must check if the return code message pointer is not NULL to determine if error message details are available
[Display Error Message Details]
Detailed error information is being processed → The system must display the program name and error message content using the message length to system error output
[Message Sent Successfully?]
The return status flag is not SUCCESSFUL → The system stores the failed Merlin ID and initiates resend procedure to default recipient OM01247
[Create Error Notification Message]
Error notification needs to be created → The system creates error message 'GCX035B INVALID MERLIN ID - [failed-id] - REPORT REROUTE TO OM01247' and sets it as both subject and message text
[Create Error Notification Message]
An error notification needs to be created → The system creates a message containing 'GCX035B INVALID MERLIN ID - [failed recipient ID] - REPORT REROUTE TO OM01247' and sets this as both the message text and subject
[Store Invalid Merlin ID]
The system detects the failure is due to an invalid Merlin ID → The invalid Merlin ID from the first recipient position is stored in the bad Merlin ID workspace for further processing
[Create Error Notification Message]
The system creates an error notification message → The message text is formatted as 'GCX035B INVALID MERLIN ID - [invalid-id] - REPORT REROUTE TO OM01247' and placed in the first text line
[Set Error Message as Subject]
The system prepares the message for sending → The error message text from the first text line is copied to the subject field
[Log Error Message]
The system needs to handle this critical error condition → The return status flag is moved to the error message code and the system calls the error handling routine
[Send Successful?]
The system checks the delivery status → If the return status flag equals SUCCESSFUL, the message was delivered successfully, otherwise it failed
[Log Error Message]
The system processes the send failure → The return status flag is moved to the error message code for logging purposes
[Call Error Handler]
The system needs to handle the send failure → The CERR error handling service is called with the communication control block

Module: GCX035C 1 Consolidated Epic Story

Epic: GCX035C Complete EDI Specification Extracted from Legacy

Contains 34 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX035C EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The checkpoint file cannot be read:
the checkpoint value is not numeric
→ Set checkpoint number to 500 and display invalid checkpoint message
[Initialize Search Counters]
The system begins the exemption table lookup process → The segment counter and department counter are both initialized to 1

Core Acceptance Criteria

[8:Generate Warning Report]
Suspected delivered field is spaces → Mark message with '>' indicator for new suspect and prepare warning report
[11:Retrieve Station Information]
Station routing table lookup is performed for destination station → Retrieve station segment with Merlin ID and alternate Merlin ID information
[Retrieve Administration Table AD-ADMINID]
The administration table with ID 'AD' and sequence 'ADMINID' is requested → The system retrieves the administration table segment containing Merlin user IDs for DCP, IFS, HHS, IM, and COPY systems
[Validate Merlin ID 1 for DCP System]
Merlin ID 1 is validated for the DCP system → If validation is successful, assign Merlin ID 1 to DCP system, otherwise display error message 'MERLIN ID 1 NOT FOUND'
[Calculate Cargo Age]
The system needs to determine cargo age → The system should move the cargo creation date to WS-DATE-CREATE, creation time to WS-TIME-CREATE, current machine date to WS-DATE-DAY, current machine time to WS-TIME-DAY, and call TIMEDIFF to calculate the difference in days
[Continue Processing]
The system determines the cargo is eligible for processing → The system should initialize processing flags, clear message details, reset location counter, and continue with equipment and exemption processing
[Calculate Time Difference Between Creation and Current Date]
The system calculates the time difference → The difference in days is computed using the TIMEDIFF utility
[Extract Event Code]
The equipment service returns zero indicating success → The system should move the event code from equipment data to the message report field
[Store Car ID in Message]
Preparing message data for reporting → The system should move the working storage car ID to the message car ID field
[Search Exempt Table Entry]
The system compares the search key against the exempt table entry → The search key WS-RF-KEY is compared against the table entry RF-TBL-CODE at the current segment and department position
[Increment Search Counter]
The system advances to the next table position → The department counter is incremented by 1, and if it exceeds 50, it resets to 1 and the segment counter is incremented by 1
[Load Station Routing Data]
The table lookup returns successful status → The system should load the MC segment data into station routing variables
[Set Empty Routing Data]
The table lookup does not return successful status → The system should set the MC segment data to spaces
[Extract Cargo Control Number]
The system extracts cargo details for message creation → The cargo control number from the cargo record is moved to the message cargo control number field
[Extract Manifest From Code]
The system processes cargo details for message creation → The manifest from transportation code is moved to the message from field
[Mark as New Delivery '>']
The suspected delivered field is empty (spaces) → The message new delivery indicator is set to '>' to mark it as a new suspected delivery
[Mark as Existing Delivery ' ']
The suspected delivered field is not empty (contains data) → The message new delivery indicator is set to space to mark it as an existing suspected delivery
[Extract Manifest To Code]
The system processes cargo details for message creation → The manifest to transportation code is moved to the message to field
[Extract Consignee Information]
The system processes cargo details for message creation → The consignee chop code is moved to the message consignee field
[Extract Car ID Information]
The system creates message details for reporting → The car ID from working storage is moved to the message car ID field
[Extract Event Code for Report]
The system processes cargo details for message creation → The equipment event code is moved to the message report field
[Extract Station Location Code]
The system creates message details for reporting → The work station code is moved to the message location field
[Get Station Routing Information from MC Table]
The system looks up the station in the MC table using the destination station name as the key → The system retrieves the station's routing segment containing Merlin ID assignments or returns empty if not found
[Shutdown Request Received?]
The checkpoint operation returns a shutdown status code 'XD' → The system displays shutdown message, logs the event, closes files, and terminates processing
[Set Station as Message Location]
Station information processing begins → Set the work station as the message location identifier
[Populate Message Fields with Cargo Data]
The system prepares the warning message → The message contains CCN key, manifest from/to transaction codes, consignee chop, and a '>' indicator for new suspects or space for existing suspects
[Retrieve Station Routing Information]
The system needs to determine routing for suspect delivery warnings → The system retrieves MC table segment using the destination station name as the port key

Structural Validations

[2:Validate Merlin System Access]
The admin table cannot be found → Display error message and call error handler
[Checkpoint File Found?]
The checkpoint file cannot be read or is at end of file → The checkpoint number is set to 500, invalid checkpoint flag is set to 'Y', and a warning message is displayed
[Checkpoint Number Valid?]
The checkpoint value from file is not numeric → The checkpoint number is set to default value 500 and a warning message is displayed
[Admin Table Found?]
The table retrieval operation is completed → If the table is not found, display error message 'AD TABLE NOT FOUND' and terminate the validation process, otherwise proceed with Merlin ID validation
[Reached Table Limits?]
The system checks if the table boundaries have been reached → Stop searching if both the segment counter equals WS-SEG-MAX and the department counter equals WS-DEP-MAX

Module: GCX035D 1 Consolidated Epic Story

Epic: GCX035D Complete EDI Specification Extracted from Legacy

Contains 136 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX035D EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize New Message Destination]
The system initializes a new message destination → The system clears message fields, sets standard header lines (libel and separator), and prepares for content accumulation starting at line 3
[Initialize Message Structure for New Recipient]
A new message structure needs to be initialized → The system clears all message fields and sets up standard header lines (libel and separator)
[Initialize New Message Structure]
A new message structure needs to be created → The system performs initialization of new destination message structure

Core Acceptance Criteria

[7:Check Merlin ID Change?]
The MAN-NOTIFY field is compared with the previous Merlin ID → If MAN-NOTIFY is different from previous Merlin ID, send accumulated messages and initialize new destination
[Special Entry for OM01247?]
MSG-NEW equals '>' and MAN-NOTIFY equals 'OM01247' → Create a log entry with message 'PLACED CARGO NOT YET RELEASED BY CANADA CUSTOMS'
[8:Send Accumulated Messages]
The recipient ID is evaluated → If recipient is 'OM01247', use 'PLACED' destination filename, otherwise use 'IN' destination filename
[13:Handle Invalid Merlin ID?]
The message send returns unsuccessful status → Reroute the message to 'OM01247' with error notification including the invalid recipient ID
[15:Perform Checkpoint Processing]
The checkpoint call counter is evaluated → If checkpoint call counter exceeds the configured checkpoint number, Execute checkpoint processing and reset counter
[Final Messages to Send?]
The system checks for remaining messages → If EMI-TEXT-LINES at position 3 is not empty, send the final message batch
[Clear Message Text Areas]
The message initialization process begins → All message text areas are set to spaces to clear any existing content
[Set Initial Message Line Counter to 3]
Setting up the message line counter → The message line counter is set to 3 to reserve the first two lines for headers
[Clear User Code Fields]
Clearing recipient information → The primary recipient user code field is set to spaces
[Clear Copy User Code Fields]
Clearing copy recipient information → The copy recipient user code field is set to spaces
[Clear Return Status Flag]
Clearing status tracking fields → The message return status flag is set to spaces
[Set Message Header Line]
Setting up message headers → The standard message header content is placed in message line 1
[Set Message Separator Line]
Setting up message formatting → The message separator content is placed in message line 2
[Merlin ID Changed from Previous?]
The current notification recipient is different from the previous delivery record's recipient (PREV-MERLIN) → The system identifies this as a recipient change requiring message processing and destination initialization
[Send Current Accumulated Messages]
The message text lines at position 3 contain content (not spaces) → The system sends the accumulated message content to the previous recipient before processing the new recipient
[Set New Merlin ID as Current]
The recipient change processing is complete → The system updates the previous recipient tracker (PREV-MERLIN) with the current recipient (MAN-NOTIFY) and sets the message counter to 3
[Send Current Message Due to Capacity]
The message needs to be sent due to capacity constraints → The system sends the current message content to the recipient to prevent message overflow
[Reset Message Counter to 3]
The system needs to continue processing with the same recipient → The system resets the message counter to 3 and reinitializes the destination for continued message accumulation
[Add Delivery Record to Message Lines]
The delivery data needs to be added to the message content → The system adds the delivery data (DELIVER-DATA) to the message lines at the current counter position and increments the counter by 1
[New Message for OM01247?]
The message type is new placement (MSG-NEW = '>') and the notification recipient is 'OM01247' → The system identifies this as a special cargo placement event requiring audit log entry
[Create Log Entry for Special Cargo]
An audit log entry needs to be created → The system creates a log entry with transaction details, timestamp, user information, and the message 'PLACED CARGO NOT YET RELEASED BY CANADA CUSTOMS'
[Set Message Subject: 'Placed Cargo Not Yet Released by Canada Customs', Set Message Subject to 'Placed Cargo Not Yet Released by Canada Customs']
The system prepares the message for delivery → The message subject is set to 'Placed Cargo Not Yet Released by Canada Customs'
[Is Recipient OM01247?]
The recipient is OM01247 → The message destination is set to 'PLACED' file and copy recipient is cleared
[Message Send Successful?]
The message delivery fails → The failed recipient ID is stored and the message is rerouted to default recipient OM01247 with error notification
[Checkpoint Limit Reached?]
The checkpoint counter exceeds the configured checkpoint number → Checkpoint processing is performed to save system state
[Send Message via EMCSEND]
The system needs to deliver the message → The EMCSEND external service is called with message parameters
[Set Default Recipient to OM01247]
The system needs to reroute the failed message → The recipient should be set to the default value OM01247
[Set Destination Filename to IN]
The destination filename needs to be configured for the rerouted message → The destination filename should be set to IN
[Send Message to Default Recipient]
The system attempts to send the rerouted message → The EMCSEND service should be called with the configured parameters to deliver the message
[Store Bad Merlin ID]
The EMI-RETURN-STATUS-FLAG indicates unsuccessful delivery → The invalid Merlin ID from EMI-TO-USERCODES(1) is stored in WS-BAD-MERLIN-ID for error reporting
[Clear Message Recipients]
The system begins message destination setup → All recipient usercode fields are cleared to spaces
[Clear Message Text Content]
The system begins message destination setup → All message text fields are cleared to spaces
[Clear Return Status Flag]
The system begins message destination setup → The return status flag is cleared to spaces
[Set Message Header Line]
The system sets up the message structure → The message header libel is placed in the first text line
[Set Message Separator Line]
The system sets up the message structure → The message separator line is placed in the second text line
[Accumulated Messages Exist?]
The system checks if message line 3 contains any content (not spaces) → The system determines whether accumulated messages exist that need to be sent
[Send Accumulated Messages to Previous Recipient]
Message line 3 is not empty (contains content other than spaces) → The system sends the accumulated messages to the previous recipient via Merlin messaging system
[Set New Recipient as Message Destination]
The message destination needs to be set → The system assigns the new recipient ID to the first position in the message destination user codes
[Reset Message Line Counter]
Message accumulation needs to start fresh → The message line counter is reset to 3 (after header lines)
[Is Recipient OM01247?]
The recipient is OM01247 → The destination filename is set to 'PLACED' and copy user code is cleared
[Set Destination to 'IN', Set Destination Filename to 'IN']
The recipient is not OM01247 → The destination filename is set to 'IN'
[Call EMCSEND to Send Message]
The system needs to deliver the notification → EMCSEND service is called with message parameters
[Resend Message to Default Recipient OM01247]
The system needs to handle the delivery failure → The message is rerouted to OM01247 using 'IN' destination filename
[Create Invalid Merlin ID Notification Message]
The system processes the delivery failure → An error notification message is created containing the invalid recipient ID and reroute information
[Increment Checkpoint Counter]
The message processing is complete → The checkpoint counter is incremented by 1
[Checkpoint Limit Reached?]
The checkpoint counter exceeds the configured checkpoint number limit → System checkpoint processing is performed and counter is reset
[Set Message Subject to 'Placed Cargo Not Yet Released by Canada Customs']
The system prepares the message for sending → The message subject is set to 'Placed Cargo Not Yet Released by Canada Customs'
[Call EMCSEND with Message Parameters]
The system needs to send the cargo notification → EMCSEND service is called with all message parameters
[Store Failed Merlin ID]
The EMCSEND service returns an unsuccessful status → The failed recipient identifier is stored for error handling
[Resend Message to Default Recipient OM01247]
The system needs to ensure the message is delivered → The message is rerouted to default recipient OM01247 using 'IN' destination filename
[Create Invalid Merlin ID Notification Message]
The system creates an error notification → A message is created stating 'GCX035D INVALID MERLIN ID - [failed_id] - REPORT REROUTE TO OM01247' and set as both subject and message content
[Send Notification to OM01247]
The system sends the error notification → The notification is sent to OM01247 via EMCSEND service
[Set Default Recipient to OM01247]
The resend process is initiated → The recipient should be set to the default value OM01247
[Set Destination Filename to IN]
The destination filename needs to be determined → The destination filename should be set to IN
[Send Message to Default Recipient]
The message send operation is executed → The message should be sent using the email communication system with all required parameters
[Clear Current Message Content]
The system prepares to create an error notification message → Both EMI-SUBJECT and EMI-TEXT are cleared to spaces to prepare for new error message content
[Prepare Message for Default Recipient]
The system prepares to send the error notification → The message recipient is set to 'OM01247' in EMI-TO-USERCODES (1) and destination filename is set to 'IN'
[Clear Message Structure Fields]
The initialize new destination process is invoked → All message structure fields including recipient user code, copy user code, message text, and return status flag are cleared to spaces
[Set Message Header Line]
Message header is being set up → The message libel content is moved to the first message text line
[Set Message Separator Line]
Message separator is being configured → The message separator content is moved to the second message text line
[Check Current Message Line Count]
The system needs to check the current message line count → The system evaluates the MERLIN-CNT variable to determine current capacity
[Message Count > 699?]
The message line count is greater than 699 → The system triggers immediate message sending to prevent capacity overflow
[Send Current Message to Merlin]
The capacity limit decision triggers message sending → The system performs the SEND-MERLIN operation to deliver the current message
[Reset Message Counter to 3]
The message sending is completed → The system sets MERLIN-CNT to 3 to account for header lines in new message
[Set Recipient to Current Merlin ID]
The recipient needs to be assigned to the new message → The system moves PREV-MERLIN to EMI-TO-USERCODES(1) to set the recipient
[Add Delivery Data to Message - Append delivery record data to message text lines]
The system processes the delivery record data for inclusion in the notification message → The delivery record data is moved to the message text line at the current counter position
[Increment Message Line Counter]
The system completes the data addition operation → The message line counter is incremented by 1 to point to the next available line position
[Is New Message Indicator '>'?]
The message new indicator is checked → If the indicator equals '>' then proceed to check Merlin notify ID, otherwise continue normal processing
[Add Cargo CCN Number]
Cargo reference information is being added → Set train or US CCN field to the message CCN number from the delivery record
[Set Message: 'PLACED CARGO NOT YET RELEASED BY CANADA CUSTOMS']
Log message text is being set → Set message field to 'PLACED CARGO NOT YET RELEASED BY CANADA CUSTOMS'
[Add Cargo Control Number]
Cargo identification is required for the transaction → Message cargo control number (MSG-CCN) is moved to the train or US cargo control number field
[Set Message: 'PLACED CARGO NOT YET RELEASED BY CANADA CUSTOMS']
Transaction message content needs to be specified → Message field is set to 'PLACED CARGO NOT YET RELEASED BY CANADA CUSTOMS'
[Running Environment Check]
The system needs to send the GCT1051E transaction → If running in BPE environment, use CSIEXCI processing method, otherwise use IMS processing method
[Send via BPE using CSIEXCI]
GCT1051E transaction needs to be sent → Transaction name is set to GCT1051E, communication area length is calculated, message data is moved to communication area, and CSIEXCI is called with appropriate parameters
[Send via IMS Environment]
GCT1051E transaction needs to be sent → Accept status is cleared, CIMS is called to change to alternate PCB, WRITMSGL is called to write the message, and CIMS is called to purge the message
[Prepare Transaction Data]
Transaction data needs to be prepared → The system copies the input message to the transaction message structure
[Calculate Message Length]
The communication area length needs to be determined → The system calculates the length as message length plus 4 bytes for header
[Copy Message Data to Communication Area]
Message data needs to be transferred → The system copies the message data to the communication area and calculates total call data length
[Call CSIEXCI to Send Transaction]
The transaction needs to be sent → The system calls CSIEXCI service with transaction parameters
[Running in BPE Environment?]
The system checks if it is running in BPE (Batch Processing Environment) → If running in BPE, use EXCI interface for transaction processing, otherwise use IMS CIMS interface
[Send via EXCI Interface]
Transaction processing is initiated via EXCI interface → Set transaction name to GCT1051E, calculate communication area length, prepare message data, and call CSIEXCI program with required parameters
[Write Message using WRITMSGL]
Message writing process is executed → Call WRITMSGL program with ALT-PCB2, message code, message content, message length, and module name parameters
[Call CIMS to Purge Message]
Transaction completion is required → Call CIMS program using PURG function with ALT-PCB2 parameter to purge the message
[Store Invalid Merlin ID]
The system detects the message delivery failure → The system stores the invalid Merlin ID from EMI-TO-USERCODES(1) into WS-BAD-MERLIN-ID for error reporting
[Resend Message to Default Recipient OM01247]
The system needs to reroute the message → The system calls the resend function to deliver the message to default recipient OM01247
[Resend Message to Default Recipient OM01247]
The system prepares the message for rerouting → The system sets the recipient to 'OM01247' and the destination filename to 'IN' for the rerouted message
[Set Destination Filename to IN]
The destination filename needs to be determined for the rerouted message → The destination filename should be set to IN
[Retry Send Message to Default Recipient]
The system attempts to resend the message → The message should be sent using the EMCSEND service with the updated recipient and destination parameters
[Display Shutdown Message]
System processes the shutdown request → Display message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035D' on console
[Display Shutdown Message]
The shutdown request is detected → The system displays 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035D' message
[IMS Shutdown Request?]
An IMS shutdown request is received (status code 'XD') → The system should display shutdown message, log error, close files and terminate
[Display Shutdown Message]
The system processes the shutdown request → The system should display 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035D' message to console

Structural Validations

[10:Check Message Capacity?]
The message line count is evaluated → If Merlin counter exceeds 699 lines, send current message batch and reset counter to 3
[Set Checkpoint Number to 500, Set Invalid Checkpoint Flag to 'Y', Display Invalid Checkpoint Message]
The checkpoint file reaches end of file or is empty → The checkpoint number is set to 500 AND the invalid checkpoint flag is set to 'Y' AND an invalid checkpoint message is displayed
[Set Default Checkpoint Number to 500, Display Invalid Checkpoint Message]
The checkpoint data is not numeric → The checkpoint number is set to 500 AND an invalid checkpoint message is displayed
[Set Checkpoint Number to 500, Set Invalid Checkpoint Flag to 'Y', Display Invalid Checkpoint Message]
The checkpoint file read operation reaches end of file (file is empty or missing) → The checkpoint number is set to default value 500, the invalid checkpoint flag is set to 'Y', and an invalid checkpoint message is displayed
[Set Checkpoint Number to 500, Display Invalid Checkpoint Message]
The checkpoint number validation fails → The checkpoint number is set to default value 500 and an invalid checkpoint message is displayed
[Message Line Count > 699?]
The message line counter (MERLIN-CNT) is evaluated → The system determines if the counter exceeds 699 lines requiring immediate message transmission
[Create Error Notification Message]
The system creates an error notification → An error message is created containing 'GCX035D INVALID MERLIN ID - [failed recipient ID] - REPORT REROUTE TO OM01247'
[Message Send Successful?]
The system needs to determine if the send operation was successful → The EMI-RETURN-STATUS-FLAG should be checked against the SUCCESSFUL status value
[Log Error Message]
The EMI-RETURN-STATUS-FLAG != SUCCESSFUL → The system should log the error status code and call the error handling service CERR
[Create Error Message Text]
Error notification processing is initiated → The system creates error message text 'GCX035D INVALID MERLIN ID - [invalid_id] - REPORT REROUTE TO OM01247' and places it in EMI-TEXT-LINES(1)
[Set Error Subject Line]
Preparing error notification for sending → The content of EMI-TEXT-LINES(1) is copied to EMI-SUBJECT as the notification subject
[Log Error to System]
Handling the secondary error → The system moves EMI-RETURN-STATUS-FLAG to CERR-MSG1-CODE, moves CERR-MSG1 to CC-ERROR-MESSAGE of CCCOM, and calls 'CERR' using CCCOM
[Message Send Successful?]
The message delivery fails (return status is not successful) → The failed recipient ID is stored and error handling is initiated
[Message Send Successful?]
The service returns a status indicating success or failure → The system evaluates if the return status flag indicates successful delivery
[Message Send Successful?]
The message delivery status is evaluated → If the return status flag equals SUCCESSFUL then delivery is successful, otherwise delivery has failed
[Log Error Message]
Error logging is required → The return status flag should be moved to error message code for logging purposes
[Call Error Handler]
Error handling is required → The system error handler should be called with the error message details
[Store Invalid Merlin ID]
The system detects the send failure with invalid recipient → The invalid Merlin ID from EMI-TO-USERCODES (1) is stored in WS-BAD-MERLIN-ID for error reporting
[Create Error Notification Message]
The system creates the error notification message → A message is constructed with format 'GCX035D INVALID MERLIN ID - [invalid_id] - REPORT REROUTE TO OM01247' and placed in EMI-TEXT-LINES (1)
[Set Error Message Subject]
The system sets the message subject → EMI-SUBJECT is set to the same content as EMI-TEXT-LINES (1) to maintain message consistency
[Send Error Notification to OM01247]
The system sends the error notification → The 7100-RESEND-MERLIN process is performed to deliver the error message to the default recipient
[Is Merlin Notify ID 'OM01247'?]
The Merlin notify ID is checked against 'OM01247' → If the ID equals 'OM01247' then initiate special log entry creation, otherwise continue normal processing
[Transaction Successful?]
Transaction completion status needs to be determined → If EXCI response code is zero AND response2 is zero AND abend code is space AND message length is zero, then transaction is successful, otherwise transaction failed
[Log Error Status]
Error status and details need to be recorded → Error details including response codes and abend code are displayed to system error log, if error message pointer is not null then error message is also displayed, and return code is set to failure status
[Transaction Successful?]
Transaction response is received → The system checks if response code is zero, response2 is zero, abend code is space, and message length is zero
[Error Message Available?]
Additional error details need to be checked → The system verifies if error message pointer is not null
[Display Detailed Error Message]
Detailed error information needs to be displayed → The system displays the detailed error message content to system error output
[Transaction Sent Successfully]
Transaction response is evaluated → If EXCI response code is zero, response2 is zero, abend code is space, and message length is zero, then set return code to success, otherwise set return code to failure and display error information
[Message Send Successful?]
The system checks the return status flag from the message sending operation → If the return status flag is not SUCCESSFUL, the system identifies this as a failed message delivery requiring error handling
[Create Error Notification Message]
The system creates an error notification message → The system clears the subject and text fields, then creates a message containing 'GCX035D INVALID MERLIN ID - [invalid_id] - REPORT REROUTE TO OM01247' and sets this as both the message text and subject
[Send Error Notification to OM01247]
The system sends the error notification → The system calls the resend function again to deliver the error notification to OM01247
[Log Error Message]
The system needs to log the critical error → The system moves the return status flag to error message code, sets the error message, and calls the error logging function CERR
[Resend Successful?]
The resend operation completes → The system should check if the EMI return status flag indicates successful delivery
[Log Error Message]
The EMI return status flag does not indicate successful delivery → The system should log the error message using the error handling service and set the error message code from the EMI return status flag
[Log Error Message]
System logs the shutdown event → Error message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035D' is logged via CERR program call
[Log Shutdown Error]
The system processes the shutdown notification → The system logs the shutdown message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035D' using error logging service
[Log Error Message]
The system continues shutdown processing → The system should log 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035D' as error message using CERR program

Module: GCX036 1 Consolidated Epic Story

Epic: GCX036 Complete EDI Specification Extracted from Legacy

Contains 81 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX036 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Empty Segment Structure]
Handling the segment not found condition → The cargo segment structure (GCSCCS52) should be initialized with empty values
[Initialize Empty Broker Configuration]
No broker configuration can be retrieved → The system should initialize empty broker and B1 segments and set batch print call letters from cargo record
[Initialize Empty Broker Segment]
The default configuration retrieval return flag is not successful → The system should initialize empty broker segment and empty B1 segment, set batch print call letters to index, and exit the configuration process
[Initialize Empty Broker Configuration]
No valid broker configuration can be retrieved from the broker table → The system initializes empty broker configuration segments and sets the batch print call letters to maintain processing flow
[Initialize Empty Additional Details]
No supplementary broker information can be retrieved from the B1 table → The system initializes an empty B1 segment to ensure consistent processing structure
[Initialize Empty Broker Configuration]
No broker table entries are found for the broker name → The system initializes empty broker and B1 segments and sets batch print call letters from cargo record
[Initialize Empty B1 Configuration]
No B1 table entry exists for the broker parameters → The system initializes empty B1 segment structure
[Initialize Empty Broker Configuration]
The system cannot retrieve any broker configuration → Empty broker configuration segments are initialized and secondary broker processing ends
[Initialize Empty Broker Segment]
The table segment retrieval returns unsuccessful status for both attempts → The system should initialize empty broker and B1 segments and skip broker notification processing
[Initialize Empty B1 Segment]
The B1 table segment lookup returns unsuccessful status → The system should initialize an empty B1 segment and continue with broker notification processing using available configuration
[Initialize Empty Broker Config]
No valid broker configuration is available → The system initializes empty broker segments and terminates secondary broker processing

Core Acceptance Criteria

[13:Retrieve Cargo Segment]
Cargo segment data is needed → Retrieve cargo segment using CCN key, segment ID '52', and sequence '0001', initializing segment if not found
[16:Get Broker Configuration]
Broker configuration is needed → Retrieve broker segment with table ID 'BK' and additional B1 segment for extended configuration, initializing B1 segment if not found
[21:Send Internet Broker Notification]
Internet notification is required → Initialize print input with CCN key, security byte, and internet address from B1 segment, then spawn print transaction
[25:Handle IMS Shutdown]
The system receives status code 'XD' indicating IMS shutdown request → Display shutdown message, log error, close files, commit transaction, and terminate program
[Display Checkpoint Configuration]
The checkpoint configuration process is complete → The system displays 'GCX036 CHECKPOINTING AT [checkpoint-number]' message to the console
[Calculate Days Since Cargo Creation]
The system needs to determine dwelling duration → The system calculates the difference in days between cargo creation date/time and current system date/time using TIMEDIFF function
[Call TIMEDIFF Utility with Date Parameters]
Time difference calculation is required → TIMEDIFF utility is called with WS-DATE-2, WS-DATE-1, and WS-RESULT-DIFF parameters
[Receive Days Difference Result in WS-DAY-DIFF]
The calculation is completed → The days difference result is available in WS-DAY-DIFF field
[Calculate Cargo Age]
The system needs to calculate cargo age for deletion processing → The system extracts the cargo original sent date and time, gets current system date and time, calls TIMEDIFF utility to calculate the difference in days, and stores the result in day difference field
[Calculate Cargo Age]
The system needs to determine cargo age for report inclusion criteria → The system extracts the cargo creation date and time, gets current system date and time, calls TIMEDIFF utility to calculate the difference in days, and stores the result in day difference field
[Set Database Access Status]
Initiating cargo segment retrieval process → The database access status should be set to ' GE' to enable segment retrieval
[Build Segment Key from Cargo CCN]
Building the segment key for database retrieval → The segment key CCN field should be populated with the cargo CCN key value
[Set Segment ID to '52']
Setting up the segment retrieval parameters → The segment ID should be set to '52' to identify the cargo segment type
[Set Segment Sequence to '0001']
Setting up segment retrieval parameters → The segment sequence should be set to '0001' to retrieve the first segment in sequence
[Execute Database Call to Get Segment]
Executing the database retrieval operation → The system should call the database interface to retrieve the cargo segment using the configured parameters
[Segment Found?]
The database status indicates segment not found (status 'GE') → The cargo segment structure should be initialized to empty values
[Set CCN Key from Cargo Record]
The system prepares the notification message → The CCN key from the cargo record should be included in the notification
[Call GCCS309C Module to Send Notification]
The system is ready to send the customs notification → The GCCS309C module should be called with the prepared notification parameters
[Get B1 Segment Configuration]
The system needs B1 segment configuration for extended broker services → The system should lookup B1 table segment using the same broker key and store the configuration if found, otherwise initialize empty B1 segment
[Send Internet Broker Notification]
The system processes cargo deletion notification for the broker → The system should initialize print input with cargo CCN key, security settings, and B1 segment internet address, then spawn internet print process
[Get Primary Broker Configuration]
The system needs to retrieve primary broker configuration → The system should set table function to GU, initialize key fields, set table ID to 'BK', use broker name from cargo, set Canadian flag to 'C', extract port from manifest code positions 2-3, and call table segment retrieval
[Use Default Port '000']
The table segment retrieval return flag is not successful → The system should retry with same broker name and Canadian flag but use default port '000' instead of manifest-derived port
[Get Additional Broker Config]
The system needs additional broker configuration details → The system should set table ID to 'B1', call table segment retrieval, and store additional configuration if found or initialize empty additional configuration if not found
[Store Broker Configuration]
Valid broker configuration data is returned from table segment retrieval → The system should move the table segment data to broker segment storage for further processing
[Is Delivery Schedule = IMMEDIATE?]
The broker delivery schedule is set to IMMEDIATE-DELIVERY → The broker is eligible to receive cargo deletion notifications
[Is Delivery Schedule = CONSIST?]
The broker delivery schedule is set to CONSIST-DELIVERY → The system requires additional validation of cargo train ID before allowing broker notification
[Allow Broker Notification]
The delivery schedule is DEFAULT, IMMEDIATE, or CONSIST with valid train ID → The system proceeds to send cargo deletion notifications to the broker through their configured communication channels
[Skip Broker Notification]
The delivery schedule is neither DEFAULT, IMMEDIATE, nor valid CONSIST delivery, or CONSIST delivery lacks required train ID → The system skips sending cargo deletion notifications to the broker and continues processing
[X12 Notification Enabled?]
The broker's X12 notification flag is set to 'Y' → The system sends an X12 EDI notification using the broker's X12 header configuration
[Secondary Broker X12 Enabled?]
The secondary broker's X12 notification flag is set to 'Y' → The system sends an X12 EDI notification using the secondary broker's X12 header configuration
[Send X12 EDI Notification]
The system processes the X12 notification request → The system calls the notification service with broker flag set and X12 broker header information
[Load Secondary Broker Configuration]
The broker configuration retrieval is successful → The system loads the broker configuration data into the working storage broker segment
[Load Additional Broker Details]
The supplementary broker details retrieval is successful → The system loads the additional broker details into the B1 segment for extended broker functionality
[Load Broker Segment Data]
The broker configuration search returns successful status → The system loads the table segment data into broker segment structure
[Search for B1 Table Configuration]
The system searches for B1 table configuration using table ID 'B1' and same broker parameters → The system attempts to locate B1 configuration entry for additional broker settings
[Load B1 Segment Data]
B1 configuration entry is found for the broker → The system loads B1 table segment data into B1 segment structure
[Allow Broker Notification]
The delivery schedule is default, immediate, or consist with valid train ID → The system continues with broker notification processing using the broker's preferred communication methods
[Skip Broker Notification]
The delivery schedule is not default, immediate, or consist without valid train ID → The system skips broker notification and continues with next processing step
[Send X12 EDI Notification to Broker]
The system calls the notification service with broker parameters → The system sends the X12 EDI notification to the configured broker
[Send Fax Notification via GCT0191E]
The system executes the fax notification transmission → The GCT0191E print service is invoked to send the fax notification to the broker
[Set Internet Address from Broker Config]
The system configures internet notification parameters → The system assigns the broker's internet address from the B1 segment configuration to the notification input internet field
[Get Secondary Broker B1 Segment]
The system attempts to retrieve B1 segment configuration using table ID 'B1' → B1 segment configuration is loaded if found, otherwise empty B1 segment is initialized
[Send Internet Notification to Secondary Broker]
The broker configuration indicates internet usage is enabled ('Y') → Internet notification is sent to the secondary broker using the B1 segment internet address
[Set Port from Manifest Code]
The system retrieves broker table segment using specific port from manifest transaction code positions 2-3 → The system should use the extracted port code to find port-specific broker configuration
[Use Default Port '000']
The broker table segment retrieval returns unsuccessful status → The system should retry the lookup using default port '000' instead of the specific port
[Get B1 Table Segment]
The system needs additional B1 table configuration for the broker → The system should retrieve B1 table segment using table ID 'B1' and the same broker key information
[Get B1 Segment for Secondary Broker]
The system retrieves B1 table segment using the same broker identification → B1 segment data is loaded if available, otherwise B1 segment is initialized as empty
[Validate Secondary Broker Delivery Schedule]
The system validates the broker's delivery schedule → Notifications proceed if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, or if delivery schedule is CONSIST-DELIVERY and Canadian customs north train ID is not empty, otherwise secondary broker processing is terminated
[Send Internet Notification to Secondary Broker]
The broker configuration indicates internet usage is enabled ('Y') → Internet notification is initiated using the B1 segment internet address and cargo CCN key
[Secondary Broker Delivery Schedule = DEFAULT or IMMEDIATE?]
The secondary broker delivery schedule is either DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → The system allows secondary broker notification to proceed
[Secondary Broker Delivery Schedule = CONSIST?]
The secondary broker delivery schedule is CONSIST-DELIVERY → The system proceeds to validate train ID presence for consist delivery eligibility
[Allow Secondary Broker Notification]
Either default/immediate delivery is configured:
consist delivery with valid train ID is present
→ The system continues with secondary broker notification process
[Skip Secondary Broker Notification]
Delivery schedule is neither default/immediate NOR consist delivery with valid train ID → The system skips secondary broker notification and ends the secondary broker processing
[Display Shutdown Message]
Processing the shutdown request → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036' is displayed to the console
[Log Shutdown Request]
Logging the shutdown event → The shutdown request message is logged through the CERR error handling routine
[Display Shutdown Message to Console]
The system needs to notify operators of the shutdown → Display the message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036' to the console
[Display Shutdown Message]
The system begins emergency shutdown procedures → The system should display 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036' message to the console
[Emergency Close Checkpoint File]
The system is performing emergency cleanup → The checkpoint file should be closed immediately
[Emergency Close Report File]
The system continues emergency cleanup procedures → The report file should be closed immediately
[Emergency Terminate Program]
The IMS shutdown processing is finalized → The program should terminate execution immediately and return control to the operating system

Structural Validations

[17:Validate Broker Delivery Schedule]
Delivery schedule validation is performed → Accept default delivery or immediate delivery schedules, or accept consist delivery only if Canadian customs north train ID is not spaces, otherwise skip broker notification
[Display Invalid Checkpoint Message]
The system detects an invalid checkpoint condition → The system displays 'INVALID CHECKPOINT - DEFAULT TO 500' message to the console
[Display Invalid Checkpoint Message]
The system detects invalid checkpoint data format → The system displays 'INVALID CHECKPOINT - DEFAULT TO 500' message to the console
[Validate Broker Delivery Schedule]
The system needs to determine if broker should be notified of cargo deletion → The system should allow notification if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, or if delivery schedule is CONSIST-DELIVERY and Canadian customs north train ID is present
[Validate Secondary Broker Delivery Schedule]
If the broker's delivery schedule setting → Processing continues if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, or if delivery schedule is CONSIST-DELIVERY and Canadian customs north train ID is present, otherwise secondary broker processing ends
[Set Error Message in CCCOM]
The system needs to record the shutdown reason in the communication area → Set the error message field to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036'
[Call Error Handler]
The system needs to process the shutdown error condition → Call the 'CERR' error handling routine with the communication area
[Log Error Message]
The system is processing the emergency shutdown → The system should move the shutdown message to the error message field and call the error logging module

Module: GCX036A 1 Consolidated Epic Story

Epic: GCX036A Complete EDI Specification Extracted from Legacy

Contains 103 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX036A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The system initializes → The system displays the compilation date, opens input files for checkpoint and notification data, clears previous MERLIN ID, initializes message text areas, and sets MERLIN counter to 3
[Initialize Message Text Structure]
Message structure initialization occurs → The message text area is cleared and set to spaces
[Initialize New Message Destination]
The system needs to prepare for new message accumulation → The system clears message areas, sets the message label in line 1, and sets the separator in line 2
[Initialize Communication Interface]
The message send process is initiated → The communication interface is initialized by calling CCISCOM
[Initialize New Message Page]
The system needs to prepare for new message content → The system should initialize a new message destination structure with cleared content areas
[Initialize Communication Interface]
The system begins message transmission process → The communication interface is initialized by calling CCISCOM module

Core Acceptance Criteria

[5:Handle User ID Changes]
The system processes the user ID change → If user ID is invalid, set previous MERLIN to 'OM01247' and display not found message; if valid, set previous MERLIN to current notification ID; if existing message batch has content, send current batch and initialize new destination; set new batch with previous MERLIN as recipient, reset MERLIN counter to 3 and sequence to 0
[6:Manage Message Pagination]
The MERLIN counter exceeds 699 lines → Send current MERLIN message batch, reset MERLIN counter to 3, initialize new destination, and set previous MERLIN as recipient for new batch
[7:Format Cargo Report Data]
The system formats the data → Move notification data to message text line at current MERLIN counter position and increment MERLIN counter by 1
[8:Log Cargo Entry]
The system creates the log entry → Initialize log input areas, set security byte to high value, set sending transaction to 'GCX036A', capture user ID, format current date and time, set action code to 'ZZZ', include train CCN number, set message to 'CARGO NOT REPORTED ON A TRAIN WITHIN 21 DAYS', and spawn GCT1051E transaction for logging
[9:Send Merlin Messages]
The system sends the MERLIN message → Increment message sequence number; if recipient is 'OM01247' set destination to 'GT21DAYS' and clear copy usercode, otherwise set destination to 'IN'; call EMCSEND with message parameters; if send fails, log error message; increment checkpoint call counter
[Set Initial Message Line Counter to 3]
Message counter initialization occurs → The Merlin message line counter is set to 3 to account for header lines
[Display Invalid Checkpoint Message]
The system sets default checkpoint number due to empty file → The message 'INVALID CHECKPOINT - DEFAULT TO 500' is displayed
[Display Final Checkpoint Number]
The checkpoint processing is complete → The message 'GCX036A CHECKPOINTING AT [checkpoint-number]' is displayed
[Set Default User ID to OM01247]
The system needs to assign a valid user ID for message processing → The system sets the user ID to the default value 'OM01247'
[Display User Not Found Message]
The system sets the default user ID → The system displays a console message indicating the user ID was not found
[User ID Validation Complete]
Either a valid user ID has been confirmed or a default user ID has been assigned → The system proceeds with the validated user ID for subsequent message processing
[Query Merlin Database for User ID - Execute database lookup to verify user existence and retrieve user details]
The system executes a database lookup using the MAN-NOTIFY as the search key in the EMTZ segment → The system sets the database status to indicate whether the user was found or not found
[Set Status: User Not Found]
The database status code != SPACE (indicating user not found) → The system assigns 'OM01247' as the default user ID to PREV-MERLIN and displays an error message
[Set Status: User Exists]
The database status code equals SPACE (indicating user found) → The system assigns the MAN-NOTIFY value to PREV-MERLIN for subsequent message routing
[Set Default User ID to OM01247]
The database lookup returns a status indicating the user ID was not found → The system sets the previous Merlin user ID to the default value 'OM01247' and displays an error message
[Accumulated Messages Exist?]
The system checks if the third message line (EMI-TEXT-LINES(3)) contains any data → The system determines whether accumulated messages exist that need to be sent
[Send Current Message Batch]
A user ID change is detected → The system calls the message sending routine (X200-SEND-MERLIN) to deliver the current batch of messages
[Set New User as Message Recipient]
The system initializes a new message destination → The system sets the previous Merlin user ID as the first recipient in the user codes array (EMI-TO-USERCODES(1))
[Reset Message Counter to 3]
The message destination has been set up with headers in lines 1 and 2 → The system sets the Merlin counter (MERLIN-CNT) to 3 to begin adding message content from the third line
[Reset Message Sequence to 0]
The message counter has been reset to 3 → The system sets the message sequence (EMI-SEQ) to 0 to start numbering from the beginning for this recipient
[Increment Message Sequence Number]
The send message batch process is initiated → The system increments the EMI sequence number by 1
[Is User ID 'OM01247'?]
The recipient user ID is 'OM01247' → The system sets the destination filename to 'GT21DAYS' and clears the copy user code
[Set Destination to 'IN' File]
The recipient user ID is not 'OM01247' → The system sets the destination filename to 'IN'
[Execute Message Send via EMCSEND]
The message send process is executed → The system calls EMCSEND with the configured message parameters
[Update Checkpoint Counter]
The message send operation completes → The system increments the checkpoint call counter by 1
[Increment Message Sequence Number]
The message transmission process begins → The message sequence number is incremented by 1
[Check Destination User]
If the destination user code → If the user code is 'OM01247', route to GT21DAYS destination file and clear copy user code, otherwise route to IN destination file
[Call EMCSEND Module with Parameters]
The system calls the EMCSEND module → The message is transmitted using the provided parameters through the external messaging service
[Update Checkpoint Counter]
The message send operation completes → Increment the checkpoint call counter by 1
[Send Current Message Batch]
The system needs to send the current batch → The system should invoke the MERLIN message sending process to transmit the current batch
[Reset Line Counter to 3]
The system prepares for the next message batch → The message line counter should be reset to 3 to reserve space for message headers
[Set Destination User Code]
The system sets up the destination for the new batch → The system should assign the same previous MERLIN user code to maintain recipient continuity
[Add Formatted Data to Message Text Line]
The system processes the notification record for message formatting → The complete NOTIN-DATA is moved to the message text line at the position specified by MERLIN-CNT
[Increment Message Line Counter]
The data formatting is complete → The message line counter (MERLIN-CNT) is incremented by 1
[Add Cargo Control Number]
Cargo identification is required in the audit log → The message cargo control number (MSG-CCN) is recorded in the train or US CCN field
[Set Message: 'CARGO NOT REPORTED ON A TRAIN WITHIN 21 DAYS']
The audit message needs to be set → Message is set to 'CARGO NOT REPORTED ON A TRAIN WITHIN 21 DAYS'
[Prepare GCT1051E Transaction Data]
Data needs to be prepared for the logging transaction → The audit log input structure is moved to the GCT1051E message format
[Calculate Message Length]
Message length calculation is required → Communication length is calculated as message length plus 4, and call data length includes header plus message length
[Set Cargo Control Number]
The transaction log entry is being prepared → The system copies the message cargo control number to the transaction train or US CCN field
[Set Message: CARGO NOT REPORTED ON A TRAIN WITHIN 21 DAYS]
The message text needs to be set → The system sets the message to 'CARGO NOT REPORTED ON A TRAIN WITHIN 21 DAYS'
[Configure Transaction Parameters]
External transaction parameters need to be configured → The system sets the transaction name to 'GCT1051E', calculates the communication length as message length plus 4, moves the message data to communication area, and computes the call data length as header length plus message length
[Set Cargo Control Number]
The cargo identifier needs to be recorded → The message CCN is recorded as the train or US CCN in the transaction log
[Set Message: CARGO NOT REPORTED ON A TRAIN WITHIN 21 DAYS]
A warning message needs to be generated → The message text is set to 'CARGO NOT REPORTED ON A TRAIN WITHIN 21 DAYS'
[Increment Message Sequence Number]
The send Merlin process is initiated → The message sequence number is incremented by 1
[Is Recipient OM01247?]
The recipient user code is OM01247 → The message destination is set to GT21DAYS file and copy user code is cleared
[Set Destination to IN File]
The recipient user code is not OM01247 → The message destination is set to IN file
[Call EMCSEND Module to Transmit Message]
The message transmission is requested → The EMCSEND module is called with message parameters including destination, recipient, subject, and message content
[Increment Checkpoint Counter]
The message has been processed regardless of send success or failure → The checkpoint counter is incremented by 1
[Increment Message Sequence Number]
The system processes the message for sending → The message sequence number is incremented by 1
[Is Destination User OM01247?]
If the destination user code → If the user code equals 'OM01247', route to GT21DAYS destination file, otherwise route to IN destination file
[Set Destination to GT21DAYS File]
The system configures message destination → The destination filename is set to 'GT21DAYS'
[Clear Copy User Code]
The system configures message parameters → The copy user code field is cleared to spaces
[Set Destination to IN File]
The system configures message destination → The destination filename is set to 'IN'
[Call EMCSEND Module with Parameters]
The system executes message transmission → The EMCSEND module is called with communication interface, from user code, destination filename, to user code, copy user code, subject, keywords, text, and return status flag parameters
[Increment Checkpoint Counter]
The system completes message transmission processing → The checkpoint call counter is incremented by 1
[Set Message Sequence Number]
The system prepares to transmit the message → The message sequence number is incremented by 1
[Is Destination User OM01247?]
The destination user code is OM01247 → The message destination is set to GT21DAYS file
[Set Destination to IN File]
The destination user code is not OM01247 → The message destination is set to IN file
[Clear Copy User Code]
The destination user code is OM01247 → The copy user code is cleared to spaces
[Call EMCSEND with All Parameters]
The system needs to transmit the message → EMCSEND module is called with from user code, destination filename, to user code, copy user code, subject, keywords, text, and return status parameters
[Increment Checkpoint Counter]
The EMCSEND call finishes regardless of success or failure → The checkpoint call counter is incremented by 1
[Set Destination to 'GT21DAYS']
The recipient user code is 'OM01247' → The message destination is set to 'GT21DAYS'
[Clear Copy User Code]
The destination has been set to GT21DAYS → The copy user code field is cleared to spaces
[Set Destination to 'IN']
The recipient user code is not 'OM01247' → The message destination is set to 'IN'
[Send Message to Designated Destination]
The message send operation is initiated → The message is transmitted to the designated destination file using EMCSEND service
[Log Send Failure]
The message send operation does not return a successful status → The failure status is logged as an error message for tracking
[Display Shutdown Message]
The shutdown request is processed → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036A' is displayed on the console
[Log Shutdown Request]
Error logging is performed → The shutdown request message is moved to the error message field and CERR program is called for logging
[Display Shutdown Message]
The system processes the shutdown request → The system displays 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036A' message to console
[Log Shutdown Request]
The system processes the shutdown logging → The system moves shutdown message to error message field and calls error logging routine
[Clear Message Structure Fields]
The message structure initialization process begins → All user code fields, message text areas, and status flags are cleared to spaces
[Set Column Labels Header]
Message headers are being initialized → The predefined column label format is placed in message line 1
[Set Separator Line]
Message formatting continues after header placement → The predefined separator line format is placed in message line 2
[Log Send Failure]
The system needs to log the send failure → The system calls the CERR program with the common communication area to log the error
[Continue Processing]
The system continues with normal processing flow → The system increments the CHKP-CALL counter by 1 to track the number of checkpoint calls made
[Check for Final Messages]
The system checks if EMI-TEXT-LINES position 3 contains any message content → If messages exist in the buffer, the system sends the final message batch via MERLIN before proceeding with termination
[IMS Shutdown Request Received]
The system receives an IMS shutdown request indicated by status code 'XD' → The system initiates emergency shutdown procedures including displaying shutdown message, logging error, and closing files
[Display Shutdown Message]
The system processes the shutdown request → A shutdown notification message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036A' is displayed to the console
[Emergency Close Checkpoint File]
The system performs emergency file closure operations → The checkpoint file is immediately closed as part of emergency shutdown procedure
[Emergency Close Not-In-Canada File]
The system continues emergency file closure operations → The not-in-Canada notification file is immediately closed as part of emergency shutdown procedure

Structural Validations

[2:Process Checkpoint File]
The system processes the checkpoint file → If the file is empty or at end, set checkpoint number to 500 and mark as invalid; if checkpoint data is numeric, use that value as checkpoint number; otherwise default to 500 and display invalid checkpoint message
[4:Validate Merlin User ID]
The system performs user ID lookup in EMTZ segment → If the lookup returns a status code other than space, the user ID is considered invalid; otherwise the user ID is valid
[Display Invalid Checkpoint Message]
The system sets default checkpoint number due to invalid format → The message 'INVALID CHECKPOINT - DEFAULT TO 500' is displayed
[Accept Current User ID]
The database query returns a successful status → The system accepts the current notification user ID as valid for message processing
[Validate New User ID in Merlin Database]
The system performs a lookup in the EMTZ segment using the notification user ID as the key → The system determines if the user ID exists in the database based on the status code returned
[Log Send Failure Error]
The message send operation returns a failure status → The system logs the failure error message and calls error handling routine
[Log Send Failure Error]
The transmission return status indicates failure (not SUCCESSFUL) → Log the failure status as an error message and call error handling routine
[Check Message Line Count]
The message line counter exceeds 699 lines → The system should trigger the current batch to be sent before adding more content
[Log Send Failure Error]
The message send status indicates failure → The failure status is logged as an error message and error handling is invoked
[Message Send Successful?]
If the transmission result → If the return status flag is not equal to SUCCESSFUL, the transmission failed, otherwise it succeeded
[Log Send Failure Error]
The system processes the transmission failure → The return status flag is moved to error message code, the error message is set, and the CERR module is called for error logging
[Message Send Successful?]
The transmission attempt is completed → The system checks if the return status flag indicates successful transmission
[Log Send Failure Error]
The return status flag does not indicate successful transmission → The system logs the failure status code as an error message and calls error handling routine
[Send Status Check]
The system checks the EMI-RETURN-STATUS-FLAG after the send operation → The system determines if the send was successful or failed based on the return status flag value
[Capture Error Code]
The EMI-RETURN-STATUS-FLAG indicates failure (not equal to SUCCESSFUL) → The system captures the error code from EMI-RETURN-STATUS-FLAG into CERR-MSG1-CODE for error processing
[Format Error Message]
The system needs to format the error for logging → The system moves the formatted error message (CERR-MSG1) to the common communication area error message field (CC-ERROR-MESSAGE OF CCCOM)
[Log Shutdown Error]
The system processes the shutdown error logging → The shutdown message is logged as an error condition using the error handling routine

Module: GCX036B 1 Consolidated Epic Story

Epic: GCX036B Complete EDI Specification Extracted from Legacy

Contains 199 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX036B EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Sequence Number to Zero]
The system begins creating transmission records → The sequence number counter is set to zero
[Initialize Transmission Line]
Starting to create a new N9 segment record → The transmission line workspace should be cleared to spaces
[Initialize Transmission Line]
The system prepares to build the shipper N1 segment → The transmission line workspace is cleared to spaces
[Initialize N1 Transmission Line]
The system needs to create a new N1 segment for consignee data → The transmission line workspace is cleared and prepared for new data
[Initialize Transmission Line]
The system begins building the R4 origin station segment → The transmission line workspace should be cleared to spaces
[Initialize L0 Transmission Line]
The system begins creating the L0 transmission segment → The transmission line workspace is cleared to spaces to ensure clean data structure
[Initialize Transmission Line]
Preparing to create transmission record → System should clear the transmission line to spaces

Core Acceptance Criteria

[Original Sent Exists?]
Checking for transmission requirement → If original sent field is not spaces, proceed with transmission creation, otherwise check checkpoint threshold
[10:Generate Transmission Number]
Generating transmission number → Retrieve current transmission number from control table 11, increment by 1, and update the control table
[11:Create Transmission Root]
Creating the transmission root → Insert a new transmission root record with the generated transmission number
[12:Create Transaction Header]
Creating the transaction header → Create B2A segment with transaction code 'B2A', action code '03', application type from cargo report, and financial code '6105A8A'
[13:Create Cargo Control Number Record]
Creating cargo control number record → Create N9 segment with transaction code 'N9', CCN code 'XC', and cargo control number as the reference value
[14:Create Shipper Information]
Creating shipper information → Create N1 segment with transaction code 'N1', entity code 'SH', and shipper name from cargo report
[15:Create Shipper Address Line 1]
Creating shipper address line 1 → Create N3 segment with transaction code 'N3' and shipper address line 1 from cargo report
[16:Create Shipper Address Line 2]
Creating shipper address line 2 → Create N4 segment with transaction code 'N4', shipper address line 2, extracted province/state, and shipper country code
[17:Create Consignee Information]
Creating consignee information → Create N1 segment with transaction code 'N1', entity code 'CN', and consignee name from cargo report
[19:Create Consignee Address Line 1]
Creating consignee address line 1 → Create N3 segment with transaction code 'N3' and consignee address line 1 from cargo report
[20:Create Consignee Address Line 2]
Creating consignee address line 2 → Create N4 segment with transaction code 'N4', consignee address line 2, extracted province/state, and consignee country code
[21:Create Railroad Information]
Creating railroad information → Create N1 segment with transaction code 'N1', entity code 'RR', and railroad name 'CP RAIL SYSTEM'
[22:Create Railroad Address Line 1]
Creating railroad address line 1 → Create N3 segment with transaction code 'N3' and address 'WINDSOR STATION'
[23:Create Railroad Address Line 2]
Creating railroad address line 2 → Create N4 segment with transaction code 'N4', city 'MONTREAL', province 'PQ', and country 'CA'
[Notify Party Exists?]
Checking for notify party → If notify party name is not spaces, create notify party segments, otherwise proceed to origin station information
[24:Create Notify Party Information]
Creating notify party information → Create N1 segment with entity code 'NP' and notify party name, N3 segment with notify party address line 1, and N4 segment with notify party address line 2, province/state, and country code
[25:Create Origin Station Information]
Creating origin station information → Create R4 segment with station code 'OSC', origin station name, origin station state code, and country code 'US' (or 'CA' if in-transit status is 'R')
[26:Create Manifest From Code]
Creating manifest from code → Create R4 segment with manifest code '3CD' and manifest from transportation code from cargo report
[27:Create Manifest To Code]
Creating manifest to code → Create R4 segment with manifest code '4CD' and manifest to transportation code from cargo report
[28:Create Destination Station Information]
Creating destination station information → Create R4 segment with station code 'ESC', destination station name, and destination station state code
[29:Create Equipment Information]
Creating equipment information → Create ED segment with equipment car initial and number (or 'NONZ' and '00000000' if conveying car initial is spaces), load/empty status, waybill number, and waybill date
[30:Create Weight Information]
Creating weight information → Create L0 segment with weight code '1', weight value, gross indicator 'G', lading quantity, lading quantity qualifier, and weight unit qualifier
[31:Create Lading Description Records]
Creating lading description records → For each of the 8 lading description data fields that is not spaces, create L5 segment with description code '1' and the description text
[32:Create Shipper Load Count]
Creating shipper load count → Create L5 segment with description code '1' and shipper load and count from cargo report
[33:Create Equipment Car Record]
Creating equipment car record → Create K1 segment with equipment car information, program code '11', and last update date (using last modify date if delete status exists, otherwise creation date)
[34:Update Control Table]
Updating control table → Replace the control table 11 record with the incremented transmission number
[36:Handle IMS Shutdown]
Handling shutdown request → Display shutdown message, log error message, close all files, and terminate program
[Move Cargo Control Number from Input Message to Database Key]
The system needs to retrieve cargo report data → The cargo control number from the input message is moved to the database key field for cargo report lookup
[Call Database to Get Cargo Report Segment]
The system executes the cargo report retrieval → The database is called to get the cargo report segment using the specified key
[Original Sent Data Exists?]
The system checks the original sent field of the cargo report → If the original sent field is not empty, the system proceeds to create an EDI transmission, otherwise the deletion process ends
[Create EDI Transmission]
The original sent data check confirms data exists → An EDI transmission is created with complete shipment details including shipper, consignee, equipment, and cargo information
[Replace cargo report segment in database with updated deletion information]
The system executes the database update operation to replace the cargo report segment → The cargo report segment in the database is replaced with the updated information containing the deletion status and audit trail
[Setup Control Table Access Parameters]
Setting up control table access parameters → Function code is set to GHU, key values are cleared, and flags are initialized to spaces
[Set Table ID to '11' for Transmission Control]
Identifying the transmission control table → Table ID is set to '11' and sequence ID is set to spaces
[Retrieve Control Table Segment]
Retrieving the control table segment → The table segment access function is performed and return status is captured
[Load Control Table Data]
Loading the control table data → Table segment data is moved to the transmission control structure
[Increment Transmission Number by 1]
Generating the next transmission number → The transmission number is incremented by 1
[Prepare Updated Control Table Data]
Preparing the updated control table data → Control table segment is moved to working storage for update operation
[Update Control Table with New Number]
Updating the control table → Function code is set to REPL and table segment update is performed
[Get Next Transmission Number from Control Table]
The system needs to create a new transmission → The system retrieves the current transmission number from control table '11', increments it by 1, and updates the control table with the new value
[Set Transmission Number in Root Segment]
Creating a transmission root segment → The system sets the transmission number in the root segment and initializes the read and delete flag to spaces
[Clear Accept Status]
Before performing the database insert operation → The system clears the accept status field to spaces
[Insert Transmission Root Segment to Database]
The system needs to create the transmission record → The system inserts the transmission root segment into the transmission database using the transmission PCB
[Clear Transaction Line]
The system prepares to build transaction data → The transaction line buffer is cleared to spaces
[Increment Sequence Number by 1]
The system needs to assign a sequence number → The sequence number is incremented by 1
[Set Sequence Number in Transmission]
The system builds the transmission record → The current sequence number is assigned to the transmission record
[Set Transaction Code to 'B2A']
The system builds the transaction header → The transaction code is set to 'B2A'
[Move Transaction Line to Transmission Data]
The system prepares to store the transmission record → The transaction line data is moved to the transmission data field
[Clear Accept Status]
The system prepares to call the transmission creation function → The accept status field is cleared to spaces
[Create Transmission Department Record]
The system needs to store the transmission record → The transmission department creation function is called to create the record
[Increment Sequence Number]
Creating a new transmission record → The sequence number should be incremented by 1
[Set Sequence Number in Transmission]
Building a transmission record → The sequence number should be assigned to the transmission record sequence field
[Set Transaction Code to 'N9']
Creating an N9 segment → The transaction code should be set to 'N9'
[Set Qualifier Code to 'XC']
Setting the reference qualifier → The qualifier code should be set to 'XC' to indicate Cargo Control Number
[Set Cargo Control Number Value]
Creating the N9 reference segment → The cargo control number key should be assigned to the reference value field
[Move Data to Transmission Record]
Finalizing the transmission record → The formatted transmission line should be moved to the transmission data field
[Clear Accept Status]
Preparing to create the transmission department record → The accept status should be cleared to spaces
[Create Transmission Department Record]
Storing the transmission record → The transmission department creation process should be invoked
[Increment Sequence Number]
The system processes the shipper information segment → The sequence number is incremented by 1
[Set Sequence Number in Transmission]
Building the transmission segment → The current sequence number is assigned to the transmission record sequence field
[Set Transaction Code to N1]
Setting up the transmission line structure → The transaction code is set to 'N1' to indicate entity information
[Set Qualifier Code to SH for Shipper]
Setting the entity qualifier → The qualifier code is set to 'SH' to identify the entity as the shipper
[Get Shipper Name from Cargo Report]
Building the shipper N1 segment → The shipper name is extracted from the cargo report shipper name field
[Build Complete Transmission Line]
Creating the transmission line → The complete transmission line is built with the formatted shipper information
[Set Accept Status]
Preparing to create the transmission detail record → The accept status is set to spaces
[Create Transmission Detail Record]
Creating the transmission detail record → The shipper information is inserted as a transmission detail record via Z410-CREAT-TRANS-DEPT
[Create Shipper Address Line 1 - Generate N3 segment with shipper address line 1]
The system processes the shipper address information for transmission → An N3 segment is created with the shipper's address line 1, sequence number is incremented, transaction code is set to 'N3', and the transmission department record is generated
[Clear Transmission Line]
Creating shipper address line 2 segment → The transmission line workspace must be cleared to spaces
[Increment Sequence Number]
Creating shipper address line 2 segment → The sequence number must be incremented by 1 and assigned to the transmission segment
[Set N4 Transaction Code]
Creating shipper address line 2 segment → The transaction code must be set to 'N4'
[Move Shipper Address 2 to Value Field]
Creating shipper address line 2 segment → The shipper address line 2 must be moved to the transmission address value field
[Parse Address for State/Province]
Creating shipper address line 2 segment → The address line 2 must be parsed to extract state or province code
[Extract State/Province Code]
Building the N4 transmission segment → The state or province code must be extracted and assigned to the transmission state field
[Set Shipper Country Code]
Creating shipper address line 2 segment → The shipper country code must be moved to the transmission country code field
[Build Complete N4 Transmission Line]
Creating shipper address line 2 segment → The complete transmission line must be moved to the transmission data field
[Create N4 Segment in Database]
Creating shipper address line 2 segment → The N4 segment must be created in the transmission database through the Z410-CREAT-TRANS-DEPT procedure
[Set Sequence Number]
The system needs to assign a sequence number to the segment → The sequence number is incremented by 1 and assigned to the transmission segment
[Set N1 Segment Code]
The system needs to identify the segment type → The segment code is set to 'N1' to indicate name/address information
[Set CN Qualifier Code]
The system needs to specify the party type → The qualifier code is set to 'CN' to indicate consignee
[Set Consignee Name]
The system needs to populate the consignee name field → The consignee name from the cargo report is copied to the transmission segment
[Setup Automotive Table Lookup]
The system needs to lookup automotive classification → The table lookup function is set to GHU and workspace areas are cleared for the lookup operation
[Use Retrieved Automotive Segment]
The lookup return flag indicates successful retrieval → The retrieved table segment data is moved to the automotive segment workspace
[Set Default Automotive Type Code]
The system needs to set the automotive type code → The automotive type code is set from the default automotive segment data
[Store Transmission Data]
The system needs to store the transmission data → The transmission line data is moved to the transmission data field and accept status is cleared
[Create Transmission Segment]
The system needs to create the transmission segment → The transmission department creation process is performed to store the consignee N1 segment
[Set Table ID to 'AU']
The system needs to determine automotive classification for transmission creation → The system sets the table identifier to 'AU' for automotive table lookup
[Call Table Lookup Function]
The system executes the table lookup → The system calls the table segment retrieval function to get automotive data
[Retrieve Automotive Segment Data]
The system processes the retrieved data → The system moves the table segment data to the automotive segment structure
[Set Automotive Type from Table]
The system processes the automotive classification → The system assigns the automotive type from the table data to the transmission automotive code
[Retrieve Automotive Table Data - Get automotive type information from table using consignee CHOP and commodity code]
The system needs to determine automotive type information for transmission creation → The system retrieves automotive table data using the consignee CHOP and commodity code as lookup keys
[Move Table Segment to Automotive Segment]
The table retrieval is successful → The system moves the retrieved table segment data to the automotive segment structure for further processing
[Create Consignee Address Line 1 - Generate N3 segment with consignee address line 1]
The system processes the consignee address information for transmission → An N3 segment is created with the consignee address line 1 data, assigned the next sequence number, and added to the transmission record
[Clear transmission line workspace]
The system begins building the transmission line → The transmission line workspace is cleared to spaces
[Increment sequence number]
A new segment is being added to the transmission → The sequence number is incremented by 1
[Set segment type to 'N3']
The segment type needs to be identified → The transmission code is set to 'N3'
[Move consignee address line 1 to transmission info]
The N3 segment is being populated with address information → The consignee address line 1 is moved to the transmission info field
[Create transmission department record]
The segment needs to be persisted in the transmission system → A transmission department record is created with the segment data
[Clear Transmission Line]
Starting to build the consignee address line 2 segment → The transmission line workspace should be cleared to spaces
[Increment Sequence Number]
Creating the consignee address line 2 segment → The sequence number should be incremented by 1 and assigned to the transmission sequence number
[Set N4 Segment Code]
Building the N4 segment for consignee address → The transmission code should be set to 'N4'
[Move Consignee Address Line 2 to Value Field]
Building the N4 transmission segment for consignee address → The consignee address line 2 should be moved to the transmission address value field
[Parse Address for State/Province]
Processing the consignee address for transmission → The address line 2 should be moved to the address parsing workspace for state/province extraction
[Extract State/Province from Address]
Building the N4 transmission segment → The state/province code should be extracted and moved to the transmission address state field
[Set Consignee Country Code]
Building the N4 transmission segment for consignee address → The consignee country code should be moved to the transmission address country code field
[Build Complete N4 Transmission Line]
Finalizing the N4 segment for consignee address → The complete transmission line should be moved to the transmission data field
[Create N4 Segment in Transmission]
Creating the transmission segment → The transmission department creation process should be performed to store the N4 segment
[Create Railroad Information - Generate N1 segment with RR qualifier for CP Rail System]
The system needs to include railroad information in the transmission → Create an N1 segment with RR qualifier containing CP Rail System as the railroad name
[Clear transmission line workspace]
Starting to build railroad information transmission data → Initialize the transmission line workspace to spaces
[Increment sequence number]
Adding a new railroad information segment → Increment the sequence number by 1 to maintain proper ordering
[Set transaction code to 'N1']
Setting up the transmission record structure → Set the transaction code to 'N1' to indicate name/address information
[Set qualifier code to 'RR' for Railroad]
Identifying the type of entity being described → Set the qualifier code to 'RR' to indicate railroad entity type
[Set railroad name to 'CP RAIL SYSTEM']
Setting the railroad company name → Use 'CP RAIL SYSTEM' as the standard railroad name value
[Create transmission department record]
The transmission line is ready to be stored → Create a transmission department record with the railroad information data
[Create Railroad Address Line 1 - Generate N3 segment with Windsor Station address]
The system needs to add the railroad's address line 1 to the transmission → The system should clear the transmission line, increment the sequence number, set the segment type to 'N3', populate the address with 'WINDSOR STATION', format the transmission line, clear the accept status, and create the transmission department segment
[Create Railroad Address Line 2 - Generate N4 segment with Montreal, PQ, CA location]
The system needs to create the N4 address segment for CP Rail System → The system should initialize a new transmission line, increment the sequence number, set transaction code to N4, populate city as MONTREAL, province as PQ, country code as CA, and create the transmission segment
[Create N1 Segment with NP Qualifier]
The system processes notify party information → The system should create an N1 segment with NP qualifier code and set the notify party name as the value
[Create N3 Segment]
The system processes notify party address information → The system should create an N3 segment and populate it with notify party address line 1 data
[Parse Address Line 2]
The system processes the address line 2 field → The system should parse the address to extract state/province information and use the notify party country code
[Create N4 Segment]
The system creates the N4 address segment → The system should create an N4 segment with notify party address line 2 as city, parsed state/province, and notify party country code
[Skip Notify Party Creation]
If notify party information → The system should skip all notify party segment creation and continue to the next transmission process
[Check Notify Party Name]
The system checks if notify party name field contains data → The system conditionally processes notify party address segments only if notify party name is not empty
[Create N1 Segment with NP Qualifier]
The system creates notify party transmission segments → The system creates N1 segment with 'NP' qualifier and assigns notify party name to the segment value
[Create N3 Segment]
The system processes notify party address information → The system creates N3 segment and populates it with notify party address line 1 data
[Create N4 Segment]
The system processes notify party geographic information → The system creates N4 segment, populates address line 2, parses the address for state/province information, and sets the notify party country code
[Increment Sequence Number]
The origin station R4 segment is being built → The sequence number should be incremented by 1 and assigned to the transmission segment
[Set R4 Transaction Code]
The transmission record type needs to be specified → The transaction code should be set to 'R4'
[Set OSC Station Qualifier]
The station qualifier needs to be specified for origin station → The station code qualifier should be set to 'OSC'
[Set Origin Station Name]
Building the R4 origin station segment → The origin station name from the cargo report should be copied to the transmission station name field
[Set Origin Station State Code]
Building the R4 origin station segment → The origin station state code from the cargo report should be copied to the transmission station state code field
[Set Default Country Code to US]
The country code needs to be determined → The station country code should be set to 'US' as the default
[In-Transit Status = 'R'?]
The cargo in-transit status is 'R' (indicating Canadian transit) → The station country code should be changed from 'US' to 'CA'
[Prepare Transmission Data]
The segment is ready to be transmitted → The transmission line should be copied to the transmission data field
[Create Transmission Department Record]
The R4 origin station segment needs to be stored → The system should create a transmission department record through the Z410 process
[Create Manifest From Code - Generate R4 segment with 3CD qualifier and manifest from transportation code]
Creating transmission segments for cargo deletion notification → An R4 segment is created with segment type 'R4', qualifier '3CD', and the manifest from transportation code from the cargo report
[Clear transmission line workspace]
Starting to build a new transmission line → The transmission line workspace is cleared to spaces
[Increment sequence number]
Building transmission data → The sequence number is incremented by 1
[Set segment type to 'R4']
Building the transmission line → The segment type is set to 'R4'
[Set qualifier to '3CD']
Building the transmission line → The qualifier is set to '3CD'
[Create transmission department segment]
The transmission data is ready to be stored → The transmission department segment is created with the transmission data
[Create Manifest To Code - Generate R4 segment with 4CD qualifier and manifest to transportation code]
The system processes the manifest to transportation code segment creation → The system should clear the transmission line, increment the sequence number, set the transmission sequence number, set segment type to 'R4', set qualifier to '4CD', retrieve the manifest to transportation code from the cargo report, build the transmission line with the manifest code data, and create the transmission segment
[Create Destination Station Information - Generate R4 segment with ESC qualifier and destination station details]
The system processes destination station information for transmission creation → The system creates an R4 segment with ESC qualifier code AND populates destination station name AND populates destination station state code AND increments the sequence number AND creates the transmission segment
[Use Equipment Car Initial from Cargo Report]
The conveying car initial field contains valid data (not empty or spaces) → The system uses the equipment car initial and equipment car number from the cargo report record
[Set Load/Empty Status from Cargo Report]
Equipment information is being compiled for the ED segment → The system assigns the load/empty status from the cargo report to the transmission record
[Set Waybill Number from Cargo Report]
Equipment information is being compiled for the ED segment → The system assigns the waybill number and waybill date from the cargo report to the transmission record
[Set Default Equipment Initial to 'NONZ']
The conveying car initial field is empty or contains spaces → The system sets equipment initial to 'NONZ' and equipment number to '00000000'
[Use Equipment Car Initial from Cargo Report]
The conveying car initial field contains valid data (not empty or spaces) → The system uses the equipment car initial and equipment car number from the cargo report
[Set Load/Empty Status from Cargo Report]
Processing equipment information for transmission → The system assigns load/empty status, waybill number, and waybill date from the cargo report data
[Create Weight Information - Generate L0 segment with weight, lading quantity, and unit qualifiers]
The system processes weight information for transmission creation → An L0 segment is created with transaction code 'L0', weight code '1', weight from cargo report, unit qualifier 'G', lading quantity from cargo report, lading quantity qualifier from cargo report, and weight unit qualifier from cargo report
[Set Sequence Number]
A new L0 segment is being created → The sequence number is incremented by 1 and assigned to the transmission segment
[Set Transaction Code to 'L0']
The system builds the L0 transmission line → The transaction code is set to 'L0' to identify this as a weight segment
[Set Weight Code to '1']
The system populates weight qualifier information → The weight code qualifier is set to '1' to indicate standard weight information
[Get Weight from Cargo Report]
The system builds the L0 weight segment → The weight value from the cargo report is extracted and included in the transmission
[Set Weight Unit Qualifier 'G']
The system processes weight unit qualification → The weight unit qualifier 'G' is assigned to indicate gross weight measurement
[Get Lading Quantity from Cargo Report]
The system builds the L0 weight segment → The lading quantity from the cargo report is extracted and included in the transmission
[Get Lading Quantity Qualifier from Cargo Report]
The system builds the L0 weight segment → The lading quantity qualifier from the cargo report is extracted and included in the transmission
[Get Weight Unit Qualifier from Cargo Report]
The system builds the L0 weight segment → The weight unit qualifier from the cargo report is extracted and included in the transmission
[Build Complete L0 Transmission Line]
The system finalizes the L0 segment construction → All data elements are combined into a complete, properly formatted L0 transmission line structure
[Store L0 Segment in Transmission Data]
The system prepares to create the transmission record → The L0 transmission line is moved to the transmission data field for database storage
[Create Transmission Department Record]
The system executes transmission record creation → A transmission department record is created in the database containing the L0 weight information
[Counter <= 8?]
Processing lading description lines → System should iterate through exactly 8 description line positions
[Description Line Contains Data?]
The lading description data for the current line is spaces → System should skip to the next description line without creating a transmission record
[Set L5 Transaction Code]
Creating transmission record for the description → System should set transaction code to 'L5', description code to '1', move the lading description data to transmission line, and create the transmission record
[Increment Sequence Number]
Setting up the record sequence → System should add 1 to the sequence number and assign it to the transmission record
[Process each lading description line and create L5 segments only for lines containing data]
The system processes each lading description line from 1 to 8 → The system creates an L5 transmission segment with sequence number, transaction code 'L5', description code '1', and the lading description data only for lines that contain data (not spaces), and skips lines that are empty
[Create L5 Transmission Segment]
The system processes the line for transmission creation → The system creates an L5 transmission segment with incremented sequence number, transaction code 'L5', description code '1', and the lading description data
[Increment Line Counter]
The system completes processing of the current line → The system increments the line counter by 1 to move to the next lading description line
[Create Shipper Load Count - Generate L5 segment with shipper load and count information]
The system processes the shipper load count segment creation → The system should initialize transmission line to spaces, increment sequence number by 1, set segment code to 'L5', set description code to '1', move shipper load and count data to transmission line, prepare transmission data, and create transmission department record
[Create Equipment Car Record - Generate K1 segment with equipment car ID, program code, and last update information]
The system creates the equipment car transmission record → A K1 segment is generated with sequence number, transaction code 'K1', equipment car ID, program code '11', and last update date from either last modify date or creation date
[Set Sequence Number]
The system prepares the segment data → The sequence number is incremented by 1 and assigned to the K1 segment
[Set Transaction Code to K1]
The system sets the transaction code → The transaction code is set to 'K1' to identify this as an equipment car segment
[Set Equipment Car ID]
The system creates the K1 segment → The equipment car ID is copied from the cargo record to the K1 segment
[Set Program Code to 11]
The system sets the program identification code → The program code is set to '11' regardless of the last update date source
[Create Equipment Car Transmission Record]
The system creates the transmission record → The complete K1 segment data is formatted as transmission data and a transmission department record is created
[Determine last update information - use last modify date if available, otherwise use creation date]
The system needs to determine the last update information for the K1 segment AND the CCN last modify date is not empty AND the delete status is not empty → The system uses the CCN last modify date as the last update timestamp
[Use Creation Date for Update Information]
The CCN last modify date is empty:
the delete status is empty
→ The system uses the CCN creation date as the last update timestamp
[Set Program Code to 11]
The last update timestamp has been determined → The system sets the program code to '11' in the transmission record
[Retrieve Control Table Segment with ID '11']
A request is made to retrieve control table segment with table ID '11' and sequence ID of spaces → The system calls the table segment retrieval function with the specified parameters
[Increment Transmission Number by 1]
A new transmission number is required → The system adds 1 to the current transmission number in the control table segment
[Replace Control Table Segment with Updated Data]
The updated control table segment needs to be persisted → The system replaces the control table segment with table ID '11' and sequence ID of spaces using the updated data
[Display Shutdown Message]
The system processes the shutdown request → A shutdown message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036B' is displayed and logged as an error message
[Display Shutdown Message]
The system processes the shutdown condition → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036B' is displayed on the console
[Log Shutdown Request]
The system processes the shutdown logging → The shutdown message is recorded in the error log through the error handling routine
[IMS Shutdown Request Received]
An IMS shutdown request is received (CC-STATUS-CODE equals 'XD') → The system displays 'IMS SHUTDOWN REQUEST RECEIVED BY GCX036B' message, logs the error message, closes the checkpoint file, closes the cargo report input file, and terminates the program

Structural Validations

[Set Checkpoint Number to 500]
The checkpoint value fails numeric validation → The system sets checkpoint number to 500 and displays an invalid checkpoint message
[Handle Missing Control Table Error]
Control table segment is not available → Error message 'CONTROL 11 SEGMENT NOT AVAILABLE' is displayed and error handling is called
[Handle Update Failed Error]
Update operation is not successful → Error message 'CONTROL 11 SEGMENT REPLACE FAILED' is displayed and error handling is called
[Set Default Automotive Code]
The system completes the default assignment process → The system assigns the automotive type from the default table structure to the transmission automotive code
[Check Notify Party Name]
The system checks the notify party name field → The system should evaluate if notify party name contains data or is empty spaces
[Set Default Car Initial to 'NONZ']
The conveying car initial field is empty or contains spaces → The system sets the equipment car initial to 'NONZ' as the default value
[Set Default Car Number to '00000000']
The conveying car initial field is empty or contains spaces → The system sets the equipment car number to '00000000' as the default value
[Display Error: Control 11 Segment Not Available]
The control table segment with ID '11' is not found or not available → The system displays an error message indicating the control segment is not available and calls the error handler
[Display Error: Control 11 Segment Replace Failed]
The control table segment replacement operation is not successful → The system displays an error message indicating the segment replacement failed and calls the error handler

Module: GCX037 1 Consolidated Epic Story

Epic: GCX037 Complete EDI Specification Extracted from Legacy

Contains 65 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX037 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Empty Broker Data]
No broker configuration is available → Broker segment and B1 segment are initialized to empty values and batch print call letters are set from cargo data
[Initialize Empty Broker Segment]
The system handles missing broker data → The system initializes empty broker segments and uses cargo batch print call letters as fallback
[Initialize Empty Broker Data]
No broker information is available → Initialize broker segments to empty values and set batch print call letters from cargo data
[Initialize Empty Broker Data]
No broker information is available → The system initializes empty broker and delivery preference segments and sets batch print call letters from cargo data

Core Acceptance Criteria

[12:Send Broker Notifications]
The broker delivery schedule is default delivery:
immediate delivery
(consist delivery AND train ID is not spaces)
→ The broker notification process should proceed, otherwise skip notification
[Display Checkpoint Number Being Used]
Checkpoint processing is complete → The system displays 'GCX037 CHECKPOINTING AT [number]' message showing the active checkpoint value
[Log Cargo Sent Automatically]
External notifications are being processed → An audit log entry is created with high security level, cargo CCN key, cargo type indicator, and automatic transmission action code
[Get Broker Delivery Preferences]
Broker configuration is available → B1 segment delivery preferences are retrieved using table ID 'B1' and the same broker key, or initialized to empty if not found
[Check Delivery Schedule]
Determining whether to send broker notifications → Notifications are sent if delivery schedule is default delivery or immediate delivery, or if delivery schedule is consist delivery and cargo has a Canadian customs north train ID
[Send X12 Notification]
Multi-channel notifications are being processed → X12 notification is sent with broker notification flag and X12 broker header information
[Send Internet Notification]
Multi-channel notifications are being processed → Internet notification is sent with cargo CCN key, high security level, and broker internet address from B1 segment
[X12 EDI Channel Enabled?]
The broker's X12 usage flag is set to 'Y' → The system should prepare X12 broker header data, set notify broker flag, and send X12 EDI notification to the broker
[Internet Channel Enabled?]
The broker's Internet usage flag is set to 'Y' → The system should initialize Internet input data with CCN key, set security parameters to high values, configure Internet address from broker B1 segment information, and send Internet notification
[Send X12 EDI Notification]
The system processes the X12 EDI notification request → The system should call GCCS309C program with notify broker flag set and X12 broker header information to transmit the notification
[Broker Uses X12?]
The system checks if the broker uses X12 EDI for notifications → The system should proceed with X12 processing if enabled, otherwise skip X12 notification
[Extract X12 Broker Header from Broker Table]
The system prepares X12 notification data → The system should extract the broker X12 header from the broker table and assign it to the X12 broker field
[Call X12 Notification Service]
The system needs to send X12 EDI notification → The system should call the X12 notification service with the prepared broker notification data
[Set Notification Type to Broker]
The system prepares broker notification → The system should set the notification type flag to indicate broker notification
[Display Shutdown Message]
The system processes the shutdown request → A shutdown message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX037' is displayed and program termination is initiated
[Terminate Program]
The system processes the termination request → The program execution is terminated through the abend procedure
[Notify Customs via GCCS309C]
The system processes customs notification → The system sends notification to customs with action code '03' and transaction 'GCT0371E' using the cargo CCN key
[Retrieve Primary Broker Information from Tables]
The system looks up broker information → The system retrieves broker segment using table ID 'BK', broker name, Canadian flag 'C', and manifest destination port code
[Default Broker Found?]
The system completes broker lookup attempts → The system initializes empty broker segments and sets batch print call letters from cargo data, then exits the notification process
[Get Broker Delivery Preferences]
The system retrieves delivery preferences → The system gets B1 segment data for the broker, or initializes empty B1 segment if not found
[Default or Immediate Delivery?]
If delivery schedule → The system proceeds with multi-channel notification processing
[Send Multi-Channel Notifications]
The system processes notification channels → The system checks and sends notifications through X12 EDI, Merlin, FAX, and Internet channels based on broker configuration
[Use X12 EDI?]
The system processes X12 notifications → The system sends broker notification via X12 EDI using the broker's X12 header information
[Use Internet?]
The system processes internet notifications → The system sends internet notification using the broker's internet address from B1 segment
[Send X12 EDI Notification]
The broker's X12 EDI usage flag is set to 'Y' → The system sends X12 EDI notification using the broker's X12 header information and sets notify broker flag to true
[Get Broker Delivery Preferences]
The system loads broker delivery preferences → Store the broker segment data and prepare to retrieve additional broker details with table ID 'B1'
[Delivery Schedule Valid?]
If the broker's delivery schedule setting → If delivery schedule is 'Default' or 'Immediate', proceed with notification; if 'Consist', check for train ID; otherwise, exit processing
[Get Primary Broker Information]
The system searches for broker information using broker name, Canadian flag 'C', and port code from manifest-to transaction code positions 2-3 → The system retrieves the broker segment data if found
[Search with Default Port 000]
The system searches again using the same broker name and Canadian flag 'C' but with default port '000' → The system retrieves the broker segment data if found with default port
[Retrieve Broker Delivery Preferences]
The system searches for delivery preferences using table ID 'B1' and the same broker key → The system loads the delivery preference segment if found, otherwise initializes empty delivery preferences
[Get Secondary Broker Information]
The system searches for secondary broker information using broker name, Canadian flag 'C', and port code from manifest-to transaction code positions 2-3 → The system retrieves the secondary broker segment data if found
[Search Secondary with Default Port 000]
The system searches again using the same secondary broker name and Canadian flag 'C' but with default port '000' → The system retrieves the secondary broker segment data if found with default port
[Retrieve Secondary Broker Delivery Preferences]
The system searches for delivery preferences using table ID 'B1' and the same secondary broker key → The system loads the secondary broker delivery preference segment if found, otherwise initializes empty delivery preferences
[Immediate Delivery Schedule?]
The broker delivery schedule is set to immediate delivery → The cargo is eligible for broker notification processing
[Validation Failed - Skip Notification]
The delivery schedule is not default, immediate, or valid consist delivery → The cargo is not eligible for broker notification and processing exits without notification
[Delivery Schedule = DEFAULT or IMMEDIATE?]
The broker delivery schedule is set to DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → The system proceeds with broker notification processing
[Delivery Schedule = CONSIST?]
The broker delivery schedule is set to CONSIST-DELIVERY → The system performs additional train ID validation before proceeding
[Skip Notification - Schedule Not Met]
The delivery schedule is CONSIST-DELIVERY and no train ID is available:
the delivery schedule is neither DEFAULT, IMMEDIATE, nor CONSIST
→ The system exits the notification process without sending notifications to the broker
[Proceed with Notification]
The delivery schedule is DEFAULT:
IMMEDIATE
the delivery schedule is CONSIST and train ID is available
→ The system performs broker notification sends via configured channels (X12, Merlin, Fax, Internet)
[Send X12 EDI Notification]
The system processes broker notifications for cargo deletion → The system should send X12 EDI notification using the broker's X12 header and set notify broker flag to true
[Start Broker Notifications]
The system processes broker notifications → The system should check and execute X12 EDI, then Merlin, then FAX, then Internet notifications independently based on each method's configuration flag
[Calculate Days Since Release]
Processing CBSA export report → The difference in days between release date and current date is calculated using TIMEDIFF function
[Set Sequence Number Counter]
Beginning the sequential search through record segments → Sequence number counter starts at 1 and is prepared for incremental searching
[Retrieve Record Type 55 by Sequence]
Attempting to retrieve record type 55 segment → Database call is made with CCN key, record type '55', and current sequence number to fetch the corresponding segment
[Set Payor Found Flag]
Confirming payor of freight identification → Payor of freight found flag is set to true to indicate successful completion of the search
[Increment Sequence Number]
Preparing for next search iteration → Sequence number counter is incremented by 1 to access the next sequential record
[Calculate Days Since Creation]
The system processes the cargo record → The time difference between original sent date/time and current machine date/time is calculated in days using the TIMEDIFF utility
[Calculate Days Since Arrival]
The system processes the cargo for batch file generation → Calculate the difference in days between cargo arrival date and current machine date using TIMEDIFF function and store the result in batch days field
[Display Program Completion Message]
The system reaches the end of the program execution → The system must display 'GCX037R: Bye!' message to indicate successful program completion
[Get Last Offline Date from Equipment]
Equipment has not been immediately marked as exited based on event code or station → The system extracts the last offline date from the equipment record for further date comparison processing
[Call TIMEDIFF Utility Program]
The system needs to calculate the exact number of days difference → The TIMEDIFF utility program is called with the date parameters
[Calculate Day Difference]
The calculation completes successfully → The day difference result is extracted from the calculation output
[Calculate Days Since Arrival]
Processing batch records → Calculate days difference between arrival date and current machine date using TIMEDIFF utility with arrival time set to zeroes and current machine time
[Send X12 EDI Notification]
The broker's X12 EDI usage flag is set to 'Y' → The system should set the notification type to broker notification, configure the X12 broker header from the broker table, and call the notification service
[Send Internet Notification]
The broker's Internet usage flag is set to 'Y' → The system should initialize the notification input, set the CCN key and security byte, configure the Internet address from the B1 segment of the broker table, and spawn the Internet notification process

Structural Validations

[3:Load STCC Table]
The table entry counter is less than 1:
the table entry counter exceeds the maximum table size
→ The program should abort with appropriate error message
[Display Invalid Checkpoint Message]
The invalid checkpoint flag is set to 'Y' → The system displays 'INVALID CHECKPOINT - DEFAULT TO 500' message to the console
[Terminate - Empty File Error]
The entry counter is less than 1 after file processing → The system displays an empty file error message and terminates the program
[Terminate - Table Overflow Error]
The entry counter exceeds the maximum table size → The system displays a table overflow error message and terminates the program
[Check Delivery Schedule]
The system checks delivery schedule requirements → The system evaluates if delivery schedule is default, immediate, or consist delivery with train ID requirements
[Entity ID = 'PF'?]
Examining the entity identification code → If the entity ID code equals 'PF' then this record contains payor of freight information, otherwise continue searching

Module: GCX037A 1 Consolidated Epic Story

Epic: GCX037A Complete EDI Specification Extracted from Legacy

Contains 54 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX037A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The system reads the checkpoint file → If the file is empty, set checkpoint to 500 and display default message, OR if the checkpoint data is not numeric, set checkpoint to 500 and display default message, OR if the checkpoint data is valid numeric, use that value as checkpoint
[Initialize Search Parameters]
The log entry search process is initiated → The log dependency indicator is cleared, time found flag is set to false, and the system is ready to iterate through log dependency segments
[Initialize Message Counter to Zero]
The arrival information extraction process begins → The message counter is set to zero
[Initialize Message Counter to Zero]
The arrival time checking process begins → The message counter is set to zero to prepare for pattern counting

Core Acceptance Criteria

[3:Handle Checkpointing]
The checkpoint operation returns status code 'XD' → Display shutdown message, close files, and terminate program execution
[10:Extract Arrival Information]
The system searches for arrival time information → If message count is greater than zero, set time found flag to true and extract arrival date and time from log departure record
[12:Set Payment Method]
Payment method needs to be assigned → Set payment method from EDI shipping method payment field
[Set Accept Status to 'GBGE']
The system initializes database access for cargo retrieval → The accept status is set to 'GBGE' to enable cargo report segment access
[Execute Get Next Call to GCSCCRT Database]
A request is made to retrieve the next cargo report segment → The system executes a Get Next database call to retrieve the next available cargo report segment from the customs cargo database
[Increment Checkpoint Counter]
The cargo data is ready for processing → The system increments the checkpoint call counter by 1 to track processing progress
[Handle System Shutdown]
The shutdown request is processed → A shutdown message is displayed, error handling is invoked, files are closed, and the program terminates
[Log Dependency Found?]
The database access operation completes → If a log dependency record exists, proceed to check its message content, otherwise end log processing
[Contains 'ARRIVED AT BORDER'?]
The message pattern count is evaluated → If the count is greater than zero, the message contains arrival information and arrival time should be extracted, otherwise continue searching other log records
[Log Dependency Found?]
If the retrieval result → Processing continues to message checking if record found, otherwise log processing completes
[Contains 'ARRIVED AT BORDER'?]
The system searches for arrival message patterns in the message content → Arrival time extraction proceeds if pattern found, otherwise search continues to next record
[Extract Arrival Date and Time]
The system extracts date and time information → Arrival date is extracted from load date field and arrival time is extracted from the first 4 positions of load time field
[Get Next Log Dependency Segment]
The system requests the next log dependency segment → The next available log dependency segment is retrieved and its status is evaluated to determine if more segments exist
[Log Dependency Found?]
The database response is received → If a valid log dependency segment is found, continue to check for arrival messages; otherwise, end the search process
[Arrival Message Found?]
The count of arrival message patterns is greater than zero → The segment is identified as containing arrival information and should be processed; otherwise, continue searching additional segments
[Process Arrival Information]
The arrival information is processed → The arrival time (first 4 characters of load time) is moved to the cargo report arrival time field, the load date is moved to the cargo report arrival date field, and the time found flag is set to true
[More Dependencies to Check?]
If continuation criteria → If more log dependency segments exist, the search continues with the next segment; if no more segments exist or arrival time has been found, the search terminates
[End Search - No More Entries]
No more log dependency segments exist and no arrival information has been found → The search process terminates and the cargo report arrival fields remain empty
[End Search - Arrival Found]
The time found flag is set to true → The search process terminates immediately and the cargo report contains the extracted arrival date and time information
[Search Log Message for 'ARRIVED AT BORDER' Text]
The system searches for arrival information in the message → The system counts all occurrences of the predefined message pattern in the log departure message
[Arrival Message Found?]
The message counter is evaluated → If the counter is greater than zero, arrival message is considered found, otherwise it is not found
[Set Time Found Flag]
The system confirms the presence of arrival information → The time found flag is set to true
[Extract Arrival Time from Log]
The system extracts timing information → The first 4 characters of the log departure load time are extracted as the arrival time
[Extract Arrival Date from Log]
The system extracts date information → The log departure load date is extracted as the arrival date
[Arrival Pattern Found?]
The pattern count is greater than zero → The arrival pattern is considered found and processing continues to extract arrival information
[Set Time Found Flag]
The system confirms the presence of arrival information → The time found flag is set to indicate successful discovery of arrival data
[Build Search Key with CCN]
The system needs to retrieve EDI payment data from the cargo secondary database → The system should set the CCN portion of the search key to the cargo control number from the current cargo record
[Set Record Type to '52']
Building the search criteria for the database query → The system should set the record type field to '52' to identify CA customs N9 EDI payment records
[Set Sequence Number to '0001']
Setting the sequence number portion of the search key → The system should set the sequence number to '0001' to retrieve the first occurrence of the EDI payment record
[Search Cargo Secondary Database]
The system executes the database search for EDI payment data → The system should query the cargo secondary database using the search key and return the matching EDI payment record if it exists
[EDI Data Found?]
The database returns a status code indicating the search results → The system should evaluate if the status code equals 'GE' to determine data availability - if status code is 'GE' then no data found, otherwise data is available
[Set EDI Data Available Flag]
The system needs to track the availability status of EDI payment data → The system should set the EDI data found flag to TRUE to indicate successful data retrieval
[Set EDI Data Not Found Flag]
The system needs to track the availability status of EDI payment data → The system should set the EDI data not found flag to TRUE to indicate no EDI payment data is available
[Build Search Key with CCN]
The system needs to retrieve EDI data for record type 52 → The system should set the cargo control number as the search key for database lookup
[Set Record Type to '52']
Building the search criteria for the cargo secondary database → The system should set the record type to '52' to identify CA customs N9 EDI records
[Set Sequence to '0001']
No specific sequence number is provided → The system should set the sequence number to '0001' to retrieve the first occurrence
[Search Cargo Secondary Database]
The system executes the database search → The system should attempt to retrieve the corresponding EDI data record from the cargo secondary database
[EDI Data Found?]
The database returns a status code indicating success or failure → The system should determine whether EDI data was found based on the status code not being 'GE'
[Set EDI Data Available Flag]
EDI data record type 52 is found in the cargo secondary database → The system should set the EDI data found flag to indicate data availability
[Set EDI Data Not Available Flag]
No EDI data record type 52 is found in the cargo secondary database → The system should set the EDI data not found flag to indicate data unavailability
[Retrieve EDI Payment Data Record Type 52]
The system attempts to retrieve EDI payment data record type 52 with sequence number 0001 for the cargo record → The system determines whether EDI payment data exists for the cargo record
[EDI Data Found?]
If the retrieval result status → If the status code equals 'GE' then EDI data is not found, otherwise EDI data is found
[Extract Shipping Method Payment Information]
The system processes the EDI data to extract payment method information → The shipping method payment code is extracted from the EDI record field BX03-SHIP-METH-PAY
[Set Payment Method in Output Record]
The system builds the cargo report output record → The extracted payment method is assigned to the payment method field in the output record

Structural Validations

[11:Fetch EDI Payment Data]
The system retrieves EDI payment data → If status code equals 'GE', set EDI data not found flag to true, OR if status code does not equal 'GE', set EDI data found flag to true
[Set Default Checkpoint = 500]
The checkpoint data is not numeric → The system sets checkpoint number to 500 and displays invalid checkpoint message
[Check Message Content]
The system analyzes the message content of the log dependency record → Check if the message contains arrival-related information by counting occurrences of specific message patterns
[Check Message for Arrival Information]
The system analyzes the message content → The message is checked for arrival indicators and relevant content
[Check for Arrival Message]
The system examines the message content within the segment → The message is analyzed to count occurrences of specific arrival-related text patterns
[Search Log Message for Arrival Text Pattern]
The system searches for arrival text patterns in the log message → The system counts all occurrences of the arrival message pattern and stores the count

Module: GCX040 1 Consolidated Epic Story

Epic: GCX040 Complete EDI Specification Extracted from Legacy

Contains 11 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX040 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Set Default Interval to 500]
Checkpoint interval needs to be established → The system sets the checkpoint interval to 500 records and displays a default message
[Display Default Message]
The system sets the default checkpoint value to 500 → The system displays 'INVALID CHECKPOINT - DEFAULT TO 500' message to the console
[Display Default Message]
The system defaults the checkpoint value to 500 → The system displays 'INVALID CHECKPOINT - DEFAULT TO 500' message to the console
[Display Final Checkpoint Value]
The final checkpoint number has been determined → The system displays 'GCX040 CHECKPOINTING AT [checkpoint_number]' message to the console
[Write to BDA CSA Report File]
The system processes the CSA report record → The system writes the record to the BDA CSA report file
[Also Write to Customs CSA Report File]
The system processes the escalated CSA case → The system writes the same record to the customs CSA report file in addition to the BDA file
[Set CCN Key]
The system sets the cargo identification fields → The system should copy the cargo control number key from the source cargo record to the customs in-bond report record
[Initiate Program Termination]
The checkpoint operation returns status code 'XD' → The system performs termination procedures, displays shutdown message, logs error message, and calls error handling routine
[Log Shutdown Request Message]
The system processes the shutdown condition → A shutdown request message 'IMS SHUTDOWN REQUEST RCDEIVED BY GCX040' is displayed to the console

Structural Validations

[Set Error Message for Shutdown]
The system prepares for error handling procedures → The error message field is populated with 'IMS SHUTDOWN REQUEST RCDEIVED BY GCX040'
[Call Error Handler]
The system needs to process the shutdown error condition → The CERR error handling program is called with the communication control block

Module: GCX041 1 Consolidated Epic Story

Epic: GCX041 Complete EDI Specification Extracted from Legacy

Contains 7 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX041 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[4:Handle No Data Scenario]
The system attempts to process cargo records → A 'no data' message is written to the report and processing terminates
[Cargo Data Available?]
End-of-file flag indicates no cargo data is available → A 'NO INPUT DATA' message is written to the report file
[Move 'NO INPUT DATA' Message to Report Record]
The system needs to generate report content → The no-data message should be moved to the report record buffer
[Write 'NO INPUT DATA' Message to Report File]
The report generation process executes → The no-data message should be written to the cargo report file
[Write New Report Headers]
The system needs to write headers for the new page → The system writes headers appropriate for the current cargo aging category (10-day, 20-day, 30-day, or 40+ day) along with current system date
[Page Count > 55?]
The system checks if the total line count exceeds 55 lines → The system determines whether to reset the line count immediately or continue with current count
[Start New Email Section]
All threshold conditions are met → The system starts a new email section to manage message length

Structural Validations

None explicitly identified in logic extraction.

Module: GCX042 1 Consolidated Epic Story

Epic: GCX042 Complete EDI Specification Extracted from Legacy

Contains 10 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX042 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Any Cargo Data?]
The cargo file is checked for data availability → If no cargo data exists, a 'no data' message is written to the report and processing terminates
[4:Handle No Data Scenario]
The system detects the absence of data → A 'no data available' message is written to the report file
[Prepare No Data Message]
The system needs to generate report output → WS-NO-DATA-LINE is moved to WS-RPT-RCD and written to INBOND-RPT-RCD
[Move 'NO INPUT DATA' Message to Report Record]
The system needs to generate the cargo report → The system moves the predefined no-data message to the report record and writes it to the output report file
[Days Since Arrival > 39?]
The days since arrival (WS-INBOND-DATEDIFF) is greater than 39 → The cargo should be categorized as 40+ days old and Title Line 4 should be assigned for report headers
[Days Since Arrival > 29?]
The days since arrival (WS-INBOND-DATEDIFF) is greater than 29 → The cargo should be categorized as 30-39 days old and Title Line 3 should be assigned for report headers
[Days Since Arrival > 19?]
The days since arrival (WS-INBOND-DATEDIFF) is greater than 19 → The cargo should be categorized as 20-29 days old and Title Line 2 should be assigned for report headers
[Line Count > 60?]
The regular line count also exceeds 60 lines → The system creates a new email section with headers and resets both email line count and regular line count to zero
[Reset Line Count to Zero]
The system prepares to start a new page → The line count is reset to zero to begin counting lines on the new page

Structural Validations

[Check if Cargo Data Exists]
The first read operation on the cargo data file immediately encounters end-of-file condition → The system sets the end-of-file indicator to true

Module: GCX043 1 Consolidated Epic Story

Epic: GCX043 Complete EDI Specification Extracted from Legacy

Contains 12 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX043 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Delete Key Record]
The system begins generating delete keys for an error segment → The delete key record is initialized with spaces to ensure clean data

Core Acceptance Criteria

[11:Generate Delete Keys]
The system needs to track processed records for deletion → A delete key record is created containing segment name 'GCSCCS54', the record's primary key, and the number of errors found
[Call IMS Database Interface]
The system needs to access GCSCCS54 error segment records → The CIMS interface should be called with the common communication area, database PCB, GCSCCS54 segment, and runtime parameters
[Set Segment Name to 'GCSCCS54']
The system creates a delete key record → The segment name field is set to 'GCSCCS54' to identify the error segment type
[Write Delete Key Record to File]
The system completes delete key generation → The delete key record is written to the delete keys file for later processing

Structural Validations

[4:Validate Input Date]
The system validates the date format and correctness → If the date is invalid, the system terminates with error message 'INVALID DATE ENTERED ON DATECARD'
[6:Retrieve Error Records]
The system needs to process error records → Error records are retrieved from GCSCCS54 IMS segment using database call
[Validate Provided Date]
Processing the provided date → The date is validated using date conversion functions and processing terminates with error message if invalid
[Set Error Message: 'INVALID DATE ENTERED ON DATECARD']
The system handles the validation failure → The error message 'INVALID DATE ENTERED ON DATECARD' is set in the common communication area
[Terminate Program with Error]
The system encounters an invalid date → The program terminates with an error through the abend routine
[Copy Error Segment Primary Key]
The system creates a delete key record → The primary key from the error segment is copied to the delete key record for identification
[Set Number of Errors Found]
The system creates a delete key record → The number of errors found is recorded in the delete key record for audit purposes

Module: GCX044 1 Consolidated Epic Story

Epic: GCX044 Complete EDI Specification Extracted from Legacy

Contains 66 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX044 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Access GCSCCRT Database]
The system performs database lookup → The system should call CIMS with 'GE' status to access GCCC cargo report segment using the CCN key
[Extract Port Code from CM Table Record]
The system processes the CM table data → The system extracts the port code from the CM table segment and assigns it to the cargo processing structure
[Retrieve CM Segment Data]
The system processes the table lookup result → The system moves the table segment data to the CM segment structure
[Extract Port Code from CM Table]
The system needs port code information for cargo processing → The system extracts the port code from the CM segment and assigns it to the transaction port code field
[Set Port Code from CM Table]
The system sets port code from CM table → The port code from CM table segment is moved to the cargo mapping input port code field
[Return Port Code from CM Table]
Port code information is needed for cargo processing → The port code is extracted from the CM table segment data for use in cargo operations
[Prepare Query Message]
The system needs to prepare a new query message → All fields in the query message structure are cleared to initial values
[Set Security Parameters]
Security parameters need to be set → The security byte is set to high-value to ensure maximum security clearance
[Set Cargo Control Number]
A query message is being prepared → The cargo control number is copied from the cargo record to the query message
[Set Canada Cargo Flag]
Cargo type needs to be specified → The cargo type flag is set to indicate Canada cargo
[Set Query Action Code 'QUP']
The action type needs to be specified → The action code is set to 'QUP' to indicate a query update operation
[Running Environment?]
The transmission method needs to be determined → If running in BPE environment, use EXCI interface; otherwise use IMS message queue
[Send via EXCI Interface]
The message needs to be transmitted → The message is sent using CSIEXCI call with transaction name GCT1481E
[Send via IMS Message Queue]
The message needs to be transmitted → The message is sent using CIMS and WRITMSGL calls through the alternate PCB
[Return Success Status]
Return status needs to be set → The return code is set to success status
[Return Failure Status]
Return status needs to be set → The return code is set to failure status
[Running in BPE Environment?]
The system checks if it is running in BPE (Batch Processing Environment) versus TPE (Transaction Processing Environment) → If running in BPE environment, use EXCI interface for transaction processing, otherwise use standard CIMS interface for transaction processing
[Set EXCI Transaction Name]
EXCI interface is selected for transaction processing → Set the EXCI transaction name to 'GCT1481E' and prepare the transaction parameters
[Calculate Message Length]
The system needs to determine the communication area size → Calculate EXCI communication length as message length plus 4 bytes and calculate call data length as EXCI communication area header length plus message length
[Copy Message Data to EXCI Buffer]
The system needs to transfer message data for EXCI processing → Copy the transaction message data to EXCI communication data area and set message pointer to null
[Call EXCI Interface]
The system needs to execute the transaction through EXCI → Call 'CSIEXCI' program with EXCI program parameters, return code, call data length, application ID, communication area, and control parameters
[Prepare Message for IMS Queue]
The system prepares the message for IMS queue transmission → The message content is copied from GCX148-INPUT to GCT1481E-MSG format for IMS processing
[Change Message Queue Status]
The system initiates message queue status change → CIMS is called with CHNG function using ALT-PCB and GCT1481E message structure
[Write Message to IMS Queue]
The system writes the message to IMS queue → WRITMSGL is called with message code, message content, message length, and module name parameters
[Purge Message Queue]
The system completes message transmission → CIMS is called with PURG function using ALT-PCB to purge the message queue
[Extract Port Code from CM Segment]
The system processes the retrieved CM table segment → The system moves the table segment data to CM segment structure for port code extraction
[Running in BPE Environment?]
The system checks the runtime environment → If running in BPE environment, use EXCI interface; otherwise use IMS message queue
[Send Message to Transaction Queue]
A cargo transaction needs to be spawned → Setup IMS message queue, send message to transaction queue using WRITMSGL, and purge the message queue
[Prepare GCT1481E Message Input]
The system prepares the transaction message → Move the prepared input data to GCT1481E message format
[Calculate Message Length]
A message needs to be prepared for transmission → The communication area length is calculated as message length plus 4 and call data length is calculated as header length plus message length
[Call CSIEXCI to Send Message]
The transaction needs to be sent → The system calls CSIEXCI program with transaction parameters and communication area
[Change to Message Queue]
A transaction needs to be processed → The system calls CIMS with CHNG function to change to alternate PCB message queue
[Write Message to Queue]
A message needs to be sent → The system calls WRITMSGL to write the message code, message content, message length and module name to the queue
[Purge Message Queue]
Message writing is completed → The system calls CIMS with PURG function to purge the alternate PCB message queue
[Running in BPE Environment?]
The system checks the runtime environment → If running in BPE environment, use EXCI processing method, otherwise use standard CIMS processing method
[Calculate Communication Length]
Preparing communication area → Calculate communication length as message length plus 4 bytes
[Move Message Data to EXCI Area]
Preparing EXCI communication area → Move message data from GCT1481E message to EXCI communication data area
[Calculate Call Data Length]
Preparing for EXCI call → Calculate call data length as EXCI communication area header length plus message length
[Calculate Communication Area Length]
The system calculates the communication area length → The communication area length should be set to the message length plus 4 bytes
[Move Message Data to Communication Area]
The system prepares the communication area → The message data should be moved to the communication data area with the specified length
[Calculate Call Data Length]
The system calculates the call data length → The call data length should be set to the communication area header length plus the message length
[Set Message Pointer to NULL]
The system initializes the message pointer → The message pointer should be set to NULL
[Prepare Transaction Message]
A cargo transaction needs to be sent → The system copies the GCX148 input data to the GCT1481E message structure
[Set Message Queue Parameters]
The message queue needs to be prepared for transaction → The system sets the accept status to spaces to clear any previous status
[Call CIMS to Change Message Queue]
The message queue needs to be changed for processing → The system calls CIMS with CHNG function to change the alternate PCB message queue
[Call WRITMSGL to Send Message]
The transaction message needs to be sent → The system calls WRITMSGL to send the message with message code, content, length and module name to the alternate PCB
[Call CIMS to Purge Message Queue]
The transaction processing is complete → The system calls CIMS with PURG function to purge the alternate PCB message queue
[Prepare Message for Transmission]
The system prepares the message for transmission → The message content is moved to GCT1481E-MSG structure for processing
[Call WRITMSGL Program]
The system needs to send the message to the message queue → WRITMSGL program is called with the message parameters to write to ALT-PCB message queue
[Send Message to Message Queue]
The message transmission is complete → The system purges the ALT-PCB to clear the message queue
[Return Table Data]
Table data retrieval is finished → The table segment data is returned along with a return flag indicating the success or failure of the operation

Structural Validations

[Message Sent Successfully?]
Transmission results need to be validated → If EXCI response is zero, response2 is zero, abend code is space, and message length is zero, then transmission is successful
[Display Error Message]
Error information needs to be reported → Display EXCI error with response codes, response2, abend code, and error message if available
[EXCI Call Successful?]
The system needs to determine if the EXCI transaction was successful → Transaction is successful if EXCI response code equals zero AND EXCI response2 code equals zero AND EXCI abend code is spaces AND EXCI message length equals zero
[Display Error Message]
The system needs to report the transaction failure → Display error message with EXCI response code, response2 code, and abend code to system error output
[Error Message Available?]
The system needs to determine if additional error details are available → Check if EXCI message pointer is not null indicating additional error message data is available
[Display Detailed Error]
The system has confirmed that error message pointer is not null → Set address of error message structure to EXCI message pointer and display the detailed error message content to system error output
[EXCI Call Successful?]
If the EXCI response codes → If response code is zero AND response2 is zero AND abend code is space AND message length is zero, then call is successful; otherwise call failed
[Display Error Message]
EXCI response indicates error condition → Display error message with response codes and abend code, and if error message pointer exists, display the error message content
[EXCI Call Successful?]
The system checks the response codes → The transaction is successful if response code is zero and response2 is zero and abend code is space and message length is zero
[Log Error Message]
Response validation criteria are not met → The system displays error message with response codes and abend code, and if error message pointer is not null, displays the error message content
[EXCI Call Successful?]
Checking transaction completion status → Transaction is successful if response code is zero, response2 is zero, abend code is space, and message length is zero
[Display EXCI Error Message]
Processing error response → Display error message with response codes and abend code, and if error message pointer exists, display the error message content
[CSIEXCI Response OK?]
If the CSIEXCI response → The transaction is considered successful if response code is zero AND response2 code is zero AND abend code is space AND message length is zero
[Error Message Available?]
The system checks for additional error message details → Additional error message should be processed if the message pointer is not NULL
[Display Error Message Details]
The system processes the detailed error information → The detailed error message should be displayed with the specified message length

Module: GCX102 1 Consolidated Epic Story

Epic: GCX102 Complete EDI Specification Extracted from Legacy

Contains 183 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX102 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Display Variables]
Initializing the display screen → All control fields, key fields, data fields, message filler, and function code are set to spaces

Core Acceptance Criteria

[1:User Security Validation - Has broker name table access?]
The system checks the user's broker name table access privileges → If user has invalid access or no access, deny entry and redirect to menu with access denied message, otherwise allow program execution
[2:Initial Screen Display - Display from lowest key]
The message ID is not display mode and not update mode → Retrieve broker records starting from the first record and populate display screen with multiple records up to the last data line
[3:Page Forward Navigation - Next page via PF2]
User presses page forward key (PF2) in display mode → If last displayed record is not empty, use it as starting point to retrieve next page of records, otherwise display last page message and remain on current page
[8:User Authorization Check - Update/super user privileges]
The system checks user authorization level → If user is not UPDATE-USER or SUPER-USER, display update violation message and remain on display screen, otherwise allow update processing
[14:Add Operation Processing - Process add function]
Function code is ADD and all validations pass → Validate update fields, if valid insert new record and display confirmation, if invalid remain on update screen with error messages
[15:Modify Operation Processing - Process modify function]
Function code is MOD and all validations pass → Validate update fields, if valid update existing record and display confirmation, if invalid remain on update screen with error messages
[16:Delete Operation Processing - Process delete function]
Function code is DEL and delete request key is pressed → Delete existing record and display confirmation, if delete request key not pressed display confirmation message and remain on update screen
[19:Database Record Insertion - Insert new record]
Database insertion is performed → If insertion successful display add confirmation message, if insertion fails set validation error flag and display database update error message
[20:Database Record Update - Update existing record]
Database update is performed → If update successful display change confirmation message, if update fails set validation error flag and display database update error message
[21:Database Record Deletion - Delete record with confirmation]
Delete request key is pressed for final confirmation → If deletion successful display delete confirmation message, if deletion fails set validation error flag and display database update error message, if confirmation not provided display confirmation delete message
[27:Confirmation Message Display - Success messages]
Operation type is determined → Display confirm-add message for successful additions, confirm-change message for successful modifications, or confirm-delete message for successful deletions
[Is User = INVALID-USER?]
If the user access status → Access is denied and user is redirected to menu with no access message
[Is User = SPACE?]
If the user access status as SPACE → Access is denied and user is redirected to menu with no access message
[Entry from Outside Screen]
The message ID is not BROKER-NAME-DISPLAY-MOD and not BROKER-NAME-UPDATE-MOD → The system performs sequential read starting from the lowest key value and sends the display screen
[Clear all screen fields and key fields]
The sequential read process begins → All screen control fields, key fields, data fields, and message filler areas are cleared to spaces
[Set broker key to space for lowest positioning]
Database positioning is being established → The broker key long name is set to space AND the data segment is cleared to space AND the broker key is moved to the key index for positioning
[Set broker key as search parameter]
The system needs to position at a specific broker record in the database → The broker key from the segment is moved to the database search parameter
[Set last page message for user]
The database call returns an error status code indicating record not found or other error condition → The system sets the user message number to indicate last page has been reached
[Clear Screen Fields and Set Last Page Message]
System detects empty broker name long field:
empty broker name short field on the last line
→ System clears control fields, key fields, message filler, and function code, sets last page message if no numeric message exists, and exits page forward process
[Use Last Record Key as Starting Point]
System extracts broker name long from the last display line (LAST-DATA-LINE) → System moves the broker name long to database key field, clears data segment, and sets broker key as index for database positioning
[Set Last Page Message]
Broker name long field:
broker name short field on the last line is empty AND no numeric message currently exists
→ System sets last page message to inform user they have reached the end of available broker name records
[Set Last Page Message]
The retrieved records result in empty broker name long field:
empty broker name short field in the last position
→ System sets last page message to inform user no more records are available for forward navigation
[Set Last Page Message]
The system processes the page forward request → The system sets a last page message to inform the user that no more records are available and clears screen control fields
[Clear Screen Control Fields]
The system processes the end of data condition → The system clears control fields, key fields, message filler, and function code to reset the screen state
[Return to Display Screen]
The function code validation fails and error messages are set → The system should Execute the display screen send operation and exit the validation process
[User has UPDATE-USER privileges?]
The system checks if the user has UPDATE-USER privileges:
SUPER-USER privileges
→ If user has either UPDATE-USER or SUPER-USER privileges, allow the modification to continue, otherwise set update violation message, highlight function field as error, and return to display screen
[Set function description to ADD]
System attempts to retrieve an existing record with the same broker name key and no record is found in the database → System sets function description to ADD, clears all data fields on update screen, and proceeds to update screen for new record entry
[Map screen key fields to database segment]
System needs to prepare for database record retrieval → System moves the broker name long key from screen to database key field, clears database data area, and sets up the broker key index
[Attempt to retrieve existing record with same broker name key]
System performs database retrieval operation using the broker key → System executes database call to get record and sets status code indicating whether record was found or not found
[Map screen key fields to database segment structure]
The system prepares to perform a database operation → The broker name long key from screen input is moved to the database key field and the database segment is prepared for the lookup operation
[Record does not exist - proceed with add operation]
The database lookup indicates no existing record with the same key → Set the add description, clear the data fields and message filler, and send the update screen to allow user to enter the new record details
[Map screen key fields to database segment structure]
The system needs to prepare for database record retrieval → The broker name long key field is mapped to the database key structure and data area is cleared
[Add delete confirmation message]
The delete update screen is displayed → A confirmation delete message is shown to the user
[Set broker key as search criteria]
The system needs to set up search criteria for database retrieval → The broker key from the current record is moved to the key value field for database search
[Execute CIMS database call with GHU command]
The system needs to retrieve and lock a specific broker record for modification → A CIMS database call is executed with GHU command, PCB, broker segment, and search criteria to retrieve the record
[Clear key fields and database segment]
PF1 page back key is pressed → Key fields and database segment are cleared to reset navigation position
[Clear control fields, data fields, and messages]
System prepares to process display request → Control fields, data fields, and message filler areas are cleared
[Execute database call to get first record]
The system executes the database call using CIMS with GU operation → The database call is executed with the broker segment, PCB, and search criteria to retrieve the first matching record
[Map Key Fields to Database Segment]
Display processing is initiated → System moves broker name long from screen key field to database key field, clears data area, and sets up broker key index
[Clear Key Fields and Database Segment]
PF key is PAGE-BCK → System clears screen key fields and database broker name segment
[Clear Key Fields and Database Segment]
Database broker key is empty (SPACE) → System exits display processing without further action
[Retrieve Database Record]
Display processing continues after key mapping → System clears control fields, key fields, data fields, message filler, and function code on screen
[Populate First Line with Record Data]
Database operation returns successful status → System moves broker name long and short from database segment to first line of display screen
[Are all validations passed?]
All validations have passed without errors → Map screen key fields to database segment, move broker short name to database field, and insert new broker record
[Map screen key fields to database segment]
System needs to prepare data for database insertion → Move broker name long key from screen to database key field, clear database data area, and set broker key index
[Insert new broker record into database]
System performs database insert operation → Call database insert function with broker name segment data
[Database insertion successful?]
Database insertion is successful (status code is SPACE) → Set confirmation add message to notify user of successful operation
[Database insertion successful?]
Database insertion fails (status code is not SPACE) → Set database update error flag and set database update error message
[Execute database replace operation]
The system executes the database replace operation → The system maps screen key fields to database segment, retrieves existing record, updates broker short name, and executes database replace operation
[Set confirmation change message]
The database update operation completes successfully → The system sets a confirmation change message to inform the user of successful modification
[Is PF5 Delete Key Pressed?]
The delete function is invoked without the PF5 delete confirmation key being pressed → The system displays a confirmation message and sets the update as invalid without proceeding with the deletion
[Display Confirmation Message]
The PF5 delete confirmation key has not been pressed → The system sets the confirmation delete message and marks the update as invalid
[Retrieve Record for Hold/Update]
The system prepares to delete the record → The system maps the screen key to database segment and retrieves the record for hold/update
[Map screen key fields to database segment structure]
The system prepares the database segment structure → The broker name long key from screen is mapped to the database key field and data area is cleared
[Move broker short name from screen to database segment]
The system populates the database segment with screen data → The broker short name from the update screen is assigned to the database segment
[Set confirmation message for successful add]
The database operation completes successfully with no error status → A confirmation message for successful add is set for user notification
[Set update operation as invalid]
The database operation fails with an error status → The update operation is marked as invalid and database update error message is set if no message exists
[Execute IMS ISRT call to insert broker record]
The system executes the database insertion operation → The broker short name field is mapped to the database segment and the record is inserted via IMS call
[Set confirmation message for successful add]
The database insertion completes successfully with no error status → The system sets a confirmation message indicating the add operation was successful
[Map screen key fields to database segment structure]
The system prepares the database segment for insertion → The broker name long field from the screen is mapped to the database key field and the database segment is properly structured
[Move broker short name to database field]
The system assigns field values to the database segment → The broker short name from the update screen is moved to the corresponding database segment field
[Map screen key fields to database segment structure]
The system prepares to insert the record into the database → The broker name long field from screen is mapped to the database key field and data fields are cleared
[Move broker short name from screen to database field]
The system processes the broker short name field → The broker short name from the update screen is moved to the database segment field
[Set confirmation message for successful add]
The database insert operation completes successfully with no errors → A confirmation message for successful add operation is set for user notification
[Map screen key fields to database segment structure]
The system needs to prepare database segment for update → The broker name long key from screen is mapped to database key field and database data area is cleared
[Move updated broker short name from screen to database segment]
The user has entered a new broker short name on the update screen → The new broker short name value is moved from screen field to database segment field
[Set confirmation message - Record Updated Successfully]
The database update operation completes successfully → A confirmation message indicating successful record update is set for display to the user
[Map screen key fields to database segment]
The system prepares to access the database record → The broker name long key from screen input is mapped to the database key field and data fields are cleared
[Move new broker short name from screen to database segment]
The new broker short name has been validated and approved for update → The new broker short name value is moved from the screen input field to the database segment field
[Set confirmation change message]
The database operation completes successfully with no errors → A confirmation change message is set to inform the user of successful update
[Map screen key fields to database segment]
The system needs to prepare the database segment for record operations → The broker name long key from screen input is moved to the database key field and data area is cleared
[Move updated broker short name to database segment]
The system prepares to update the database record → The new broker short name from screen input is moved to the database segment field
[Set confirmation change message]
The database operation status indicates success → The system sets a confirmation change message for user notification
[PF5 Delete Key Pressed for Confirmation?]
The PF5 delete confirmation key has not been pressed → Display confirmation delete message and set update as invalid without proceeding with deletion
[Map Screen Key Fields to Database Segment]
The system needs to prepare for database deletion operation → Map the broker name long key from screen to database segment and clear data fields
[Retrieve Record for Deletion GHU Database Call]
The system needs to locate the record for deletion → Execute GHU database call to retrieve and hold the broker name record for deletion
[Display Success Message CONFIRM-DELETE]
The database deletion operation completes successfully → Display confirm delete success message to user
[Set Confirmation Delete Message]
The PF5 delete confirmation key has not been pressed → The system should display a confirmation delete message and set the update status to invalid
[Map Screen Key to Database Segment]
The system needs to prepare the database operation → The system should map the screen key fields to the database segment structure
[Get Database Record for Update]
The system needs to locate the record for deletion → The system should Execute a get hold unique operation to retrieve and lock the specific broker record
[Set Confirm Delete Message]
The database delete operation completes successfully → The system should display a confirmation message indicating the broker record has been successfully deleted
[Set confirmation delete message]
The delete confirmation validation fails → Set the confirmation delete message to prompt user and mark the update operation as invalid
[Map screen key fields to database segment]
The system needs to identify the record to delete → Map the broker name long key from screen to database segment and clear data fields
[Delete Operation Successful?]
The database operation completes successfully → Set confirmation delete message to inform user of successful deletion
[Delete Operation Successful?]
The database operation fails → Mark update as invalid and set database update error message to inform user of failure
[Clear screen control and data fields]
System begins to populate screen with broker data → All screen control fields, key fields, data fields, and message filler areas are cleared to spaces
[Set key to spaces for first page]
Page back key is pressed → Key fields and broker name segment are set to spaces to start from beginning
[Set key to spaces for first page]
Broker key in database segment equals spaces → System exits the display processing without further database operations
[Map screen key fields to database segment structure]
The system needs to prepare database key fields from screen input → The broker name long field from screen is mapped to database key field, data area is cleared, and broker key is set as index
[Set database key from broker key field]
The system needs to set up the database search key → The broker key from the segment is moved to the database key value field for search positioning
[Set last page message if no records]
The database operation does not return a successful status indicating no records found → A last page message is set to inform the user that no records are available
[Get broker name long key from screen field GCM1021-KY-BROK-NAME-L]
The system needs to prepare the database segment for broker name operations → The broker name long key value is moved to the database field GCT2-KEY-BROKER-NAME-LONG
[Clear database data area GCT2-DATA with spaces]
The key field mapping process is executed → The database data area GCT2-DATA is cleared with spaces
[Set database key index GCT2-BROKER-NAME-KEY-INDEX from broker key]
The key field mapping process is executed → The database key index GCT2-BROKER-NAME-KEY-INDEX is set to the value of GCT2-BROKER-KEY
[PF1 Key Pressed]
User presses PF1 (PAGE-BCK) key → System should clear all key fields and database segment to reset position to beginning
[Clear Key Fields and Database Segment]
System processes the page back request → System should clear GCM1021-KEY-FIELDS and GCT2-BROKER-NAME-SEGMENT to reset search position
[Clear Control Fields, Data Fields, and Message Areas]
Key fields have been cleared → System should clear GCM1021-CNTL-FIELDS, GCM1021-DATA-FIELDS, and GCM1021-MSG-FILLER
[Last line broker name empty?]
The broker name long field:
the broker name short field in the last display line is empty (SPACE)
→ Set last page message to notify user they have reached the end of data AND do not attempt to retrieve additional records
[No More Records Available]
Database operation completes AND the retrieved broker name fields are empty (indicating no more records) → Set last page message to inform user that no additional records are available
[Set Last Page Message]
Either the current page shows empty records:
database retrieval returns no additional records AND user message number is not already set to a numeric value
→ Set user message number to last page constant to display appropriate message to user
[Set CONFIRM-ADD Message]
The system processes the successful add operation result → The system sets the CONFIRM-ADD message to be displayed to the user
[Set CONFIRM-CHANGE Message]
The system processes the successful modify operation result → The system sets the CONFIRM-CHANGE message to be displayed to the user
[Set CONFIRM-DELETE Message]
The system processes the successful delete operation result → The system sets the CONFIRM-DELETE message to be displayed to the user
[Return to Display Screen]
The confirmation message processing is complete → The system returns to the main broker name display screen for continued user interaction
[Set Update Violation Message]
User is not UPDATE-USER and not SUPER-USER → System displays update violation error message, highlights function field, and returns to display screen
[Set Last Page Message]
User attempts page forward and last displayed record is empty, or database retrieval returns non-space status indicating no more records → System displays last page message and remains on current page
[Set First Page Message]
User presses PAGE-BCK key and user message number is not numeric → System displays first page message

Structural Validations

[4:Invalid PF Key Handling - Display screen error]
User presses an invalid function key → Display invalid function key message and remain on display screen
[5:Invalid PF Key Handling Update - Update screen error]
User presses an invalid function key → Display invalid function key message and remain on update screen
[6:Delete Request Validation - PF5 with delete only]
The function code is not set to delete function → Display invalid function key message and remain on update screen
[7:Function Code Validation - Valid Add/Modify/Delete]
The function code is evaluated → If function code is not ADD, MOD, or DEL, display bad function code error message and remain on display screen, otherwise proceed with function processing
[9:Add Function Key Validation - Key field not blank]
The broker name long field is evaluated → If field is blank, zero, low-value, or high-value, display blank/zero error message, set error flag, and remain on display screen, otherwise proceed with add processing
[10:Database Record Retrieval for Add - Check existing record]
System searches for existing record with same key → If record already exists, display invalid add message and remain on display screen, otherwise proceed to update screen with add description
[11:Database Record Retrieval for Modify/Delete - Get existing record]
System searches for existing record with specified key → If record exists, populate update screen with current data and appropriate function description, if record does not exist, display invalid change or delete message and remain on display screen
[17:Broker Name Field Validation - Short name not blank]
Field validation is performed → If field is blank, zero, high-value, or low-value, set validation error flag, highlight field, and display blank/zero error message
[18:First Character Validation - First char not blank]
First character validation is performed → If first character is blank, high-value, or low-value, set validation error flag, highlight field, and display specific first character error message
[28:Error Message Display - Validation/database errors]
Error type is determined → Display specific error message such as invalid function code, blank/zero error, update violation, database update error, or field-specific validation errors
[Set Error Message: NO-ACCESS-TO-BROKER-NAME-TABLE]
The system processes the access denial → The system sets NO-ACCESS-TO-BROKER-NAME-TABLE message and redirects to GC-MENU-SCREEN
[Set first page message if applicable]
The page navigation is processed → The first page message is set to indicate the user has reached the beginning of the data
[Is Last Record Complete?]
User requests to navigate to the next page AND the last displayed record has empty broker name long field:
empty broker name short field
→ System prevents page navigation, clears control and key fields, sets last page message, and maintains current display
[Set error message: PF Key Invalid]
User presses an invalid PF key selection AND the current message ID is BROKER-NAME-DISPLAY-MOD AND the PF key is INV-PFKEY-SELECTION → Set user message to CST-PF-KEY-INVALID AND Execute display screen processing to show the error message
[User presses invalid PF key on update screen]
The user presses an invalid PF key selection (INV-PFKEY-SELECTION) → The system sets an invalid PF key error message (CST-PF-KEY-INVALID) and sends the update screen back to the user with the error message displayed
[Set invalid PF key error message]
User presses PF5 (DELETE-REQUEST) key AND function code is not DEL-FUNCTION → System displays invalid PF key error message and returns to update screen
[Is Function Code = ADD, MODIFY, or DELETE?]
The system receives a function code that is not ADD-FUNCTION, MOD-FUNCTION, or DEL-FUNCTION → The system should reject the request and set an invalid function code error message
[Set Invalid Function Code Error Message]
The function code validation fails and no previous error message exists → The system should set the user message to 'CST-BAD-FNC-CDE-1005' indicating invalid function code
[Set authorization violation message]
The authorization check fails and no numeric message is already set → Set the update violation message number to inform user of insufficient privileges
[Return to display screen with error]
The update violation message and field highlighting are set → Execute send display operation to return user to display screen with error indicators
[Set blank/zero error message]
No numeric error message is currently set → The system should set the blank zero error message (CST-BLANK-ZERO-ERR) to inform user of the validation failure
[Mark key field with error flag if blank/low/high value]
The broker name long key field equals SPACE:
LOW-VALUE
HIGH-VALUE
→ The system should set the field value to CST-EDIT-ERROR-FLAG to mark it for user correction
[Record found in database?]
System attempts to retrieve an existing record with the same broker name key and the record is found in the database → System sets invalid add error message, highlights the key field with error attributes, and returns to display screen with error indication
[Execute database lookup to check for duplicate]
The system executes a database lookup using the broker name key → If a record with the same key already exists, display an invalid add error message and highlight the key field, otherwise proceed with the add operation
[Set duplicate record error message]
The database lookup returns a successful status indicating the record already exists → Set the invalid add error message, highlight the broker name key field with error attributes, and return to the display screen
[Display error message for invalid modify]
The record does not exist in the database → An invalid modify error message is displayed
[Display error message for invalid delete]
The record does not exist in the database → An invalid delete error message is displayed
[Highlight key field with error]
An error message is displayed → The broker name key field and function field are highlighted to indicate the error location
[Set 'First Page' message]
User is already at the first page and no error message is currently set → First page message is displayed to inform user they are at the beginning
[Set last page indicator message]
The system needs to inform the user about the result and the user message number is not already set → The last page indicator message (CST-LAST-PAGE) is set to inform the user that no more records are available
[Send Display Screen]
PF key is PAGE-BCK and user message number is not numeric → System sets first page message to inform user they are at the beginning
[Is broker short name blank, zero, high-value, or low-value?]
The broker short name is SPACE or ZERO or HIGH-VALUE or LOW-VALUE → Set validation error flag, mark field with error highlighting, and set blank/zero error message
[Is first character of broker name blank, high-value, or low-value?]
The first character of broker short name is SPACE or HIGH-VALUE or LOW-VALUE → Set validation error flag, mark field with error highlighting, and set first character error message
[Is broker short name SPACE, ZERO, HIGH-VALUE, or LOW-VALUE?]
The broker short name field contains SPACE, ZERO, HIGH-VALUE, or LOW-VALUE → The system marks the update as invalid, highlights the field for user attention, sets an edit error flag if the field contains SPACE, LOW-VALUE, or HIGH-VALUE, and displays a blank/zero error message
[Is first character SPACE, HIGH-VALUE, or LOW-VALUE?]
The first character of the broker short name is SPACE, HIGH-VALUE, or LOW-VALUE → The system marks the update as invalid, highlights the field for user attention, and displays a first character error message
[Is broker short name SPACE, ZERO, HIGH-VALUE, or LOW-VALUE?]
The broker short name field contains SPACE, ZERO, HIGH-VALUE, or LOW-VALUE → The system marks the field as invalid, highlights it with error attributes, sets an error flag for display values, and displays a blank/zero error message
[Is first character SPACE, HIGH-VALUE, or LOW-VALUE?]
The first character of the broker short name is SPACE, HIGH-VALUE, or LOW-VALUE → The system marks the field as invalid, highlights it with error attributes, and displays a first character error message
[Validate Broker Short Name Field]
The broker short name field is blank, zero, high-value, or low-value → The system sets validation error flag, highlights the field with error formatting, and displays blank/zero error message
[Is first character blank or invalid?]
The first character of broker short name field is blank, high-value, or low-value → The system sets validation error flag, highlights the field with error formatting, and displays first character error message
[Set database update error message]
The database update operation fails → The system sets database update error flag and displays database update error message
[Is broker short name field SPACE, ZERO, HIGH-VALUE, or LOW-VALUE?]
The broker short name field contains SPACE, ZERO, HIGH-VALUE, or LOW-VALUE → The system marks the field as invalid, highlights it with error attributes, sets an error flag if the field contains SPACE, LOW-VALUE, or HIGH-VALUE, and displays a blank/zero error message
[Is first character of broker short name SPACE, HIGH-VALUE, or LOW-VALUE?]
The first character of the broker short name field is SPACE, HIGH-VALUE, or LOW-VALUE → The system marks the field as invalid, highlights it with error attributes, and displays a first character error message
[Is broker short name SPACE, ZERO, HIGH-VALUE, or LOW-VALUE?]
The broker short name is SPACE:
ZERO
HIGH-VALUE
LOW-VALUE
→ The system marks the update as invalid AND highlights the field with error attribute AND sets blank/zero error message
[Is broker short name SPACE, LOW-VALUE, or HIGH-VALUE?]
The system processes the invalid field value → The system sets the field to edit error flag value
[Is first character SPACE, HIGH-VALUE, or LOW-VALUE?]
The first character of broker short name is SPACE:
HIGH-VALUE
LOW-VALUE
→ The system marks the update as invalid AND highlights the field with error attribute AND sets first character error message
[Set Confirmation Delete Message]
The database delete operation completes successfully → The system sets a confirmation delete message to inform the user of successful deletion
[Set Database Update Error Message]
The database delete operation fails → The system sets a database update error message and marks the update as invalid
[Is broker short name blank, zero, or invalid characters?]
The broker short name field is SPACE:
ZERO
HIGH-VALUE
LOW-VALUE
→ Set update as invalid AND highlight the field for correction AND apply edit error flag if field is SPACE OR LOW-VALUE OR HIGH-VALUE AND set blank zero error message
[Is first character blank or invalid?]
The first character of broker short name field is SPACE:
HIGH-VALUE
LOW-VALUE
→ Set update as invalid AND highlight the field for correction AND set first character error message
[Is first character of broker name blank, high-value, or low-value?]
The first character of the broker name short field is blank, high-value, or low-value → Set the update as invalid, highlight the field with error attribute, and display first character invalid error message
[Set error flag for invalid update]
The validation check is performed → Set the update status flag to UPDATE-NOT-VALID to prevent the update operation from proceeding
[Display error message: First character invalid]
The user message number is not already numeric (indicating no prior error) → Set the user message number to the first character invalid error code (CST-GCX102-001-ERR)
[Set update operation as invalid]
The database insertion fails with an error status → The system marks the update operation as invalid and sets a database update error message if no message is already set
[Set update operation as invalid and Set database update error message]
The database insert operation fails with an error status → The update operation is marked as invalid and a database update error message is set for user notification
[Set update validation flag to invalid and Set database update error message]
The database update operation fails → The update validation flag is set to invalid and a database update error message is set for display to the user
[Set update not valid flag and Set database update error message]
The database operation fails or encounters an error → The update is flagged as not valid and a database update error message is set for user notification
[Set database update error message]
The system needs to notify the user of the failure → If no message is already set, the system sets a database update error message
[Display Database Error Message CST-DB-UPDATE-ERR]
The database deletion operation fails → Display database update error message and set update invalid flag
[Is PF5 Delete Key Pressed?]
The delete function is requested but PF5 delete confirmation key is not pressed → The system should set a confirmation delete message and mark the update as invalid without proceeding with the deletion
[Set Database Update Error Message]
The database delete operation fails for any reason → The system should display a database update error message and mark the update as invalid
[Is PF5 Delete Key Pressed?]
The system checks if the PF5 delete confirmation key was pressed → If PF5 was not pressed, set confirmation delete message and mark update as invalid, otherwise proceed with deletion process
[Set last page message if no more data]
User message number is not already set to a numeric value → First page message is set to inform user they are at the beginning
[Set last page message if no more data]
Database record retrieval fails indicating end of data and user message number is not already numeric → Last page message is set to inform user they have reached the end of available data
[Set First Page Message]
No records are found or user message is not already set → System should set CST-FIRST-PAGE message to inform user they are at the beginning
[Set PF Key Invalid Message]
User presses an invalid PF key or function key selection → System displays PF key invalid error message and returns to appropriate screen
[Set Bad Function Code Message]
Function code entered is not ADD-FUNCTION, MOD-FUNCTION, or DEL-FUNCTION → System displays bad function code error message, highlights function field, and returns to display screen
[Set Blank/Zero Error Message]
Broker name long field is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE, or broker name short field is SPACE, ZERO, HIGH-VALUE, or LOW-VALUE → System displays blank zero error message, sets error flag in field, highlights field attributes, and returns to appropriate screen
[Set Invalid Add Message]
Broker name record already exists in the database → System displays invalid add error message, highlights broker name and function fields, and returns to display screen
[Set Invalid Change Message]
Broker name record does not exist in the database → System displays invalid change error message, highlights broker name and function fields, and returns to display screen
[Set Invalid Delete Message]
Broker name record does not exist in the database → System displays invalid delete error message, highlights broker name and function fields, and returns to display screen
[Set Database Update Error Message]
Database operation fails with non-space status code → System displays database update error message, sets update as invalid, and returns to update screen
[Set First Character Error Message]
First character of broker name short field is SPACE, HIGH-VALUE, or LOW-VALUE → System displays first character error message, sets update as invalid, and highlights broker name short field
[Set Error Flag in Field]
Broker name long field is SPACE, LOW-VALUE, or HIGH-VALUE, or broker name short field contains invalid values → System sets CST-EDIT-ERROR-FLAG in the respective field
[Send Display Screen with Error]
Error involves invalid function code, authorization violation, invalid add/change/delete operations, or navigation errors → System sets output select code to BROKER-NAME-DISPLAY and sends display screen with error message
[Send Update Screen with Error]
Error involves invalid PF key, database update failure, or field validation errors in update mode → System sets output select code to BROKER-NAME-UPDATE and sends update screen with error message

Module: GCX104 1 Consolidated Epic Story

Epic: GCX104 Complete EDI Specification Extracted from Legacy

Contains 179 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX104 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Merlin Message Fields]
The system begins Merlin format processing → The system clears all Merlin message fields including copy usercode, destination usercode, and message text to prepare for new content

Core Acceptance Criteria

[4:Entry Point Routing]
Message ID is not customs log display and first 6 characters do not match any train or cargo display modules → System initializes keys to default values and performs initial display processing
[11:Spawn Entry Processing]
Module type matches train or cargo display variants → System sets input field from message, clears keys, and retrieves display data
[15:Next Page Data Validation]
System checks last data line for content → If last line fields are all spaces, system sets last page message, otherwise retrieves next page data
[17:Security Authorization Check]
User does not have UPDATE, HEAD-OFFICE, INQUIRY, or SUPER user privileges for the requested function → System sets update violation message
[25:Database Root Retrieval]
Root record retrieval is initiated with log route key → System calls database to get root record and if not found, highlights key and sets key not found message
[31:Detail Records Loading]
Detail records need to be loaded for printing → System retrieves all detail records, formats each with execution date/time and user information, and handles message overflow by splitting long messages
[32:Merlin Message Sending]
Print transmission is initiated or line count exceeds 480 → System calls EMCSEND3 to send print job and prepares next page if more data exists
[Perform Blank Screen Detection]
Screen display processing is initiated → The 7600-BLANK-SCREEN procedure is performed to clear any existing display data
[Is Message ID = GCO041?]
The message ID equals 'GCO041' → The system proceeds to validate the SCAC code in the customs log key
[Clear Input Fields]
The system needs to prepare the screen for corrected input → The system clears the return line number and performs field clearing operations
[Message ID = Customs Log Display?]
The message ID equals CUSTOMS-LOG-DISPLAY-MOD → Route to customs log display processing flow
[From Train/Cargo Display?]
The first 6 characters of the message ID match US-TRAIN-DISPLAY-MOD-6:
US-CARGO-DISPLAY-MOD-6
CA-CARGO-DISPLAY-MOD-6
CA-TRAIN-DISPLAY-MOD-6
CA-TRAIN-DISPLAY-MOD-6A
CA-TRAIN-DISPLAY-MOD-6B
CA-TRAIN-DISPLAY-MOD-6C
CA-TRAIN-DISPLAY-MOD-6D
CA-CARGO-DISPLAY-MOD-6A
CA-CARGO-DISPLAY-MOD-6B
CA-CARGO-DISPLAY-MOD-6C
→ Route to spawn entry processing
[PF Key = Page Forward?]
The PF key equals PAGE-FWD → Route to page forward processing and send display
[PF Key = Print?]
The PF key equals PRINT-VALUE → Route to display processing, prepare Merlin print job, and send display
[PF Key = Selection Request?]
The PF key equals SELECTION-REQUEST → Route to spawn transaction processing
[Route to Current Display Processing]
The PF key is not PAGE-FWD, PRINT-VALUE, SELECTION-REQUEST, or INV-PFKEY-SELECTION → Route to standard display processing and send display
[First Time Entry]
The message ID does not match CUSTOMS-LOG-DISPLAY-MOD and first 6 characters do not match any train/cargo display module patterns → Initialize log route key and display parameters, process display, and send display
[Clear Message Filler Area]
The system initializes the display fields → The message filler area is cleared to spaces
[Last Line Has Data?]
The last data line has no done-by-who, execution date, execution time, and action data → The system displays a last page message and prevents forward navigation
[Set Position to Next Page]
The system prepares to retrieve next page data → The system sets the log route key and detail key to current values, clears all data areas including date-time-current, data fields, and message filler areas
[Format Detail Line Data]
The system formats the detail line data → The system converts the detail key to execution date/time format, extracts user code, activity message, and process date/time from the detail record and formats them into a print line
[Message Has Extension?]
The detail message contains additional content beyond position 50 (characters 51-60 are not spaces) → The system creates an additional print line with the extended message content and increments the line counter
[Send Final Page to Merlin]
The system completes the print job → The system sends the final page to the print destination, displays a successful print message, and clears the print ID field
[Format Activity Message]
The system formats the record for print display → The activity message is moved from the detail record to the display format
[Add Formatted Line to Print Buffer]
The system builds the print report → The formatted data line is added to the print buffer at the current line position and line counter is incremented
[Message Has Extended Text?]
The system processes the message for print formatting → If positions 51-60 of the message contain non-space characters, extended text processing is required
[Create Additional Line for Extended Text]
The system processes extended text for printing → A new line is created with spaces in execution date/time, user ID, and process date/time fields, and the extended text is placed in the activity field
[Add Extended Text Line to Buffer]
The system continues building the print report → The extended text line is added to the print buffer at the next line position and line counter is incremented
[Move Activity Message to Display Field]
Activity information needs to be displayed → The message should be moved to the action display field for the current record
[Load Detail Record into Buffer]
The detail record is processed for printing → The record data including execution date, time, user ID, and activity message is formatted and added to the buffer at the current line position
[Message Has Extended Data?]
The system checks positions 51-60 of the message field → If positions 51-60 contain non-space characters, the message has extended data requiring an additional buffer line
[Add Extended Data Line]
The extended data is processed → A new buffer line is created with blank timestamp and user fields, containing only the extended message data from positions 51-60
[Clear Buffer]
The page transmission is complete → The print buffer text area is cleared to spaces to prepare for new content
[User Message Already Set?]
A user message number is already set and is numeric → Exit the current position display processing immediately without further processing
[Retrieve Root Segment Data]
The system attempts to retrieve the root log segment → Call the database to get the root segment and check if the record exists
[Root Found Successfully?]
The root log record is found successfully → Format the root data for display and proceed to retrieve associated detail records
[Clear Return Line Number]
No error message is currently set → Clear the return line number field to spaces
[Copy Input Field to Log Key]
Processing spawn entry data initialization → Copy the message input field value to both the log route key and the database key field
[Clear All Data Fields]
Starting the data retrieval process → Clear all log route data, detail data, current date-time, data fields, and message filler areas to spaces
[Retrieve Root Segment Data]
Initiating data retrieval for the log entry → Call the database access routine to retrieve the root log route segment using the specified key
[Retrieve Detail Records Loop]
The database status indicates successful retrieval (status code is space) → Execute detail record retrieval loop from record 1 until reaching the last data line or no more records are available
[Call Database to Get Root Segment]
The system attempts to retrieve the root segment data from the database → The system calls the database interface to fetch the root segment record
[Move Action Message to Display Field]
The system processes the detail record for display → The message describing the action is moved to the action display field for the current line
[User Message Already Set?]
The user message number is already set to a numeric value → Skip all page backward processing and exit immediately
[Current Key ≠ Last Key?]
The current log route key != the last route key → Clear the return line number to spaces
[Last Line Has Data?]
The system checks the last data line for content in done-by-who, execution date, execution time, and action fields → If all fields are empty, the system should set a last page message and prevent further forward navigation
[User Message Numeric?]
The user message number is numeric → The spawn return processing should be skipped and exit immediately
[Clear Return Line Number]
The user message number is not numeric → The return line number field should be cleared to spaces
[Clear All Data Fields]
Preparing for data retrieval → All route data, detail data, current date-time, data fields, and message filler should be cleared to spaces
[Retrieve Root Segment Data]
Data retrieval begins → The root segment should be retrieved using the log route key via database call
[Retrieve Detail Records Loop]
The database status indicates success → Detail records should be retrieved in a loop until the last data line is reached or no more records are available
[Set Security Violation Message]
The user does not have UPDATE-USER:
HEAD-OFFICE-USER
INQUIRY-USER
SUPER-USER privileges for the requested function type
→ Set security violation message number for display to user
[Detail Data Formatting]
The detail data is being formatted for display → The user code from the detail record is assigned to the 'done by who' display field and the message from the detail record is assigned to the action display field
[Move Root Key to Display Fields]
The root data formatting process begins → The root key is moved to both the current log route key field and the last route key field in the display structure
[Extract Record Type Code]
Root data is being formatted for display → The record type code is extracted from the root segment and moved to the display type code field
[Store Detail Key for Last Position]
The detail data formatting begins → The detail key is stored as the last detail key for position tracking
[Format User ID Who Performed Action]
Formatting detail data for display → The ACF2 user code is moved to the 'done by who' display field
[Format Action Message]
Formatting detail data for display → The message is moved to the action display field
[Extract Processing Month from Load Date]
Formatting detail data for display → Characters 3-4 of the load date are extracted and moved to the processing month display field
[Extract Processing Day from Load Date]
Formatting detail data for display → Characters 5-6 of the load date are extracted and moved to the processing day display field
[Extract Processing Hour from Load Time]
Formatting detail data for display → Characters 1-2 of the load time are extracted and moved to the processing hour display field
[Extract Processing Minutes from Load Time]
Formatting detail data for display → Characters 3-4 of the load time are extracted and moved to the processing minutes display field
[Clear Root Data Segment]
The system clears data segments → The root data segment and detail data segment are set to spaces
[Clear Current Date/Time Display]
The system clears display areas → The current date/time display, data fields display, and message filler fields are all set to spaces
[Start Database Root Retrieval]
The system attempts to retrieve the root segment from the customs log database → The system should initiate the database retrieval process with the specified key
[Set Root Key from Input]
The system prepares to query the database for the root segment → The log route key should be assigned to the database query key parameter
[Set Database Status to Not Found]
The database query is being prepared → The database status should be set to 'not found' as the initial state
[Call Database to Get Root Segment]
The system executes the database retrieval operation → The database should be called to retrieve the root segment using the CIMS interface
[Clear Display Fields]
The system processes the not found condition → The date-time current, data fields, and message filler should be cleared to spaces
[Set Key Not Found Message]
The system processes the not found condition → The user message should be set to indicate the key was not found and the last route key should be set to low-value
[Call Database System to Get Next Detail Record]
The system calls the database to get the next detail record using GNP operation → The system retrieves the next customs log detail segment from the GCSLGDP database
[Move Action Message to Display Field]
The detail data is being formatted for display → The system moves the message content to the action display field
[Next Page Data Retrieval - Retrieve data for next page navigation]
The system attempts to retrieve the next page of customs log data by first accessing the root segment with the current route key and then retrieving the next detail segment with the current detail position key → The system successfully retrieves both the root customs log segment and the next detail segment, making next page data available for display
[Retrieve Customs Log Root Segment]
The system attempts to retrieve the customs log root segment using the current route key → The system accesses the customs log root segment and establishes the foundation for retrieving associated detail records
[Retrieve Next Detail Segment]
The system attempts to retrieve the next detail segment using the current detail position key → The system accesses the next detail segment containing the log data records for the next page display
[Format Detail Record Data]
The system formats the detail record → The system converts the detail key to execution date/time format, extracts user code, activity message, and process date/time, and formats them into a printable line
[Format Detail Record Data]
The system processes the extended message portion → The system creates an additional print line with the extended message content (positions 51-60) and clears other fields for the continuation line
[Set Success Message]
All pages have been sent without errors → The system displays a print successful message and clears the print ID field to spaces
[Clear Merlin Message Structure]
The system begins preparing a Merlin print job → All Merlin message fields are cleared to spaces including copy usercode and to usercode
[Clear Merlin Message Structure]
The system initializes the Merlin message structure → The EMI-TEXT field is cleared to spaces
[Retrieve Customs Log Root Key]
The system retrieves the root record for the print job → The system calls CIMS with GU function to get the GCSLGRT segment using the log route key
[Format Activity Message]
The system formats the record for print display → The message field should be extracted and assigned to the activity display field
[Message Has Additional Text?]
The system checks for extended content → If positions 51-60 of the message are not spaces, additional processing is required
[Create Additional Line for Extended Message]
The system creates an additional line for the extended content → A new line should be created with spaces for date/time and user fields, and the extended message content in the activity field
[Add Extended Message Line to Print Output]
The system adds the extended line to the print output → The extended message line should be moved to the next position in the print text buffer
[Increment Line Counter Again]
The system updates the line tracking → The line counter should be incremented by 1 again
[Move User Code to Display, Move Activity Message to Display]
The system formats the record for display → The user code is moved to the 'done by who' display field and the activity message is moved to the action display field
[Retrieve Next Detail Record]
The system attempts to retrieve the next detail record using GNP operation → The system should fetch the next available detail record from GCSLGDP segment
[Format Primary Activity Message]
The system formats the primary activity message → The system should populate execution year, month, day, hour, minute, user code, activity message, and process date/time fields from the detail record
[Move Primary Message to Output Line]
The system assigns the message to an output line → The formatted activity data should be moved to the display line at the current line counter position
[Increment Line Counter, Increment Line Counter Again]
The system updates the line tracking → The line counter should be incremented by 1 to point to the next available line position
[Extended Message Available?]
The system checks for extended message content → Processing should continue with extended message formatting if characters 51-60 of the message field contain non-space data
[Clear Date/Time Fields for Extended Line]
The system prepares the extended message line → The execution year, month, day, hour, minute, user code, and process date/time fields should be set to spaces to show only the extended activity text
[Format Extended Activity Message]
The system formats the extended message → The extended message text (characters 51-60) should be moved to the activity field while keeping other fields as spaces
[Move Extended Message to Output Line]
The system assigns the extended message to an output line → The extended message data should be moved to the display line at the current line counter position
[Send Current Page to Merlin]
The system sends the current page to Merlin → The system should call EMCSEND3 to transmit the formatted activity data and handle any transmission errors
[Print ID Validation Successful]
The system validation confirms the print ID is valid → The system clears the print ID field, formats the print data, and sends the successful print message
[Format Report Title Lines]
The system formats the print report → The system creates title lines using the log route key and adds them to the Merlin message structure
[Set Line Counter to 6]
The system prepares to add detail records → The system sets the line counter to 6 to track the next available line position
[Format Detail Record Data]
The system formats the record for printing → The system extracts and formats the user code, message text, and load date/time information into display format
[Add Detail Line to Message]
The system adds content to the message → The system places the formatted detail line at the current line counter position in the Merlin message text
[Increment Line Counter]
The system updates tracking information → The system increments the line counter by 1 to point to the next available line position
[Message Has Extended Data?]
The system checks for additional content → If characters 51-60 of the message field contain non-space data, the system identifies extended activity information exists
[Format Extended Activity Line]
The system processes the extended data → The system creates a new line with blank date/time and user fields, placing the extended message text in the activity field
[Send Current Message Page]
The system needs to continue processing more records → The system sends the current message via EMCSEND3 call and initializes a new message page with title lines
[Send Final Message Page]
No more detail records exist → The system sends the final message page via EMCSEND3 call to complete the print job
[Format Primary Activity Message]
The system formats the record for display or printing → The system moves the message field to the display field for the action performed
[Add Formatted Line to Print Output]
The system needs to add this information to the print output → The system moves the formatted data line to the EMI text line at the current line count position and increments the line counter
[Extended Message Available?]
The system checks for additional message content → If positions 51-60 of the message field are not spaces, extended message text is available for processing
[Clear Date/Time Fields for Extension]
The system prepares the extended message line → The system clears execution date, time, user ID, and process date/time fields to spaces, keeping only the extended message text
[Format Extended Message Text]
The system formats the extended message line → The system moves the extended message text from positions 51-60 to the activity field while leaving other fields as spaces
[Add Extended Message Line to Print]
The system adds this line to the print output → The system moves the extended message line to the EMI text line at the current line count position and increments the line counter
[Format Execution Date Fields, Format Execution Time Fields]
The system formats the log entry for display → Move the ACF2 user code to the done-by-who field and move the message to the action field in the display record
[Load Primary Message Text]
Processing log data for display → The primary message text should be moved to the activity display field
[Message Has Overflow Text? Characters 51-60 Not Spaces]
Characters 51 through 60 of the message are not spaces → The system should identify that overflow text exists and requires additional processing
[Clear All Display Fields]
Preparing to display the overflow text → All execution date, time, and user identification display fields should be cleared to spaces
[Move Overflow Text to Activity Field]
Processing the overflow text for display → The overflow text should be moved to the activity display field
[Move Activity Message to Output]
The system formats the record for print output → The activity message from the detail record is extracted and placed in the appropriate print output field
[Format Detail Line for Print]
The system prepares the information for print output → All detail information is formatted into a structured print line ready for output
[Format Additional Message Line]
The system formats the continuation line → A new line is created with blank execution date, time, and user fields, containing only the additional message text from characters 51-60
[Add Additional Line to Print]
The system adds the continuation line to print output → The additional message line is placed in the print output buffer at the current line counter position
[Increment Line Counter Again]
The system updates the line tracking for the continuation line → The line counter is incremented by one to reflect the additional line in the output
[Clear Message Sequence Numbers]
The system initializes message parameters → Both numeric and alphabetic message sequence identifiers are cleared to spaces
[Reset Total Messages Counter]
The system sets up message parameters → The total messages sent counter is reset to zero
[Call EMCSEND3 to Send Message]
The system sends the message to Merlin → EMCSEND3 service is called with all required message parameters including user codes, text content, and formatting specifications
[Clear Message Text Buffer]
The system prepares for next message or completes current processing → The message text buffer is cleared to spaces
[Increment Page Number]
The system prepares for the next page of the report → The output page number is incremented by 1
[Set New Page Number]
The system prepares the next message page → The message page number is updated to match the new output page number
[Rebuild Report Header Lines]
The system formats the new page content → All five standard title lines are rebuilt and placed in the message text buffer

Structural Validations

[2:SCAC Code Validation]
The SCAC code field (first 4 characters of log route key) is blank or spaces → System clears all fields, highlights the key field, sets invalid SCAC blank message, and sends display screen
[3:SCAC Access Security Check]
System calls GCCSCAC program to validate user access and receives invalid access flag → System clears all fields, highlights the key field, sets invalid SCAC access message, and sends display screen
[6:Page Forward Navigation]
Current log route key does not equal last route key → System clears fields, highlights key, sets invalid PF2 message, and sends display
[9:Invalid PF Key Handling]
PF key is not recognized as valid function → System sets invalid PF key message and sends display screen
[14:Page Backward Navigation]
Page backward is requested → System clears return line number, clears fields, highlights key, and sets invalid PF1 message
[28:Merlin Print Preparation]
Print ID is blank → System sets print ID spaces message, otherwise validates print ID and prepares print job
[29:Print ID Validation]
System validates print ID through ISCCCOM call → If print ID is not found, system highlights print ID field and sets invalid print ID message
[Clear Edit Error Flag]
The system processes the display request → The GCM1041-KY-LOG-RT field is cleared to SPACE to remove the error flag
[Is SCAC Code in Customs Log Key Blank?]
The SCAC code in the customs log key (first 4 characters) is blank or contains only spaces → The system clears the return line number, clears all input fields, highlights the key field, sets an invalid SCAC blank message, and sends the display screen to prompt for valid input
[Set Invalid SCAC Blank Message]
The validation process determines the input is invalid → The system sets the user message number to indicate invalid SCAC blank condition
[Set Access Denied Message]
User message number is not already set to a numeric value → The user message number is set to invalid SCAC access message code
[Display Error Screen]
System needs to inform user of access denial → The display screen procedure is performed to show the error message to the user
[PF Key = Invalid?]
The PF key equals INV-PFKEY-SELECTION → Set invalid PF key message and send display
[Route to Invalid Program Function]
The message does not match any recognized patterns for customs log display or train/cargo display modules → Set invalid program function message and send display
[Current Key = Last Displayed Key?]
The current log route key does not match the last displayed route key → The system clears all display fields, highlights the key field, displays an invalid PF2 key error message, and prevents forward navigation
[Next Page Data Available?]
The system attempts to retrieve the next page data using current log route key and last detail key and the database returns a not found status → The system displays a last page message and prevents forward navigation
[Print ID Provided?]
The print ID field is blank or contains only spaces → The system displays an error message indicating print ID is required and stops print processing
[Print Destination Valid?]
The system validates the print destination and the destination is not found or not accessible → The system highlights the print ID field and displays an error message indicating the print ID is not valid
[Root Record Found?]
The system attempts to retrieve the customs log root record using the log route key and the record is not found → The system highlights the print ID field and displays an error message indicating the root record was not found
[PF Key = Invalid Selection?]
The PF key pressed equals the invalid PF key selection value → Set the invalid PF key message number and display the error to the user
[Set Invalid PF Key Message]
The message ID equals the customs log display module identifier AND the PF key equals the invalid PF key selection constant → Move the invalid PF key error message number to the user message field
[Display Error Message to User]
The system needs to communicate the error to the user → Execute the send display routine to show the error message on the screen
[PF Key = Page Back AND Not at Last Key?]
The current log route key does not match the last route key displayed → Clear all display fields, highlight the key field, set invalid PF1 message, and exit processing
[Root Found Successfully?]
The root log record is not found in the database → Reset the last route key, highlight the key field, and set key not found message
[Set First Page Message]
No user message has been set during processing → Set a message indicating the user is at the first page
[Error Message Already Set?]
An error message number is already set and is numeric → Skip all spawn entry processing and exit immediately
[Set Key Not Found Message]
The database returns a 'not found' status code → The system sets the last route key to low-value, highlights the key field, and sets an appropriate 'key not found' message
[User Message Not Set?]
The user message number is not numeric (no message currently set) → Set the user message to invalid PF1 error message
[PF Key = Page Back AND No Message Set?]
The PF key is page back AND the user message number is not numeric (no message set) → Set the user message to first page message
[Current Key = Last Key?]
The system validates the page forward request → The system should clear all fields, highlight the key field, set an invalid PF2 error message, and prevent forward navigation
[Next Detail Record Found?]
The system positions to the current root and detail key and attempts to read the next detail record → If no next detail record is found, the system should set a last page message, otherwise allow forward navigation to proceed
[Blank Screen Detected and Cleared]
Key Log RT field is empty AND Last RT Key field is empty AND Done By Who field for line 1 is empty AND Exec Date field for line 1 is empty AND Exec Time field for line 1 is empty AND Action field for line 1 is empty → Initialize Detail Key to zero AND Initialize Last Detail Key to zero AND Set Last RT Key to low values AND Clear Key Log RT field AND Clear RT Data segment AND Clear Detail Data segment AND Clear Return Line Number AND Clear Date Time Current AND Clear Data Fields AND Clear Message Filler
[Root Segment Found?]
The system checks the database operation result → The system should determine if the root segment was found based on the database status code being space
[Root Segment Found?]
The system checks if the root segment was successfully found → If the root segment is found, the system proceeds to retrieve detail segments; if not found, no more data is available
[Detail Segment Found?]
The system checks if the detail segment was successfully found → If the detail segment is found, next page data is available; if not found, no more data is available for pagination
[Print ID Provided?]
The print ID field is empty or contains only spaces → The system displays an error message indicating that print ID is required and stops print processing
[Print ID Valid?]
The system validates the print ID and finds it does not exist or is not accessible → The system highlights the print ID field, displays an invalid print ID error message, and prevents print processing
[Root Data Found?]
The system attempts to retrieve the root customs log record and the record is not found → The system highlights the print ID field, displays a root record not found error message, and terminates print processing
[Retrieve Customs Log Root Key]
The system attempts to retrieve the root record → If the root record is not found, highlight the print ID field and display root not found message
[Line Count Exceeds Page Limit?]
The system checks the current line count against the page limit → A new page should be triggered if the line count exceeds 480 lines
[Print ID Field Empty?]
The print ID field is empty or contains only spaces → The system displays an error message indicating that print ID is required
[Print ID Valid in System?]
The system validation check returns that the print ID is not found → The system highlights the print ID field and displays an invalid print ID error message
[Root Data Found?]
The system checks the retrieval status → If the root record is not found, the system sets an error message indicating root not found and terminates processing
[Message Size Limit Reached?]
The system checks the line counter → If the line counter exceeds 480 lines, the system determines the message size limit has been reached
[Message Has Additional Text?]
The system checks for additional message content → If characters 51-60 of the message contain non-space data, additional text processing is required
[Message Send Successful?]
The system checks the transmission result → The message transmission is considered successful if the return status flag equals '0', otherwise it is considered failed
[Log Error Message]
The system processes the transmission failure → The error status flag is logged as an error message for further processing
[Call Error Handler]
The system handles the transmission error → The error handling routine CERR is called to process the error condition

Module: GCX106 1 Consolidated Epic Story

Epic: GCX106 Complete EDI Specification Extracted from Legacy

Contains 639 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX106 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize EDI Transaction Parameters]
The system begins EDI transaction processing → All necessary EDI transaction parameters should be initialized with default values and system settings
[Initialize Multi-Part Processing]
Multi-part processing is required → The system initializes part counters and processing variables for multi-part email transmission
[Initialize Print Processing]
System initializes print processing → System begins the actual report generation and transmission process
[Initialize Import Report Parameters]
The system begins report generation process → Report parameters are initialized with default values for format, transmission method, and recipient settings
[Initialize Import Report Parameters]
The system begins report preparation → All report parameters are initialized including equipment counters, report buffers, and transmission settings

Core Acceptance Criteria

[EDI Transaction Processing]
User lacks RESEND authorization:
train is not in resend status
→ The system prevents resend operation and displays authorization or status error
[Email Report Transmission]
Report is being sent via email → The system splits report into multiple emails with continuation headers and proper pagination
[Call GCWUTRIO Module with Train ID]
The system calls GCWUTRIO module with the train ID → Train list data is retrieved from the GCUTR train root segment
[Scan Preceding Equipment Positions]
The system begins scanning equipment positions before the container position → Each preceding equipment position is examined in reverse sequence order
[Refresh Equipment Status Counters]
The system prepares to redisplay the train screen → The system must refresh all equipment status counters (released, held, proceed, etc.) to reflect current state
[Check 30-Day Business Rule - Validate train EDA against current system date and implement 30-day modification restriction]
User attempts to modify train data and the system calculates the difference between EDA and current date → If the EDA is more than 30 days from current date, modification is blocked with restriction message, otherwise modification is allowed
[Display Restriction Message]
User attempts to modify train data → Display clear message explaining 30-day modification restriction
[Is Train Status = LOCKED?]
The train status is LOCKED → All modification operations are prevented and lock status message is displayed
[Hold Allows Modifications?]
Hold reason does not allow modifications → All modifications are prevented and hold status message is displayed
[Train Being Processed by Another User?]
Train is being processed by another user → Temporary lock is set, processing message is displayed, and busy status is returned
[User Profile Found?]
The user security profile is not found in GCSTBRT segment → The system sets authorization as denied for all operations
[Authorization Granted?]
If the final authorization result → If authorization is granted, the operation proceeds; if denied, an authorization error message is displayed
[Access User Authorization Database]
The system accesses the user authorization database → The GCSTBRT security segment is read to obtain user credentials and permissions
[Read GCSTBRT Security Segment]
The system reads the GCSTBRT security segment → User security data is retrieved for further validation processing
[Check Super User Status]
The user has super user status 'S' or 'U' → The system grants resend authorization immediately
[Is Super User 'S/U'?]
The user has super user status 'S' or 'U' → The system grants add/modify authorization immediately
[Check User Authorization]
The system checks user authorization level → Only users with Super User privileges are allowed to proceed with EDI processing, otherwise authorization error is returned
[Check Train Type]
The system determines train type → If train ID ends with 'T' suffix, call export EDI module GCCU358T, otherwise call import EDI module GCCE358
[Call Export EDI Module GCCU358T]
The system processes export EDI transaction → The export EDI module GCCU358T is called to handle export-specific processing
[Call Import EDI Module GCCE358]
The system processes import EDI transaction → The import EDI module GCCE358 is called to handle import-specific processing
[Generate Export Report to Merlin]
The system generates export report → An export-specific report is created and prepared for transmission to Merlin system
[Generate Import Report to Merlin]
The system generates import report → An import-specific report is created and prepared for transmission to Merlin system
[Send Report via Email System]
The system sends report via email → The report is transmitted through email system using EMCSEND functionality
[Set Train Resend Flag]
The system updates train record → The train resend flag is set to indicate successful EDI processing completion
[Update Train Status]
The system updates train status → Train status is updated to reflect completed EDI transaction processing
[Log EDI Transaction]
The system logs the transaction → An audit log entry is created documenting the EDI transaction processing details
[Check Train Type]
EDI transaction processing is initiated → System checks train type and routes to GCCU358T for export trains or GCCE358 for import trains
[Call GCCU358T for Export Processing]
EDI processing begins → System calls GCCU358T module to handle export train processing
[Call GCCE358 for Import Processing]
EDI processing begins → System calls GCCE358 module to handle import train processing
[Equipment Has Action Code?]
Processing equipment for EDI transmission → System checks each equipment for ADD, DELETE, or no action code and routes accordingly
[Add Equipment to Consist]
Processing equipment actions → System adds the equipment to the train consist for EDI transmission
[Remove Equipment from Consist]
Processing equipment actions → System removes the equipment from the train consist for EDI transmission
[Transmit to Merlin System]
Initiating transmission to Merlin → System sends the complete report package to the Merlin system
[Update Train Status]
Processing successful transmission results → System updates train status to indicate successful EDI processing completion
[Retry Transmission]
Attempting to recover from transmission failure → System retries transmission to Merlin system
[Set Resend Flag Complete]
Finalizing EDI processing → System sets the resend flag to complete status indicating EDI processing is finished
[EDI Resend Operation?]
The system checks if this is an EDI resend operation → Equipment action code processing is enabled for EDI resend operations and skipped for regular operations
[Action Code Type?]
The system reads the equipment action code → ADD action codes trigger equipment addition processing, DELETE action codes trigger equipment removal processing, and blank or other codes skip equipment processing
[Add Equipment to Train Consist]
The system processes the equipment addition → The equipment is added to the train consist and becomes part of the active equipment list
[Update Double-Stack Counters]
The system updates double-stack counters → Double-stack counters are incremented based on the equipment type and traffic classification
[Remove Equipment from Train Consist]
The system processes the equipment removal → The equipment is removed from the train consist and no longer part of the active equipment list
[Correct Double-Stack Counters]
The system corrects double-stack counters → Double-stack counters are decremented based on the equipment type and traffic classification
[More Equipment to Process?]
The system checks for additional equipment records → Additional equipment records continue the processing loop and no additional records proceed to train consist update
[Update Train Consist]
The system updates the train consist → The train consist reflects all equipment additions and deletions with accurate equipment counts and status
[Generate EDI Transaction Response]
The system generates EDI transaction response → An EDI response is created confirming the successful processing of equipment action codes and train consist changes
[Retrieve Cargo Information]
The system validates equipment for addition to a train → The system should call GCUSRT segment to retrieve cargo information and verify cargo exists in the system
[Train Status Arrived?]
The system checks if train status is 'ARRIVED' → If train has arrived, prepare EDI 309 transaction for cargo detachment, otherwise use standard cargo detachment process
[Prepare EDI 309 Transaction]
EDI 309 transaction preparation is initiated → Create EDI 309 transaction with proper cargo detachment information and validate transaction requirements
[Queue EDI 309 for Transmission]
Transaction is ready for transmission → Queue EDI 309 transaction for transmission and update equipment status accordingly
[Standard Cargo Detachment]
Standard cargo detachment process is initiated → Update cargo records to reflect detachment from equipment without EDI transaction requirements
[Set Equipment Action Code to DELETE]
Equipment is ready for deletion processing → Set equipment action code to DELETE and update resend flag for EDI transmission
[Fax Transmission Required?]
The system needs to determine output method → The system checks if fax transmission is required and branches to appropriate header formatting
[Setup Fax Header Information]
The system needs to prepare fax-specific header information → Additional fax header fields are configured with appropriate transmission details
[Add Fax Station Information]
The manifest header needs fax routing details → Fax station identification and routing information are added to the header
[Add Fax Number Details]
The manifest header needs fax destination details → Destination fax number and transmission details are added to the header
[110:Train Deletion Confirmation Processing]
The system processes the bulk deletion request → All equipment in the train is marked for deletion with GCWTL-ACT-DELETE flag and the train is flagged for EDI resend
[Train Arrived?]
The system checks if the train has arrived → The system either updates cargo records directly for non-arrived trains or processes EDI 309 transactions for arrived trains
[58:EDI 309 Transaction Processing]
The system processes the deletion → EDI 309 transactions are sent for export cargo, import cargo, and multi-transit cargo as appropriate
[Mark All Equipment for Deletion]
The delete all equipment function is executed → All equipment items are marked with DELETE action code and the train is flagged for EDI resend
[Send EDI 309 Transaction]
EDI processing is initiated → Send EDI 309 transactions for export cargo, import cargo, and multi-transit cargo as applicable
[Train Status = Arrived?]
If whether to process EDI 309 transactions → EDI 309 processing should only proceed if the train status is 'Arrived', otherwise no EDI processing is required
[Get Cargo Information]
The system needs to process cargo for EDI 309 transactions → All cargo information associated with the train should be retrieved including cargo type, status, and related details
[Cargo Type?]
If cargo for EDI 309 processing → The cargo should be classified as either Export, Import, or Multi-Transit type to determine the appropriate processing path
[Set Export Transaction Code]
The system processes export cargo for EDI 309 transactions → The system should set the EDI transaction code specific to export cargo operations
[Set Import Transaction Code]
The system processes import cargo for EDI 309 transactions → The system should set the EDI transaction code specific to import cargo operations
[Set Multi-Transit Transaction Code]
The system processes multi-transit cargo for EDI 309 transactions → The system should set the EDI transaction code specific to multi-transit cargo operations
[Export Cargo Valid?]
If export cargo validation results → If export cargo passes all validation checks, proceed with export EDI 309 processing, otherwise generate export validation error
[Import Cargo Valid?]
If import cargo validation results → If import cargo passes all validation checks, proceed with import EDI 309 processing, otherwise generate import validation error
[Multi-Transit Cargo Valid?]
If multi-transit cargo validation results → If multi-transit cargo passes all validation checks, proceed with multi-transit EDI 309 processing, otherwise generate multi-transit validation error
[Process Export EDI 309]
The system processes export cargo for EDI 309 transactions → The system should execute export-specific EDI 309 processing including proper formatting, data mapping, and export compliance requirements
[Process Import EDI 309]
The system processes import cargo for EDI 309 transactions → The system should execute import-specific EDI 309 processing including proper formatting, data mapping, and customs clearance requirements
[Process Multi-Transit EDI 309]
The system processes multi-transit cargo for EDI 309 transactions → The system should execute multi-transit-specific EDI 309 processing including proper formatting, data mapping, and bond transit requirements
[Send Export EDI Transaction]
The system transmits the export EDI transaction → The export EDI 309 transaction should be sent to the designated export processing system with proper routing and acknowledgment handling
[Send Import EDI Transaction]
The system transmits the import EDI transaction → The import EDI 309 transaction should be sent to the designated import processing system with proper routing and acknowledgment handling
[Send Multi-Transit EDI Transaction]
The system transmits the multi-transit EDI transaction → The multi-transit EDI 309 transaction should be sent to the designated transit processing system with proper routing and acknowledgment handling
[Transaction Successful?]
If the transmission result → If the transaction was successful, proceed with success processing, otherwise generate export EDI send failure error
[Transaction Successful?]
If the transmission result → If the transaction was successful, proceed with success processing, otherwise generate import EDI send failure error
[Transaction Successful?]
If the transmission result → If the transaction was successful, proceed with success processing, otherwise generate multi-transit EDI send failure error
[Update Cargo Status]
The system processes the successful transmission result → The cargo status should be updated to reflect the successful EDI 309 processing and transmission
[Log EDI Transaction]
The system completes EDI transaction processing → An audit log entry should be created documenting the EDI 309 transaction details, timestamp, cargo information, and processing results
[Display 30-Day Rule Violation Message]
The system needs to inform the user of the restriction → A 30-day rule violation message is displayed explaining why the modification cannot proceed
[Override Warning Issued]
System processes the override → System displays appropriate warning message and allows the equipment addition to proceed
[Send EDI 309 Transaction]
The system processes the equipment deletion → Generate and transmit EDI 309 transaction to notify relevant parties of the equipment deletion from the arrived train
[Block AEI Operation]
The system validates the operation against train status → The system blocks the AEI operation and displays error message 'Cannot Block AEI for Arrived Train'
[Block Equipment Addition]
The system determines addition is not allowed → The system blocks the equipment addition and displays restriction message
[Block Deletion]
The system validates cargo attachment for deletion → The system blocks the deletion and displays cargo attachment error message
[Process EDI 309 Transaction]
The system processes the equipment deletion → The system generates and sends EDI 309 transaction for the arrived train deletion
[Block Modification]
The system validates the modification request → The system blocks the modification and displays arrived train restriction message
[Block Position Change]
The system determines position change is not allowed → The system blocks the position change and displays position restriction message
[Cargo Status Valid for Deletion?]
The system validates the cargo status → If cargo status is invalid for deletion, prevent deletion with cargo attachment error, otherwise proceed with EDI 309 processing
[Generate EDI 309 for Arrived Train]
The system processes the deletion request → Generate EDI 309 transaction and mark equipment for deletion
[Cargo Status Allows Detachment?]
The system validates if cargo status allows detachment → If cargo status prevents detachment, block deletion with status error, otherwise check EDI 309 requirements
[EDI 309 Required?]
If EDI 309 requirements → If EDI 309 is required, process EDI 309 transaction, otherwise skip EDI processing and proceed to deletion
[Process EDI 309 Transaction]
The system processes the EDI 309 requirement → Generate and transmit EDI 309 transaction, then mark equipment for deletion
[Check Train Status]
The train status indicates the train has already arrived → The system blocks the AEI operation and displays an error message indicating AEI cannot be blocked for arrived trains
[Check User Authorization]
The user does not have proper authorization for AEI blocking operations → The system denies access and displays an authorization error message
[Display Success Message: AEI Block Removed]
All processing is completed → The system displays a success message confirming AEI block has been removed
[Display Success Message: AEI Block Applied]
All processing is completed → The system displays a success message confirming AEI block has been applied
[Refresh Train Display Screen]
The user interface needs to reflect current train status → The system refreshes the train display screen with updated information
[Cargo Attachment Denied]
The system completes cargo validation process → Deny cargo attachment and display appropriate error message to user
[Retrieve User Security Profile]
The system needs to check user authorization → The system retrieves the user's complete security profile from GCSTBRT segment
[Check GCSTBRT User Authorization Segment]
The system checks the GCSTBRT authorization segment → The system identifies the user's specific authorization levels and override permissions
[User Has Override Authority?]
If the user has override authority → The system returns true if user has super-user privileges or specific override permissions, otherwise returns false
[Display Override Not Permitted Message]
The system needs to deny the override request → The system displays a message indicating override is not permitted for this error type
[Create Special Manifests]
The system creates special manifests for the misrouted cargo → A diversion manifest is generated with cargo details, routing correction instructions, processing priority, and queued for transmission
[Create Port Change Manifest]
Port change manifest creation is initiated → Generate port change document with equipment details, cargo information, and port routing instructions for proper cargo redirection
[Print Type Selection]
If the print type selection → Route to Merlin Report validation if Merlin type selected, or Train List validation if train list selected, or Cargo List validation if cargo list selected, or Fax validation if fax transmission selected
[Setup Merlin Report Parameters]
The system sets up Merlin report parameters → Configure report destination, format settings, and transmission parameters for Merlin system processing
[Transmit to Merlin System]
The system transmits to Merlin → Send the complete report to the specified Merlin destination ID and confirm successful transmission
[Setup Fax Transmission Parameters]
The system sets up fax transmission parameters → Configure fax format, destination number, transmission options, and delivery confirmation settings
[Configure Fax Report Format]
The system configures fax report format → Set page layout, font size, margins, and other formatting parameters optimized for fax transmission
[Transmit via Fax]
The system transmits via fax → Send the report to the specified fax number and confirm successful transmission or report transmission errors
[Report Size Check]
The system checks report size → If report exceeds 699 lines, route to multi-part email processing, otherwise proceed with single email transmission
[Split into Multiple Email Parts]
The system splits the report into multiple parts → Divide the report into segments that comply with email size limits while maintaining logical content boundaries
[Add Continuation Headers]
The system adds continuation headers → Add part numbers, total parts count, and continuation indicators to each email segment header
[Send Multi-Part Email]
The system sends multi-part email → Transmit each part in sequence, confirm delivery of each part, and track overall transmission status
[Spawn Audit Log Transaction]
The system spawns audit log transaction → Create audit log entries recording print type, destination, timestamp, user ID, and transmission status
[Report Size Check]
System checks report size against 699 line limit → System either splits report into multiple parts with continuation headers or sends as single report
[Fax Option Selected?]
The system checks if fax option is selected → If fax option is not selected, skip fax setup process, otherwise proceed with fax parameter configuration
[Station Found?]
The system performs station lookup → If station is not found, display station not found error, otherwise proceed with fax number validation
[Configure Fax Transmission Parameters]
The system configures fax transmission parameters → Set fax destination settings, initialize fax report headers, and setup transmission method
[Lines > 699?]
The report contains more than 699 lines → The system initiates multi-part email processing
[Send Single Email Report]
The system processes the email transmission → The report is sent as a single email without multi-part headers
[Send Part 1 via Email]
The email part is ready for transmission → The system sends the email part via EMCSEND with proper formatting
[More Content Remaining?]
If remaining report content → The system determines if additional email parts are needed to complete the report transmission
[Increment Part Number]
A new email part is being prepared → The system increments the part number counter by 1
[Send Current Part via Email]
The current part is ready for transmission → The system sends the current email part via EMCSEND with proper continuation formatting
[All Parts Transmitted Successfully]
No more content remains for transmission → The system confirms all parts of the multi-part email report have been transmitted successfully
[Single Email Sent Successfully]
The single email transmission is complete → The system confirms the single email report has been sent successfully
[Determine Bond Type]
The system determines bond type → Processing follows specific rules for Regular, In-Transit, Immediate Export, Transportation Export, Transportation, or Multi-Transit bonds
[Laredo Station?]
The system checks station location → If at Laredo station, Mexican customs hold status is checked; otherwise pedimento processing is skipped
[International Service Required?]
The system checks international service requirements → If international service is required, indicator is marked; otherwise domestic service is indicated
[Format Immediate Export Bond]
System formats bond information → Immediate export bond formatting rules are applied to the display line
[Add Pedimento Hold Indicator]
System adds pedimento hold indicator → Pedimento hold indicator is displayed on the equipment line
[Transmission Method?]
System determines transmission method → Appropriate transmission path is selected (Email, Fax, or Merlin system)
[Send via Email System]
System sends report via email → Report is delivered through email system to designated recipients
[Send via Fax System]
System sends report via fax → Report is delivered through fax system to designated fax numbers
[Send to Merlin System]
System sends report to Merlin → Report is delivered to Merlin system for processing
[Bond Type = IE?]
The bond type equals 'IE' (Immediate Export) → Format the bond display with Immediate Export information and IE specific format
[In-Bond Control Number Available?]
If remaining entry number options → If in-bond control number is available and not blank, use it as the medium priority entry number for display
[Access GCSUSS08 Segment]
Hazmat validation is required → The system accesses the GCSUSS08 segment to retrieve hazmat data for the bill
[Hazmat Record Found?]
No hazmat record is found for the bill → The system sets a flag indicating no hazmat materials are present
[Generate Final Manifest Report]
The system generates the final manifest report → A complete electronic manifest report is generated containing all valid cargo entries for CBP transmission
[Transmission Successful?]
The system checks transmission results → Successful transmission proceeds to status update, failed transmission logs error and queues for retry
[Queue for Retry]
The system handles transmission failure recovery → Failed transmission is queued for automatic retry according to system retry policies
[Generate Confirmation Report]
The system generates confirmation documentation → A confirmation report is generated documenting successful electronic manifest submission with transmission details and cargo counts
[Update Train Status for EDI Resend]
The system updates train status → The train status is updated to indicate EDI resend is required
[Set Train Resend Flag]
The system sets processing flags → The train resend flag is activated to trigger EDI transmission
[Prepare EDI Transaction Parameters]
The system prepares EDI parameters → EDI transaction parameters are set with train deletion information and proper transaction codes
[Schedule Train for EDI Resend Processing]
The system schedules EDI processing → The train is queued for EDI resend processing to transmit deletion notification to external systems
[Display Deletion Confirmation Message]
The deletion process completes successfully → A confirmation message is displayed to the user indicating successful train deletion
[Bond Type?]
If the bond type → The system applies REG processing for regular bonds, IT processing for in-transit bonds, IE processing for immediate export, TE processing for transportation export, TR processing for transportation bonds, or MT processing for multi-transit
[Immediate Export Processing]
The system processes the bond information → The system applies immediate export processing rules and includes appropriate entry number information
[Laredo Station?]
The system checks if cargo is at Laredo station → Laredo station cargo receives pedimento hold status, while other cargo proceeds to international service checking
[International Service?]
The system checks for international service requirements → International service cargo is marked accordingly, while domestic cargo proceeds to conveying status checking
[Check Pedimento Hold Status]
Checking pedimento hold requirements → System sets pedimento hold indicator for Laredo station cargo with hold status
[Retrieve Primary Cargo Data]
The system calls GCCUSIO module to retrieve primary cargo data from GCSUSRT cargo segment → The system reads the primary cargo record associated with the bill number
[Retrieve Supplementary Data]
The system calls GCCUSIO2 for additional data retrieval → The system retrieves export message data from GCSUSS07 and hazmat information from GCSUSS08
[Supplementary Data Available?]
If supplementary data availability → If supplementary data is not available, continue with primary data only; otherwise proceed to retrieve export message data
[Call GCSUSS07 Segment]
The system needs export message information → The GCSUSS07 segment is called to fetch export message data
[Export Messages Found?]
If export message availability → If export messages are not found, skip export message processing; otherwise proceed to retrieve hazmat information
[Call GCSUSS08 Segment]
The system needs hazmat information → The GCSUSS08 segment is called to fetch hazmat data
[Hazmat Data Found?]
If hazmat data availability → If hazmat data is not found, skip hazmat processing; otherwise set hazmat indicators
[K3: Set Train Resend Flag]
Train resend flag needs to be set for deletion processing → The system sets the train resend flag to trigger appropriate EDI transactions
[Update Export Message Data GCSUSS07]
The train consist information has been updated → The system updates the export message data in GCSUSS07 to maintain export documentation requirements
[Update Hazmat Information GCSUSS08]
Export message data has been updated → The system updates the hazmat information in GCSUSS08 to maintain safety and regulatory compliance
[6300: Setup Delete Confirmation Screen]
System displays warning message → Clear warning message about deletion consequences is shown to user
[6300: Setup Delete Confirmation Screen]
System configures confirmation prompt → User is prompted to explicitly confirm the deletion action
[Fax Transmission Required?]
The system checks fax transmission requirements → If fax transmission is required, the system proceeds to setup fax parameters, otherwise continues with equipment line processing
[In-Transit Bond Processing]
The system processes in-transit bond information → In-transit bond number, routing information, and intermediate location details are formatted according to IT bond processing rules
[Immediate Export Processing]
The system processes immediate export bond information → Immediate export bond details, export documentation references, and compliance information are formatted according to IE processing rules
[Special Forms Import Required?]
If special forms requirements → If special forms are required based on cargo type, value, or origin, system proceeds to add special forms indicator; otherwise continues to pedimento hold check
[Laredo Station?]
If station location for pedimento requirements → If processing location is Laredo station, system proceeds to add pedimento hold indicator; otherwise continues to check for more equipment
[Add Pedimento Hold Indicator]
The system processes pedimento hold indicators → Pedimento hold status, Mexican customs requirements, and related documentation indicators are added to the equipment line
[Complete Report Generation]
The system completes report generation → Complete report is finalized, validated for completeness, and prepared for transmission, printing, or storage according to user specifications
[Fax Transmission Required?]
The system checks if fax transmission is required → If fax option is selected and valid fax number exists, fax transmission is enabled, otherwise standard processing continues
[Setup Fax Parameters]
The system sets up fax parameters → Fax destination number is validated, cover page information is prepared, and transmission options are configured
[Format TE Bond]
The system formats TE bond information → The report displays TE bond number, intermediate destination, final export destination, and processing status
[Format MT Bond]
The system formats MT bond information → The report displays MT bond number, transit route, intermediate stops, and transit processing status
[Add Pedimento Hold Indicators]
The system adds Pedimento hold indicators → The report displays Pedimento hold status, Pedimento numbers, and Mexican customs processing indicators
[Complete Report Generation]
The system completes report generation → The final report is ready for transmission, printing, or electronic delivery
[Identify Bond Type]
If the bond type code from the cargo data → Route to appropriate bond processing based on bond type: REG for Regular, IT for In-Transit, IE for Immediate Export, TE for Transportation Export, TR for Transportation, MT for Multi-Transit, or Other for unknown types
[Process Immediate Export Bond]
The system processes the Immediate Export bond → Format the bond display for immediate export requirements and validate IE bond status
[Access GCSUSS08 Hazmat Segment]
The system accesses the GCSUSS08 hazmat information segment → Hazmat data is read from the segment for the current equipment
[Mark Equipment as Non-Hazmat]
No hazmat data is found for the equipment → Equipment is marked as non-hazmat and no hazmat indicators are set
[Report Size Check]
The system checks the report size → If report has 699 lines or fewer, process as single part email, otherwise process as multi-part email
[Single Part Email]
The system processes the email transmission → The report is sent as a single email without part headers or splitting
[Multi-Part Email Processing]
The system processes the email transmission → The system calculates the number of parts needed and initiates multi-part email processing
[Prepare Email Headers]
The system prepares the email headers → Standard email headers are configured with appropriate metadata
[Process First Part]
The system processes the first part → The first segment of the report is prepared for email transmission
[Add Part Header Information]
The system adds part header information → Part identification headers are added indicating current part and total parts
[Call EMCSEND3 for Current Part]
The system calls EMCSEND3 for the current part → The external email service is invoked to transmit the current email part
[More Parts Remaining?]
The system checks for remaining parts → If more parts remain to be processed, continue with next part, otherwise complete transmission
[Increment Part Counter]
The system increments the part counter → The part counter is increased to track the next part to be processed
[Add Continuation Header]
The system adds continuation headers → Continuation headers are added to indicate this is a subsequent part of the transmission
[Prepare Next Part]
The system prepares the next part → The next segment of the report is prepared with appropriate headers for transmission
[Single Email Sent Successfully]
The system processes the success result → The email transmission is marked as successfully completed
[All Email Parts Sent Successfully]
The system processes the final success result → The entire multi-part email transmission is marked as successfully completed
[Email Send Failed]
The system processes the failure result → The email transmission is marked as failed and appropriate error handling is initiated
[Multi-Part Email Failed]
The system processes the failure result → The entire multi-part email transmission is marked as failed and appropriate error handling is initiated
[Log Email Failure]
The system logs the email failure → Failure details are recorded for audit and troubleshooting purposes
[Log Multi-Part Email Failure]
The system logs the multi-part email failure → Failure details are recorded indicating which part failed and overall transmission status
[Report Size Check]
The system checks report size → Report is either transmitted as single document or split into multiple parts if over 699 lines
[Split into Multiple Parts]
The system splits into multiple parts → Report is divided into manageable sections for transmission
[Transmit to Merlin System]
The system transmits to Merlin system → Report is sent to Merlin system for further processing and distribution
[Generate PDF Version]
The system generates PDF version → PDF format version of report is created for archival purposes
[Log Report Generation]
The system logs report generation → Report generation activity is recorded with timestamp, user, and transmission details
[Update Report Status]
The system updates report status → Database records are updated to show successful report generation and transmission
[PDF Report Ready for Transmission]
The system confirms report readiness for transmission → The system marks the PDF report as complete and ready for distribution through appropriate channels
[IE Bond Import Rules]
The system processes cargo attachment for IE bond on import train → Apply IE-specific import validation rules with immediate entry processing
[Reject Cargo Attachment]
The system processes attachment validation → Reject cargo attachment and provide vessel mismatch error message
[Set Equipment Action Code to ADD]
The system sets tracking flags for the equipment → Set the equipment action code to ADD and set resend flag for EDI processing
[Retrieve User Security Profile]
The system needs to validate user permissions → The user security profile is retrieved from GCSTBRT user security segment
[Access GCSTBRT User Security Segment]
The system accesses user authorization data → GCSTBRT user security segment is accessed to retrieve security permissions
[End Security Check - Not Authorized]
Security check process is finalized → Security check ends with not authorized status preventing user from proceeding with train operations
[Set Export Transaction Parameters]
The system processes EDI 309 transaction for export cargo → Export transaction parameters are set and the cargo is classified as export type
[Set Import Transaction Parameters]
The system processes EDI 309 transaction for import cargo → Import transaction parameters are set and the cargo is classified as import type
[Set Multi-Transit Transaction Parameters]
The system processes EDI 309 transaction for multi-transit cargo → Multi-transit transaction parameters are set and the cargo is classified as multi-transit type
[Send Export EDI 309 Transaction]
The system sends the export EDI 309 transaction → The EDI 309 transaction is transmitted with export-specific formatting and routing
[Send Import EDI 309 Transaction]
The system sends the import EDI 309 transaction → The EDI 309 transaction is transmitted with import-specific formatting and routing
[Send Multi-Transit EDI 309 Transaction]
The system sends the multi-transit EDI 309 transaction → The EDI 309 transaction is transmitted with multi-transit-specific formatting and routing
[Log Export EDI Transaction]
The system logs the export EDI transaction → Transaction details are recorded with timestamp, cargo information, and transmission status
[Log Import EDI Transaction]
The system logs the import EDI transaction → Transaction details are recorded with timestamp, cargo information, and transmission status
[Log Multi-Transit EDI Transaction]
The system logs the multi-transit EDI transaction → Transaction details are recorded with timestamp, cargo information, and transmission status
[Prepare Message Queue Entry]
The system prepares the message queue entry → A properly structured message queue entry is created with all required fields initialized
[Set Report Generation Parameters]
The system sets report generation parameters → All necessary parameters for report generation are configured according to the report type and business requirements
[Format Message Queue Request]
The system formats the message queue request → A properly formatted message queue request is created with all parameters, data, and context information structured according to queue specifications
[Submit Request to Message Queue]
The system submits the request to the message queue → The report request is submitted to the appropriate message queue for asynchronous processing
[Queue Submission Successful?]
The system checks the submission result → The system determines if the queue submission was successful or if an error occurred during submission
[Update Request Status]
The system updates the request status → The request status is updated to reflect successful submission and queued processing state
[Generate Confirmation Message]
The system generates a confirmation message → A confirmation message is created indicating successful report request submission with relevant reference information
[Log Report Request Activity]
The system logs the report request activity → Complete audit trail information is logged including user, timestamp, report type, and request details
[Equipment Available?]
If equipment availability → If no equipment exists, display 'No Equipment Message', otherwise proceed to display equipment items
[Equipment Limit Check]
The current equipment count would exceed 500 items after adding new equipment → Display equipment limit exceeded error message and prevent the addition
[Authorization Check]
User does not have DELETE authorization (UTF-DELETE permission) → Display authorization error message and prevent deletion
[30-Day Business Rule Check]
Train's Estimated Date of Arrival (EDA) is more than 30 days old and user is not a super user → Display date restriction error message and prevent modification
[Train Lock Status]
Train status is LOCKED → Display train locked error message and prevent modification
[Authorization Level Check]
User authorization level is insufficient for PTT operations → Display authorization error message and prevent PTT function
[Train Status Check]
Train status indicates it has already arrived → Display already arrived error message and prevent arrival processing
[Future Date Check]
Arrival date is in the future compared to current system date → Display future date error message and prevent arrival processing
[Authorization Check]
User does not have CANCEL ARRIVAL authorization (UTF-CAN-ARRIVE permission) → Display authorization error message and prevent cancel arrival operation
[Train Arrival Status]
Train has not arrived or is not in arrived status → Display not arrived error message and prevent cancel arrival operation
[Container Group Check]
Attempting to move equipment into container positions or violating container group integrity → Display container move error message and prevent move operation
[Train Status Check]
Train has already arrived → Display already arrived error message and prevent enroute status change
[Authorization Check]
User does not have ENROUTE authorization (UTF-ENROUTE permission) → Display authorization error message and prevent enroute status change
[Train Arrival Status]
Train has already arrived → Display cannot block arrived train error message and prevent AEI blocking operation
[Authorization Check]
User does not have AEI-BLOCK authorization → Display authorization error message and prevent AEI blocking operation
[Display Lock Status Message]
A user attempts to modify the train → Display lock status message and show train status as LOCKED
[Set Temporary Lock]
The system detects concurrent processing → Set temporary lock, display processing message, and block user modifications
[Mark Train for EDI Resend]
System marks train for EDI resend → Train resend flag is set to trigger EDI transmission of updated consist information to external systems
[Retrieve User Security Profile]
The system needs to validate user permissions for resend operations → The system retrieves the user security profile from GCSTBRT user security segment
[Super User or Update Permission?]
The system checks GCSTBRT-US-UTF-CHANGE permission level → If UTF-CHANGE equals 'S' (Super User) or 'U' (Update), grant full authorization access, otherwise proceed to check basic user permissions
[Full Resend Authorization Granted]
All authorization checks pass successfully → Grant full resend authorization and proceed with complete EDI resend processing capabilities
[Limited Resend Authorization Granted]
Basic authorization checks pass successfully → Grant limited resend authorization and proceed with restricted EDI resend processing capabilities
[User Authorization Level]
The system checks the user's authorization level → If user has authorized override privileges, allow error status override; If user does not have authorization, display authorization required for error override message
[Send EDI 309 Transaction if Train Arrived]
The system checks train arrival status and generates EDI transaction → EDI 309 transaction is sent for arrived trains while non-arrived trains skip EDI generation
[Clear DELETE Action Code]
The system clears the DELETE action code from the equipment record → Equipment record no longer has DELETE action code and will not be reprocessed in subsequent resend operations
[More Equipment to Process?]
The system checks for remaining unprocessed equipment in train consist → Processing continues with next equipment if more exist, otherwise proceeds to EDI resend generation
[Generate EDI Resend Transaction]
The system generates EDI resend transaction → EDI resend transaction is created and prepared for transmission based on train type
[Train Type?]
If train type (export or import) → Export trains use GCCU358T module while import trains use GCCE358 module for EDI processing
[Call Export EDI Module GCCU358T]
The system calls export EDI module GCCU358T → Export-specific EDI processing is performed with appropriate transaction formatting and validation
[Call Import EDI Module GCCE358]
The system calls import EDI module GCCE358 → Import-specific EDI processing is performed with appropriate transaction formatting and validation
[Generate Export Report to Merlin]
The system generates export reports for Merlin transmission → Export reports are formatted and transmitted to Merlin system with proper export documentation
[Generate Import Report to Merlin]
The system generates import reports for Merlin transmission → Import reports are formatted and transmitted to Merlin system with proper import documentation
[Update Train Resend Status]
The system updates train resend status → Train resend status is updated to indicate successful completion and prevent duplicate resend processing
[Mark All Equipment for Deletion]
The system processes the train deletion → The system marks all equipment in the train for deletion and sets the train for EDI resend
[Export TE Manifest Processing Not Found]
The system attempts to locate the Export TE manifest processing logic → The system cannot generate the required flowchart or business rules because the source code implementation is not available in the provided code segments
[User Authorized for Enroute Changes?]
User attempts to change train status to enroute AND user does not have UTF-ENROUTE authorization → System displays error message 'User Not Authorized for Enroute Operations' AND prevents the status change
[Train in Valid Status for Enroute?]
User attempts to change train status to enroute AND the train's current status does not allow enroute transition → System displays error message 'Invalid Current Status for Enroute Change' AND prevents the status change
[Display Success Message]
System finishes updating all related records and displays → System displays a success message confirming the train status has been changed to enroute
[Present Report Type Options]
System presents printing options to user → System displays Merlin, Train List, Cargo List, and Fax transmission options
[Configure Merlin Transmission]
System configures Merlin transmission → System sets up Merlin transmission parameters and prepares for report generation
[Configure Fax Transmission]
System configures fax transmission → System sets up fax transmission parameters and prepares for report delivery
[Display Position Change Success]
System confirms successful position change → System displays 'Position change successful' confirmation message
[Container Can Move with Parent Flatcar?]
Container movement would separate it from parent flatcar → System displays error message that container must move with flatcar
[Locate Next Equipment Position]
The system searches for the next position in the consist → The system locates the immediate next equipment position for potential swapping
[Locate Previous Equipment Position]
The system searches for the previous position in the consist → The system locates the immediate previous equipment position for potential swapping
[Display Bill Not Found Message]
No equipment cargo contains a matching bill number → The system displays a 'Bill Not Found' message to inform the user that the search was unsuccessful
[Return to Train Display]
The 'Bill Not Found' message has been displayed → The system returns the user to the main train display screen to continue other operations
[Has EDI 309 Been Sent?]
System checks EDI transaction status → System verifies EDI 309 has not been sent or returns error preventing addition after EDI 309 transmission
[Reject Equipment Addition - ID Mismatch]
Equipment addition is processed → System rejects equipment addition and displays error message indicating equipment ID mismatch
[Reject Equipment Addition - Invalid Export Status]
Equipment addition is attempted → System rejects equipment addition and displays error message indicating invalid export status for non-arrived train
[Reject Equipment Addition - Attachment Rules]
Equipment addition is attempted → System rejects equipment addition and displays error message indicating specific attachment rule violation
[Access Cargo Bill Records via GCSUSRT Segment]
The system needs to access cargo bill records → The system retrieves cargo bill data via GCSUSRT segment
[Display Override Warning]
The override process is initiated → The system must display a warning message and request user confirmation
[Call FWCARGET Module]
The system calls the FWCARGET module to access SHIPROOT segment → The system should retrieve waybill data from the SHIPROOT IMS segment for the specified equipment
[Request Corrected Equipment Type]
The system requires a valid equipment type to continue processing → The system requests the user to provide a corrected equipment type code
[Retrieve Cargo Information for Equipment]
The system needs cargo information to determine routing status → Cargo data is retrieved from the GCSUSRT cargo segment using the equipment identifier
[Queue Manifest for Processing]
The system queues the manifest for processing → The manifest is added to the processing queue for subsequent transmission and handling
[Set Merlin Transmission Parameters]
Merlin transmission is selected → System sets Merlin transmission parameters including public ID and transmission flags
[Transmission Method?]
Transmission method is determined → System sends report via email, fax, or Merlin system based on selected method
[Send via Email System]
Report is ready for transmission → System sends report via EMCSEND email system with proper formatting and pagination for large reports
[Send via Fax System]
Report is ready for transmission → System sends report via fax system to configured fax station
[Send to Merlin System]
Report is ready for transmission → System sends report to Merlin system for further processing and distribution
[Update Audit Log]
Success or error message is displayed → System updates audit log with print operation details, transmission method, and outcome status
[Access Authorized?]
The user does not have authorization to access the specified Merlin ID → System displays 'Access Denied' error message and returns user to print menu
[Set Merlin Destination Parameters]
System validates all Merlin ID requirements → System sets up Merlin destination parameters and configures report transmission settings
[Configure Report Transmission Settings]
System proceeds with transmission configuration → System configures report transmission settings and marks validation as successful for report generation
[Validate Train Print Option]
System validates the train print selection → System proceeds to transmission method validation for train reports
[Validate Cargo Print Option]
System validates the cargo print selection → System proceeds to transmission method validation for cargo reports
[Set Merlin Transmission Parameters]
System sets up Merlin transmission → System configures Merlin transmission parameters and marks validation as complete
[Perform Station Lookup]
System performs station lookup for fax processing → System retrieves station information for fax number validation
[Set Fax Transmission Parameters]
System sets up fax transmission parameters → System configures fax transmission settings and marks fax validation as complete
[Prepare Print Confirmation Screen]
System prepares the print confirmation screen → System sets up confirmation screen with selected print options and transmission method
[Display Print Options to User]
System displays print options to user → User sees the selected print type and transmission method for confirmation
[Fax Option Selected?]
The system checks the fax option selection status → If fax option is not selected, skip fax setup process, otherwise proceed with fax configuration
[Retrieve Current Station Information]
The system needs to configure fax parameters → Retrieve current station information from the system database
[Report Size Check]
The system checks the report size → If report has 699 lines or fewer, use single email transmission; if report exceeds 699 lines, use multi-part email processing
[Set Email Parameters]
The system prepares email parameters → Set standard email headers, recipient addresses, subject line, and attach complete report content
[Call EMCSEND3 Module]
The system initiates email transmission → Call EMCSEND3 module with configured parameters to send the email
[Spawn Audit Transaction]
The system processes successful transmission → Generate audit transaction record with transmission details, timestamp, and recipient information
[Split Report into Parts]
The system processes large report for transmission → Divide report into multiple parts with each part not exceeding maximum email size limit
[Add Continuation Headers]
The system prepares each part for transmission → Add continuation headers indicating part number, total parts, and original report identification
[Process First Part]
The system processes the first part → Include original report headers, set part 1 indicators, and prepare for initial transmission
[Call EMCSEND3 for Part 1]
The system initiates first part transmission → Call EMCSEND3 module with multi-part parameters to send first part of report
[Process Remaining Parts]
The system processes remaining report parts → Process each remaining part in sequence with appropriate part headers and continuation indicators
[Add Part Headers]
The system prepares the part for transmission → Add part-specific headers with current part number, total parts, and continuation indicators
[Call EMCSEND3 for Each Part]
The system initiates part transmission → Call EMCSEND3 module with part-specific parameters to send the individual part
[Complete Multi-Part Transmission]
The system completes multi-part transmission → Finalize transmission process and prepare for success logging
[Log Successful Transmission]
The system logs transmission results → Record successful transmission with timestamp, recipient details, and report identification in audit log
[Log Multi-Part Success]
The system logs transmission results → Record successful multi-part transmission with timestamp, recipient details, total parts sent, and report identification in audit log
[Log Transmission Failure]
The system logs failure details → Record transmission failure with error code, timestamp, recipient details, and report identification in error log
[Log Multi-Part Failure]
The system logs failure details → Record multi-part transmission failure with error code, failed part number, timestamp, recipient details, and report identification in error log
[Update Transmission Status]
The system updates transmission status → Set transmission status to successful, update completion timestamp, and mark report as delivered
[Arrival Date in Future?]
The arrival date is later than the current system date → System displays error message 'Future Dates Not Allowed' and rejects the input
[Within Business Rules?]
The arrival date/time falls outside of established business day rules or operating hours → System displays error message 'Outside Business Day Rules' and rejects the input
[Setup Delete Confirmation Screen]
The system sets up the delete confirmation screen → The system displays a delete warning message and sets delete function field attributes
[Set Train for EDI Resend]
The system sets the train for EDI resend → The system activates the EDI resend flag to transmit deletion information to external systems
[Update Train Status to DELETED]
The system updates the train status → The system sets the train status to DELETED
[Finalize TE Manifest]
The system finalizes the manifest → All TE manifest entries are consolidated, validated, and prepared for transmission or storage
[Update Train Status for EDI Resend]
System updates train status for EDI processing → System sets train status to trigger EDI resend processing for the deleted train
[Set Train Resend Flag]
System configures EDI transmission flags → System sets the train resend flag to ensure deletion is transmitted via EDI
[Prepare Train for EDI Transaction Processing]
System prepares EDI transaction processing → System configures the train for EDI transaction transmission to communicate the deletion
[Set Train Deletion Complete Flag]
System finalizes the deletion process → System sets train deletion complete flag to indicate successful completion of deletion processing
[Status = ACKNOWLEDGED?]
User attempts to process arrival → System validates user has arrival authorization before proceeding
[Send EDI Notifications]
System sends EDI notifications → Appropriate EDI notifications are transmitted to relevant parties
[Bond Type?]
The system processes bond information → Formatting is applied based on bond type: REG (Regular), IT (Immediate Transportation), IE (Immediate Export), TE (Transportation Entry), TR (Transportation), or MT (Merchandise in Transit)
[Format IT Bond]
The system formats bond information → IT bond formatting is applied with specific entry number processing for immediate transportation
[Format IE Bond]
The system formats bond information → IE bond formatting is applied with specific entry number processing for immediate export
[Laredo Station?]
The system checks processing station → If cargo is at Laredo station, check pedimento status; otherwise, continue normal processing
[Check Pedimento Status]
The system checks pedimento requirements → Pedimento hold status is evaluated and appropriate indicators are set
[Format IT Bond Display]
The system formats the bond display → IT bond information is formatted with specialized display layout for immediate transportation
[Format IE Bond Display]
The system formats the bond display → IE bond information is formatted with specialized display layout for immediate export
[Send Single Report]
The system transmits the report → Complete report is sent as single transmission
[Split into Multiple Parts]
The system splits the report → Report is divided into multiple parts with appropriate continuation headers and part numbering
[Format IT Bond]
The system processes bond formatting → The system applies IT-specific bond formatting rules for display and reporting
[Format IE Bond]
The system processes bond formatting → The system applies IE-specific bond formatting rules for display and reporting
[Entry Number Priority?]
If entry number priority hierarchy → The system classifies the priority as broker entry (highest), in-bond control (medium), or standard entry number (lowest)
[Laredo Station?]
The system checks processing location → The system determines if cargo is at Laredo station requiring special pedimento processing
[Process Pedimento Hold]
The system processes pedimento requirements → The system applies Laredo-specific pedimento hold processing rules and indicators
[Skip Pedimento Processing]
The system continues processing → The system skips pedimento processing and proceeds to hazmat evaluation
[Pedimento Hold?]
The system checks pedimento hold status → The system branches to hold indicator processing if pedimento hold exists, otherwise continues with standard processing
[Add Hold Indicator]
The system processes hold indicators → The system adds hold indicators, hold reasons, and release requirements to the cargo description
[Is Station Laredo?]
The system checks the station location → If the station is Laredo, pedimento hold processing is enabled, otherwise pedimento processing is bypassed
[Retrieve Cargo Information]
The system needs to evaluate pedimento hold requirements → Cargo information including customs status and hold indicators is retrieved from the cargo records
[Pedimento Hold Required?]
If pedimento hold requirements → If customs status indicates pending pedimento documentation, a hold is required, otherwise normal processing continues
[Set Normal Processing Status]
The system sets cargo processing status → The cargo is assigned normal processing status without pedimento hold restrictions
[Set Pedimento Hold Indicator]
The system applies hold status to the cargo → A pedimento hold indicator is set on the cargo record to prevent release until customs clearance
[Apply Special Hold Status Management]
The system manages the hold status → Special hold status management procedures are applied including restricted release authorization and customs notification requirements
[Update Cargo Hold Status]
The system updates cargo records → The cargo hold status is updated in the database to reflect the current pedimento hold state
[Format Hold Indicator for Display]
The system prepares display information → Pedimento hold indicators are formatted appropriately for screen display and user notification
[Include in Report Generation]
Reports are generated for the cargo → Pedimento hold status and indicators are included in all relevant reports for customs compliance documentation
[Continue Equipment Processing]
The system continues with equipment processing → Standard equipment processing procedures continue with the updated pedimento hold status information
[Save Changes to Train List]
All equipment status change processing is complete → System saves all equipment changes to train list database and sets resend flag for EDI processing
[Fax Transmission Required?]
If fax transmission requirements → If fax transmission is required, the system proceeds to setup fax transmission header, otherwise it proceeds to format the complete header
[Setup Fax Transmission Header]
Fax transmission header is being setup → Fax station information, fax number, and transmission parameters are added to the report header
[Store Current Screen Context]
User initiates navigation to any target screen → System stores current screen context and navigation parameters in stack before proceeding to target screen
[Process Pedimento Hold Indicator]
Station is Laredo → Pedimento hold indicator is processed for report display
[Skip Pedimento Processing]
Station is not Laredo → Pedimento processing is skipped
[Laredo Station?]
Evaluating station location for pedimento processing → System determines 'Yes' if processing at Laredo station or 'No' for other locations
[Add Pedimento Hold Indicator]
Adding pedimento hold indicator to display → Pedimento hold indicator is added to the equipment line formatting
[Check Cargo for Mexican Customs Requirements]
If cargo type, destination, and customs requirements → The system determines if Mexican customs pedimento processing is mandatory
[Pedimento Hold Required?]
If pedimento documentation status and requirements → The system decides whether to apply pedimento hold or allow normal processing
[Retrieve Pedimento Hold Indicators]
The system needs to check current pedimento status → The system retrieves all relevant pedimento hold indicators and documentation flags
[Pedimento Documentation Complete?]
The system checks for completeness of all required pedimento documents → The system determines if documentation is complete or incomplete
[Clear Pedimento Hold Status]
The system processes the documentation clearance → The system clears the pedimento hold status and allows normal cargo processing
[Set Pedimento Hold Indicator]
The system processes the documentation deficiency → The system sets the pedimento hold indicator to prevent cargo release
[Apply Special Hold Status Management]
The system applies special hold management procedures → The system implements enhanced tracking and notification procedures for held cargo
[Update Equipment Display with Hold Status]
The system updates the equipment display → The system shows current hold status with appropriate visual indicators
[Mark Equipment as Held for Documents]
The system marks the equipment hold reason → The system flags the equipment as held specifically for document deficiencies
[Allow Normal Processing]
The system authorizes processing → The system allows normal cargo processing without pedimento restrictions
[Update Equipment Status Counter]
The system updates status counters → The system maintains accurate counts of equipment by hold status for reporting purposes
[Set Normal Processing Status]
The system assigns processing status → The system sets normal processing status without pedimento hold restrictions
[Skip Pedimento Processing]
If pedimento processing requirements → The system skips all pedimento hold processing and continues with standard procedures
[Send Single Email Report]
The system processes the email transmission → The complete report is sent as a single email without splitting
[Add Continuation Header]
The system prepares the email part for transmission → A continuation header is added to identify the part number and total parts
[More Parts to Send?]
The system checks for remaining parts → The system determines if the current part counter is less than the total number of required parts
[Setup Fax Header Information]
Fax header information is being setup → Fax station information, fax number, and system Merlin ID are added to the header
[Equipment Available?]
The system checks for equipment availability → If no equipment exists, generate empty report message; otherwise proceed with equipment processing
[Generate Empty Report Message]
The system generates report content → Report displays message indicating no equipment is available for the train
[Add Pedimento Hold Indicators]
The system adds pedimento information → Pedimento hold indicators and related Mexican customs data are displayed when applicable
[Prepare Single Report]
The system prepares single report → Report is formatted as single transmission unit ready for delivery
[Determine Transmission Method]
The system determines transmission method → Transmission method is selected based on system configuration and recipient preferences
[Email Transmission?]
The system checks for email transmission → If email transmission is selected, proceed with email processing; otherwise use Merlin system
[Send via Email System]
The system sends via email → Report is transmitted through email system using EMCSEND functionality
[Send to Merlin System]
The system sends to Merlin → Report is transmitted through Merlin system for processing and distribution
[Transmit Report Parts]
The system transmits report parts → Each report part is sent as separate email transmission to designated recipients
[Transmission Successful?]
The system checks transmission status → If transmission succeeds, log success; otherwise log transmission error
[Log Successful Transmission]
The system logs success → Success details are recorded including transmission timestamp and recipient information
[Merlin Transmission OK?]
The system checks transmission status → If Merlin transmission succeeds, log success; otherwise log Merlin error
[Log Merlin Success]
The system logs success → Merlin success details are recorded including transmission timestamp and processing information
[End Report Generation]
The system ends report generation → Process is completed with appropriate status and cleanup operations performed
[Add Pedimento Hold Status]
The system processes pedimento information → Equipment line includes pedimento hold indicators and related Mexican customs status
[Prepare Multi-Part Email]
The system prepares email transmission → Multiple email messages are prepared with proper sequencing and identification
[Prepare Single Email]
The system prepares email transmission → Single email message is prepared with complete report content
[Transmit Report via Email System]
The system transmits the report → Report is sent via email system to configured recipients with proper addressing and formatting
[Log Successful Transmission]
The system confirms successful delivery → Successful transmission is logged with confirmation details and timestamp
[Generate PDF Version]
The system generates PDF version → Report is converted to PDF format with proper formatting and layout preservation
[Transmit PDF Report]
The system transmits PDF report → PDF report is sent to recipients via appropriate transmission method
[Report Size > 699 Lines?]
The report contains more than 699 lines → The system initiates multi-part email processing instead of single email transmission
[Send Single Email Report]
The report contains 699 lines or fewer → The system sends the complete report in a single email without splitting
[Send Current Email Part]
The part is ready for transmission → The system sends the email part and verifies transmission success before proceeding
[Send Final Email Part]
The final part contains the remaining report content → The system sends the final email part and completes the multi-part transmission process
[Prepare Email Transmission]
Email transmission preparation is initiated → System validates recipient addresses, formats message headers, and prepares report content for email delivery
[Email System Available?]
Email system availability check is performed → System verifies email system connectivity and routes to transmission if available, or logs error if unavailable
[Report Size Check]
Report size validation is performed → System checks if report exceeds 699 lines and routes to multi-part processing if large, or single email processing if normal size
[Single Email Transmission]
Single email transmission is initiated → System sends complete report as single email with proper headers and recipient information
[Create Multi-Part Email Headers]
Multi-part email headers are created → System generates headers with part numbers, total parts, and continuation indicators for each email segment
[Send First Email Part]
First part transmission is initiated → System sends first email part with header indicating part 1 of total parts and continuation notice
[More Parts?]
Part transmission completion check is performed → System checks if more parts exist and continues transmission if true, or completes multi-part process if false
[Send Next Email Part]
Next part transmission is initiated → System sends next email part with updated part number and appropriate continuation headers
[Complete Multi-Part Transmission]
Multi-part transmission completion is processed → System confirms all parts sent successfully and logs completion of multi-part transmission
[Log Transmission Success]
Success logging is required → System logs transmission success with timestamp, recipient information, and report details for audit trail
[Update Audit Records]
Audit record update is required → System updates audit records with generation timestamp, transmission status, recipient information, and report details
[Prepare Email Transmission Parameters]
Email transmission preparation begins → Email parameters including subject, format, and transmission settings are configured
[Set Designated Recipients]
Recipient determination is performed → Designated recipients are identified and configured based on train type and business rules
[Report Size > 699 Lines?]
Report size validation is performed → Report is flagged for multi-part transmission if it exceeds 699 lines, otherwise single transmission is used
[Split Report into Multiple Parts]
Report splitting is performed → Report is divided into multiple parts with each part not exceeding the line limit
[Transmit First Part via Email]
First part transmission is initiated → First report part is transmitted via email system to all designated recipients
[Transmit Remaining Parts]
Remaining parts transmission is initiated → All remaining report parts are transmitted in sequence to designated recipients
[Log Multi-Part Transmission]
Transmission logging is performed → Multi-part transmission details including part count and recipients are logged
[Transmit Complete Report via Email]
Single report transmission is initiated → Complete report is transmitted via email system to designated recipients
[Log Single Report Transmission]
Transmission logging is performed → Single report transmission details including recipients and timestamp are logged
[Update Transmission Status]
Status update is performed → Transmission status is updated to indicate successful delivery completion
[Generate Audit Trail Entry]
Audit trail creation is performed → Comprehensive audit entry is created documenting train ID, report details, transmission method, and completion status
[Format PDF for Transmission]
PDF needs to be prepared for transmission → PDF document is formatted with proper transmission parameters
[Prepare Transmission Parameters]
Transmission parameters need to be set → Destination addresses, delivery methods, and transmission options are prepared
[Send PDF Report]
Report transmission is initiated → PDF report is sent to designated recipients
[Get Primary Cargo Data]
The system accesses GCSUSRT segment for cargo data → Retrieve primary cargo information including bill number, cargo status, bond type, entry number, broker information, and haulage status
[Access GCSUSS08 Segment]
The system accesses GCSUSS08 segment → Retrieve special forms data including SED information and other required documentation
[Cross-Border Requirements Met?]
The cross-border requirements are not satisfied → A routing error flag is set, a routing error message is generated, and routing validation failure is returned
[Set Duplicate Processing Flag]
The system attempts to process the same cargo for TIB again → Set a duplicate processing flag and log a warning message to prevent duplicate TIB operations
[Call FWCARGET Module]
The system needs to retrieve waybill data → The FWCARGET module is called to access the SHIPROOT segment and retrieve waybill information
[Set Export Transaction Parameters]
EDI 309 transaction processing is initiated for export cargo → Export transaction parameters are initialized and export transaction code is set
[Set Import Transaction Parameters]
EDI 309 transaction processing is initiated for import cargo → Import transaction parameters are initialized and import transaction code is set
[Set Multi-Transit Transaction Parameters]
EDI 309 transaction processing is initiated for multi-transit cargo → Multi-transit transaction parameters are initialized and multi-transit transaction code is set
[Send Export EDI 309 Transaction]
Export EDI 309 transaction transmission is initiated → EDI 309 transaction is sent for export cargo and transaction is logged
[Send Import EDI 309 Transaction]
Import EDI 309 transaction transmission is initiated → EDI 309 transaction is sent for import cargo and transaction is logged
[Send Multi-Transit EDI 309 Transaction]
Multi-transit EDI 309 transaction transmission is initiated → EDI 309 transaction is sent for multi-transit cargo and transaction is logged
[Cargo Type Determination]
Cargo type determination is performed → Cargo is classified as export, import, or multi-transit based on cargo characteristics and routed to appropriate processing path

Structural Validations

[Valid Input?]
The input field is empty or blank → The system displays 'absent train' message and prevents further processing
[Equipment Addition Request Processing]
Equipment has 'A' (Auto) status AND has CCN number:
Equipment has 'L' (Loaded) status AND lacks CCN number without container attachments
→ The system rejects the addition and displays appropriate error message
[Line Selection Validation]
Selection is empty:
not numeric
outside valid equipment range
outside screen display limits
→ The system displays appropriate error message and prevents operation
[Clear Error Message Fields]
Error message fields are being cleared → All error message areas are set to spaces or empty values
[Train ID Present?, Train ID Provided?]
The train ID input field is empty or blank → The system displays an 'absent train' error message and stops processing
[Verify Parent-Child Relationship]
The system verifies the parent-child relationship eligibility → The flatcar's capability to serve as parent for the container is confirmed
[Validate Input Format]
The system processes the input → The input format must be validated and invalid formats must trigger format error messages
[Line Number Entered?]
The system checks if a line number was entered → If no line number is entered, the system must display line selection error message
[Retrieve User Security Profile]
The system needs to check user authorization → The system retrieves the user security profile from GCSTBRT segment and validates if the profile exists
[Train Already Arrived?]
The train has already arrived at its destination → The system denies enroute authorization with message 'Train Arrived'
[Train Status Allows Cancel?]
The train status does not allow cancel arrival operations → The system denies cancel arrival authorization with message 'Invalid Status'
[Validate Train Status]
The system validates train status for EDI processing → If train is locked, processing is denied with train locked error, otherwise processing continues
[Email Transmission Successful?]
The system checks transmission status → If email transmission failed, return email transmission error, otherwise proceed to set train resend flag
[Transmission Successful?]
Checking transmission results → System determines if transmission was successful or failed and routes accordingly
[Log Transmission Error]
Processing failed transmission results → System logs the transmission error with appropriate error details
[Equipment Valid?]
The system validates the equipment for addition → Valid equipment proceeds to addition processing and invalid equipment generates validation errors
[Equipment Exists in Consist?]
The system validates equipment existence in the train consist → Existing equipment proceeds to deletion processing and non-existing equipment generates not found errors
[EDI Requirements Met?]
The system validates EDI transaction requirements including Merlin public ID and transmission parameters → If EDI requirements are not met, display 'EDI Transaction Validation Error' and terminate process, otherwise queue transaction for transmission
[Container Group Integrity Error]
Container group integrity validation fails → Deletion process is terminated with container group integrity error message
[Partial Group Deletion Error]
Partial group deletion is detected → Deletion process is terminated with partial group deletion error message
[Parent-Child Relationship Error]
Parent-child relationship validation fails → Deletion process is terminated with parent-child relationship error message
[Authorization Denied Error]
Authorization check fails → Deletion process is terminated with authorization denied error message
[Position Sequence Error]
Position sequence validation fails → Deletion process is terminated with position sequence error message
[Business Rule Violation Error]
Business rule violation is detected → Deletion process is terminated with business rule violation error message
[Validate Export Cargo Status]
The system validates export cargo for EDI 309 processing → The export cargo status should meet all required criteria including proper export status, valid documentation, and compliance requirements
[Validate Import Cargo Status]
The system validates import cargo for EDI 309 processing → The import cargo status should meet all required criteria including proper import status, valid documentation, and customs clearance requirements
[Validate Multi-Transit Cargo Status]
The system validates multi-transit cargo for EDI 309 processing → The multi-transit cargo status should meet all required criteria including proper transit status, valid routing documentation, and bond requirements
[Display Date Validation Error]
The system needs to inform the user of the validation failure → A date validation error message is displayed explaining the invalid date condition
[Validate Line Selection Input]
System checks for line selection input → System displays error message if no line selection is provided
[Equipment ID Provided?]
No equipment ID is provided in the input field → The system displays an error message 'Equipment ID Required' and prevents equipment addition
[Validate Arrival Date/Time Format]
The system validates the date/time format → The system accepts valid date/time formats and rejects invalid formats with appropriate error message
[Check Future Date Restriction]
The system compares the entered date with the current system date → The system rejects the entry if the arrival date is in the future and displays an error message
[Validate Train Not Arrived]
The system checks if the train has already arrived → The system prevents the status change if train is already arrived and displays appropriate error message
[Error: Container Must Have Parent Flatcar]
No parent flatcar relationship is found for the container → System displays error message indicating container must have parent flatcar and prevents the operation
[Bill Number Provided?]
User submits search request without providing a bill number → System displays error message indicating bill number is required and prevents search execution
[Display Error: Bill Number Not Found]
System completes search through entire train consist without finding matching bill number → System displays error message indicating bill number was not found in current train
[Cargo Found?]
The system searches for the cargo record in the database → If no cargo record is found, display cargo not found error message and stop processing
[Equipment Mismatch Error]
The system detects the equipment mismatch → Display equipment mismatch error message and prevent cargo attachment to train
[Display Authorization Error Message]
The system needs to deny the override request → The system displays an authorization error message and denies the operation
[Validate Train Print Options]
The system validates train print parameters → Verify train identification exists and print options are valid before proceeding to train list parameter setup
[Validate Cargo Print Options]
The system validates cargo print parameters → Verify cargo selection criteria and print options are valid before proceeding to cargo list parameter setup
[Validate Fax Parameters]
The system validates fax parameters → Verify fax number format and station configuration are valid before proceeding to fax station lookup
[Valid Fax Number?]
The system validates the fax number configuration → If fax number is invalid or not configured, display 'Invalid Fax Configuration' error and stop processing, otherwise proceed with fax transmission setup
[Verify System Merlin ID]
The system verifies system Merlin ID → Validate that the system's Merlin ID is active and authorized for fax transmission operations
[Validate Print Parameters]
System validates print parameters → System either proceeds to print type selection or displays parameter error message
[Validate Fax Station]
System validates fax station → System either proceeds to fax number validation or displays invalid fax station error
[Validate Fax Number]
System validates fax number → System either proceeds to setup fax transmission or displays invalid fax number error
[Report Size Check]
The system checks the report size → The system determines whether the report requires single or multi-part email processing
[Pedimento Hold?]
System checks pedimento hold status → Pedimento hold status is determined based on cargo characteristics
[Log Transmission Error]
The system handles transmission failure → Transmission error details are logged for troubleshooting and audit purposes
[Hazmat Cargo?]
The system checks for hazmat status → Hazmat cargo receives hazmat indicators, while non-hazmat cargo proceeds to pedimento hold checking
[Validate Cargo Exists]
The system attempts to retrieve the cargo record → The system validates that the cargo record exists in the database before proceeding with the attachment
[Create Error Message - Cargo Not Found]
The cargo record does not exist in the database → The system creates an error message indicating the cargo was not found and prevents the equipment attachment
[Display Error: Line Selection Required]
User submits a request without entering any line selection → System displays error message indicating line selection is required
[Display Error: Invalid Line Selection Format]
Line selection contains non-numeric characters after conversion → System displays error message indicating invalid line selection format
[Display Error: Line Selection Must Be Greater Than Zero]
Line selection value is zero or negative → System displays error message indicating line selection must be greater than zero
[Display Error: Line Selection Exceeds Equipment Count]
Line selection value is greater than the total equipment quantity → System displays error message indicating line selection exceeds equipment count
[Display Error: Line Selection Below Valid Range]
Line selection is less than the saved item position → System displays error message indicating line selection is below valid range
[Add Fax Station Information]
The system processes fax station setup → Fax station information is retrieved, validated, and added to the report configuration
[Add Fax Number]
The system processes fax number configuration → Fax number is validated for format and added to the report transmission parameters
[Hazmat Data Found?]
The system checks if hazmat data is present in the segment → Equipment is classified as either having hazmat data or being non-hazmat based on data presence
[Validate Hazmat Classification]
The system validates the hazmat classification information → Hazmat classification is confirmed as valid and ready for type identification
[Email Send Success?]
The system checks the transmission result → If transmission was successful, mark as success, otherwise mark as failed
[Email Part Send Success?]
The system checks the transmission result → If transmission was successful, continue processing, otherwise mark entire multi-part transmission as failed
[Check Pedimento Hold Status]
The system checks pedimento hold status → Hold status indicator is added to report line if cargo is held for pedimento
[Transmission Successful?]
The system validates transmission success → Transmission status is confirmed as successful or error handling is initiated
[Handle Transmission Error]
The system handles transmission error → Error is logged, appropriate notifications are sent, and retry procedures are initiated if applicable
[Report Valid?]
The system performs the final report validity check → The system determines if the report is valid and ready for transmission or if formatting errors need to be addressed
[Cargo Rejected - Status Error]
The system processes attachment validation → Reject cargo attachment and provide status error message
[Validate Export Cargo Status]
The system validates the export cargo status → The cargo status must be in valid export states (EXPORT, AEXP, RELEASED) to proceed with EDI processing
[Validate Import Cargo Status]
The system validates the import cargo status → The cargo status must be in valid import states (OK, SENT, RELEASED) to proceed with EDI processing
[Validate Multi-Transit Cargo Status]
The system validates the multi-transit cargo status → The cargo status must be in valid multi-transit states to proceed with EDI processing
[Log Queue Submission Error]
The system processes the submission failure → Detailed error information is logged including failure reason, timestamp, and request details for troubleshooting
[Function Field Empty?]
The function field is empty or contains only spaces → Clear all error messages and return to normal display mode
[Valid Function Code?]
The function code is not one of: ADD, DEL, MOD, PTT, ARRIVAL, PRINT, CAN-ARR, MOVE, ENROUTE, AEI-BLOCK → Display invalid function error message
[Line Selection Valid?]
No line is selected or the selected line number is invalid or outside the valid range → Display line selection error message
[Train Status Check]
Train status does not allow deletion (train is locked, arrived, or in invalid status) → Display train status error message and prevent deletion
[Date/Time Format Check]
Arrival date or time format is invalid or improperly formatted → Display date format error message and prevent arrival processing
[Print Options Check]
Print options are invalid or not properly specified (train list, cargo list, or both) → Display print options error message and prevent printing
[Merlin ID Check]
Merlin ID is invalid or not properly configured for the user → Display Merlin ID error message and prevent printing
[Line Selection Check]
No line is selected or the selected line number is invalid for movement operations → Display line selection error message and prevent move operation
[Is Train Locked?]
The system checks the current train status → If train status is LOCKED, prevent modification access and display lock status message
[Train Being Processed?]
The system checks train processing status → If train is being processed, set temporary lock and display processing message
[Valid Line Range?]
The system validates the selection → The system accepts the selection if line number is between 1 and the number of equipment items displayed on current page, otherwise displays error message
[User Confirmation?]
The user provides a response (CONFIRM, CANCEL, or invalid input) → The system routes to authorization validation for CONFIRM, cancels operation for CANCEL, or displays error message for invalid input
[Date/Time Format Valid?]
The system validates the date/time format → If the date format is invalid or time format is invalid, the system displays format error message and prevents processing
[Valid Format?]
The date or time format is invalid or cannot be parsed → The system displays an invalid date/time format error and stops processing the arrival request
[Check Train Status]
User attempts to change train status to enroute AND the train status indicates it has already arrived → System displays error message 'Cannot Change Arrived Train to Enroute' AND prevents the status change
[Train Currently Locked?]
User attempts to change train status to enroute AND the train is currently in locked status → System displays error message 'Train is Locked - Cannot Modify' AND prevents the status change
[Valid Merlin ID?]
System validates Merlin ID for transmission → System checks if Merlin ID is valid and either proceeds with configuration or displays error message
[Display Merlin ID Error]
System detects invalid Merlin ID → System displays Merlin ID error message and returns user to input screen
[Station Lookup for Fax]
System validates fax destination → System performs station lookup to verify fax transmission capability
[Validate Fax Number]
System validates fax number → System checks fax number format and accessibility for transmission
[Display Fax Setup Error]
System detects invalid fax configuration → System displays fax setup error message and returns user to input screen
[Display Invalid Line Selection Error]
Line number validation fails → System displays 'Invalid line selection' error message and returns to train display
[Display Line Out of Range Error]
Range validation fails → System displays 'Line out of range' error message and returns to train display
[Display Cannot Move Down Error]
Move down capability check fails → System displays 'Cannot move down' error message and returns to train display
[Display Cannot Move Up Error]
Move up capability check fails → System displays 'Cannot move up' error message and returns to train display
[Display Container Group Error]
Containers are not properly grouped with parent equipment → System displays 'Container group error' message and returns to train display
[Line Number Field Empty?]
User submits request without entering a line number → System displays error message requiring line number input
[Convert Input to Numeric Using JSTNUM]
Line number contains non-numeric characters or invalid format → System displays error message indicating invalid numeric format
[Line Number > 0?]
Line number is zero or negative → System displays error message that line number must be greater than zero
[Line Number <= Equipment Quantity?]
Line number exceeds the total equipment count → System displays error message that line number exceeds equipment count
[Line Number >= Saved Item Position?]
Line number is below the saved item position range → System displays error message that line number is below valid range
[Equipment Exists at Line?]
No equipment exists at the selected line position → System displays error message that no equipment exists at selected line
[Display Error: Container Must Have Parent Flatcar]
No parent flatcar is found for the container → The system displays an error message that container must have a parent flatcar and prevents the movement
[Display Error: All Containers Must Move as Group]
Only some containers are selected for movement → The system displays an error message that all containers must move as a group and prevents the movement
[Display Error: Insufficient Space for Container Group]
The target position does not have sufficient consecutive space for all containers and the flatcar → The system displays an error message about insufficient space and prevents the movement
[Validate Search Input]
The search input field is empty or contains only spaces → The system displays an input error message and prevents the search from proceeding
[Equipment Quantity < 500?]
The current equipment count in the train is 500 or more pieces → The system should reject the addition request and display an equipment limit exceeded error message
[Is Cargo Status = RELEASED or OK?]
System validates cargo status for equipment addition → System confirms cargo status is RELEASED or OK or returns invalid cargo status error
[Validate IT Bond Status]
Equipment addition is requested for non-arrived train → System validates IT bond specific status requirements and location matching criteria
[Validate IE Bond Status]
Equipment addition is requested for non-arrived train → System validates IE bond status requirements for immediate export processing
[Reject Equipment Addition - Error Status]
Equipment addition is attempted → System rejects equipment addition and displays error message indicating cargo error status prevents attachment
[Equipment ID Matches Bill?]
ID matching validation is performed → System compares equipment ID with cargo record equipment ID - match allows proceeding to attachment rules, mismatch results in rejection
[Cargo Bill Record Found?]
The system checks for the existence of a cargo bill record → If no cargo bill record is found, the system sets an error indicating bill record not found, otherwise processing continues
[Display Error Message to User]
The system needs to inform the user of the validation failure → An error message is displayed to the user indicating the equipment type is invalid
[Counter Overflow Error]
The system processes the validation results → Generate counter overflow error and terminate the counting process
[Valid Merlin ID?]
Merlin ID is empty or invalid format → System displays Merlin ID error message and returns to print options
[Valid Fax Setup?]
Fax number is missing or fax station is not configured → System displays fax configuration error and returns to print options
[Email Successful?]
Email transmission completes → System displays success message if transmission successful, otherwise displays email error message
[Fax Successful?]
Fax transmission completes → System displays success message if transmission successful, otherwise displays fax error message
[Merlin Transmission Successful?]
Merlin transmission completes → System displays success message if transmission successful, otherwise displays Merlin error message
[Merlin ID Provided?]
No Merlin ID is provided in the print request → System displays 'Merlin ID Required' error message and returns user to print menu
[Valid Format?]
The Merlin ID format does not meet system format requirements → System displays 'Invalid Merlin ID Format' error message and returns user to print menu
[Merlin ID Found?]
The Merlin ID does not exist in the system database → System displays 'Merlin ID Not Found' error message and returns user to print menu
[Transmission Method?]
User has not selected either Merlin or Fax transmission method → System displays 'Transmission Method Required Error' and prevents processing
[Merlin ID Valid?]
System validates the provided Merlin ID → If Merlin ID is invalid, system displays 'Invalid Merlin ID Error', otherwise proceeds with Merlin transmission setup
[Merlin ID Valid?]
The system verifies Merlin ID configuration → If Merlin ID is invalid, display Merlin ID error, otherwise configure fax transmission parameters
[Configuration Complete?]
The system validates the complete fax configuration → If configuration is incomplete, display configuration error, otherwise mark fax setup as complete and ready for transmission
[Transmission Success?]
The system checks transmission result → If transmission succeeded, proceed to audit transaction spawning; if transmission failed, handle transmission error
[Part 1 Success?]
The system checks first part transmission result → If first part succeeded, proceed with remaining parts; if first part failed, handle multi-part transmission error
[All Parts Sent?]
The system checks transmission completion status → If more parts remain, continue loop processing; if all parts are sent, complete multi-part transmission
[Handle Transmission Error]
The system handles transmission error → Log transmission failure with error details, timestamp, and attempted recipient information
[Handle Multi-Part Error]
The system handles multi-part transmission error → Log multi-part transmission failure with error details, failed part information, timestamp, and attempted recipient information
[Set Error Status]
The system updates transmission status → Set transmission status to error, update failure timestamp, and mark report as undelivered
[Arrival Date/Time Entered?]
No arrival date or time is entered → System displays error message 'Arrival Date/Time Required' and prevents processing
[Valid Date Format?]
The date format is invalid or does not match system requirements → System displays error message 'Invalid Date Format' and rejects the input
[Valid Time Format?]
The time format is invalid or does not match system requirements → System displays error message 'Invalid Time Format' and rejects the input
[Arrival Before Train Creation?]
The arrival date/time is earlier than the train creation date/time → System displays error message 'Arrival Must Be After Train Creation' and rejects the input
[Report Size Check?]
The system checks the report size → Report is sent as single transmission if within limits, otherwise split into multiple parts
[Check Pedimento Hold Status]
If pedimento hold requirements → The system determines pedimento hold status based on cargo characteristics and location
[Check Hazmat Status]
If cargo for hazardous materials → The system determines hazmat status based on cargo classification and regulatory requirements
[Check Mexican Customs Status]
If Mexican customs requirements → The Mexican customs status is checked to determine pedimento hold applicability
[Check Pedimento Hold Status]
Evaluating pedimento hold status → Pedimento hold status is determined based on cargo and station conditions
[Check Pedimento Hold]
Checking for pedimento hold status → System determines if cargo has pedimento hold based on Mexican customs requirements
[Check Hazmat Status]
Checking for hazardous materials → System determines if cargo contains hazmat based on cargo classification and regulatory requirements
[Is Cargo at Laredo Station?]
The system checks the cargo location → The system identifies if the cargo is at Laredo station for pedimento processing requirements
[Validate Pedimento Documentation Status]
The system validates pedimento documentation completeness → The system confirms whether all required pedimento documents are present and valid
[Check Report Size]
The system checks the report size → The report line count is evaluated to determine if it exceeds the maximum single email limit
[Email Send Successful?]
The system checks the transmission result → The system determines if the email was sent successfully or if an error occurred
[Handle Email Transmission Error]
The system processes the transmission error → Appropriate error handling procedures are executed and the process terminates with error status
[Single Email Sent Successfully]
The transmission is completed → The system confirms the single email was sent successfully
[Validate Email Recipients]
The system validates recipients → Email addresses are validated for proper format and deliverability
[Log Transmission Error]
The system logs the error → Error details are recorded including failure reason and timestamp
[Validate Merlin Destination]
The system validates destination → Merlin destination parameters are validated for proper connectivity and authorization
[Log Merlin Error]
The system logs the error → Merlin error details are recorded including failure reason and timestamp
[Split Report into Multiple Parts]
The system prepares report for transmission → Report is split into multiple parts with each part not exceeding 699 lines
[Log Transmission Error]
The system detects transmission failure → Transmission error is logged with error details and timestamp for troubleshooting
[Handle Email Error]
The transmission fails for any reason → The system logs the transmission error and handles the failure without stopping the entire process
[Log Transmission Error]
Error logging is required → System logs transmission error with error details, timestamp, and report information for troubleshooting
[Transmission Successful?]
Transmission process completes → System verifies if transmission was successful
[Handle Transmission Error]
Transmission error is detected → System handles the transmission error and terminates with error status
[Check IT Bond Rules]
The system checks vessel information availability → The system should allow attachment if vessel information is available, otherwise deny attachment with missing vessel info message
[Check TR Bond Rules]
The system validates TR bond status → The system should allow attachment if TR bond status is valid, otherwise deny attachment with invalid TR status message
[Check MT Bond Rules]
The system validates MT bond status → The system should allow attachment if MT bond status is valid, otherwise deny attachment with invalid MT status message
[Check TE Bond Rules]
The system validates TE bond status → The system should allow attachment if TE bond status is valid, otherwise deny attachment with invalid TE status message
[Check IE Bond Rules]
The system validates IE bond status → The system should allow attachment if IE bond status is valid, otherwise deny attachment with invalid IE status message
[Validate Canadian Bond Destination]
The system validates the Canadian destination → The system should allow attachment if the Canadian destination is valid, otherwise deny attachment with invalid Canadian destination message
[Valid Canadian Destination?]
The destination code is not found in the valid Canadian location codes → A validation error flag is set, an error message is generated, the invalid destination code is logged, and validation failure is returned
[Display Export Authorization Error]
The system validates export security level → An export authorization error message is displayed and processing stops
[Display Import Authorization Error]
The system validates import security level → An import authorization error message is displayed and processing stops
[Display Insufficient Authority Error]
The system validates authority levels → An insufficient authority error message is displayed and processing stops
[Display Equipment Limit Exceeded Error]
A user attempts to add additional equipment → An equipment limit exceeded error message is displayed and processing stops
[Display Invalid Line Selection Error]
The system validates line selection → An invalid line selection error message is displayed and processing stops
[Display Train Locked Error]
A user attempts to add equipment → A train locked error message is displayed and processing stops
[Display Date Restriction Error]
A user attempts to add equipment → A date restriction error message is displayed and processing stops
[Display Status Restriction Error]
A user attempts to add equipment → A status restriction error message is displayed and processing stops
[Valid Line Selection?]
System checks if a line has been selected → If no line is selected, display line selection error message and return to display
[All Containers in Group Selected?]
System checks if all containers in the group are included in the selection → If not all containers in group are selected, display container group error message and return to display
[Validate Export Cargo Status]
Export cargo status validation is performed → Cargo status is verified against export-specific validation criteria and validation result is determined
[Validate Import Cargo Status]
Import cargo status validation is performed → Cargo status is verified against import-specific validation criteria and validation result is determined
[Validate Multi-Transit Cargo Status]
Multi-transit cargo status validation is performed → Cargo status is verified against multi-transit-specific validation criteria and validation result is determined

Module: GCX108 1 Consolidated Epic Story

Epic: GCX108 Complete EDI Specification Extracted from Legacy

Contains 84 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX108 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Retrieve Admin Configuration]
The system looks up admin table with ID 'AD' and admin 'ADMINID' → The system retrieves admin segment data or displays error if not found
[Retrieve Manifest Information]
The system looks up manifest customs table with ID 'MC' using location ID name → The system retrieves manifest customs segment or displays error if customs broker table not found
[Retrieve US Cargo Data]
The system calls GCCUSIO2 to retrieve US cargo segments → The system retrieves all cargo segment data if successful, or displays error with CCN if retrieval fails
[Process Long Description]
Long description is empty:
description data exists in segments
→ The system uses free-form description if long description is empty, consolidates description from multiple segments, and removes extra spaces from description text
[Print Harmonized Codes]
Harmonized commodity codes exist in cargo segments → The system prints primary harmonized code, prints secondary harmonized code if exists, or marks processing complete if no secondary code
[Print Buyer Information]
Entity name is not spaces for cargo segments → The system looks up entity description from entity code table, prints default entity information if description not found, or prints specific entity information if description found
[Print Vehicle Information]
Vehicle ID number is spaces AND factory car order number is spaces → The system skips vehicle processing, otherwise prints vehicle header and processes all vehicle segments with ID and order information
[Send to Merlin System]
CPRS train ID exists:
no train ID exists
→ The system creates subject line with 'CARGO PR' and report count, includes train ID and sequence for train cargo or equipment and CCN for non-train cargo, determines recipient based on Internet/FAX/Merlin preferences, and sends message via EMCSEND2
[Spawn Log Transaction]
Output message needs to be logged → The system sets action code to 'CFR' for FAX Internet or US FAX, 'ZZZ' for Internet email, 'CTP' for train cargo, or 'CPR' for standard cargo, creates GCX105 message with appropriate routing information, and spawns GCT1051E transaction for logging
[Call READQ to Read Message Queue]
The system calls READQ to read the message → The message is retrieved with specified input parameters and message length
[Extract GCX108 Input Parameters]
The system extracts the security byte parameter → The security byte value is available for authorization validation
[Extract GCX108 Input Parameters]
The system extracts the US CCN parameter → The US CCN is available for cargo identification and processing
[Extract GCX108 Input Parameters]
The system extracts train ID and sequence on train parameters → Train identification information is available for cargo positioning
[Extract GCX108 Input Parameters]
The system extracts FAX number, Internet address, and Merlin ID parameters → Communication method options are available for document delivery determination
[Extract GCX108 Input Parameters]
The system extracts diversion flag and delete flag parameters → Special processing indicators are available for cargo handling decisions
[Extract GCX108 Input Parameters]
The system extracts previous broker key, port name, bill type, and bond type parameters → Historical broker information is available for cargo processing continuity
[Access Manifest Table with Diversion Port Name]
The system accesses the manifest table with the diversion port name → Execute table segment retrieval using the diversion port name as the manifest key
[Extract Port Information from Table]
The system processes the retrieved table segment → Extract US statistics exit port name (first 12 characters) and port code (characters 2-4 of exit code) and update the diversion port name and code fields
[Call Table Segment Retrieval]
Table segment retrieval is executed → The system performs the W300-GET-TABLE-SEGMENT procedure to retrieve admin data
[Move Admin Data to Working Storage]
Data storage is performed → The retrieved table segment is moved to GCSTBRT-AD-SEGMENT for subsequent processing
[Extract Phone Number from Table]
The system processes the lookup result → The system extracts phone number from table segment AND assigns it to phone number field for report usage
[Call Table Retrieval Function]
Executing the table retrieval operation → The system calls the table I/O function to retrieve the manifest segment data
[Store Manifest Segment Data]
Processing the retrieved table segment → The table segment data is moved to the manifest customs segment structure for further processing
[Call GCCUSIO2 to Get US Cargo Segments]
The system calls GCCUSIO2 with cargo segments and arrays → All cargo segment data is retrieved including buyer data, vehicle information, harmonized codes, additional cargo data, and extended descriptions
[Move Cargo Segment Data to Work Areas]
The system processes the retrieved segment arrays → The first occurrence of each segment type (buyer data, vehicle information, harmonized codes, additional cargo data, and extended descriptions) is moved to corresponding work areas
[Extract Long Description from Cargo]
The system processes cargo description information → The long description is extracted from the cargo data and additional description data from segments is also captured
[Process Description Text Cleanup]
The system prepares description text for formatting → All description components are consolidated into a comprehensive description work area including extended descriptions from multiple segments
[Move Long Description to Work Area]
The system processes description consolidation → The system should move the long description (GCUS-N1002-LONG-DESC) to the US07 section of the work area (WS-DESC-US07), move the additional description data (GCSUSS10-N10-MORE-DATA) to the US10 section (WS-DESC-US10), and process all huge description segments by iterating through up to 46 segments and moving each GCSUSS12-N10-HUGE-DESC to the corresponding WS-DESC-US12 position
[Terminate Processing - Master Segment Not Printable]
The manifest BOL type code equals '77' indicating a master segment → The system terminates the current processing flow and returns control without generating any printable output
[Print Diversion Message Line 1]
The system prints the first diversion message line → The first line of the diversion notification is displayed
[Print Diversion Message Line 2]
The system prints the second diversion message line → The second line of the diversion notification is displayed
[Print New Port Information]
The system displays the new port information → The new port name and code for the diverted cargo are shown
[Print Cargo Description Lines]
The cargo description needs to be formatted for display → The system compresses multiple consecutive spaces into single spaces, formats the description into lines, and prints each non-empty description line
[Print Harmonized Commodity Codes]
Processing harmonized commodity codes for display → The system prints line 27A, then for each segment with non-empty primary harmonized code, prints the primary code with continuation flag, and if secondary code exists, prints it with continuation flag, otherwise marks as done and stops processing
[Print Buyer/Consignee Information]
Processing buyer information where segment data is not empty or low-values and entity name is not empty → The system prints spaces, processes entity data with type description lookup, and prints buyer details including lines 35-40
[Print Vehicle Information]
Either vehicle ID number or factory car order number is not empty → The system prints three spaces, vehicle header lines 44 and 45, one space, then processes all vehicle segments printing line 46 for each occurrence
[Print Additional Cargo Details]
All main cargo sections have been processed → The system prints cargo detail lines 8 through 28, processes cargo segments with lines 29, 31, and 32 for each occurrence
[Buyer Name Exists?]
The buyer entity name field contains valid name information (not spaces) → The system processes the buyer record and prints blank line followed by entity data formatting
[Loop Through Buyer Segments]
Processing buyer information → The system loops through each buyer segment from 1 to the maximum sequence number or until empty buyer data is encountered
[Access Bond Type Code from US Cargo Data]
The system needs to access bond type information for customs processing → The in-bond type code (M1201-IN-BOND-TYP-CDE) is retrieved from the US cargo segment
[Access Bill Type Code from US Cargo Data]
The system needs to access bill type information for manifest processing → The bill of lading type code (M1109-BOL-TYP-CDE) is retrieved from the US cargo segment
[Combine Description Sources]
Processing cargo description data → The system should combine long description, more data description, and all huge description segments into a single consolidated description
[Loop Through Available Harmonized Code Segments]
The system processes harmonized codes → The system loops from segment 1 to the maximum sequence number or until no more harmonized codes flag is set
[Format First Harmonized Code for Output]
The system processes the first code in the segment → The system moves the first harmonized commodity code to the output string, sets continuation line flag, and prints the harmonized code line
[Format Second Harmonized Code for Output]
The system checks for a second harmonized commodity code in the same segment → If the second code is not spaces, the system formats it for output, sets continuation flag, and prints it; otherwise sets done line flag and prints final line
[Set No More Harmonized Codes Flag]
The segment contains no valid harmonized commodity codes or processing is complete → The system sets the no more harmonized codes flag to true and may print a final done line if this is not the first segment
[Loop Through Buyer Segments]
Processing buyer information → System iterates through all buyer segments up to maximum sequence number
[Get Buyer Segment Data]
Extracting buyer data → System moves buyer segment data from working storage array to current buyer segment structure
[More Buyers?]
Checking for additional buyers → System continues loop if more buyer segments exist, otherwise ends buyer processing
[Increment Report Count]
The send to Merlin process is initiated → The system increments the Merlin report count by 1
[Build Train Subject Line]
Building the subject line for Merlin transmission → The system creates subject line with format 'CARGO PR [count]: [train_id] [sequence] [equipment_car]'
[Build Cargo Subject Line]
Building the subject line for Merlin transmission → The system creates subject line with format 'CARGO PR [count]: [equipment_car] [CCN]'
[Set External FAX Routing]
Setting up Merlin routing configuration → The system sets recipient to 'EXTFAX' for external FAX transmission
[Set External Mail Routing]
Setting up Merlin routing configuration → The system sets recipient to 'EXTMAIL' for external email transmission
[Purge Message Queue]
Performing post-transmission cleanup → The system calls 'CIMS' with 'PURG' to purge the alternate PCB message queue
[Set Message to Internet Address]
The system processes the email routing → The message is formatted as 'INTERNET: ' followed by the internet parameter value
[Set Message to Merlin ID]
The system processes the train communication routing → The message is set to the Merlin ID value
[Set Message to FAX Number]
The system processes the FAX communication routing → The message is set to the FAX number value
[Set Message to Merlin ID]
The system processes the default communication routing → The message is set to the Merlin ID value
[Set FAX Communication Method]
The SC-US-FAX-NUMBER field contains a valid FAX number (not spaces) → The system sets the FAX number as the communication method and creates a FAX line in the output message
[Configure Internet Email Format]
The Internet field is not spaces AND does not start with 'FAX:' or 'fax:' → The system formats the message as 'INTERNET: [address]' in the output line
[Set Internet Lines Per Page = 500]
Internet address is not empty, not HIGH-VALUES, and not LOW-VALUES → The lines per page should be set to 500 for internet transmission
[Format Internet FAX Address with Control Parameters]
The system processes the internet communication address → The system should clear the message line, extract the fax number from positions 5-14 of the internet field, and format it with opening parenthesis, NAK control parameter, NOCVR control parameter, and closing parenthesis
[Set Action Code 'ZZZ' for Internet]
The system determines the action code for the transaction log → The action code should be set to 'ZZZ' and the message should be formatted as 'INTERNET: ' followed by the internet address
[Set Action Code 'CFR' for FAX]
The system determines the action code for the transaction log → The action code should be set to 'CFR' and the message should contain the FAX number extracted from positions 5-14 of the internet address
[Set Action Code 'CTP' for Train]
The system determines the action code for the transaction log → The action code should be set to 'CTP' and the message should contain the Merlin ID
[Set Action Code 'CFR' for FAX]
The system determines the action code for the transaction log → The action code should be set to 'CFR' and the message should contain the FAX number
[Set Action Code 'CPR' for Print]
The system determines the action code for the transaction log → The action code should be set to 'CPR' and the message should contain the Merlin ID
[Write Transaction to Log Queue]
The system writes the transaction to the audit log → The transaction should be spawned to GCT1051E program, written to the message log queue using WRITMSGL, and the message queue should be purged for cleanup

Structural Validations

[Check Master Segment]
The bill of lading type code equals '77' → The system terminates cargo processing and exits
[Generate Error Message]
The system needs to handle the missing port information → Set error message to 'CAN NOT FIND DIVERSION NAME IN MC TABLE' and invoke error handling procedure
[Set Error Message: Cannot Find Admin Table]
Error message is set → The error message 'CAN NOT FIND ADMIN TABLE' is assigned to the system error message field
[Call Error Handler]
Error handling is invoked → The system calls 'CERR' using CCCOM to handle the admin table not found error
[Manifest Table Found?]
Checking the table lookup return status → If return flag equals 'SUCCESSFUL', proceed to extract customs broker information, otherwise generate error message
[Generate Error Message]
Table retrieval returns unsuccessful status → The error message 'CAN NOT FIND CUSTOMS BROKER TABLE' is set in the communication area
[Call Error Handler]
Handling the lookup failure → The system calls the error handler routine using the communication area to terminate processing
[Log Cargo Retrieval Error]
The system handles the retrieval failure → The US CCN is moved to error CCN field and an error message is set for display
[Skip Empty Buyer Record]
The buyer entity name field is empty or contains only spaces → The system skips processing this buyer record and continues to the next buyer segment
[Bond Type Code Available?]
The system checks for bond type code availability → The system determines if the in-bond type code field contains valid data (not spaces or null)
[Bill Type Code Available?]
The system checks for bill type code availability → The system determines if the bill of lading type code field contains valid data (not spaces or null)
[Harmonized Code Segment Available?]
The system checks the segment for valid harmonized commodity code data → The system continues processing if the first harmonized commodity code is not spaces, otherwise sets no more harmonized codes flag
[Buyer Data Available?]
Checking buyer data availability → System validates that buyer cargo data is not spaces or low values
[Buyer Name Exists?]
Validating buyer information → System checks if buyer entity name is not spaces
[Log Error Message]
Handling the transmission error → The system moves the return status to error message and calls 'CERR' for error logging

Module: GCX109 1 Consolidated Epic Story

Epic: GCX109 Complete EDI Specification Extracted from Legacy

Contains 203 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX109 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Export Segment Header]
The export segment structure needs to be initialized → The ITX header (WS-ITX-HEADER) is moved to the first export segment position (WS-EXP-SEGM(1))
[Initialize Export Header]
The system needs to create export message structure → The ITX header is moved to the first export segment position
[24: Initialize MQ Variables]
The system initializes MQ variables → The system sets output options, syncpoint and default context options, USC queue name, datagram message type, message format as string, calculates EDI message length based on line count and segment length, sets buffer length including MQ header length, initializes message timestamps, and sets record format and page information
[24: Initialize MQ Variables]
The system calculates buffer length → The system computes buffer length as EDI message length plus MQ header length
[24: Initialize MQ Variables]
The system calculates EDI message length → The system computes EDI message length as line count multiplied by segment length
[Initialize MQ Object and Message Descriptors]
MQ descriptors are being initialized → The queue name should be set to USC queue name, object queue manager name should be spaces, reply-to queue and queue manager should be spaces, message ID should be MQMI-NONE, and correlation ID should be MQCI-NONE
[24: Initialize MQ Variables]
The system initializes MQ variables for transmission → The system sets output options, syncpoint options, queue name to USC, message type to datagram, calculates EDI message length based on line count and segment length, sets buffer length including MQ header, and initializes message format and pagination parameters
[Initialize MQ Message Structure]
Initializing the message container → The MQ message structure should be initialized to clear any previous data
[Initialize Error Message Text]
The error mapping process begins → The output message text field is cleared and initialized to empty state
[Initialize Output Message Text]
The error mapping service is initiated → The output message text field is cleared to remove any previous error information
[Initialize Output Message Text]
The error message mapping process begins → The output message text area is cleared and initialized to empty state

Core Acceptance Criteria

[3:Validate Security Authorization]
The system checks the security byte in the message AND the return code from queue reading operation → Processing continues only if security byte equals HIGH-VALUES AND return code is either 0 or 3, otherwise the system terminates with an error
[Transaction Type?]
The system analyzes the segment ID in the transmission data → The system classifies the transaction as Manifest (309), Customs Status Info (350), Events Advisory (353), or Consist Info (358) based on the segment identifier
[16:Handle Export Manifest Processing]
The system checks the application type in the manifest record AND finds it equals rail export manifest type → The system sets USC export flag to true AND sets ITX route to USC export AND moves the ITX header to the export segment array
[17:Determine KCSM Routing]
The system finds a location ID that starts with Laredo TX port code in either port info segments:
in-bond info segments
→ The system sets the send-to-KCSM flag to true for additional message routing
[6:Process Transaction Segments]
The system processes equipment details segments:
conveyance ID segments
→ The system extracts and stores equipment initial and equipment number from the respective segment fields
[18:Remove Container Check Digit]
The equipment number without check digit is numeric → The system removes the check digit by moving a leading zero plus the first 7 digits of the original equipment number AND replaces the original equipment ID with the modified version in the EDI message
[22:Send EDI to US Customs]
The transaction type is Manifest:
Events Advisory
Consist Info
→ The system sends the EDI message to US Customs destination
[23:Send EDI to KCSM]
The transaction type is Manifest:
Customs Status Info
→ The system sends a copy of the EDI message to KCSM destination with KCSM routing header
[30:Delete Processed Transmission]
The transmission number is NOT one of the dummy transmission numbers (309, 353, 358) → The system deletes the processed transmission data from the system
[Get System Date and Time]
The system timestamp capture process is executed → The current system date and time are captured and stored for transaction processing
[Save Current Program Name]
Program initialization begins and module identification is about to be set → The current program name is saved to a backup variable for later restoration
[Set Input Message Length]
The system prepares to read the queue message → The input message length is set to the length of the GCX109-INPUT structure
[Call READQ to Retrieve Message]
The system needs to retrieve a transmission message → The READQ service is called with the communication control block, input message structure, and message length parameters
[Check Security Byte Value]
The system checks the security byte value in the message header → EDI processing is allowed only if the security byte equals HIGH-VALUES, otherwise processing is skipped
[Set Transmission Number as Database Key]
The system needs to retrieve transmission segment data from the database → The transmission number should be set as the database key (A9RT-KEY-VALUE) for the lookup operation
[Call Database to Get GCA9RT Segment]
The system executes the database retrieval operation → The system should call the database service to get the GCA9RT transmission segment using the key
[Clear EDI Message Structure]
The system begins EDI message initialization → The EDI message structure is cleared and reset to initial state
[Clear Header Timestamps]
The system prepares header information → Both header timestamp fields are cleared and initialized
[Set Default Route to US Customs]
The system initializes routing information → The routing flag is set to direct messages to US Customs by default
[Get Transaction Set from Transmission Data]
The system processes the transmission data → The transaction set value is extracted and stored for message processing
[Set Transaction Set ID]
The system builds the EDI header → The transaction set identifier is assigned to the EDI header transaction set ID field
[Create Initial EDI Header]
The system creates the EDI message structure → The EDI header is placed in the first segment position of the message
[Set Line Count to 1]
The system sets up message tracking → The line count is set to 1 to account for the header segment
[Set Current Machine Time]
The system captures timing information → The current machine time is stored in the header timestamp time field
[Set Current Machine Date]
The system captures timing information → The current machine date is stored in the header timestamp date field
[Set Control Number from Transmission]
The system creates the EDI header → The transmission number is assigned as the control number in the header timestamp
[Read Next Dependent Segment from GCA9DP]
A request is made to read the next dependent segment from GCA9DP database → The system retrieves the next available dependent segment data
[Replace Special Characters in Segment Data]
The segment data is processed → All asterisk (*) characters are replaced with periods (.) and all colon (:) characters are replaced with periods (.)
[What Segment Type?]
If the segment identifier → The segment is classified as Manifest (M10), Port Info (P4), Equipment (N7), In-Bond (M12), Conveyance (VID), or Other type
[Extract Manifest Information M10 Segment]
The segment data is processed → The cargo control number is extracted from record number field and the application type is extracted to determine if it is a rail export manifest
[Extract Port Information P4 Segment]
The segment data is processed → The location ID is extracted from the port information field
[Port Code = Laredo?]
The location ID is evaluated → If the first 4 characters of the location ID match the Laredo TX port code, the KCSM routing flag is set to true
[Extract Equipment Details N7 Segment]
The segment data is processed → The equipment initial is extracted from the equipment initial field and the equipment number is extracted from the equipment number field
[Extract In-Bond Information M12 Segment]
The segment data is processed → The location ID is extracted from the in-bond location field
[Location = Laredo?]
The in-bond location ID is evaluated → If the first 4 characters of the location ID match the Laredo TX port code, the KCSM routing flag is set to true
[Extract Conveyance Information VID Segment]
The segment data is processed → The equipment initial is extracted from the conveyance equipment initial field and the equipment number is extracted from the conveyance equipment number field
[More Segments?]
The system checks for additional segments to process → If more segments exist, processing continues with the next segment, otherwise processing ends
[Replace all asterisks '*' with periods '.']
The segment data is being processed for EDI formatting → All asterisk characters '*' are replaced with period characters '.'
[Replace all colons ':' with periods '.']
The segment data is being processed for EDI formatting → All colon characters ':' are replaced with period characters '.'
[Extract Cargo Control Number from M10-12-RCD-NUM]
The system encounters M10 segment data → The cargo control number is extracted from M10-12-RCD-NUM field and stored in WS-CCN
[Is Application Type = Rail Export Manifest?]
The application type equals WS-RAIL-EXPORT-MANIFEST → The system identifies this as a rail export manifest for special processing
[Set Export Manifest Flag]
The system processes the manifest information segment → The USC export flag (WS-USC-EXP) is set to true to enable export processing
[Set USC Export Routing Flag]
The system configures routing parameters → The ITX route USC export flag (WS-ITX-ROUTE-USC-EXP) is set to true for proper message routing
[Extract Location ID from P4-01-LOCATION-ID]
The segment ID indicates port information → The location ID is extracted from P4-01-LOCATION-ID field and stored for routing decisions
[Store Location ID in Working Storage]
The location ID extraction is complete → The location ID is moved to working storage variable WS-LOCATION-ID
[Is Location ID Laredo, TX Port Code?]
The first 4 characters of the location ID equal the Laredo TX port code → The KCSM routing flag is set to TRUE to enable additional message routing
[Set KCSM Routing Flag to TRUE]
The location ID matches the Laredo TX port code pattern → The WS-SEND-2-KCSM flag is set to TRUE to enable KCSM message routing
[Check Segment Type]
The segment ID matches the equipment details identifier (A9DP-SEG-ID-EQUIP-DETAILS) → The system recognizes this as an equipment details segment and proceeds to extract equipment information
[Extract Equipment Initial]
The system parses the N7-01 field containing the equipment initial → The equipment initial value is extracted and stored in working storage for further processing
[Extract Equipment Number]
The system parses the N7-02 field containing the equipment number → The equipment number value is extracted and stored in working storage for further processing
[Parse M12 Segment Data]
The system processes the A9DP-SEG-ID-IN-BOND-INFO segment → The location ID is extracted from M12-03-LOCATION-ID field and stored in working storage
[Check if Location ID starts with Laredo TX Port Code?]
The first 4 characters of the location ID equal the Laredo TX port code → The system sets the KCSM routing flag to TRUE for additional message routing
[Extract Equipment Initial from VID-02-EQUIP-INIT]
The segment ID matches conveyance identification type → The equipment initial is extracted from VID-02-EQUIP-INIT field and stored in working storage
[Extract Equipment Number from VID-03-EQUIP-NUM]
The segment ID matches conveyance identification type → The equipment number is extracted from VID-03-EQUIP-NUM field and stored in working storage
[Identify VID Segment]
The segment ID field matches the conveyance identification pattern → The segment is classified as a VID conveyance segment and conveyance processing is initiated
[Set Transaction ID to 309]
The manifest segment creation process begins → The transaction ID is set to 309 to identify this as a manifest transaction
[Extract Routing Information from Header]
The segment ID indicates a transaction set header → The routing information is extracted from characters 4 through 15 of the transmission data
[Update Manifest Header with Routing Info]
Processing a transaction set header for manifest data → The ITX header with routing information is moved to the first manifest segment position
[Is Export Manifest?]
The system checks the manifest type → If the USC export flag is set, the manifest is identified as an export manifest
[Create USC Export Segment]
The USC export flag indicates this is an export manifest → A USC export segment is created using the XA000-CREATE-USC-EXP-SEGMENT procedure
[Copy Transmission Data to Manifest Segment]
Standard transmission data needs to be copied → The transmission data is moved to the manifest segment at the current line count position
[Set Segment Length to 309 Max Length]
The segment length needs to be established → The segment length is set to the 309 maximum segment length value
[Set Transaction ID to 350]
The create customs status segments process begins → The transaction ID must be set to 350
[Check Segment Type]
The segment type is evaluated → The system must check if it is a transaction set header, USC export manifest, or other segment type
[Extract Routing Information from Header]
The segment is identified as a transaction set header → The system must extract characters 4-15 from the transmission data and store as routing information
[Build EDI Header Segment]
The EDI header needs to be built → The system must move the ITX header to the first position of the customs status information segment array
[Adjust Line Count]
The header segment has been built → The line count must be reduced by 1
[Create Export Segment]
The segment is identified as USC export type → The system must Execute the USC export segment creation process
[Copy Transmission Data to Segment]
The segment is not a transaction set header and not a USC export type → The transmission data must be copied to the customs status information segment at the current line count position
[Set Segment Length to 350 Max]
The transmission data has been copied to the segment → The segment length must be set to the 350 maximum segment length value
[Set Transaction ID to 353]
The create events advisory segments process begins → The transaction ID should be set to 353
[Extract Routing Information from Header]
The segment type is transaction set header → The routing information should be extracted from characters 4 through 15 of the transmission data
[Update Header with Routing Info]
Processing a transaction set header for events advisory → The ITX header should be moved to the first position of the events advisory segment array
[Is Export Manifest?]
The segment is not a transaction set header → The system should check if USC export processing is required
[Create Export Segment]
Export processing is required → The create USC export segment process should be invoked
[Copy Transmission Data to Events Advisory Segment]
The segment type is other than transaction set header or export → The transmission data should be copied to the events advisory segment at the current line count position
[Set Segment Length to 353 Maximum]
Processing non-header, non-export events advisory data → The segment length should be set to the 353 maximum segment length value
[Set Transaction ID to 358]
The consist segment creation process begins → The transaction ID should be set to 358
[Extract Routing Information from Header]
The segment is identified as a transaction set header → The routing information should be extracted from characters 4-15 of the transmission data and stored in the ITX route info field
[Update Consist Info Header Segment]
The routing information has been extracted → The ITX header should be moved to the first position of the consist information segment array
[Adjust Line Count]
The header segment has been updated → The line count should be decreased by 1
[Export Manifest?]
The segment type is not a transaction set header → The system should check if USC export processing is required and route accordingly
[Create USC Export Segment]
USC export processing is required → The USC export segment creation process should be invoked
[Copy Transmission Data to Consist Segment]
The segment is not a transaction set header and does not require USC export processing → The transmission data should be copied to the consist information segment array at the current line count position
[Set Segment Length to 358 Max Length]
The transmission data has been copied to the segment → The segment length should be set to the 358 maximum segment length value
[Check Manifest Info Segment]
The application type in M10-14 field equals rail export manifest type → The system recognizes this as a rail export manifest requiring special processing
[Set Export Flag to TRUE]
The application type matches rail export manifest criteria → The system sets USC export flag to TRUE and USC export route flag to TRUE
[Extract Route Information]
The segment ID indicates transaction set header → The system extracts characters 4-15 from transmission data as route information and updates the ITX header
[Create USC Export Segment]
The system processes transmission data for export → The transmission data is moved to the export segment at the current line count position and export segment length is set
[Is Export Processing?]
The USC export flag is set to TRUE → The system routes to export segment creation instead of regular manifest processing
[Extract Port Location ID from P4 Segment]
The system processes the segment data → The port location ID is extracted from the P4 segment and stored for routing evaluation
[Extract In-Bond Location ID from M12 Segment]
The system processes the segment data → The in-bond location ID is extracted from the M12 segment and stored for routing evaluation
[Port Code = Laredo TX?, In-Bond Location = Laredo TX?]
The first 4 characters of the location ID equal the Laredo TX port code → The KCSM routing flag is set to TRUE
[KCSM Flag = TRUE AND NOT Export Manifest?]
The transaction is NOT a USC Export manifest → The message is routed to KCSM in addition to USC
[KCSM Flag = TRUE AND NOT Export Manifest?]
The transaction is NOT a USC Export manifest → The message is routed to KCSM
[Route to US Customs Only]
The routing destination is determined → The message is routed to USC only, regardless of KCSM routing flag status
[Parse P4 Port Info Segment]
The segment ID matches port info pattern → The location ID is extracted from P4-01-LOCATION-ID field
[Parse M12 In-Bond Info Segment]
The segment ID matches in-bond info pattern → The location ID is extracted from M12-03-LOCATION-ID field
[Get Location ID from P4 Port Info Segment]
The system processes the segment data → The location ID is extracted from the P4-01-LOCATION-ID field and stored for routing evaluation
[Get Location ID from M12 In-Bond Info Segment]
The system processes the segment data → The location ID is extracted from the M12-03-LOCATION-ID field and stored for routing evaluation
[First 4 Characters = Laredo TX Port Code?]
The first 4 characters of the location ID are compared against the Laredo TX port code → If the first 4 characters match the Laredo TX port code, the system sets a flag to route the message to KCSM in addition to standard routing
[Replace Equipment ID in EDI Message]
The system needs to update the EDI message → The system should replace the first occurrence of the original equipment ID with the check digit removed equipment ID in the EDI message
[Replace Equipment ID in EDI Message]
The system updates the EDI message for KCSM transmission → The system replaces the first occurrence of the original equipment ID with the modified equipment ID in the EDI message
[Remove Check Digit from Equipment ID]
Check digit removal is performed → Equipment number without check digit is created by prefixing '0' and taking first 7 digits, and EDI message is updated to replace original equipment ID with the modified version
[Retrieve Shipment Root Record]
System performs shipment root lookup → System calls shipment root retrieval function with waybill key and segment type 'SHIPROOT'
[25: Connect to Message Queue]
A connection to the message queue is requested → The system connects to the MQ manager and validates the connection is successful, otherwise handles connection failure
[26: Put Message to Queue]
The system puts the message to the queue → The system moves the EDI message to message text, calls MQPUT1 to send the message, captures completion code and reason, and validates the operation was successful
[27: Disconnect from Message Queue]
The system disconnects from the message queue → The system calls MQDISCC to disconnect and validates the disconnection is successful, otherwise handles disconnection failure
[32: Log Transaction Details]
The system logs transaction details → The system displays system date and time, transmission number, EDI segment ID, CCN, equipment ID, equipment ID without check digit, location ID, MQ queue name, completion code, reason code, buffer length, and first 600 characters of the message
[Set MQ Options for Output]
MQ variables are being initialized for transmission → The MQ options should be set to MQOO-OUTPUT to enable message output operations
[Set MQ Put Message Options with Syncpoint]
MQ put message options are being set → The options should include MQPMO-SYNCPOINT and MQPMO-DEFAULT-CONTEXT for transactional delivery with default message context
[Set Message Type to Datagram]
Message type is being set → The message type should be set to MQMT-DATAGRAM for one-way transmission
[Set Insert and Put Timestamps]
Message structure is being initialized → The MQ message should be initialized, insert timestamp should be set to header timestamp 1, and put timestamp should be set to header timestamp 2
[Calculate EDI Message Length]
EDI message length needs to be calculated → The EDI message length should equal line count multiplied by segment length
[Convert Message Length to Text Format]
Message length needs to be included in MQ message → The EDI message length should be moved to numeric length field and then to MQ text length field
[Calculate Total Buffer Length]
Total buffer length needs to be calculated for MQ transmission → The buffer length should equal EDI message length plus MQ header length
[Set Record Format to Fixed 'F']
Record format is being set → The record format should be set to 'F' indicating fixed length records
[Set Page Number to 1]
Page number is being set → The page number should be set to 1 as the starting page
[Set Page Flag to Last 'L']
Page flag is being set → The page flag should be set to 'L' indicating the last page
[Convert Segment Length to Record Length]
Record length needs to be set in MQ message → The segment length should be moved to numeric length field and then the 4-character portion should be moved to MQ record length
[Calculate Total Message Length Line Count × Segment Length]
The system needs to calculate the total message length → The total message length is calculated as line count multiplied by segment length
[Convert Message Length to Display Format]
The system prepares the message for MQ transmission → The message length is converted to display format and stored in the MQ text length field
[Calculate Buffer Length Message Length + MQ Header Length]
The system prepares the buffer for MQ message transmission → The buffer length is calculated as EDI message length plus MQ header length
[Calculate EDI Message Length Line Count × Segment Length]
The system calculates the EDI message length → The EDI message length equals the line count multiplied by the segment length
[Add MQ Header Length to EDI Message Length]
The system prepares the message for MQ transmission → The total buffer length equals the EDI message length plus the MQ header length
[Set Total Buffer Length for MQ Transmission]
The system initializes MQ variables for message transmission → The MQ message text length is set to the calculated EDI message length
[25: Connect to Message Queue]
A connection to the message queue is requested → The system calls MQCONNC to establish connection and validates the connection was successful
[Export Manifest?]
The system checks if the transaction is a USC export manifest → If it is NOT a USC export manifest, the system sets KCSM routing header; if it IS a USC export manifest, the system proceeds to transaction type processing
[Set KCSM Routing Header]
The system prepares the message for KCSM transmission → The system sets the ITX route to KCSM in the message header
[Transaction Type?]
The system determines the transaction type → If transaction type is 309 Manifest, update manifest header for KCSM; if transaction type is 350 Customs Status, update customs status header for KCSM
[Update Manifest Header for KCSM]
The system updates the message header → The system moves the ITX header to the first manifest segment
[Update Customs Status Header for KCSM]
The system updates the message header → The system moves the ITX header to the first customs status segment
[Equipment Type Container?]
The system checks the equipment type → If equipment type is container, proceed with container check digit validation; if not container type, proceed to message queue transmission
[18: Remove Container Check Digit]
The system removes the check digit → The system creates new equipment number by adding leading zero and taking first 7 digits of original number, then replaces the equipment ID in the EDI message with the modified version
[26: Put Message to Queue]
The system transmits the message to the queue → The system calls MQPUT1 to send the message and validates the transmission was successful
[27: Disconnect from Message Queue]
The system disconnects from the message queue → The system calls MQDISCC to close the connection and validates the disconnection was successful
[Set MQ Output Options]
Setting up MQ connection parameters → The MQ options should be set to MQOO-OUTPUT to enable message output operations
[Set MQ Put Message Options with Syncpoint]
Setting up message transmission parameters → The MQPMO options should be set to MQPMO-SYNCPOINT plus MQPMO-DEFAULT-CONTEXT to ensure transactional control and proper message context
[Set Queue Name to US Customs Queue]
Configuring the target queue for EDI messages → The MQ object name should be set to the US Customs queue name from working storage
[Set Message ID to None, Set Correlation ID to None]
Configuring message ID and correlation ID parameters → The message ID should be set to MQMI-NONE and correlation ID should be set to MQCI-NONE
[Set Message Type to Datagram]
Setting the message type for EDI transmission → The message type should be set to MQMT-DATAGRAM for one-way message delivery
[Set Insert Timestamp, Set MQ Put Timestamp]
Populating timestamp fields in the MQ message → The insert timestamp should be set from header timestamp 1 and MQ put timestamp should be set from header timestamp 2
[Calculate EDI Message Length]
Calculating the total EDI message length → The EDI message length should be computed as line count multiplied by segment length
[Set Message Text Length]
Setting the message text length in MQ structure → The message text length should be set to the calculated EDI message length
[Calculate Buffer Length]
Calculating the total buffer length for MQ transmission → The buffer length should be computed as EDI message length plus MQ header length
[Set Record Format to Fixed]
Configuring the record format type → The record format should be set to 'F' indicating fixed-length records
[Set Page Number to 1, Set Page Flag to Last]
Configuring page number and page flag → The page number should be set to 1 and page flag should be set to 'L' indicating last page
[Set Record Length]
Setting the record length in MQ message structure → The record length should be set from the segment length converted to appropriate numeric format
[Call MQ Connect Service]
A connection request is made to the message queue manager → The system calls the MQ connect service to establish the connection
[Set Message Format to String]
The system prepares the message for transmission → The message format should be set to string format
[Copy EDI Message to MQ Message Buffer]
The system prepares to send the message → The EDI message content should be copied to the MQ message text buffer
[Call MQ PUT1 to Send Message]
The system executes the message send operation → The MQPUT1 function should be called with connection handle, object descriptor, message descriptor, put options, buffer length, and message content
[Log Transaction Details]
The system logs the transaction → The log should include transmission number, segment ID, cargo control number, equipment ID, equipment ID without check digit, location ID, queue name, completion code, reason code, buffer length, and first 600 characters of the message
[Call MQ Disconnect Function]
The EDI message processing is complete and disconnect is requested → The system calls the MQ disconnect function to close the connection
[Clear Accept Status]
The system prepares to execute the GHU database call → The accept status field must be cleared to spaces to initialize the database operation state
[Execute GHU Database Call]
The system needs to mark the transmission segment as processed → The system must execute a GHU database call using CIMS interface with the transmission segment data and SSAQ parameters
[Check Transmission Number]
If the transmission number against dummy transmission number list (309, 353, 358) → The transmission is classified as either dummy (skip deletion) or regular (proceed with deletion)
[Skip Deletion for Dummy Numbers]
The transmission number matches dummy transmission numbers WS-DUMMY-XMIT-NUM-309, WS-DUMMY-XMIT-NUM-353, or WS-DUMMY-XMIT-NUM-358 → The system continues without deleting the transmission segment and preserves the data
[Execute IMS DLET Function]
The system needs to clean up processed transmission data → The system executes database deletion operation to remove the transmission segment from GCA9RT database
[Queue Read Failure]
The queue read return code != 0 or 3 → Set error message to 'READQ FAILED!' and invoke system error handler to terminate program abnormally
[Map MQ Return Code to Text Message]
Error processing is initiated → Map the numeric MQ reason code to descriptive text message using external error mapping service
[Display Complete Transaction Log]
The system needs to create an audit log entry → The system displays a complete log entry containing timestamp, transmission number, EDI segment ID, cargo control number, equipment ID with and without check digit, location ID, MQ queue name, completion code, reason code, buffer length, and message sample

Structural Validations

[6:Process Transaction Segments]
The system processes the transmission data → The system replaces all asterisk characters with periods AND replaces all colon characters with periods
[Message Retrieved Successfully?]
The system checks the operation result → The message is considered successfully retrieved if the return code equals zero or three, otherwise it is considered failed
[Transmission Segment Found?]
The database operation completes → If the status code is not spaces (indicating success), the system should terminate processing with an error
[Report Database Error and Stop Processing]
The database status indicates an error condition → The system should terminate processing immediately and report the database error
[Clear Header Filler Fields]
The system completes header preparation → All header filler fields are set to zero values
[Segment Found?]
The system checks the status of the read operation → Processing continues if segment data exists, otherwise processing ends
[Is Equipment Type Container?]
The system needs to determine if check digit removal is required → The system should identify if the equipment type is a container and proceed with waybill lookup only for container equipment
[28: Handle MQ Errors]
An MQ error occurs → The system maps the return code to text message, moves the error text to MQ error message, sets transaction set information, and triggers system abend
[25: Connect to Message Queue]
The completion code != MQCC-OK → The system sets error text to 'CONN FAILED' and performs MQ error handling
[26: Put Message to Queue]
The completion code != MQCC-OK → The system sets error text to 'PUT1 FAILED' and performs MQ error handling
[27: Disconnect from Message Queue]
The completion code != MQCC-OK → The system sets error text to 'DISC FAILED' and performs MQ error handling
[Check Digit Numeric?]
The system validates the equipment number → If equipment number check digit is numeric, proceed with check digit removal; if not numeric, proceed to message queue transmission
[Connection Successful?]
The connection response is received → The system checks if the completion code equals MQCC-OK to determine success
[Set Error Message: 'CONN FAILED']
The completion code != MQCC-OK → The system sets error message to 'CONN FAILED' and initiates error handling process
[Message Send Successful?]
The system checks the completion code → If the completion code equals MQCC-OK then the message send is successful, otherwise it has failed
[Map Error Code to Text Message]
The system needs to provide error details → The numeric reason code is converted to descriptive text message using error mapping function
[Set Transaction Set in Error Message]
Error message is being prepared → The current transaction set identifier is included in the error message context
[Set Error Message in System]
The complete error message needs to be set in the system → A formatted error message containing all error context is placed in the system communication area
[Terminate Processing with Error]
Processing continuation would be unsafe or invalid → The system terminates processing abnormally with error details
[Call Error Mapping Service]
Error message conversion is required → The GCCMQERR service is called with the error code to generate a business-friendly error message
[Call Error Mapping Service GCCMQERR]
Business-friendly error message is needed → The GCCMQERR service is called with the reason code and returns a mapped error message in OUTPUT-MESSAGE-TEXT
[Map MQ Error Code to Text Message]
Error mapping is requested → The system translates the MQ reason code into descriptive text message
[Set MQ Error Details]
Error details need to be assembled → The system sets MQ error text, transaction set identifier, and creates formatted error message
[Set General Error Message]
Error handling is invoked → The system sets the error message with transmission number and transaction set details
[Transaction Set Error]
The transaction set is not Manifest, Customs Status Info, Events Advisory Details, or Consist Info → Set error message with transaction set and transmission number details and invoke system error handler to terminate program abnormally
[Format Complete Error Message]
Error message formatting is required → Move mapped error text to MQ error text field, move transaction set to MQ transaction set field, and set complete error message for system error handler
[Call System Error Handler]
Error handling is required → Call system error handler with error message details
[Call Error Message Mapping Service]
A readable error message is needed for the MQ error → The GCCMQERR service is called to map the reason code to a descriptive error message text
[Return Mapped Error Text Message]
The calling process needs the readable error message → The descriptive error message text is made available for error reporting

Module: GCX114 1 Consolidated Epic Story

Epic: GCX114 Complete EDI Specification Extracted from Legacy

Contains 58 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX114 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Validate Input Source]
The message ID is evaluated → If message is from train menu module, process train menu input; if from train selection module, process train selection screen; if from train display module, process train display return; otherwise redirect to main menu with unknown spawn error
[6:Process Train Selection Screen]
The function key or input type is evaluated → If PF key is invalid, show invalid key message; if selection not available, show not available message; if input field is empty, clear train lines and show message 0501; if input field changed, clear lines and validate new train ID; if page back key, process first page; if page forward key, process next page; if line selection made, process selected line
[7:Process Page Forward Navigation]
The last displayed train ID is checked → If last train ID is empty, show last page message; otherwise calculate time complement from last displayed train time, set appropriate key values based on index type, read next train data, and if successful display new page or show last page message if no more data
[Route to Train Menu Processing]
The message ID equals the train menu module constant → The system performs train menu processing
[Route to Train Selection Processing]
The message ID equals the train selection module constant → The system performs train selection processing
[Route to Train Display Processing]
The message ID equals the train display module constant → The system performs train display processing
[Set Main Menu Screen Code]
The message ID does not match any known module constants → The output selection code is set to main menu screen, the system message number is set to unknown spawn error, and the input field is cleared
[Set Train Not Found Message]
The database operation fails or returns an error status → Set train not found message number and highlight the input field with cursor attribute
[Clear Train Lines Display]
Input field is empty or contains only spaces → System clears train lines display, sets message 0501, and positions cursor for input
[Set First Page Message]
Page back function key is pressed → System validates and reads train ID, then sets first page message
[Display Last Page Message]
User attempts to navigate to the next page → Display last page message and terminate the page forward operation
[More Trains Available?]
Checking if more trains can be displayed → If more trains are available, proceed to display them, otherwise show last page message
[Display Last Page Message]
User has reached the end of available train records → Display the last page message to inform the user
[Parse Hour Component from Position 7-8]
The system needs to parse time components for pagination → The hour component is extracted from positions 7 through 8 of the time string
[Parse Minute Component from Position 10-11]
The system needs to parse time components for pagination → The minute component is extracted from positions 10 through 11 of the time string
[Parse Hour Component from Position 7-8 - Extract and validate hour digits from specific character positions in time string]
The system processes the time string to extract hour information → The hour component is parsed from characters at position 7-8 and moved to the hour work field for further processing
[Parse Minute Component from Position 10-11 - Extract and validate minute digits from specific character positions in time string]
The system needs to extract the minute component for time complement calculation during page forward processing → The system moves the time string to SPLIT-LINE work area, extracts characters from positions 10-11, and moves the extracted minute digits to TIME-WORK-MIN field
[Parse Hour Component]
The system parses the hour component from the time string → The hour component (positions 7:2) is extracted from the split line and moved to the time work hour field
[Parse Minute Component]
The system parses the minute component from the time string → The minute component (positions 10:2) is extracted from the split line and moved to the time work minute field
[Calculate Time Complement Value]
The system calculates the time complement for database sequencing → The time complement is computed by subtracting the combined time work value from the maximum complement value (NINES-COMP2)
[Set Train ID as Input Field]
The train ID is not empty → The system moves the train ID from the selected line to the input message field and clears the rest of the message
[Call Stack Management System]
Stack management operation is required → The stack management system is called with communication control, message area, output selection code, current selection code, and return code parameters
[Train Arrived AND Message Sent/Acknowledged?]
The train arrived flag is yes AND the message is either sent:
acknowledged
→ Set the train status display to ARRIVED and complete status evaluation
[Manual Arrival AND Message Sent/Acknowledged?]
The train arrived manual flag is true AND the message is either sent:
acknowledged
→ Set the train status display to MANUAL ARRIVAL and complete status evaluation
[Check Train Arrival Status]
If train arrival confirmation (GCUTR-ARRIVED-YES) and message status (GCUTR-SENT or GCUTR-ACK) → The train status is set to arrived if both arrival is confirmed and message is sent or acknowledged
[Manual Arrival?]
If manual arrival confirmation (GCUTR-ARRIVED-MANUAL) and message status (GCUTR-SENT or GCUTR-ACK) → The train status is set to manual arrival if both manual arrival is confirmed and message is sent or acknowledged
[Check Manual Arrival Status]
The train has manual arrival flag set to true AND either the sent flag or acknowledgment flag is true → Set the train status to manual arrival on the display screen
[Continue to Next Status Check]
The train does not have manual arrival flag set:
neither sent flag nor acknowledgment flag is true
→ Continue to evaluate the next train status condition without setting manual arrival status
[Extract Equipment ID Components - Parse equipment ID into first 4 characters and last 6 characters for reformatting]
The system processes the equipment ID for lead unit display → The equipment ID should be reformatted by taking the first 4 characters (positions 1-4) and placing them in positions 1-4 of the output, and taking characters from positions 7-12 and placing them in positions 5-10 of the output
[Unknown Module Called Program]
If the message module ID and finds no matching handler → The system sets output selection code to main menu screen, sets system message number to unknown spawn error, and clears the input field
[Empty Input Field on Selection Screen]
The input field contains only spaces → The system clears all train display lines, sets system message number to 0501, and sets cursor attribute to regular display for input field
[Accept Justified Input]
The train ID for the selected line is not spaces → The system moves the train ID to input field, clears rest of message, sets output selection code to train display spawn, and pushes the selection code to stack

Structural Validations

[8:Process Line Selection]
The selected line is validated → If line input is not numeric, show invalid item message; if line number is outside valid range (1 to max screen lines), show invalid item message; if selected line contains valid train data, navigate to train display screen; otherwise show invalid item message
[16:Handle Train Not Found]
No train data is found or database status indicates error → Set system message to train not found error and highlight input field with cursor attribute
[17:Process Invalid Input]
Error processing is required → Set appropriate error message (PF key invalid, PF not available, or item invalid) and set cursor highlighting on input field
[Set Invalid PF Key Message]
Function key pressed is marked as invalid selection → System sets invalid PF key error message
[Set PF Key Not Available Message]
Function key pressed is marked as not available → System sets PF key not available error message
[Last Train ID on Screen Empty?]
The system checks the last train ID position on the current screen display → If the last train ID is empty, display last page message and stop navigation
[Is Input Alphabetic?]
The input contains alphabetic characters → The system displays an invalid item error message and highlights the input field with high intensity cursor
[Justification Successful?]
The justification return flag is not successful → The system displays an invalid item error message and highlights the input field with high intensity cursor
[Line Number Within Valid Range?]
The line number is less than the first page value or greater than the maximum screen number → The system displays an invalid item error message and highlights the input field with high intensity cursor
[Selected Line Has Train ID?]
The train ID for the selected line is empty or contains only spaces → The system displays an invalid item error message and highlights the input field with high intensity cursor
[Log Error Message for Invalid Selection Code]
Error logging is required → An error message is constructed containing 'GCCSTACK FAILED WITH INVALIDE CUR-SEL-CODE:' followed by the current selection code value and logged to the error handling system
[Database Status Code = SPACES?]
The system checks the database operation status code → If the status code is not SPACES, the system should set the train not found condition and display an appropriate error message to the user
[Set Error Message: Train Not Found]
The system determines that no valid train data is available → The system should set the train not found error message, highlight the input field with high intensity display attributes, and prepare the error for user display
[Invalid PF Key Pressed]
User presses a PF key that is marked as invalid selection → The system sets system message number to PF key invalid error
[PF Key Not Available]
User presses a PF key that is marked as selection not available → The system sets system message number to PF not available error
[Reject Invalid Numeric Input]
The justification return flag indicates failure (not successful) → The system sets system message number to item invalid error and sets input line attribute to cursor with high intensity display
[Invalid Line Selection Input]
The line selection input is alphabetic → The system sets system message number to item invalid error and sets input line attribute to cursor with high intensity display
[Line Number Out of Range]
The line number is less than first page value or greater than maximum screen number → The system sets system message number to item invalid error and sets input line attribute to cursor with high intensity display
[Selected Line Has No Train Data]
The train ID for the selected line contains only spaces (no train data) → The system sets system message number to item invalid error and sets input line attribute to cursor with high intensity display
[Is Input Alphabetic?]
The input contains alphabetic characters → The system displays an invalid item error message and highlights the input field with high intensity display attribute
[Set Invalid Item Error]
The justification return flag does not indicate success → The system displays an invalid item error message and sets the input field to high intensity display attribute
[Continue Processing]
The line number is less than the first page number or greater than the maximum screen number → The system displays an invalid item error message and highlights the input field with high intensity display attribute
[Continue Processing]
The train ID for the selected line is not empty → The system moves the train ID to the input field, clears the rest of message, sets the output selection code to train display spawn, and pushes the selection code to the stack
[Continue Processing]
The train ID for the selected line is empty → The system displays an invalid item error message and highlights the input field with high intensity display attribute
[Handle Justification Error]
The justification process fails → The system sets an invalid item error message and highlights the input line attribute field
[Set Error Status]
The system detects a non-space status code indicating failure → The system sets train not found error message and highlights the input field with high intensity display attributes

Module: GCX115 1 Consolidated Epic Story

Epic: GCX115 Complete EDI Specification Extracted from Legacy

Contains 73 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX115 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Process Function Selection]
The message ID equals train error modification constant → The system processes from train error flow, otherwise processes display train flow
[5:Process Page Navigation]
The PF key is page back → The system processes display train and sets message to first page
[8:Navigate to Train Display]
The selected train ID exists → The system sets train ID as input field, clears rest of message, and sets output select code to train display spawn
[18:Handle No Records Found]
No records are found (status code is not successful) → The system sets message to no train error, clears input field, and sets output select code to train menu
[Check Message ID]
If the message ID against the train error modification constant → If the message ID equals the train error modification constant, route to train error processing, otherwise route to display train processing
[Route to Display Train Processing]
If all message ID conditions → The system routes to the standard display train processing as the default action
[Route to Display Train Processing]
The routing decision directs to display train processing → The system performs the display train processing function
[Process Backward Page Navigation]
User presses page back PF key → System processes train display and sets system message to first page
[Process Forward Page Request]
User presses page forward PF key → System performs page forward processing
[Process Line Selection]
User enters input in the line selection field (input line is not spaces) → System performs line selection processing
[Set First Page Message]
Backward page navigation is processed → System message number is set to first page constant
[PF Key = Page Back?]
PF key is page back → System processes display train function and sets first page message
[Backward Page Request]
The PF key type is PAGE-BCK (backward page) → The system processes display train records and sets first page message
[Set Last Page Message]
Forward page navigation is requested → Set system message number to last page constant and terminate forward page processing
[Set Last Page Message - No More Records]
No more train records are available for next page → Set system message number to last page constant
[Set Train ID for Display]
The system processes the train selection → Move the train ID from selected line to input message field and clear the rest of message area
[Set Train ID as Input Field]
The selected line contains a non-empty train ID → The system sets the train ID as the input field, clears the rest of the message, sets output to train display spawn, and pushes the navigation stack for return capability
[Set Train ID in Message Field]
The system prepares to transfer control to the train display screen → The train ID is moved to the message input field for communication with the target screen
[Clear Rest of Message]
The system prepares the message for the next screen → The rest of the message area is cleared to spaces to prevent data contamination
[Set Output Selection Code to Train Display]
The system determines the next screen to display → The output selection code is set to the train display spawn constant to direct navigation to the train display screen
[Transfer Control to Train Display Screen]
All preparation for screen transfer is complete → The system transfers control to the train display screen where the selected train details can be viewed
[Train Records Found?]
No train records are found (status code is not spaces) → System sets no train error message, clears input field, and navigates to train menu
[Set Last Page Message]
Forward pagination is requested → Set system message number to last page constant and terminate pagination
[Set Last Page Message]
System processes the failed retrieval → Set system message number to last page constant
[Check Last Page Condition - Determine if user is already on the last page of results]
The last train ID on the current display screen is empty (spaces) → System sets last page message and exits without attempting to retrieve more records
[Next Page Records Found?]
No additional train records are found (status code is not spaces) → System sets last page message to inform user they have reached the end of available data
[Clear Train Root Segment]
The system prepares the data structure for database access → The train root segment is cleared to ensure clean data retrieval
[Clear Train Root Segment]
The system begins the database access process → The train root segment structure is cleared to spaces to ensure clean data retrieval
[Call IMS Database Interface]
The system needs to retrieve train records from the database → The IMS database interface is called with the train root segment and qualified search criteria
[Return Train Record Data]
The status code indicates successful operation (spaces) → The train record data is available in the train root segment for further processing
[Clear Train Root Segment]
The system prepares to retrieve train records → The train root segment is cleared to ensure clean data retrieval
[Execute CIMS Call with Parameters]
The system executes the CIMS database call → Train data is retrieved using the common control block, database control block, train segment, and search criteria
[Check Database Query Status]
The database query returns no records (CC-STATUS-CODE is populated) → The system should set a no train error message, clear the input field, and redirect to the train menu
[Set Output to Train Menu]
The system has set the error message and cleared the input field → The system should set OUTPUT-SELECT-CODE to CST-US-TRAIN-MENU to redirect user to train menu
[Call Stack Management System with Parameters]
The stack management system is called → The system should invoke GCCSTACK with communication area, message filler, output selection code, current selection code, and return code parameters

Structural Validations

[3:Process Train Error Display]
The PF key is invalid selection → The system sets message to PF key invalid
[4:Validate PF Key Selection]
The PF key selection is not available → The system sets message to PF not available
[7:Validate Line Number Input]
The input is alphabetic → The system sets message to item invalid and highlights the input field
[14:Check Last Page Condition]
The last displayed train ID is empty → The system sets message to last page and exits
[7:Validate Line Number Input]
The line number is less than first page or greater than maximum screen number → The system sets message to item invalid and highlights the input field
[8:Navigate to Train Display]
The selected train ID is empty → The system sets message to item invalid and highlights the input field
[19:Justify Numeric Input]
The justification return flag indicates failure → The system sets message to item invalid and highlights the input field
[Message ID = Train Error Mod?]
The message ID is compared to the train error modification constant (CST-US-TRAIN-ERROR-MOD) → If they match, the system selects the train error processing path
[Route to Train Error Processing]
The routing decision directs to train error processing → The system performs the train error processing function
[Set Invalid PF Key Message]
User presses an invalid PF key selection → System sets system message number to PF key invalid constant
[Set PF Key Not Available Message]
User selects a PF key that is not available → System sets system message number to PF not available constant
[Set Invalid PF Key Message]
PF key pressed equals invalid PF key selection constant → System message number is set to PF key invalid constant
[Set Selection Not Available Message]
PF key pressed equals selection not available constant → System message number is set to PF not available constant
[PF Key = Invalid Selection?]
PF key selection is invalid → System sets PF key invalid error message
[PF Key = Selection Not Available?]
PF key selection is not available → System sets PF not available error message
[Last Line Has Train ID?]
The last line on the current screen has no train ID (is empty/spaces) → The system sets last page message and exits navigation
[Set Last Page Message]
No more train records are available for retrieval:
last line has no train ID
→ System sets last page message to inform user no more pages are available
[Last Line on Current Page Empty?]
The last line on the current screen display is empty (contains no train ID) → Set system message to indicate last page reached and exit without processing
[Is Input Numeric?]
The system checks if the input contains alphabetic characters → If input is alphabetic, set invalid item error message and highlight input field with cursor attribute, then exit processing
[Justification Successful?]
The system checks the justification return status → If justification failed, set invalid item error message and highlight input field, then exit processing; otherwise use the formatted number
[Line Number Within Valid Range?]
The system validates the line number against minimum and maximum screen boundaries → If line number is less than first page value or greater than maximum screen number, set invalid item error message and highlight input field, then exit processing
[Selected Train ID Exists?]
The system checks if a train ID exists at the specified line position → If no train ID exists at selected line (train ID is spaces), set invalid item error message and highlight input field; otherwise proceed with train selection
[Is Input Numeric?]
The input contains alphabetic characters → The system sets an invalid item error message and highlights the input field
[Justification Successful?]
The justification return flag does not indicate successful completion → The system sets an invalid item error message and highlights the input field
[Line Number Within Valid Range 1-20?]
The line number is less than the first page number or greater than the maximum screen number → The system sets an invalid item error message and highlights the input field
[Selected Line Has Train ID?]
The selected line does not contain a train ID (is empty or spaces) → The system sets an invalid item error message and highlights the input field
[Is Input Alphabetic?]
The input contains alphabetic characters → The system sets an invalid item error message and highlights the input field with cursor attributes
[Justification Successful?]
The justification process fails → The system sets an invalid item error message and highlights the input field with cursor attributes
[Is Input Alphabetic?]
The input contains alphabetic characters → The system sets an invalid item error message and highlights the input field with error attributes
[Justify Number Successful?]
The justification process returns a failure status → The system sets an invalid item error message and highlights the input field with cursor and error attributes
[Line Number Within Valid Range?]
The line number is less than the first page number or greater than the maximum screen number → The system sets an invalid item error message and highlights the input field with cursor and error attributes
[Display No Train Error Message]
No train records are found (status code is not spaces) → System displays no train error message, clears input field, and sets output to train menu
[Last Train ID on Current Page Empty?]
The train ID in the last screen position is empty (spaces) → Set system message to indicate last page reached and exit pagination process
[Set No Train Error Message]
CC-STATUS-CODE is populated indicating query failure → The system should set SYSTEM-MSG-NUM to CST-GCX115-NO-TRAIN-ERROR
[Is Input Alphabetic?]
The input contains alphabetic characters → The system sets an invalid item message and highlights the input field with cursor attributes
[Justification Successful?]
The justification return flag indicates failure → The system sets an invalid item message and highlights the input field with cursor attributes
[Log Error Message for Invalid Selection Code]
Error logging is required → The system should create an error message containing 'GCCSTACK FAILED WITH INVALIDE CUR-SEL-CODE:' followed by the current selection code value
[Call Error Handler]
Error processing is required → The system should call the CERR error handler with the communication area containing the error message

Module: GCX116 1 Consolidated Epic Story

Epic: GCX116 Complete EDI Specification Extracted from Legacy

Contains 15 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX116 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[5:Retrieve Next Cargo Report Segment]
The system calls the CIMS program with carrier key value → Cargo report segment is cleared, key value is set from input field, and CIMS is called to retrieve segment data
[Process Next Waybill Line]
The system processes the waybill line → Format the waybill line data AND retrieve the user segment data
[Format Next Waybill Line]
The system formats the waybill line → Move waybill line data to display format AND retrieve user segment data
[Is Processing Finished?]
The system validates the processing results → Continue processing if status code is blank AND carrier ID number matches the input field, otherwise set finished flag to 'YES'
[Retrieve Next Cargo Report Segment]
The system needs to continue processing additional waybill lines → The cargo report segment is cleared AND the input field value is set as the key AND the CIMS program is called to retrieve the next cargo report segment
[Clear Cargo Report Segment Area]
The system prepares to retrieve cargo data → The cargo report segment area must be cleared to spaces
[Set Equipment Number as Search Key]
The system prepares the database search criteria → The equipment number from the saved input field must be set as the key value for the search
[Call Database System to Get Next Record]
The system needs to retrieve cargo report data → The CIMS database system must be called with the cargo report segment parameters and qualified search criteria
[Continue Processing Current Record]
Both the database call is successful AND the equipment number matches the input → The system continues processing the current record without setting the finished flag
[Set Processing to Finished]
Either the database call failed:
the equipment number does not match the input
→ The system sets processing status to finished to stop further record processing
[Extract Canadian Cargo Status Description from Record]
The system processes cargo status information for display → The Canadian cargo status description is extracted from field GCUSRT-RT10B-CPCARGO-STAT-DSC and moved to CPRS-STATUS
[Extract US Cargo Status Description from Record]
The system processes cargo status information for display → The US cargo status description is extracted from field GCUSRT-RT21-USCARGO-STAT-DESC and moved to USCS-STATUS

Structural Validations

[6:Validate Equipment Number Match]
The system checks data validity for continued processing → Continue processing only if status code is blank AND carrier ID number index matches the saved input field value, otherwise set finished flag to 'YES'
[Database Call Successful?]
The system checks the database call status → Processing continues only if the database call was successful (status code is blank), otherwise processing is marked as finished
[Equipment Number Matches Input?]
The system compares the retrieved record's carrier ID number with the saved input field value → Processing continues only if the carrier ID number matches the input field, otherwise processing is marked as finished

Module: GCX116R 1 Consolidated Epic Story

Epic: GCX116R Complete EDI Specification Extracted from Legacy

Contains 103 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX116R EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program Control - Message ID Check]
The message ID != CARGO-BY-EQUIP-MOD → The system routes to menu cargo processing, otherwise routes to cargo by equipment processing

Core Acceptance Criteria

[3:Handle Equipment Entry - Process Input]
Input field is empty → Clear cargo display and show blank equipment message
[5:Find Equipment Records - Search Database]
Equipment record search is performed → Retrieve equipment data from GCUS-CARGO-REPORT-SEGMENT using the equipment number as key
[7:Handle Page Forward Navigation]
First info line is empty → Show no CCN message, when last info line (12) is empty show last page message, otherwise retrieve next set of records
[8:Handle Page Backward Navigation]
Equipment input field equals the saved input field value → Process waybill display request, otherwise highlight input field and show equipment change message
[10:Process CCN Selection]
The selected line contains no CCN data (spaces) → Highlight selection field and show no CCN selected message, otherwise prepare cargo transaction spawn with selected CCN
[12:Retrieve Initial Cargo Segment - GU Call]
Initial data retrieval is requested → Execute GU call to CIMS using equipment number as key to get first cargo segment
[13:Retrieve Next Cargo Segment - GN Call]
Next data retrieval is requested → Execute GN call to CIMS using equipment number as key to get next cargo segment
[15:Validate PF Key Operations]
PF key is PAGE-BCK, PAGE-FWD, or ENTER-VALUE → Route to appropriate handler, otherwise show invalid PF key message
[18:Format Screen Display]
Screen formatting is required → Call GCX116A program to format cargo report segment for display
[Check Message ID]
If the message ID against the cargo equipment module identifier → If the message ID does not match the cargo equipment module, route to GC menu processing, otherwise route to cargo equipment processing
[Call Program Stack Manager]
The system needs to manage the program execution stack → The GCCSTACK program is called with communication parameters, message data, output select code, program return ID, and user message number
[Clear Equipment Field and Set Blank Message]
Input field is empty (contains spaces) → Clear cargo by equipment field, clear saved input field, and set blank equipment message
[Set No Records Found Status]
The system completes the unsuccessful search operation → The no records found status is set and an appropriate user message is prepared
[Clear Search Results]
The system handles the unsuccessful search → All information lines and saved input fields are cleared, the input field is highlighted, and a no CCN message is displayed
[Retrieve Next Cargo Segment]
The system needs to collect cargo segment data → The next cargo segment is retrieved using database get-next operation with the equipment key
[More Records Available?]
The system checks for additional records → If database status is successful AND the retrieved record matches the input equipment, more records are available, otherwise no more records exist
[Add Record to Collection]
The record needs to be included in the display collection → The cargo record is added to the collection structure for subsequent formatting and display
[No More Records Available]
No matching records are found:
no additional records are available
→ The system indicates no more records are available and may display appropriate user messages
[Check Last Info Line Status]
The twelfth information line is empty indicating no more records on current page → System displays last page message and sets item selection attribute to indicate end of data
[No Records Available]
The first information line on the current display is empty → The system should display a no CCN message to indicate no records are available
[Last Page Reached]
The first information line contains data but the twelfth information line is empty → The system should set the item select attribute to normal display mode and show a last page message
[No More Records Found]
The database status code indicates failure or the equipment number does not match the saved input field value → The system should display a no more CCN message to indicate no additional records are available
[Execute Initial Database Search - GU Call]
The system executes a database search using the equipment number as key → The system calls CIMS database service to retrieve cargo report segment using GU operation with equipment number qualifier
[Equipment Records Found Successfully]
The database search completes successfully with no error status → The system proceeds with the retrieved cargo report segment data
[Clear Cargo Report Segment]
The system initiates the cargo record retrieval process → The cargo report segment is cleared to spaces to prepare for new data
[Execute Database Call to Retrieve First Cargo Record]
The system executes the database retrieval operation → A database call is made using GU operation to retrieve the first matching cargo record
[Call External Format Program GCX116A]
The system needs to format cargo information for display → The system calls external formatting program GCX116A with communication control block, output message structure, and cargo report segment data to format cargo control numbers and structure information lines for screen display
[Check Last Info Line]
The twelfth (last) information line is empty (contains spaces) → The system displays a 'Last Page' message and prevents further forward navigation
[Retrieve Next Cargo Segment]
The system executes a get-next operation to retrieve the subsequent cargo segment → The system attempts to read the next cargo record using the equipment input field as the search qualifier
[Display No More CCN Message]
No additional records are found:
the retrieved record does not match the current equipment
→ The system displays a 'No More CCN' message indicating the end of available data for this equipment
[Last Page Reached?]
The twelfth information line on the display is empty → System displays last page message and prevents further forward navigation
[Retrieve Next Cargo Segment]
System executes get-next operation for cargo segments → System attempts to retrieve the next available cargo record using the equipment key
[No More Records Available]
No more records are found or retrieved records do not match the current equipment → System displays no more CCN message to inform user that end of records has been reached
[Current CCN Matches Last Displayed CCN?]
System retrieves each cargo segment and compares the CCN key → If current record CCN does not match target CCN, continue to next record; if CCN matches, positioning is complete
[Retrieve One More Segment for Forward Display]
Forward page navigation is requested → System retrieves the next cargo segment following the positioned record to start building the next page of results
[Retrieve Next Database Segment]
The system needs to advance to the next record in sequence → The system calls the database interface to retrieve the next cargo report segment using the equipment number key
[Set Match Status Failed]
The status code indicates failure or the CCN index doesn't equal the saved input field → The system clears display information, highlights the input field, and shows no CCN message
[Input Field Changed Since Last Display?]
System compares current equipment input field with previously saved equipment input field → If equipment number is unchanged, proceed to display waybill; if equipment number has changed, highlight input field and display equipment change error message
[Move CCN to Input Field]
System is preparing the cargo transaction spawn → The system moves the selected CCN value to the message input field for transaction processing
[Prepare Transaction Context Parameters]
The system needs to manage program stack operations → The GCCSTACK service is called with communication control, message filler, output select code, current program return ID, and user message number parameters
[Set Selected CCN as Input Field]
The system is configuring the spawned transaction parameters → The CCN from the selected item position is moved to the message input field
[Clear Cargo Report Segment]
The system prepares to retrieve cargo data for an equipment number → The cargo report segment is cleared to spaces to ensure no residual data affects the search
[Execute Database GU Call to Get First Cargo Record]
The system needs to retrieve cargo data for the equipment → A GU (Get Unique) database call is executed using the cargo report segment and qualified search criteria to retrieve the first matching cargo record
[Clear Cargo Report Segment Work Area]
The system begins the retrieval process → The cargo report segment work area is cleared to spaces
[Execute GN Database Call to Get Next Cargo Record]
The system executes the Get Next database call → The next cargo record segment is retrieved from the database using the qualified search criteria
[Input Field Changed]
Current input field value does not equal the saved input field value → System highlights the input field AND displays equipment change message
[Clear Equipment Field and Set Blank Message]
Input field is empty (SPACE) → Clear cargo by equipment field, clear saved input field, and set blank equipment message number
[Clear Equipment Field]
The input field for equipment number is empty → The system clears the cargo by equipment display field, clears the saved input field, and sets a blank equipment message
[Format Screen Display - Call external program to format cargo information screen]
The system needs to present cargo report data to the user → The system invokes external program GCX116A with common control block, output message structure, and cargo report segment data to format the display screen
[Equipment Record Found?]
The system compares the found equipment record with the requested equipment number → If no matching equipment record is found, clear display and show error message, otherwise continue normal processing
[Set No Equipment Found Message]
The system needs to inform the user about the validation failure → Set the user message to indicate no equipment was found for the entered number
[More Records Available?]
If record availability for pagination → If no more records are available, display end-of-data message, otherwise continue with normal pagination processing
[Set No More Records Message]
The system determines that pagination has reached the end of available data → Display a message indicating no more records are available and maintain current display state
[Call Stack Management Program GCCSTACK]
Program flow control needs to be managed → GCCSTACK program is called with communication control, message area, select code, return ID, and message number parameters

Structural Validations

[Equipment Found?]
Status code is successful AND the found equipment ID matches the saved input field → Display waybill screen with current time, otherwise clear display and show no CCN message with field highlighting
[9:Validate Item Selection]
Selection is not numeric:
equals zero
exceeds last line number
→ Highlight selection field and show invalid range message, otherwise validate selected CCN availability
[14:Handle Input Field Changes]
Current input field value does not equal saved input field value → Highlight input field and show equipment change message instead of processing navigation
[Highlight Input Field and Set Change Message]
Current input field value is different from previously saved input field value → Highlight the input field and set equipment change message
[Set Invalid PF Key Message]
Function key pressed is not page back, page forward, or enter → Set item select field to normal display attribute and set invalid function key message
[Clear Information Lines / Highlight Equipment Input Field / Set Error Message - No CCN Found]
The system cannot display valid equipment information → Information lines are cleared, the equipment input field is highlighted, the input field save area is cleared, and a 'No CCN Found' error message is displayed
[Find Matching CCN in Database?]
The system searches the database for matching cargo records → If matching records are found with valid status, proceed to retrieve cargo segments, otherwise indicate no records available
[Check First Info Line Status]
The first information line is empty indicating no records are available → System displays no records message to inform user that no cargo data exists for the equipment
[Check Record Availability]
No valid records are found or the equipment number does not match the search criteria → System displays no more records message to inform user that pagination has reached the end
[Check First Info Line]
The first information line is empty (contains spaces) → The system displays a 'No CCN' message and prevents page forward navigation
[More Records Available?]
The database operation completes successfully AND the retrieved record's equipment number matches the saved input field → The system confirms more records are available for the next page display
[Check Current Display State]
The first information line on the display is empty → System displays no CCN message and prevents navigation
[Equipment Records Found?]
System checks if records were found and equipment ID matches the saved input field → If records found and equipment ID matches, proceed to format cargo screen; if no records or mismatch, clear display and show no records message
[Show Equipment Change Error Message]
System detects equipment number change → Input field is highlighted for user attention and equipment change error message is displayed to user
[Show No Records Found Message]
System determines equipment data is invalid or unavailable → All information lines are cleared, input field is cleared, input field is highlighted, and no records found message is displayed to user
[Selection is Numeric?]
The item selection is checked for numeric content → If the selection is not numeric, the system highlights the selection field and displays invalid range message
[Selection Greater Than Zero?]
The item selection value is checked against zero → If the selection equals zero, the system highlights the selection field and displays invalid range message
[Selection Within Valid Range?]
The item selection is compared against the last valid line number → If the selection exceeds the last line number, the system highlights the selection field and displays invalid range message
[Selected Line Has Cargo Data?]
The system checks if the selected line contains cargo control number data → If the selected line has no cargo control number, the system highlights the selection field and displays no cargo selection message
[Selection Numeric?]
The selection input is evaluated for numeric content → If the selection is not numeric, the system highlights the selection field and displays an invalid range message
[Selection Equal Zero?, Is Selection Zero?]
The selection value equals zero → The system highlights the selection field and displays an invalid range message
[Selection Greater Than Maximum Line?]
The selection value is greater than the maximum line number (LAST-LINE) → The system highlights the selection field and displays an invalid range message
[Selected Line Has Data?]
The selected line number corresponds to an empty line (no CCN data) → The system highlights the selection field and displays a no CCN selected message
[Is Selection Numeric?]
The selection contains non-numeric characters → The system highlights the selection field and displays an invalid range message
[Is Selection > Maximum Line?]
The selection value exceeds the maximum line number available → The system highlights the selection field and displays an invalid range message
[Does Selected CCN Exist?]
The selected line does not contain a CCN (Car Control Number) → The system highlights the selection field and displays a no CCN selected message
[Is Selection Numeric?]
The item selection contains non-numeric characters → The system highlights the selection field and displays an invalid range message
[Is Selection Zero?]
The item selection equals zero → The system highlights the selection field and displays an invalid range message
[Is Selection > Maximum Line '12'?]
The item selection is greater than the maximum line number (12) → The system highlights the selection field and displays an invalid range message
[Does CCN Exist at Selected Line?]
The CCN (Car Control Number) at the selected line position is empty → The system highlights the selection field and displays a message indicating no CCN is available for selection
[Is Selection > Maximum Lines?]
The selection value is greater than the last line number → The system highlights the selection field and displays an invalid range message
[CCN Available for Line?]
The selected line does not contain a Cargo Control Number (CCN is empty) → The system highlights the selection field and displays a no CCN selected message
[Is Selection Numeric?]
The selection value contains non-numeric characters → The system highlights the selection field and displays an invalid range message
[Is Selection Within Valid Range?]
The selection value exceeds the last line number displayed on screen → The system highlights the selection field and displays an invalid range message
[Does Selected Line Have CCN Data?]
The selected line does not contain CCN data (is empty or spaces) → The system highlights the selection field and displays a no CCN selected message
[Highlight Input Field - Equipment Change Error]
Current input field does not equal saved input field (changes detected) → Set input field attribute to highlight cursor and set equipment change message number
[Set Invalid PF Key Error Message]
Function key pressed is not SPACE, PAGE-BCK, PAGE-FWD, or ENTER → Set item select attribute to normal protected alphabetic regular display and set invalid PF key message number
[Is Selection Numeric?]
The system processes the item selection → The selection must be numeric, otherwise display invalid range error message
[Is Selection > 0?]
The system validates the selection value → The selection must be greater than zero, otherwise display invalid range error message
[Is Selection Within Valid Range?]
The system checks the selection against display limits → The selection must not exceed the last line number, otherwise display invalid range error message
[Does Selected Line Have CCN?]
The system checks the CCN data for that line → The selected line must contain CCN data, otherwise display no CCN selected error message

Module: GCX117 1 Consolidated Epic Story

Epic: GCX117 Complete EDI Specification Extracted from Legacy

Contains 76 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX117 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Route Message Processing]
The message ID != CARGO-BY-WB-MOD → The system routes to GC Menu Cargo processing, otherwise routes to Cargo by Waybill processing
[6:Process Page Backward Request]
Page backward key is pressed and waybill input equals saved waybill data → The system requests equipment display, otherwise highlights waybill field and shows waybill change message
[7:Process Page Forward Request]
Page forward key is pressed and waybill input equals saved waybill data → The system requests page forward operation, otherwise highlights waybill field and shows waybill change message
[14:Process Forward Paging Logic]
First info line is empty → The system displays no CCN message, when 12th info line is empty displays last page message, otherwise searches for next records
[15:Handle End of Records]
Next records are found and waybill matches saved waybill → The system sets time and formats screen, otherwise displays no more CCN message
[17:Process Cargo Control Number Selection]
No CCN exists at the selected position → The system highlights selection field and displays no CCN selected message, otherwise prepares cargo spawn transaction
[20:Perform Database Get Unique]
Database get unique operation is requested → The system clears cargo segment, sets waybill as key value, and calls database with get unique command
[21:Perform Database Get Next]
Database get next operation is requested → The system clears cargo segment, sets waybill as key value, and calls database with get next command
[Route Message Processing - Determine processing path based on message ID, either from GC menu cargo or from cargo by waybill module]
If the message ID against the CARGO-BY-WB-MOD identifier → If the message ID does not equal CARGO-BY-WB-MOD, route to GC menu cargo processing, otherwise route to cargo by waybill processing
[Clear Display Areas, Highlight Waybill Input Field, Display Invalid Waybill Number Message]
Any component of the waybill number (carrier code, origin number, or waybill number) is not numeric → System clears information display areas, highlights the waybill input field, and displays invalid waybill number message
[Clear Display Areas, Highlight Waybill Input Field, Display No Records Found Message]
Waybill is not found in database or does not match the saved input → System clears information display areas, highlights the waybill input field, and displays no records found message
[Execute Database Get Unique Call]
The system executes a database search for the waybill → A database call is made to retrieve cargo report segment data for the specified waybill
[Search Failed - No Matching Records]
Either the database returns an error status or the retrieved waybill does not match the input waybill → The system clears information lines, highlights the waybill input field, and displays a no matching records message
[Compare Current Input with Saved Data - Determine if waybill input has been modified since last save]
User presses PAGE-BCK function key to navigate backward → If current waybill input equals saved waybill data, system displays equipment information; otherwise system highlights waybill input field and displays waybill change warning message
[Compare Current Input with Saved Data - Determine if waybill input has been modified since last save]
User presses PAGE-FWD function key to navigate forward → If current waybill input equals saved waybill data, system performs page forward operation; otherwise system highlights waybill input field and displays waybill change warning message
[Already at Last Page?]
The 12th information line is empty (contains spaces) → Display 'Last Page Reached' message and highlight item selection field
[No More Records]
No valid matching record is found or database error occurs → Display 'No More Records' message to inform user that end of data is reached
[Last Info Line Empty?]
The twelfth information line on the current display is empty → System displays last page message and prevents further forward navigation
[Display No More Records Message]
The retrieved record does not match the current waybill number → System displays no more CCN records message to indicate end of available data
[Set Selected CCN as Input Field]
Cargo spawn transaction is being initialized → System should move selected CCN data to message input field for next program
[Display Invalid Waybill Message]
The system processes the validation failure → An invalid waybill number error message is displayed to the user
[Display No Records Found Message]
The system processes the no-records-found condition → A no records found error message is displayed to the user
[Display Invalid Waybill Number Message]
The system completes error handling → An invalid waybill number message is displayed to inform the user of the format error
[Clear Cargo Report Segment]
The system prepares the data retrieval area → The cargo report segment is cleared to spaces to ensure no residual data affects the search results
[Execute Database Get Unique Call]
The system executes the database retrieval operation → A database call is made using CIMS with GU operation, PCB3 control block, cargo report segment, and qualified search criteria
[Waybill Found Successfully]
The database call completes successfully with a valid status code → The waybill data is available in the cargo report segment for further processing
[Format Waybill Screen Display - Call external program GCX117A to format and display waybill information on screen]
The waybill screen formatting is requested → The system calls external program GCX117A with communication control, output message, and cargo report segment data to format the waybill information for display
[Clear Information Display Lines]
The database search completes and no matching records are found for the waybill:
the found record does not match the input waybill
→ The system clears all information display lines, highlights the waybill input field, and displays a 'No CCN Found' message
[Set No CCN Message for Paging]
The first information line is empty indicating no records are available → The system displays a 'No CCN Found' message to inform the user that no records are available for paging
[Already at Last Page?]
The system checks if the 12th information line is empty → If the 12th information line is empty (SPACE), display 'Last Page' message and highlight item selection field
[Read cargo report segments sequentially]
The system performs a Get Next operation on the cargo report segment → The next cargo report record is retrieved from the database using the waybill search criteria
[Is Line 12 Empty?]
User requests to page forward through records → System sets cursor to item select field and displays last page message to indicate no more records are available
[Display Last Page Message]
System processes the page forward request → System displays last page message number to notify user no additional records are available
[Set Selected CCN as Input Field]
The system prepares input for the spawned transaction → Move the selected cargo control number to the message input field
[Set Cargo Control Number as Input]
The system assigns input for the spawned transaction → Move the selected cargo control number to the message input field and clear the spawning program data
[Clear Cargo Report Segment]
The system prepares to execute a database call → The cargo report segment data structure is cleared to spaces to remove any existing data
[Execute Database Call with Unique Key]
The system executes a get unique database operation → The database call is made using the waybill key to retrieve the corresponding cargo report segment with qualified search criteria
[Perform Database Get Next - Execute database call to retrieve next cargo report segment in sequence]
The system needs to retrieve the next cargo report segment in sequence → The system clears the cargo report segment buffer, sets the waybill number as search key, executes database get next call, and retrieves the next cargo report segment
[Clear Cargo Report Segment Buffer]
The system prepares to retrieve cargo report data → The cargo report segment buffer is cleared to space
[Execute Database Get Next Call]
The system executes the database get next operation → A database call is made using get next command with cargo report segment and qualified search criteria

Structural Validations

[5:Handle Blank Waybill Input]
The waybill input field is empty (SPACE) → The system clears cargo by waybill display, clears saved waybill data, and displays blank waybill message
[9:Validate Invalid Function Keys]
An invalid function key is pressed (not PAGE-BCK, PAGE-FWD, or ENTER) → The system highlights item selection field and displays invalid function key message
[10:Validate Waybill Number Format]
CCN carrier is not numeric or origin number is not numeric or waybill number is not numeric → The system clears information lines, highlights waybill field, and displays invalid waybill number message
[13:Handle No Records Found]
No records are found or waybill number does not match saved waybill → The system clears information lines, highlights waybill field, and displays no CCN message
[16:Validate Item Selection Input]
Selection is not numeric or equals zero or exceeds maximum line number → The system highlights selection field and displays invalid range message
[Set Invalid Waybill Number Error Message]
The system completes the validation error processing → An invalid waybill number error message is set to inform the user of the validation failure
[Set Blank Waybill Message]
The waybill input field is blank or empty → A blank waybill message is displayed to prompt the user for waybill entry
[Highlight Waybill Input Field]
System detects changes in waybill information → System highlights waybill input field with cursor and displays waybill change warning message
[Any Records Currently Displayed?]
The first information line is empty (contains spaces) → Display 'No Records Found' message and prevent navigation
[First Info Line Empty?]
The first information line on the current display is empty → System displays no CCN message and prevents forward navigation
[Set Error Highlight on Item Selection]
Selection is invalid, zero, or out of range → System should highlight item selection field and set invalid range error message
[Set No CCN Selected Error Message]
The selected item contains no CCN data → System should highlight item selection field and display no CCN selected error message
[Selection Numeric and Not Zero and Within Range?]
The selection is not numeric:
equals zero
exceeds the maximum allowed range
→ The system highlights the item selection field and displays invalid range error message
[CCN Exists for Selected Item?]
No CCN exists at the selected item position (CCN field is space) → The system highlights the item selection field and displays no CCN selected error message
[Set Item Selection Field Attribute to Normal Protected]
The user presses a function key that is not PAGE-BCK, PAGE-FWD, or ENTER → The system sets the item selection field attribute to normal protected and displays an invalid function key error message
[Display Error Message to User]
The twelfth information line is empty indicating the last page has been reached → The system enables item selection field and displays a 'Last Page' message to indicate no more records are available
[Set No CCN Selected Message]
The selected line item has no cargo control number associated with it → The system highlights the item selection field and displays a 'No CCN Selected' message
[Display Error Message to User]
The database search for additional records returns no matching waybill records:
returns an error status
→ The system displays a 'No More CCN Found' message to indicate no additional records are available
[Any Records Currently Displayed?]
The system checks if any records are currently displayed by examining the first information line → If the first information line is empty (SPACE), display 'No Records Found' message and stop paging process
[Next Record Belongs to Same Waybill?]
The system validates the retrieved record → If the waybill number index (first 15 characters) matches the saved waybill input AND the status code is SPACE, proceed to format new page; otherwise display 'No More Records' message
[Item Selection Numeric?]
The item selection value is not numeric → The system highlights the item selection field and displays an invalid range error message
[Item Selection is Zero?]
The item selection value equals zero → The system highlights the item selection field and displays an invalid range error message
[Item Selection Exceeds Maximum Range?]
The item selection value is greater than the last line number (maximum range) → The system highlights the item selection field and displays an invalid range error message
[Selected Item Position Contains Data?]
The selected item position does not contain any cargo data (CCN is empty) → The system highlights the item selection field and displays a no item selected error message
[Input Numeric?]
The item selection input is not numeric → The system highlights the item selection field and displays an invalid range error message
[Input Equal Zero?]
The item selection input equals zero → The system highlights the item selection field and displays an invalid range error message
[Input Greater Than Maximum Line?]
The item selection input is greater than the last available line number → The system highlights the item selection field and displays an invalid range error message
[Selected Line Has Data?]
The selected line number corresponds to an empty line with no cargo data → The system highlights the item selection field and displays a no selection available error message
[Item Selection Numeric?]
The system validates the item selection format → If the item selection is not numeric, display invalid range error message and highlight the item selection field
[Item Selection > 0?]
The system validates the item selection value → If the item selection equals zero, display invalid range error message and highlight the item selection field
[Item Selection Within Valid Range?]
The system validates the item selection range → If the item selection is greater than the last line number, display invalid range error message and highlight the item selection field
[Cargo Control Number Exists?]
The system checks for cargo control number at that position → If the cargo control number field is empty or contains spaces, display no cargo control number selected error message and highlight the item selection field
[Item Selection Numeric?]
The item selection is not numeric → Display invalid range error message and highlight the item selection field
[Item Selection Greater Than Zero?]
The item selection equals zero → Display invalid range error message and highlight the item selection field
[Item Selection Within Valid Range?]
The item selection is greater than the last line number → Display invalid range error message and highlight the item selection field
[Cargo Control Number Exists?]
The cargo control number at the selected position is space or empty → Display no cargo control number selected error message and highlight the item selection field

Module: GCX117A 1 Consolidated Epic Story

Epic: GCX117A Complete EDI Specification Extracted from Legacy

Contains 17 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX117A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[9:Display Cargo Control Number]
Formatting display line information → The cargo control number key is moved to the display line CCN field
[5:Retrieve Next USRT Segment]
Cargo report segment data is needed → Clear the cargo report segment area, set the waybill number as key value, and call CIMS system to retrieve the data
[Extract Canadian Cargo Status Description]
The system processes cargo status information for display → The Canadian Pacific cargo status description is extracted and moved to the CP status field
[Extract US Cargo Status Description]
The system processes cargo status information for display → The US cargo status description is extracted and moved to the US status field
[Clear Cargo Report Segment Area]
The system prepares to retrieve USRT segment data → The cargo report segment area is cleared to spaces
[Set Waybill Key Value for Search]
The system prepares to search for cargo report segments → The waybill key value is set to the input waybill number
[Call Database System to Get Next Segment]
The system needs to retrieve cargo report segment data → The CIMS system is called with the cargo report segment parameters and qualified search criteria
[Move CCN Key to Screen Display Field at Current Line Position]
The system processes the CCN line for display formatting → The U.S. CCN key value from the cargo report segment should be moved to the CCN display field at the current screen line position
[Get Canadian Cargo Status Description]
The system processes cargo status information → The Canadian Pacific cargo status description is extracted and moved to the Canadian status field
[Move Canadian Status to CPRS-STATUS]
The system assigns status values to designated fields → The Canadian Pacific cargo status description is moved to CPRS-STATUS field
[Get U.S. Cargo Status Description]
The system processes cargo status information → The U.S. cargo status description is extracted and moved to the U.S. status field
[Move U.S. Status to USCS-STATUS]
The system assigns status values to designated fields → The U.S. cargo status description is moved to USCS-STATUS field

Structural Validations

[11:Validate Waybill Number Match]
The system call status code equals SPACE AND the first 15 characters of the waybill number index match the input waybill number → Continue processing the current record, otherwise set FINISHED to 'YES' to stop processing
[Status Code = SPACE?]
The system checks the retrieval status → If the status code is not SPACE (indicating failure), processing should be marked as complete and stopped
[Waybill Number from Record = Input Waybill Number?]
The system compares the first 15 characters of the waybill number from the retrieved record with the input waybill number → If the waybill numbers do not match, processing should be marked as complete to stop further record processing
[Check Status Code = SPACE?]
The system checks the status code returned from the database call → Processing continues only if the status code equals SPACE (indicating success), otherwise processing is marked as complete
[Check Waybill Number Match?]
The system compares the first 15 characters of the retrieved waybill number with the input waybill number → Processing continues only if the waybill numbers match exactly, otherwise processing is marked as complete

Module: GCX118 1 Consolidated Epic Story

Epic: GCX118 Complete EDI Specification Extracted from Legacy

Contains 60 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX118 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The system initializes and the message ID indicates a Cargo Selection Menu Module → The system preserves input field data, clears saved field data and layout, and clears PF key data
[1:Initialize Program]
The system initializes and the message ID indicates a US Held Cargo Display Module → The system preserves both current input field data and saved input field data
[1:Initialize Program]
The system initializes and the message ID indicates a module other than Cargo Selection Menu or US Held Cargo Display → The system uses saved station number and type, clears input fields, layout, and PF key data
[Initialize Cargo Search Segment]
The cargo search process begins → The cargo search segment is initialized to clear any previous search data
[Initialize Cargo Search Segment]
The system begins searching for cargo records → The cargo search segment is initialized to empty state

Core Acceptance Criteria

[20:Handle No Cargo Found]
No cargo is found and the operation is forward paging → The system returns a Last Page error message
[Determine Message Source]
If the message ID → The message source type is determined as either Cargo Selection Menu, US Held Cargo Display, or Other source
[Copy Input Field Data]
Input data initialization is performed → The input field data from the message is copied to the working storage input field
[Clear Input Field Save Area]
Input field initialization is being performed → The input field save area is cleared to spaces
[Clear Layout and PF Key]
Screen initialization is performed → The layout structure and PF key data are cleared to spaces
[Copy Input Field Data and Save Area]
Input data initialization is performed → Both the input field data and input field save area are copied from the message to working storage
[Restore Station Data from Save Area]
Station data initialization is performed → The station number and station type are restored from their respective save areas
[Clear Input Fields and Layout]
Input field initialization is performed → The input field, input field save area, layout, and PF key data are all cleared to spaces
[Validation Passed - Single Operation Detected]
User performs only one operation (paging:
line selection
station changes) without combining multiple operations
→ System proceeds with the requested operation without displaying error message 5301
[Display No Cargo Found Message]
No cargo records are found for the station → System displays error message 5305 and clears cargo table, or displays last page message if user was paging forward
[Look up Station in DR Table]
The system looks up the station number in the GCSTBRT DR table → The system determines if the station exists in the table and retrieves the corresponding DR segment
[Set DR Index for Paging]
The system needs to set the DR index for cargo retrieval → The DR segment from the table lookup is moved to the working DR segment for further processing
[Look up Station in DR Table]
The system looks up the station number in the GCSTBRT DR table → The system determines if the station exists in the DR table and retrieves the corresponding DR segment
[Station Found in DR Table?]
The lookup operation is successful → The system uses the retrieved DR table segment data and sets the appropriate DR index based on the paging mode
[Set Up Database Access Parameters]
Setting up database access parameters → Initialize database communication parameters and set segment type to cargo secondary records
[Access Cargo Secondary Database GCSUSS07]
Executing database access to GCSUSS07 segment → Retrieve the shipper and consignee record from the cargo secondary database
[Handle No Cargo Found - Display appropriate message when no cargo exists for specified criteria]
The system attempts to retrieve cargo data for display → The system should highlight the station number field and display context-appropriate error messages
[Set Last Page Message]
The system processes the page forward action with no available cargo → The system should set and display the last page message

Structural Validations

[2:Validate PF Key Selection]
The PF key selection is invalid → The system returns a PF Key Invalid error message
[2:Validate PF Key Selection]
The selected PF key function is not available in the current context → The system returns a PF Key Not Available error message
[6:Validate Page Navigation]
The PF key is page backward and the current page is the first page → The system returns a First Page error message
[6:Validate Page Navigation]
The PF key is page forward and the last displayed line contains no cargo data → The system returns a Last Page error message
[8:Validate Selected Line Number]
The line number is not numeric or not exactly 2 digits → The system returns an Item Invalid error message
[8:Validate Selected Line Number]
The line number is less than 1 or greater than the last screen line → The system returns an Item Invalid error message
[PF Key = INV-PFKEY-SELECTION?]
The function key value equals INV-PFKEY-SELECTION → The system sets error message to PF Key Invalid and stops further processing
[PF Key = SEL-NOT-AVAILABLE?]
The function key value equals SEL-NOT-AVAILABLE → The system sets error message to PF Not Available and stops further processing
[Set Error Message 5302 Station Number Required for Held Cargo Display]
Station number is not provided (empty or spaces) → System displays error message 5302 indicating station number is required for held cargo display
[Set Error Message 5306 Station Number Required for Menu]
Station number is not provided (empty or spaces) → System displays error message 5306 indicating station number is required for menu
[Set Error Message 5303 Invalid Station Type]
Station type is not provided (empty or spaces) → System displays error message 5303 indicating invalid station type
[Set Error Message 5303 Invalid Station Type]
Station type is not Border Station and not Destination Station → System displays error message 5303 indicating invalid station type
[Station Type Empty?]
The station type field is empty or contains spaces → The system should set the station type field attribute to high intensity display and set error message 5303
[Station Type = Border OR Destination?]
The station type is not a border station (B) and not a destination station (D) → The system should set the station type field attribute to high intensity display and set error message 5303
[Set Error Message 5303]
The system needs to communicate the validation error to the user → The system should set output message number to 5303
[Is Paging Operation Requested? -> Has Station Number Changed? -> Set Error Message 5301]
User attempts to page forward or backward AND the station number has been changed from its saved value → System displays error message 5301 indicating multiple operations are not allowed
[Is Paging Operation Requested? -> Has Station Type Changed? -> Set Error Message 5301]
User attempts to page forward or backward AND the station type has been changed from its saved value → System displays error message 5301 indicating multiple operations are not allowed
[Is Paging Operation Requested? -> Is Line Selection Made? -> Set Error Message 5301]
User attempts to page forward or backward AND has entered a line selection in the input field → System displays error message 5301 indicating multiple operations are not allowed
[Is Line Selection Made? -> Has Station Number Changed? -> Set Error Message 5301]
User enters a line selection in the input field AND the station number has been changed from its saved value → System displays error message 5301 indicating multiple operations are not allowed
[Is Line Selection Made? -> Has Station Type Changed? -> Set Error Message 5301]
User enters a line selection in the input field AND the station type has been changed from its saved value → System displays error message 5301 indicating multiple operations are not allowed
[Currently on First Page?]
User requests to navigate to previous page AND currently on first page → System displays first page error message and prevents navigation
[Last Screen Line Empty?]
User requests to navigate to next page AND last displayed line contains no cargo data → System displays last page error message and prevents navigation
[Does Line Contain Valid CCN?]
The cargo control number (CCN) at the selected line position is empty or spaces → Error message 5304 is displayed indicating no cargo exists on the selected line
[Is Input Numeric?]
The numeric validation utility determines the input is not a valid numeric value → The system sets an invalid item error message and rejects the selection
[Line Number >= 1 AND <= Last Screen Line?]
The system checks if the line number is less than 1 or greater than the last available screen line → The system sets an invalid item error message if the line number is outside the valid range
[Check if CCN exists for selected line]
The system checks if the Cargo Control Number (CCN) exists for the selected line position → If the CCN field is blank or contains only spaces, set error message 5304 indicating the line has no cargo, otherwise allow the user to proceed to the detailed cargo display screen
[Stack Setup Successful?]
The service returns a response code → If the return code indicates invalid current selection code, the system must abort with an error message
[System Error - Invalid Selection Code]
The service returns an invalid current selection code error → An error message is constructed with the failure details and the system performs abnormal termination
[Validate Station Number and Type]
Station number field is empty or spaces → System displays error message 5302 for held cargo display mode or 5306 for other modes and highlights station number field for correction
[Validate Station Number and Type]
Station type is empty or is not Border Station and not Destination Station → System displays error message 5303 and highlights station type field for correction
[Validate Station Number and Type]
Station number is not found in station master table → System validates station number as 6-digit numeric format, and if validation fails, displays error message 5302 with station field highlighted
[Set Station Number Error]
Processing the validation failure → The station number attribute is set to highlight display and error message 5302 is set in output message number
[Set Station Number Error]
The system processes the invalid station number → The system sets error message 5302 indicating invalid station number and highlights the station number field
[Set Station Number Attribute to High Display]
The validation is not successful → The system should set the station number attribute to high display intensity and set error message 5302 for invalid station
[Station Found in DR Table?]
The system performs a lookup in the GCSTBRT DR table using the station number as the sequence ID → If the station is found successfully, the system uses the existing DR table segment data for further processing
[Set Error - Invalid Station Number]
The JSTNUM validation returns unsuccessful status → The system sets the station number attribute to highlight display and assigns error message 5302 for invalid station
[Set No Cargo Found Message 5305]
The system has cleared the cargo display table → The system should set message 5305 indicating no cargo found

Module: GCX119 1 Consolidated Epic Story

Epic: GCX119 Complete EDI Specification Extracted from Legacy

Contains 50 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX119 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize GCMSG Structure]
The program environment initialization is performed → The GCMSG message control structure must be initialized to ensure clean processing state

Core Acceptance Criteria

[6:Process Special Character Replacements]
The system encounters a '%' character in the message text → The system replaces the '%' character with HIGH-VALUES
[6:Process Special Character Replacements]
The system encounters an '@' character in the message text → The system replaces the '@' character with LOW-VALUES
[7:Handle Module Name Processing]
The input module name is empty (SPACES) → The system sets the destination module name to 'XXXXXXXX'
[8:Process TABLE Module Special Case]
The input module name equals 'TABLE' → The system sets PF-KEY to 'XX', security byte to HIGH-VALUES, useable screen indicator to 'Y', moves GCMSG to destination message text, and uses the input module name as destination module name
[7:Handle Module Name Processing]
The input module name is not 'TABLE' and not SPACES → The system uses the input module name as the destination module name
[12:Send Message to Destination]
All validations pass and the destination transaction is confirmed valid → The system calls the message writing service to transmit the message to the destination
[Set Program Identifier to 'GCX119']
The program environment is being set up → The program identifier must be set to 'GCX119' to identify this as a message routing program
[Clear Input Record Buffer]
The input buffer needs to be prepared for data reading → The input record buffer must be cleared to spaces to prevent data contamination from previous operations
[Call READQ Function]
The READQ function is called to retrieve the input record from the message queue → The input record is populated with the message data for further processing
[Clear Input Record Area]
The input record area needs to be cleared → The input record is set to spaces to ensure clean data processing
[Terminate Program]
The system cannot proceed without valid input data → The system should terminate the program execution and return control to the calling environment
[Continue Processing]
The read operation returns a zero status indicating success → The system should continue with normal message processing workflow
[Copy Complete Input Record to Destination Message]
The system processes the input record for message routing → The complete input record content is copied to the destination message structure
[Extract Transaction Code from Input Record]
The system parses the input message components → The transaction code is extracted and assigned to the destination field
[Extract Message Text from Input Record]
The system parses the input message components → The message text is extracted and assigned to the destination message text field
[Set Screen Header - GCX119 INPUT]
The screen display is being set up → The system sets 'GCX119 INPUT' as the first screen table entry for program identification
[Display Complete Input Message]
The screen display is being prepared → The system displays the complete destination message as the third screen table entry
[Set Transmitted Message Label]
The transmitted message section needs identification → The system sets 'TRANSMITTED MESSAGE' as the fourth screen table entry
[Display Origin Module Information]
The screen display is being populated → The system displays the origin module information as the ninth screen table entry
[Display Processed Message Text]
The screen display is being finalized → The system displays the processed destination message text as the fifth screen table entry
[Is Character '%'?]
The character validation check is performed on the current position → The percent symbol is replaced with HIGH-VALUES in the message text
[Is Character '@'?]
The character validation check is performed on the current position → The at symbol is replaced with LOW-VALUES in the message text
[All 500 Characters Processed?]
The processing loop evaluates whether all characters have been checked → Processing continues until the counter exceeds 500 characters, at which point character processing is complete
[Check Current Character Position - Examine each character in message text sequentially from position 1 to 500]
The system examines each character position from 1 to 500 in the message text → The system continues processing until all positions up to 500 have been examined or the end of text is reached
[Copy GCMSG to Message Text]
The system processes the TABLE module → The configured GCMSG structure should be copied to the destination message text
[Configure TABLE Module Settings]
The input module value equals 'TABLE' → The system should set PF key to 'XX', set security byte to HIGH-VALUES, set useable screen indicator to 'Y', update the message text with the configured message, and set the destination module name from the input module
[Set PF-Key to 'XX']
The system processes the TABLE module configuration → The PF-key should be set to 'XX', the security byte should be set to HIGH-VALUES, the useable screen indicator should be set to 'Y', the GCMSG structure should be moved to the message text, and the destination module name should be set to 'TABLE'
[Move GCMSG Structure to Message Text]
The system applies the structure to the message → The GCMSG structure should be moved to the destination message text
[Terminate Processing]
The system completes error handling → Processing is terminated and control returns to the calling program
[Continue to Next Process]
The system completes validation checking → Processing continues to the message transmission phase
[Transaction Validation Successful]
If the successful validation response → The system continues with message transmission processing
[Show Invalid Transaction Message]
The system needs to present the error to the user and halt further processing → The system calls the display service to show the error message and terminates the current processing session
[Call WRITMSGL Service]
The system initiates message transmission to the destination transaction → The WRITMSGL service is called with the communication control block, alternate PCB, destination message code, complete destination message, message length, and destination module name to successfully transmit the message

Structural Validations

[3:Validate Input Read Operation]
The read operation returns a non-zero return code indicating failure → The system displays an error message showing invalid return code and terminates processing
[11:Handle Invalid Destination Transaction]
The destination transaction validation returns a non-blank status code indicating invalid transaction → The system displays 'DESTINATION TRANSACTION INVALID' error message with the destination name and terminates processing
[Retrieve Message from Queue]
The message reading operation fails (return code != 0) → The system displays an invalid return code error message and terminates processing
[Check Return Code from READQ]
The read operation returns a non-zero status indicating failure → The system should reject the operation and not proceed with message processing
[Prepare Error Message Display]
The system needs to inform the user about the failure → The system should display program identifier, error description as 'INVALID RETURN CODE', and the specific return code value to the user
[Is Character '%'? - Replace with HIGH-VALUES]
The character at the current position is a percent symbol ('%') → The system replaces that character with HIGH-VALUES
[Is Character '@'? - Replace with LOW-VALUES]
The character at the current position is an at symbol ('@') → The system replaces that character with LOW-VALUES
[Prepare Invalid Transaction Error Message]
The system needs to inform the user of the validation failure → Error message 'DESTINATION TRANSACTION INVALID' is prepared with the invalid destination code and other display fields are cleared
[Display Error Message to User]
The system needs to show the error to the user → The error display service is called to present the message to the user
[Prepare Invalid Transaction Error Display]
The system needs to inform the user about the invalid transaction → The system prepares screen display with error message 'DESTINATION TRANSACTION INVALID' and the invalid destination transaction code
[Display Error Message to User]
The system needs to communicate the validation failure to the user → The system displays the error message screen showing the invalid transaction details
[Terminate Process]
The system has completed error handling for the invalid transaction → The system terminates the current process and returns control
[Check Transaction Validation Status]
The transaction validation returns a non-blank status code indicating the transaction is invalid → The system should display 'DESTINATION TRANSACTION INVALID' error message along with the invalid transaction code and terminate processing
[Set Error Message: 'DESTINATION TRANSACTION INVALID']
The system prepares to inform the user of the validation failure → The system should set screen table position 2 to display 'DESTINATION TRANSACTION INVALID' message
[Display Error Screen to User]
The system needs to present the error information to the user → The system should call the display function to show the error screen with all prepared error messages
[Prepare Error Display]
The system needs to communicate the validation failure to the user → The system clears existing display content and populates screen with 'DESTINATION TRANSACTION INVALID' message along with the invalid transaction identifier

Module: GCX120 1 Consolidated Epic Story

Epic: GCX120 Complete EDI Specification Extracted from Legacy

Contains 43 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX120 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Cargo Search Segment]
The system begins the cargo retrieval process → The cargo search segment is initialized to empty state
[Initialize Cargo Search from Beginning]
System prepares cargo search parameters → System should initialize cargo segment and clear all search key values to start fresh retrieval

Core Acceptance Criteria

[10:Retrieve Station Configuration]
The system looks up station configuration in GCSTBRT station table → If station is found, retrieve station segment data and set pagination index, otherwise attempt numeric conversion of station number
[17:Process No Cargo Found]
The system processes the empty result → If page forward navigation, display 'Last Page' message, otherwise clear cargo table and display 'No Cargo Found' message
[Check Message Source Type]
If the message ID to determine processing mode → The system sets the appropriate mode as Cargo Selection Menu, US Destination Cargo Display, or Other mode
[Cargo Selection Menu Mode]
The system processes the cargo selection menu configuration → Input field is set from message data, input field save area is cleared, screen layout is cleared, and PF key is cleared
[US Destination Cargo Display Mode]
The system processes the US destination cargo display configuration → Input field is set from message data and input field save area is set from message save data
[Other Mode]
The system processes the default mode configuration → Input field save is set from SPA filler, input field is cleared, station number is restored from save area, input field save area is cleared, screen layout is cleared, and PF key is cleared
[Message Source = US Destination Cargo Display?]
The current module is US Destination Cargo Display mode → The system should set the error message to 'Invalid Station'
[Extract Station Configuration from DR Table]
The system processes the retrieved table segment → The station configuration data is moved to the DR segment for further processing
[Display 'No More Records' Message]
No more cargo records are found in any station → Display 'Last Page' message to indicate end of available data
[Display No Cargo Found Message]
No cargo records are found for the station → System should display 'No cargo found' message and clear the cargo display table
[Set Message: 'Last Page Reached']
The system processes the page forward request → The system should display 'Last Page Reached' message
[Clear Cargo Display Table]
The system processes the request → The system should clear the cargo display table AND display 'No Cargo Found' message

Structural Validations

[2:Validate PF Key Input]
The system validates the PF key input → If the PF key is invalid, display 'PF Key Invalid' message, or if the PF key selection is not available, display 'PF Not Available' message
[3:Validate Station Number Input]
The system checks if station number is provided → If station number is blank and in destination cargo display mode, display 'Invalid Station' message, otherwise display 'Enter Station' message
[4:Check Multiple Request Conflict]
The system detects both line selection input and station number change, or page navigation with conflicting inputs → Display 'Request Only One' error message to prevent conflicting operations
[4:Check Multiple Request Conflict]
The station number hasn't changed and no input line is selected → Display 'Nothing Done' message to indicate no action was taken
[4:Check Multiple Request Conflict]
The last line of current screen contains no cargo data → Display 'Last Page' message and prevent forward navigation
[6:Process Line Selection]
The system validates the input line number → If the line number is not numeric or outside valid range (1 to maximum screen lines), display 'Item Invalid' error message
[7:Verify Selected Line Has Cargo]
The system checks if the selected line contains cargo data → If the selected line has no CCN (cargo control number), display 'No CCN On Line' error message
[9:Validate Station Number Format]
The system validates the station number format → If the station number cannot be converted to valid 6-digit numeric format, display 'Invalid Station' error message
[Is PF Key = INV-PFKEY-SELECTION?]
The pressed function key equals INV-PFKEY-SELECTION (invalid function key selection) → The system sets an error message indicating the function key is invalid
[Is PF Key = SEL-NOT-AVAILABLE?]
The pressed function key equals SEL-NOT-AVAILABLE (selection not available) → The system sets an error message indicating the function key option is not available
[Check Station Number Input]
The station number field is blank or empty → The system should set the station number attribute to display mode and proceed to determine the appropriate error message
[Set Error Message: ENTER-STATION-120]
The current module is not US Destination Cargo Display mode → The system should set the error message to 'Enter Station'
[Check Multiple Request Conflict - Validate that only one action (paging, new station, or line selection) is requested at a time]
User attempts to perform paging (PAGE-BCK:
PAGE-FWD) AND has changed the station number
has entered input line data
user enters both input line data AND changes station number
→ System displays 'REQUEST-ONLY-ONE-120' error message to prevent conflicting operations
[Is Line Selection Made? Input Line Not Blank]
Station number has been changed from the saved station number value → System identifies this as a conflicting multiple request scenario and sets error message
[Validation Passed: Single Action Confirmed]
Only one action is requested (either paging:
station change
line selection, but not multiple)
→ System allows the operation to proceed without displaying conflict error message
[Check if forward/backward paging is valid based on current page position]
The user presses PAGE-FWD:
PAGE-BCK function key AND has changed the station number
has entered an input line selection
→ The system should display a 'Request only one operation' error message and prevent the page navigation
[Is Last Screen Line Empty?]
The user presses PAGE-FWD function key AND the last line of the current screen display is empty (no cargo CCN data) → The system should display a 'Last page' error message and prevent forward navigation
[Set Multiple Request Error]
The user has entered an input line selection AND has changed the station number from the previously saved value → The system should display a 'Request only one operation' error message
[Line Number >= 1?]
The line number is less than 1 → The system sets an invalid item error message
[Line Number <= Screen Last Line?]
The line number is greater than the screen last line → The system sets an invalid item error message
[Input is Numeric?]
The numeric validation service determines the input is not numeric → The system sets an invalid item error message
[Check CCN Field for Selected Line]
The system checks the CCN field for the selected line → If the CCN field is empty or blank, display 'No CCN on Line' error message, otherwise allow proceeding to cargo display screen
[Stack Operation Successful?]
The stack operation returns with an invalid current selection code → The system should terminate the program with an error message
[Display Stack Error Message]
The stack operation has failed → An error message is constructed with the invalid selection code details and the program is terminated
[Mark Station as Invalid]
The system determines the station is invalid → Set station number attribute to highlight display mode and set error message to 'Invalid Station'
[Set Invalid Station Error Message]
The conversion failure is processed → The station number attribute is set to high intensity display and an invalid station error message is set
[Mark Station as Invalid]
The system completes station validation → The station number attribute is highlighted and an invalid station error message is set
[Station Number Not Zero?]
The system checks the station number validity → If station number from GCSTBRT segment at current index is not equal to zero then station is valid, otherwise station is invalid
[Last Line on Current Page Empty?]
The last line on the current screen has no cargo control number (CCN) → Display 'Last Page' message and prevent forward navigation

Module: GCX121 1 Consolidated Epic Story

Epic: GCX121 Complete EDI Specification Extracted from Legacy

Contains 205 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX121 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize MQ Message Structure]
The system begins formatting the MQ message → The MQ message structure is initialized with spaces and default values
[Initialize MQ Message Structure]
The system begins message configuration → The MQ message structure is initialized to clear any previous content

Core Acceptance Criteria

[3:Validate Security Access]
The security byte is either HIGH-VALUES or LOW-VALUES → The system allows processing to continue, otherwise terminates the program
[4:Retrieve Transmission Record]
The system searches for the transmission record → The corresponding transmission segment is retrieved from the database
[7:Identify Message Type]
The transaction type is 'REP' → The system sets customer reporting mode and stores partner information, otherwise processes as regular EDI transaction
[10:Build Message Array]
Data storage is required → Store in REP array if customer reporting mode, in 309 array if 309 reporting mode, otherwise in standard EDI array
[12:Determine Output Queue]
Queue destination is determined → Route to 'GC.CCRA.INTERNAL.OUTBOUND' queue if transaction type is 'REP', '309', or '358', otherwise generate error for invalid transaction type
[14:Calculate Message Length]
Message formatting is required → Use 600-byte records for customer REP reporting, 330-byte records for 309 reporting, and 200-byte records for other EDI transactions
[Check Transmission Type]
Post-processing cleanup is performed → Preserve records if transmission number is '309CANCUST', '358CANCUST', or 'CUSREPCCRA', otherwise delete the transmission record
[Clear Work EDI Storage Area]
Work storage area initialization is executed → The work EDI storage area is cleared to spaces
[Call READQ to Read from Queue]
The READQ operation is called with communication control block and input area parameters → The system retrieves the message from the queue into the designated input area
[Retrieve Input Message Length]
The READQ operation completes successfully → The system obtains the input message length parameter for subsequent processing
[Move Message Data to Input Buffer]
The system processes the message data transfer → The message content from position 1 to the input message length is moved to the GCX121-INPUT buffer for further processing
[Security Byte = HIGH-VALUES or LOW-VALUES?]
The security byte is evaluated for authorization → If security byte equals HIGH-VALUES or LOW-VALUES then processing continues, otherwise program terminates
[Authorization Invalid - Terminate Program]
The security byte is not HIGH-VALUES and not LOW-VALUES → The program terminates immediately without processing the transmission
[Authorization Valid - Continue Processing]
The security byte equals HIGH-VALUES or LOW-VALUES → Processing continues to mainline transmission handling
[Set Transmission Number as Search Key]
The system prepares to retrieve transmission data from the database → The transmission number is assigned as the search key value for the database query
[Execute Database Get Request for Transmission Segment]
The system executes a database get operation for transmission segment → A database call is made to retrieve the transmission segment record using GHU operation with the specified key
[Set Transmission Number to Header Timestamp 1 Control Number]
Setting up header timestamp information → The transmission number is stored as the control number in header timestamp 1
[Get Next Dependent Segment from Database]
The system requests the next dependent segment → The system calls the database to get the next dependent segment using GHNP command
[Segment Found?]
The system checks the status code → If status code equals spaces, a segment was found, otherwise no segment exists
[Extract Transmission Data]
The system processes the segment → The transmission data is moved to the EDI identifier field
[Is ST Segment?]
The system checks the segment identifier → If the identifier equals 'ST ', it is a Start Transaction segment
[Transaction Type = REP?]
The system checks the transaction type field → If the transaction type equals 'REP', it is a reporting transaction
[Set Partner for REP Report, Create REP Header, Set CUSREP Reporting Flag]
The system processes the REP transaction → The partner destination is set, REP header is created, and CUSREP reporting flag is activated
[Move EDI Header to Array]
The system processes the transaction → The partner destination and transaction type are set, and EDI header is moved to appropriate array
[Increment Line Counter]
The system processes the segment → The line counter is incremented by 1
[CUSREP Reporting?, Add Data to REP Array, Add Data to Standard Array]
The system determines the storage destination → If CUSREP reporting is active, data is stored in REP array, otherwise data is stored in standard EDI array
[Check if ST Identifier?]
The segment identifier equals 'ST ' → The system recognizes this as a Start Transaction segment and proceeds to extract transaction type information
[Check Transaction Type]
The transaction type field (ST-02-TRANSACTION) equals 'REP' → The system classifies this as a customer reporting transaction and activates customer reporting processing mode
[Extract REP Destination]
The ST segment contains destination information in ST-01-DESTINATION field → The system extracts and stores the destination as the partner REP identifier
[Extract Transaction Destination]
The system processes the ST segment → The destination information from ST-01-DESTINATION is extracted and stored as PARTNER-DEST
[Set Transaction Type]
The transaction type is extracted from ST-02-TRANSACTION field → The system sets both TS-TYPE and TYPE-OF-REPORT fields to the extracted transaction type value
[Move EDI Header to Array]
The system initializes the data array → If 309-reporting flag is active, the EDI header is moved to WORK-309-DATA array position 1, otherwise it is moved to WORK-EDI-DATA array position 1
[Increment Line Counter]
The segment is not an ST identifier segment → The line counter is incremented by 1 to maintain proper array indexing
[Is ST Segment?]
The system checks the segment identifier in the EDI data → If the ST-IDENTIFIER equals 'ST ', the segment is classified as an ST segment, otherwise it is classified as a data segment
[Is REP Transaction?]
If the transaction type in ST-02-TRANSACTION field → If ST-02-TRANSACTION equals 'REP', the transaction is classified as a REP transaction, otherwise it is classified as another transaction type
[Move ST-01-DESTINATION to PARTNER-REP]
The system processes the destination information → The ST-01-DESTINATION value is moved to PARTNER-REP field
[Set CUSREP-REPORTING Flag]
The system configures processing mode → The CUSREP-REPORTING flag is set to TRUE
[Move ST-01-DESTINATION to PARTNER-DEST]
The system processes the destination information → The ST-01-DESTINATION value is moved to PARTNER-DEST field
[Move ST-02-TRANSACTION to TS-TYPE and TYPE-OF-REPORT]
The system processes transaction type information → The ST-02-TRANSACTION value is moved to both TS-TYPE and TYPE-OF-REPORT fields
[Is 309 Reporting?]
The system determines which work array to use for header data → If 309-REPORTING flag is true, 309 processing mode is selected, otherwise standard EDI processing mode is selected
[Move HEADER-EDI to WORK-309-DATA Position 1]
The system sets up the work array for 309 data → The HEADER-EDI is moved to the first position of WORK-309-DATA array
[Move HEADER-EDI to WORK-EDI-DATA Position 1]
The system sets up the work array for EDI data → The HEADER-EDI is moved to the first position of WORK-EDI-DATA array
[Is CUSREP-REPORTING?]
The system determines which work array to use for the data → If CUSREP-REPORTING flag is true, customer reporting mode is selected, otherwise standard processing mode is selected
[Move Transmission Data to WORK-REP-DATA at LINE-CNT]
The system stores the transmission data → The A9DP-TRANSMISSION-DATA is moved to WORK-REP-DATA at the position indicated by LINE-CNT
[Is 309 Reporting?]
The system determines which work array to use for the data → If 309-REPORTING flag is true, 309 processing mode is selected, otherwise standard EDI processing mode is selected
[Move Transmission Data to WORK-309-DATA at LINE-CNT]
The system stores the transmission data → The A9DP-TRANSMISSION-DATA is moved to WORK-309-DATA at the position indicated by LINE-CNT
[Move Transmission Data to WORK-EDI-DATA at LINE-CNT]
The system stores the transmission data → The A9DP-TRANSMISSION-DATA is moved to WORK-EDI-DATA at the position indicated by LINE-CNT
[Check if ST Identifier?]
The system checks the segment identifier field → If the identifier equals 'ST ' then process as transaction header, otherwise process as data content
[Check Transaction Type]
The transaction type field in position ST-02 equals 'REP' → Set message type to REP and enable customer reporting mode
[Set Partner REP Destination]
Processing the ST segment → Move the destination field from ST-01 to PARTNER-REP for routing purposes
[Set REP Message Type]
Processing REP transaction header → Move HEADER-REP to the first position of WORK-REP-DATA array
[Set Partner Destination]
Extracting routing information → Move the destination field from ST-01 to PARTNER-DEST for message routing
[Set Transaction Type]
Extracting transaction information → Move transaction type from ST-02 to both TS-TYPE and TYPE-OF-REPORT fields
[Check if 309 Transaction?]
If the transaction type → If transaction type equals '309' then enable 309-specific processing, otherwise use standard EDI processing
[Set 309-REPORTING Flag]
Setting processing flags → Set 309-REPORTING flag to TRUE to enable 309-specific data handling
[Set 309-REPORTING Flag]
Processing 309 transaction header → Move HEADER-EDI to the first position of WORK-309-DATA array
[Set Standard EDI Routing]
Processing standard EDI transaction header → Move HEADER-EDI to the first position of WORK-EDI-DATA array
[Is ST Identifier = 'ST '?]
The system checks the segment identifier in the transmission data → If the identifier equals 'ST ' then process as transaction header, otherwise continue processing as data segment
[Is Transaction Type = 'REP'?]
If the ST-02-TRANSACTION field → If the transaction type equals 'REP' then set up customer reporting mode, otherwise process as standard EDI transaction
[Set Message Type as REP]
The system processes the REP transaction configuration → Set CUSREP-REPORTING flag to true, extract destination partner from ST-01-DESTINATION, and store header information in REP data array
[Extract Transaction Type from ST Segment]
The system extracts transaction details from the ST segment → Move ST-01-DESTINATION to PARTNER-DEST and ST-02-TRANSACTION to both TS-TYPE and TYPE-OF-REPORT fields
[Is Transaction Type = '309'?]
If 309-REPORTING flag is set → If 309-REPORTING is true then configure for 309 transaction processing, otherwise check for other transaction types
[Set Message Type as 309]
The system processes the 309 transaction configuration → Store header information in 309 data array at position 1
[Is Transaction Type = '358'?]
If the transaction type → If transaction type equals '358' then configure for 358 processing, otherwise treat as standard EDI transaction
[Set Message Type as Other EDI]
The system processes the standard EDI transaction configuration → Store header information in standard EDI data array at position 1
[Check ST Identifier]
The system checks the segment identifier → If the identifier equals 'ST ', the segment is recognized as a transaction header, otherwise it is processed as regular data
[Extract Transaction Type from ST-02]
The system processes the ST segment → The transaction type is extracted from the ST-02 field
[Transaction Type = 'REP'?]
If the transaction type → If the transaction type equals 'REP', special reporting processing is initiated, otherwise standard EDI processing is performed
[Create REP Header Structure]
The system creates the message header → A REP-specific header structure is built using the extracted partner information
[Message Type = '309'?]
If the message type → If the message type equals '309', specialized 309 processing is initiated, otherwise standard EDI processing continues
[Move EDI Header to 309 Work Array Position 1]
The system stores the header → The EDI header is placed in position 1 of the 309 work data array
[Move EDI Header to EDI Work Array Position 1]
The system stores the header → The EDI header is placed in position 1 of the standard EDI work data array
[Replace '*' with '.']
The data cleaning process is executed → All asterisk characters are replaced with period characters
[Replace ':' with '.']
The data cleaning process is executed → All colon characters are replaced with period characters
[Replace '!' with space]
The data cleaning process is executed → All exclamation mark characters are replaced with space characters
[Replace '¦' with space]
The data cleaning process is executed → All pipe characters are replaced with space characters
[Check if ST Segment?]
The segment identifier equals 'ST ' → The segment is routed for transaction header processing
[Transaction Type = 'REP'?]
The transaction type in position ST-02 equals 'REP' → Customer reporting mode is activated and partner REP destination is set
[Set Partner REP Destination]
The ST-01 destination field contains partner information → The partner REP destination is set from ST-01 field
[Set Partner Destination from ST-01]
The ST-01 field contains destination information → The partner destination is set from ST-01 field
[Set Transaction Type from ST-02]
The ST-02 field contains transaction type information → The transaction type and type of report are set from ST-02 field
[309 Reporting Type?]
The 309-reporting flag is TRUE → The header EDI data is moved to position 1 of work-309-data array
[Move Header EDI to Work-309-Data Position 1]
Header information needs to be stored → The header EDI data is moved to position 1 of the work-309-data array
[Move Header EDI to Work-EDI-Data Position 1]
Header information needs to be stored → The header EDI data is moved to position 1 of the work-EDI-data array
[Increment Line Counter]
The segment needs to be added to the work array → The line counter is incremented by 1
[CUSREP Reporting?]
CUSREP-REPORTING flag is TRUE → The transmission data is moved to the work-REP-data array at the current line counter position
[Move Data to Work-REP-Data Array]
Transmission data has been processed and cleansed → The data is stored in the work-REP-data array at the current line counter position
[309 Reporting?]
309-reporting flag is TRUE → The transmission data is moved to the work-309-data array at the current line counter position
[Move Data to Work-309-Data Array]
Transmission data has been processed and cleansed → The data is stored in the work-309-data array at the current line counter position
[Move Data to Work-EDI-Data Array]
Transmission data has been processed and cleansed → The data is stored in the work-EDI-data array at the current line counter position
[Is ST Identifier = 'ST '?]
The segment identifier equals 'ST ' (with trailing space) → The system processes the segment as a transaction header and extracts transaction details
[Is Transaction Type = 'REP'?]
The ST-02-TRANSACTION field equals 'REP' → The system activates customer reporting mode and processes the transaction as a customer report
[Extract ST-01-DESTINATION to PARTNER-DEST]
The ST-01-DESTINATION field contains partner destination information → The system moves the destination value to PARTNER-DEST field for standard EDI processing
[Extract ST-02-TRANSACTION to TS-TYPE and TYPE-OF-REPORT]
The ST-02-TRANSACTION field contains transaction type information → The system moves the transaction type to both TS-TYPE and TYPE-OF-REPORT fields for classification
[Is 309-REPORTING Flag Set?]
If the 309-REPORTING flag status → The system routes the header data to the appropriate work array based on the flag setting
[Move HEADER-EDI to WORK-309-DATA Position 1]
The system needs to initialize the work array with header data → The system places the HEADER-EDI structure in the first position of WORK-309-DATA array
[Move HEADER-EDI to WORK-EDI-DATA Position 1]
The system needs to initialize the work array with header data → The system places the HEADER-EDI structure in the first position of WORK-EDI-DATA array
[Is ST Identifier = 'ST '?]
The segment identifier equals 'ST ' → The system processes it as a transaction header segment
[Is Transaction Type = 'REP'?]
The transaction type field (ST-02-TRANSACTION) equals 'REP' → The system sets up customer reporting processing mode
[Set Partner REP Destination]
Processing the ST header segment → The system moves the destination from ST-01-DESTINATION to PARTNER-REP
[Set Partner Destination from ST-01]
Processing the header information → The system moves ST-01-DESTINATION to PARTNER-DEST
[Set Transaction Type from ST-02]
Processing the header information → The system moves ST-02-TRANSACTION to both TS-TYPE and TYPE-OF-REPORT
[Is 309 Reporting?]
Determining the reporting mode → The system checks if 309-REPORTING flag is set
[Move EDI Header to 309 Array Position 1]
Processing the header information → The system moves HEADER-EDI to position 1 of WORK-309-DATA array
[Move EDI Header to EDI Array Position 1]
Processing the header information → The system moves HEADER-EDI to position 1 of WORK-EDI-DATA array
[Increment Line Counter]
Starting to process the segment → The system adds 1 to LINE-CNT
[Does Data Start with 'NA '?]
Checking the first 7 characters of the data → The system determines if A9DP-TRANSMISSION-DATA positions 1-7 equal 'NA '
[Is CUSREP Reporting?]
Determining storage location → The system checks if CUSREP-REPORTING flag is set
[Move Data to REP Array at Line Position]
Storing the processed data segment → The system moves A9DP-TRANSMISSION-DATA to WORK-REP-DATA at LINE-CNT position
[Is 309 Reporting?]
Determining storage location → The system checks if 309-REPORTING flag is set
[Move Data to 309 Array at Line Position]
Storing the processed data segment → The system moves A9DP-TRANSMISSION-DATA to WORK-309-DATA at LINE-CNT position
[Move Data to EDI Array at Line Position]
Storing the processed data segment → The system moves A9DP-TRANSMISSION-DATA to WORK-EDI-DATA at LINE-CNT position
[Replace '*' with '.']
Data transformation rules are applied to the transmission data → All asterisk characters are replaced with period characters
[Replace ':' with '.']
Data transformation rules are applied to the transmission data → All colon characters are replaced with period characters
[Replace '!' with space]
Data transformation rules are applied to the transmission data → All exclamation characters are replaced with space characters
[Replace '¦' with space]
Data transformation rules are applied to the transmission data → All pipe characters are replaced with space characters
[Call MQCONNC to Connect to MQ Manager]
The system attempts to connect to the MQ manager using MQCONNC → A connection handle is established for subsequent message operations
[Set MQ Options for Output Operations]
The system configures queue options → MQ options are set to MQOO-OUTPUT to enable message sending operations
[Set Message Put Options with Syncpoint]
The system sets message put options → Put message options are configured with MQPMO-SYNCPOINT and MQPMO-DEFAULT-CONTEXT for transactional control
[Set Queue to GC.CCRA.INTERNAL.OUTBOUND for REP Messages]
The message type is identified as 'REP' → The system sets the output queue to 'GC.CCRA.INTERNAL.OUTBOUND'
[Set Queue to GC.CCRA.INTERNAL.OUTBOUND for 309/358 Messages]
The message type is identified as '309' or '358' → The system sets the output queue to 'GC.CCRA.INTERNAL.OUTBOUND'
[Set Header Timestamps]
Header timestamps need to be set → Current machine time is assigned to header timestamp 2, current machine date is assigned to header timestamp 2, transmission number is assigned to header timestamp 1 control number, and filler fields are set to zeros
[Set Message Format Properties]
Message format properties need to be configured → Record format is set to 'F', page number is set to 1, and page flag is set to 'L'
[Determine Message Type]
The system needs to determine message type → If CUSREP-REPORTING flag is true then REP message type is selected, else if 309-REPORTING flag is true then 309 message type is selected, else other EDI message type is selected
[Format REP Message]
The message needs to be formatted → Message length is calculated as line count multiplied by 600, text length is set to calculated message length, buffer length is calculated as message length plus 140, record length is set to 600, and work REP array is assigned to message text
[Format 309 Message]
The message needs to be formatted → Message length is calculated as line count multiplied by 330, text length is set to calculated message length, buffer length is calculated as message length plus 140, record length is set to 330, and work 309 array is assigned to message text
[Format Other EDI Message]
The message needs to be formatted → Message length is calculated as line count multiplied by 200, text length is set to calculated message length, buffer length is calculated as message length plus 140, record length is set to 200, and work EDI array is assigned to message text
[Set MQ Message Descriptor]
The message descriptor needs to be set → Message format is set to MQFMT-STRING
[Set MQ Object Descriptor Properties]
The system initializes the object descriptor → The object queue manager name and reply queue information are cleared to default values
[Clear Reply Queue Information]
The system configures message properties → Both reply queue name and reply queue manager are set to empty values
[Set Message ID to None]
The system sets up message identifiers → Both message ID and correlation ID are set to none to allow system generation
[Set Message Type to Datagram]
The system determines message communication pattern → The message type is set to datagram for fire-and-forget delivery
[Set Insert Timestamp from Header]
The system configures message timing properties → Insert timestamp and MQ put timestamp are populated from header timestamp values
[Set Record Format to Fixed 'F']
The system configures message structure properties → Record format is set to fixed 'F', page number is set to 1, and page flag is set to last 'L'
[Set Message Format to String]
The system finalizes message configuration → The message format is set to string format for text-based content
[Set Record Length = 600, Calculate Buffer = LINE-CNT * 600 + 140]
Buffer specifications need to be calculated → Set record length to 600 bytes, calculate text length as LINE-CNT multiplied by 600, and calculate buffer length as text length plus 140 bytes overhead
[Set Record Length = 330, Calculate Buffer = LINE-CNT * 330 + 140]
Buffer specifications need to be calculated → Set record length to 330 bytes, calculate text length as LINE-CNT multiplied by 330, and calculate buffer length as text length plus 140 bytes overhead
[Set Record Length = 200, Calculate Buffer = LINE-CNT * 200 + 140]
Buffer specifications need to be calculated → Set record length to 200 bytes, calculate text length as LINE-CNT multiplied by 200, and calculate buffer length as text length plus 140 bytes overhead
[Calculate REP Specifications: - Length = LINE-CNT × 600 - Record Length = 600 - Buffer = Length + 140]
The system calculates message specifications → The message length should be calculated as LINE-CNT multiplied by 600, record length should be set to 600, buffer length should be message length plus 140, and message text should be assigned from WORK-REP-ARRAY
[Calculate 309 Specifications: - Length = LINE-CNT × 330 - Record Length = 330 - Buffer = Length + 140]
The system calculates message specifications → The message length should be calculated as LINE-CNT multiplied by 330, record length should be set to 330, buffer length should be message length plus 140, and message text should be assigned from WORK-309-ARRAY
[Calculate Standard Specifications: - Length = LINE-CNT × 200 - Record Length = 200 - Buffer = Length + 140]
The system calculates message specifications → The message length should be calculated as LINE-CNT multiplied by 200, record length should be set to 200, buffer length should be message length plus 140, and message text should be assigned from WORK-EDI-ARRAY
[Calculate REP Buffer Length LINE-CNT × 600 + 140]
The system needs to calculate the buffer length for message transmission → The buffer length should be calculated as number of lines multiplied by 600 bytes plus 140 bytes overhead
[Set REP Record Length = 600]
The system configures the message format parameters → The record length should be set to 600 bytes
[Calculate 309 Buffer Length LINE-CNT × 330 + 140]
The system needs to calculate the buffer length for message transmission → The buffer length should be calculated as number of lines multiplied by 330 bytes plus 140 bytes overhead
[Set 309 Record Length = 330]
The system configures the message format parameters → The record length should be set to 330 bytes
[Calculate EDI Buffer Length LINE-CNT × 200 + 140]
The system needs to calculate the buffer length for message transmission → The buffer length should be calculated as number of lines multiplied by 200 bytes plus 140 bytes overhead
[Set EDI Record Length = 200]
The system configures the message format parameters → The record length should be set to 200 bytes
[Check Message Type]
If the message type → The system should identify whether it is CUSREP-REPORTING, 309-REPORTING, or other EDI message type
[Set MQ Put Options]
Setting up MQ put options → The system sets output options to MQOO-OUTPUT and put message options to MQPMO-SYNCPOINT plus MQPMO-DEFAULT-CONTEXT
[Set Queue Name to GC.CCRA.INTERNAL.OUTBOUND]
The transaction type is REP or 309 or 358 → The system sets the queue name to GC.CCRA.INTERNAL.OUTBOUND, otherwise generates an error message
[Configure Message Properties]
Configuring message properties → The system sets reply queue to spaces, reply queue manager to spaces, message ID to MQMI-NONE, correlation ID to MQCI-NONE, and message type to MQMT-DATAGRAM
[Set Message Format and Timestamps]
Setting up message format and timestamps → The system sets insert timestamp from header timestamp1, MQ put timestamp from header timestamp2, record format to 'F', page number to 1, page flag to 'L', and message format to MQFMT-STRING
[Calculate REP Message Length 600 bytes per record]
The report type is customer reporting (CUSREP-REPORTING) → The system calculates message length as line count multiplied by 600, sets record length to 600, calculates buffer length as message length plus 140, and moves work report array to message text
[Calculate 309 Message Length 330 bytes per record]
The report type is 309 reporting → The system calculates message length as line count multiplied by 330, sets record length to 330, calculates buffer length as message length plus 140, and moves work 309 array to message text
[Calculate Other Message Length 200 bytes per record]
The report type is neither customer reporting nor 309 reporting → The system calculates message length as line count multiplied by 200, sets record length to 200, calculates buffer length as message length plus 140, and moves work EDI array to message text
[Put Message to MQ Queue]
Executing the MQ put operation → The system calls MQPUT1 with connection handle, object descriptor, message descriptor, put options, buffer length, and message content
[Message Successfully Sent]
The completion code is not MQCC-OK → The system generates error message with reason code, sets transaction type for error context (REP or OTR), sets error text to 'PUT1 FAILED', and calls error handler, otherwise continues processing
[Set Queue to GC.CCRA.INTERNAL.OUTBOUND for REP Messages]
The message type is identified as 'REP' (customer reporting) → The system sets the output queue name to 'GC.CCRA.INTERNAL.OUTBOUND'
[Set Queue to GC.CCRA.INTERNAL.OUTBOUND for 309/358 Messages]
The message type is identified as '309' or '358' → The system sets the output queue name to 'GC.CCRA.INTERNAL.OUTBOUND'
[Set Queue to GC.CCRA.INTERNAL.OUTBOUND for REP Messages]
The message type is identified as 'REP' (customer reporting) → The system sets the output queue destination to 'GC.CCRA.INTERNAL.OUTBOUND'
[Set Queue to GC.CCRA.INTERNAL.OUTBOUND for 309/358 Messages]
The message type is identified as '309' or '358' → The system sets the output queue destination to 'GC.CCRA.INTERNAL.OUTBOUND'
[Execute MQPUT1 Call]
The system executes MQPUT1 operation with the prepared message buffer and queue descriptor → The EDI message is transmitted to the specified message queue using the configured put options and message descriptor
[Report Transmission Failure]
The system reports the transmission failure → Error is reported through CERR utility with complete error message and processing is terminated
[Skip Deletion Process]
The transmission number is '309CANCUST':
'358CANCUST'
'CUSREPCCRA'
→ The system skips the deletion process and preserves both transmission and dependent records in the database
[Delete Transmission Record from Database]
The transmission number is NOT '309CANCUST' AND NOT '358CANCUST' AND NOT 'CUSREPCCRA' → The system retrieves the transmission record using the transmission number key and deletes both the transmission segment and dependent segments from the database

Structural Validations

[9:Clean Data Content]
Data cleansing is performed → Replace '*' with '.', ':' with '.', '!' with spaces, '¦' with spaces, and change 'NA ' to 'NA ----'
[Record Found Successfully?]
The system checks the operation result status → If the status code is blank spaces, the record retrieval is considered successful, otherwise it indicates an error condition
[Handle Record Not Found Error]
The system detects the error condition → An error handling routine is invoked to process the database operation failure
[Clean Special Characters in Data, Replace * with ., Replace : with ., Replace ! with space, Replace ¦ with space]
The system processes the data → All asterisks are replaced with periods, colons are replaced with periods, exclamation marks are replaced with spaces, and pipe characters are replaced with spaces
[Data starts with 'NA '?, Replace with 'NA ----']
The system checks if data starts with 'NA ' (NA followed by 5 spaces) → The data is replaced with 'NA ----' (NA followed by space and 4 dashes)
[Replace '*' with '.']
Data cleaning process is executed → All asterisk characters are replaced with period characters throughout the transmission data
[Replace ':' with '.']
Data cleaning process is executed → All colon characters are replaced with period characters throughout the transmission data
[Replace '!' with space]
Data cleaning process is executed → All exclamation mark characters are replaced with space characters throughout the transmission data
[Replace '¦' with space]
Data cleaning process is executed → All pipe characters are replaced with space characters throughout the transmission data
[Check if data starts with 'NA ' and Replace 'NA ' with 'NA ----']
Data cleaning process checks the first 7 characters → The first 7 characters are replaced with 'NA ----' (NA followed by space and 4 dashes)
[Replace 'NA ' with 'NA ----']
The data cleaning process checks the beginning of the data → The 'NA ' is replaced with 'NA ----' in the first 7 character positions
[Replace Special Characters]
Data cleansing is performed → All '*' characters are replaced with '.', all ':' characters are replaced with '.', all '!' characters are replaced with spaces, and all '¦' characters are replaced with spaces
[Data starts with 'NA '?]
The first 7 characters equal 'NA ' → The first 7 characters are replaced with 'NA ----'
[Replace '*' with '.' in Data]
Cleaning the data segment → The system replaces all '*' characters with '.' in A9DP-TRANSMISSION-DATA
[Replace ':' with '.' in Data]
Cleaning the data segment → The system replaces all ':' characters with '.' in A9DP-TRANSMISSION-DATA
[Replace '!' with Space in Data]
Cleaning the data segment → The system replaces all '!' characters with spaces in A9DP-TRANSMISSION-DATA
[Replace '¦' with Space in Data]
Cleaning the data segment → The system replaces all '¦' characters with spaces in A9DP-TRANSMISSION-DATA
[Replace with 'NA ----']
Applying data formatting rules → The system replaces positions 1-7 of A9DP-TRANSMISSION-DATA with 'NA ----'
[Replace 'NA ' with 'NA ----']
Data transformation rules are applied to check the first 7 characters of the transmission data → The field is replaced with 'NA ----' (NA followed by space and 4 dashes)
[Generate Connection Error Message]
The system processes the connection failure → An error message is generated using the MQ reason code and formatted for business reporting
[Determine Transaction Type for Error Reporting]
The system determines the transaction type for error reporting → If CUSREP-REPORTING is true then transaction type is 'REP', otherwise transaction type is 'OTR'
[Set Error Text as 'CONN FAILED']
The system sets error context information → Program error text is set to 'CONN FAILED' to indicate the nature of the failure
[Call Error Handler]
The system needs to handle the connection error → The error handler 'CERR' is called with the complete error message for processing
[Generate Error for Invalid Message Type, Generate Error - Invalid Message Type]
The message type is not 'REP', '309', or '358' → The system generates an error message 'bad msg sent to gcx121' and calls error handling
[MQ Put Successful?]
The system checks the MQ completion code returned from the put operation → Processing continues normally if completion code equals MQCC-OK, otherwise error handling is initiated
[Capture Error Details]
The system processes the transmission failure → The MQ reason code is captured and converted to display format for error reporting
[Format Error Message]
The system formats the error message for reporting → A formatted error message is generated using the MQ error handling utility and stored in the error text field
[Determine Transaction Type for Error]
The system determines the transaction type for error context → Transaction set is marked as 'REP' if processing customer reporting messages, otherwise marked as 'OTR' for other transaction types
[Set Error Context]
The system sets the error context for the failure → Program error text is set to 'PUT1 FAILED' and complete error message is prepared for reporting
[Format Error Message with Reason Code]
The system needs to format an error message → The reason code is moved to display format and used to generate a detailed error message through GCCMQERR
[Report Disconnection Error]
The system needs to report the disconnection error → The complete error message is moved to CC-ERROR-MESSAGE and reported through CERR
[MQ Connection Error]
The connection completion code is not MQCC-OK → The system should format the error reason, determine transaction type for error context, set connection failure message, and call error handler to terminate processing
[MQ Put Message Error]
The put operation completion code is not MQCC-OK → The system should format the error reason, determine transaction type for error context, set put failure message, call error handler and terminate processing
[MQ Disconnect Error]
The disconnect completion code is not MQCC-OK → The system should format the error reason, determine transaction type for error context, set disconnect failure message, and call error handler
[Set Error Message Text]
Error message formatting is required → The system should convert reason code to display format, call error formatting utility to get error text, and store formatted error message
[Database Access Error]
The status code is populated (indicating an error) → The system should immediately call the error handler

Module: GCX129 1 Consolidated Epic Story

Epic: GCX129 Complete EDI Specification Extracted from Legacy

Contains 80 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX129 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[2:Initialize Messageway Header]
The system initializes the MessageWay header → All header fields are set to zero or spaces: header length=0, text length=0, timestamps=0, record format=space, record length=0, parse method=space, page number=0, page flag=space, and all other fields=spaces
[3:Initialize EDI Message Buffer]
The system initializes the EDI message buffer → The EDI message area is cleared to spaces
[8:Open Output Queue]
The system opens the output queue → Queue is opened for output with context passing using target queue name from user data, otherwise terminate with queue open error
[Initialize Messageway Header - Sets up 140-byte header structure with default values for message routing]
The header initialization process is executed → All header fields are set to their default values: header length to zero, text length to zero, insert timestamp to zero, MQ put timestamp to zero, record format to space, record length to zero, parse method to space, number of record mark characters to space, record mark characters to spaces, page number to zero, page flag to space, exchange way header to spaces, and filler fields to spaces
[Handle Queue Open Error]
The completion code != MQCC-OK → The system must Throw error: with reason code, set error text to 'OPEN1 FAILED', and call error handling routine
[Open Output Queue for Tandem]
The system needs to send a message to the Tandem system → The system opens the specified queue for output operations with context passing enabled

Core Acceptance Criteria

[1:Read IMS Message Queue]
The system attempts to read from IMS queue → The system continues reading until a message with valid status is received
[Message Received?]
The system checks the message retrieval status → If status code is SPACES then proceed with message processing, otherwise continue reading queue
[4:Connect to MQ Manager]
The system attempts to connect to MQ Manager → If connection is successful then proceed with queue operations, otherwise terminate with connection error
[6:Retrieve EDI Message]
The system retrieves a message from the queue → Message is retrieved using synchronous wait with syncpoint, clearing message ID and correlation ID to get any available message, otherwise handle retrieval error unless reason code is 2033
[7:Calculate Message Length]
The system calculates the message length → Find the last non-empty segment (up to 4000 segments), then find the last non-space/non-low-value character within that segment, and compute total length as (complete segments × 1024) + remaining characters
[9:Populate Message Header]
The system populates the message header → Set header length to standard constant, text length to EDI message length, put timestamp to current system time, record format to 'V', parse method to 'R', page number to 1, page flag to 'L', and clear all other header fields
[10:Send Message to Tandem]
The system sends the message to target queue → Message is sent as datagram type with no reply queue, using synchronous put with default context, and total message size equals EDI message length plus header length, otherwise terminate with put error
[11:Close Input Queue]
The system closes the input queue → Input queue handle is closed, otherwise handle closure error
[Set Program ID to GCX129]
The program begins execution → The program identifier should be set to 'GCX129' in the communication control block
[Call IMS to Read Message Queue]
The system calls the IMS interface to read from the message queue → The system should execute the IMS call with the proper parameters including communication control block, get-unique operation, IO program control block, and input message buffer
[Message Available?]
The system checks the status code returned from the IMS operation → If the status code is SPACES, a valid message is available for processing, otherwise no message is available
[Extract Queue Names and Connection Details]
The system processes the available message → The system should initialize MessageWay headers, initialize message content, get the MQ message, put the enhanced message to target queue, and close MQ connections
[Wait for Next Message]
The system completes the current read attempt → The system should continue performing IMS read operations until a valid message becomes available
[Clear EDI Message Storage Area]
The EDI message initialization process is triggered → The EDI message storage area is cleared and set to spaces to ensure clean data processing
[Connection Failed]
The completion code indicates failure → The system should format the reason code for display, initialize error message text, call error message formatting service, set connection failure error message, and invoke error handling
[Set Input Queue Name to GC.USCS.EXTERNAL.INBOUND]
Configuring the input queue connection → The queue name must be set to the configured queue manager queue name (MQTMC-QNAME)
[Configure Queue Access Options for Input with Exclusive Access]
Setting queue access options → The options must include exclusive input access (MQOO-INPUT-EXCLUSIVE) combined with context preservation (MQOO-SAVE-ALL-CONTEXT)
[Queue Ready for Reading EDI Messages]
Queue open completion code equals MQCC-OK → The system can proceed to the next step in the EDI message processing workflow
[Set Message Retrieval Options]
Message retrieval options are being configured → The system sets wait mode and syncpoint options for message retrieval
[Set Buffer Length for EDI Message]
Buffer length is being configured for message retrieval → The system sets buffer length to the maximum EDI message size constant
[Configure Wait and Syncpoint Parameters]
Wait interval is being set for message retrieval → The system uses the predefined wait interval value
[Clear Message ID and Correlation ID]
Message identifiers are being configured → The system clears both message ID and correlation ID to accept any message
[Get EDI Message from Input Queue]
The system attempts to get a message from the queue → The system calls MQ service to retrieve the message into the EDI message buffer
[Message Retrieved Successfully?]
If the retrieval result → The system considers retrieval successful if completion code is OK or if the reason is timeout (2033), otherwise it handles the retrieval issue
[Scan Message Content to Find Actual End]
The system needs to determine the actual message length → The system scans segments from 1 to 4000 until it finds a segment that is all spaces or low-values, then identifies the last non-empty segment
[Calculate Actual Message Length]
The system needs to find the precise end of message content → The system scans backwards from position 1024 in the final segment until it finds a non-space and non-low-value character, then calculates total message length as (complete segments × 1024) + remaining character position
[Scan Through 1024-byte Segments]
The system scans each segment starting from segment 1 and finds a segment containing only spaces or low-values → The system identifies this as the boundary where actual message content ends and stops scanning further segments
[Adjust Index for Last Valid Segment]
The segment index is greater than 1 → The system decrements the segment index by 1 to point to the last segment with actual content, otherwise it sets the index to 1
[Scan Backwards Within Last Segment]
The system examines each character position from the end backwards and finds a character that is a space or low-value → The system decrements the character index and continues scanning backwards until it finds the last meaningful character or reaches position 0
[Calculate Total Message Length]
The total message length needs to be calculated → The system multiplies the number of complete segments by 1024 and adds the character position within the last segment to get the total message length
[Adjust segment index if greater than 1]
The identified segment index is greater than 1 → The system subtracts 1 from the segment index to get the last segment with content, otherwise sets the index to 1
[Scan backwards in segment]
The system scans backwards through character positions and encounters a character that is a space or low-value → The system decrements the character position index and continues scanning until a non-space, non-low-value character is found or the beginning of segment is reached
[Calculate total message length]
The system needs to calculate the total message length → The system multiplies the segment index by 1024 bytes per segment and adds the character position within the last segment to get the total message length
[Scan segments for non-empty content]
The system scans each segment starting from segment 1 and checks if the segment contains all spaces or all low-values → The system continues scanning until it finds an empty segment or reaches the maximum limit of 4000 segments
[Adjust segment index if greater than 1]
The segment index is greater than 1 → The system decrements the segment index by 1 to point to the last data-containing segment, otherwise sets it to 1
[Set character index to 1024 for last segment]
Character-level scanning needs to be performed → The system sets the character index to 1024 to start scanning from the end of the segment backwards
[Calculate total message length = 'segments × 1024' + characters]
The total message length needs to be determined → The system multiplies the number of complete segments by 1024 and adds the character index from the last segment
[Scan backwards in segment]
The system needs to determine the actual message length by scanning backwards from position 1024 in the last segment → The system should move the scan position backward by 1 character each time it encounters a space or low-value character, and stop when it finds a meaningful character or reaches position 0, then calculate the final message length as (number of complete segments × 1024) + remaining character position
[Is current character space or low-value?]
The system examines the character at the current scan position → If the character is a space or low-value, the scan position should be decremented by 1, otherwise the end-found flag should be set to true to stop scanning
[Is scan position > 0 AND end not found?]
If whether to continue the backward scan loop → The scan should continue only if the scan position is greater than 0 AND the end-not-found flag is still true, otherwise the scan should terminate and proceed to calculate the final message length
[Calculate final message length]
The backward scan has completed and identified the actual end of the message data → The total message length should be calculated as (WS-EDI-SEGMENT-INDEX × 1024) + WS-EDI-SEGMENT-X-INDEX
[Set Queue Object Type to Queue]
The output queue configuration process begins → The queue object type is set to standard queue type for message operations
[Get Target Queue Name from Message Data]
The system needs to identify the destination queue → The target queue name is extracted from the first 48 characters of the message user data
[Queue Ready for Writing]
The queue open operation completes successfully → The output queue is confirmed ready for message writing operations
[Clear Header Area]
The header population process begins → All header fields are cleared to spaces
[Set Header Length to 140 bytes]
The header length field needs to be set → The header length is set to the standard constant header length value
[Set Text Length to EDI Message Size]
The header text length field needs to be populated → The text length is set to the total length of the EDI message
[Set Insert Timestamp to Zero]
The insert timestamp field needs to be initialized → The insert timestamp is set to zero
[Set MQ Put Timestamp to Current Time]
The MQ put timestamp field needs to be populated → The MQ put timestamp is set to the saved system time from when processing began
[Set Record Format to 'V' - Variable]
The record format field needs to be set → The record format is set to 'V' indicating variable-length format
[Set Record Length to Zero]
The record length field needs to be set → The record length is set to zero
[Set Parse Method to 'R' - Record]
The parse method field needs to be set → The parse method is set to 'R' indicating record-based parsing
[Clear Record Mark Fields]
Record mark fields need to be initialized → All record mark fields are set to spaces
[Clear Exchange Header Fields]
Exchange header and filler fields need to be initialized → The exchange header and filler fields are set to spaces
[Set Page Number to 1]
The page number field needs to be set → The page number is set to 1
[Set Page Flag to 'L' - Last]
The page flag field needs to be set → The page flag is set to 'L' indicating this is the last page
[Clear Messageway Header]
The system prepares to construct the header → All header fields are cleared to spaces to ensure clean initialization
[Set Header Length to 140 bytes]
The header length field needs to be populated → The header length is set to the constant value of 140 bytes
[Set Text Length to EDI Message Size]
The Messageway header text length field is populated → The text length is set to the length of the EDI message structure
[Set Timestamp to Current Time]
The timestamp field in the header needs to be set → The system time captured earlier is recorded as the message put timestamp
[Set Record Format to 'V' - Variable]
The record format field needs to be specified → The record format is set to 'V' indicating variable length records
[Set Parse Method to 'R' - Record]
The parse method field needs to be specified → The parse method is set to 'R' indicating record-based parsing
[Set Page Number to 1]
The page number field needs to be set → The page number is set to 1 indicating the first page
[Set Message Type to Datagram]
The message type needs to be specified → The message type is set to datagram indicating no reply is expected
[Calculate Total Buffer Length - EDI Message + Header]
The total buffer size for transmission is calculated → The buffer length equals the EDI message length plus the header length
[Put Complete Message to Tandem Queue]
The message is ready for transmission to Tandem → The entire message buffer is sent to the target Tandem queue using synchronous transmission

Structural Validations

[Reached Maximum 4000 Segments?]
The segment index reaches or exceeds 4000 segments → The system stops scanning and treats the current position as the end of message content
[Scan EDI message segments]
The system scans segments starting from index 1 and encounters a segment that contains all spaces or all low-values or reaches the maximum segment limit of 4000 → The system stops scanning and identifies the current segment index as the boundary for message content
[Reached segment 4000 or found empty segment?]
The segment index reaches 4000 or an empty segment (all spaces or low-values) is encountered → The scanning process terminates and proceeds to segment index adjustment
[Current character is space or low-value?]
A character at the current position is examined → If the character is a space or low-value, continue scanning backwards; otherwise, the end of actual data is found
[Character index reached 0?]
The character index reaches 0 → The scanning process stops as the beginning of the segment has been reached
[Log Close Failure Error]
The completion code != MQCC-OK → The system moves the reason code to display format, initializes error message text, calls error message formatting service, sets MQ error text, sets program error text to 'CL-2 FAILED', moves error message to communication area, and calls error handling service
[Log Disconnect Error]
The system detects the disconnection failure → The system formats the error reason code, retrieves error message text, sets disconnect failure message, and calls error handling routine

Module: GCX130 1 Consolidated Epic Story

Epic: GCX130 Complete EDI Specification Extracted from Legacy

Contains 51 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX130 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[2:Initialize Message Structures]
Message processing begins → Initialize all messageway header fields to zeros or spaces and clear EDI message content
[7:Open Output Queue]
Output queue is opened → Extract target queue name from first 48 characters of message user data, open queue for output with context passing, otherwise report queue open failure
[Handle Open Failure]
The completion code indicates failure → The system must capture the reason code, retrieve error message details, set program error text to 'OPEN2 FAILED', and call error handling
[Open Output Queue for Writing]
The system attempts to open the output queue for writing with output and pass-all-context options → The output queue should be successfully opened for message transmission
[Handle Queue Open Error]
The queue open operation fails (completion code is not OK) → The system should Throw error: indicating 'OPEN2 FAILED' and invoke error handling

Core Acceptance Criteria

[1:Read IMS Message Queue]
The system reads from IMS message queue → Continue reading until a valid message is found (status code is not spaces) and then process the message
[Message Available?]
The status code from IMS read operation is evaluated → If status code equals spaces, proceed with message processing, otherwise continue reading queue
[3:Connect to MQ Manager]
MQ connection is attempted → Connect to MQ Manager and validate connection is successful, otherwise report connection failure
[5:Retrieve EDI Message]
Message retrieval is attempted → Get message with wait interval and syncpoint control, ignore 'no message available' condition (reason 2033), otherwise report retrieval failure
[6:Calculate Message Length]
Message length calculation is performed → Scan up to 4000 segments of 1024 characters each, find last non-space/non-low-value character, and calculate total length as (complete segments × 1024) + remaining characters
[9:Send EDI Message]
EDI message is sent → Send message as datagram type with string format, use calculated length, apply syncpoint and default context, otherwise report send failure
[10:Close Input Queue]
Input queue cleanup is performed → Close input queue handle, otherwise report close failure
[Set Program ID to GCX130]
The system begins execution → The program identifier must be set to 'GCX130' for tracking and identification purposes
[Call IMS to Read Message Queue]
Reading messages from the queue → The system must continue reading until a valid message is retrieved (status code is not spaces)
[Message Status Check]
The read operation completes → If status code equals spaces then no message is available and reading should continue, otherwise a message is available for processing
[Message Successfully Retrieved]
Message processing begins → The system must initialize message headers, retrieve MQ message, put message to target queue, and close MQ connections
[Clear Messageway Header Fields]
The system initializes the Messageway header structure → All header length fields are set to zero, all text length fields are set to zero, all timestamp fields are set to zero, record format is set to space, record length is set to zero, parse method is set to space, number of RM characters is set to space, RM character fields are set to spaces, page number is set to zero, page flag is set to space, crossway header is set to spaces, and filler area is set to spaces
[Clear EDI Message Storage]
The system initializes the EDI message storage area → The EDI message storage area is set to spaces
[Set Connection Parameters]
Setting up connection parameters → The object type should be set to Queue Manager and the queue manager name should be retrieved from the trigger message configuration
[Connection Failed]
The completion code != MQCC-OK → The system should capture the reason code, Throw error: using the error handling service, set the program error text to 'CONN FAILED', and invoke the error handling routine
[Set Queue Object Type]
The queue configuration process begins → The queue object type must be set to message queue type
[Set Message Retrieval Options]
Message retrieval options are being configured → The system should set wait option and syncpoint option for transactional message processing
[Configure Wait Parameters]
Setting up message retrieval parameters → The system should use the configured wait interval for message get operations
[Clear Message Identifiers]
Message identifiers need to be cleared → The system should set message ID to none and correlation ID to none to accept any message
[Execute Message Get Operation]
Executing the message get operation → The system should call MQGET with connection handle, object handle, message descriptor, get options, buffer length, message buffer, data length, completion code and reason code
[Message Retrieved Successfully?]
The completion code is not OK and the reason code is not 2033 (no message available) → The system should treat this as a retrieval error and handle accordingly
[Scan Message Content for Data End]
Scanning message segments from index 1 to find data boundary → The system should continue scanning until it finds a segment that is all spaces or low-values, or reaches the maximum of 4000 segments, and set the segment index to the last segment with data
[Calculate Actual Message Length]
Calculating the actual message length → The system should scan backwards from position 1024 to find the last non-space and non-low-value character, then calculate total length as (number of complete segments × 1024) + position of last character
[Set Last Valid Segment Index]
The segment index is greater than 1 → The system subtracts 1 from the segment index to get the actual last valid segment, otherwise sets the index to 1
[Calculate Total Message Length]
The system needs to determine the total message length → The system multiplies the number of complete segments by 1024 and adds the number of valid characters in the last segment
[Check Current Segment]
System scans segments starting from index 1 and encounters a segment that contains all spaces:
all low-values
reaches segment index 4000
→ System stops scanning and identifies the current position as the boundary of actual message data
[Is Index > 1?]
The current segment index is greater than 1 → System decreases the segment index by 1 to point to the last segment with actual data
[Is Character Space or Low-Value?]
The character at current position is a space or low-value → System moves to the previous character position to continue searching for actual data
[Calculate Total Message Length]
Calculating total message length → System multiplies complete segments by 1024 characters per segment and adds the character position from the last segment
[Start Character Scanning]
The system begins scanning for the exact end of message content → The scanning index is set to 1024 characters and the end-not-found flag is activated
[End of Message Found OR Scan Index = 0?]
If whether to continue scanning → The loop continues if the end has not been found AND the scan index is greater than 0, otherwise the loop terminates
[Set End-Found Flag]
The system identifies this as actual message content → The end-found flag is set to true to indicate the message boundary has been located
[Calculate Final Message Length]
The system calculates the total message length → The message length equals the number of complete segments multiplied by 1024 plus the character position in the final segment
[Get Target Queue Name from Trigger Message]
The system needs to determine the target queue for message output → The target queue name must be extracted from the first 48 characters of the trigger message user data
[Identify EDI Message Portion]
The system scans through segments from index 1 until it finds a segment that contains all spaces:
all low-values
reaches the maximum limit of 4000 segments
→ The system identifies the last segment containing actual EDI data and sets the segment index to that position
[Calculate EDI Message Length Only]
The system scans backwards from the end of the last segment to find the last non-space and non-low-value character → The system calculates total EDI message length as (number of complete segments minus 1) multiplied by 1024 plus the position of the last meaningful character
[Prepare Message for Output]
The system prepares the message for output transmission → The system uses only the EDI message portion with the calculated length, effectively stripping any Messageway header from the original message
[Set Message Properties]
Message properties need to be configured → The system should set message type to datagram, report option to none, clear reply queue information, reset message ID, set format to string, and configure options for syncpoint with default context
[Send EDI Message to Output Queue]
The system puts the EDI message to the output queue using the calculated buffer length → The EDI message should be successfully transmitted to the target queue
[Call MQ Close for Output Queue Handle]
The system initiates the close operation for the output queue handle → The output queue connection is terminated

Structural Validations

[Scan EDI Message Segments]
The system encounters a segment that contains all spaces:
all low-values
reaches the maximum limit of 4000 segments
→ The system stops scanning and identifies the last valid segment containing actual data
[Scan Characters in Last Segment]
The system encounters a character that is a space or low-value at the current position AND the character index is greater than 0 → The system decrements the character index and continues scanning backward until it finds a non-space, non-low-value character or reaches position 0
[Set Index to 1]
The current segment index is not greater than 1 → System sets the segment index to 1 to maintain minimum valid position
[Character is Space or Low-Value?]
The system checks the character value → If the character is a space or low-value, it is considered padding; otherwise it is considered actual message content
[Handle Message Send Error]
The message put operation fails (completion code is not OK) → The system should Throw error: indicating 'PUT FAILED' and invoke error handling
[Handle Disconnect Error]
The completion code != MQCC-OK → The system formats error message as 'DISC FAILED', retrieves error details, and calls error handling routine

Module: GCX131 1 Consolidated Epic Story

Epic: GCX131 Complete EDI Specification Extracted from Legacy

Contains 31 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX131 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Status Fields]
Database positioning operation is initiated → All status fields and record segments are cleared to initial state

Core Acceptance Criteria

[10:Archive Eligible Records]
The system processes the eligible record → The log root segment is moved to history record structure and written to history file if no initial log dependencies are found
[13:Process Dependent Records]
The system processes dependent records → All log dependent records are retrieved and each dependent segment is written to the history file until no more dependents are found
[14:Perform Checkpoint Processing]
The system performs checkpoint processing → Checkpoint operation is executed, and if IMS shutdown request is received, then system displays shutdown message and terminates gracefully
[Display Program Version with Compile Date]
Module startup occurs → A message displaying 'GCX131 AS OF :' followed by the compilation date is shown to operators
[Display Checkpoint Setting]
Checkpoint confirmation is required → A message displaying 'GCX131 CHECKPOINTING AT' followed by the checkpoint value is shown to operators
[Use File Checkpoint Value]
The checkpoint number is numeric and greater than or equal to 1 → The system accepts the checkpoint number from the file and displays a confirmation message showing the checkpoint setting
[Display Invalid Checkpoint Message]
The system applies the default checkpoint interval → Display a message indicating invalid checkpoint and the default value being used
[Display Checkpoint Interval Message]
The checkpoint interval is successfully established → Display a message confirming the checkpoint interval that will be used for processing
[Terminate Program]
The purge configuration is not available for processing → The system must terminate the program execution as it cannot proceed without the required configuration data
[Call Database Interface]
Log record positioning is requested → Database interface is called with Get Hold Next operation, log database connection, record segment, and selection criteria
[Copy Log Root Data to History Record]
The data transfer process executes → The entire log root segment is copied to the history record structure
[Copy Dependent Record to History]
Processing each dependent record → The dependent record segment is copied to the history record structure
[Copy Log Root Data to History Record]
The system transfers the log root data → The entire log root segment is copied to the history record structure
[Copy Dependent Data to History Record]
The system processes each dependent record → The dependent record segment data is copied to the history record structure
[Move Dependent Record Data to History Structure]
The dependent record data needs to be prepared for history archival → The dependent record segment data is moved to the history record structure
[Display Shutdown Message]
The system processes the shutdown request → A shutdown notification message 'IMS SHUSTDOWN REQUEST RECEIVED BY GCX131' is displayed to the console and stored as an error message
[Terminate Processing]
The system initiates termination procedures → The system performs abnormal termination processing to gracefully shut down
[Display Shutdown Message]
The system processes the shutdown request → A shutdown notification message is displayed to the console indicating that GCX131 received the shutdown request
[Retrieve Next Log Root Record from Database]
A request is made to get the next log root record → The system executes a database call to retrieve the next hierarchical log root record and initializes the record segment
[Display Count Message to Console]
The system reaches the ending phase of processing → The system displays a message showing the total number of log root records to delete along with the count value to the console

Structural Validations

[Display Invalid Checkpoint Message]
Checkpoint validation fails → An 'INVALID CHECKPOINT - DEFAULT TO' message is displayed and the default checkpoint value is assigned
[File Read Successfully?]
The file read operation fails because the file is missing or empty → The system sets the checkpoint number to the default value (CST-CHKP-DEFAULT) and displays an invalid checkpoint message to notify operators
[Checkpoint Number Valid?]
The checkpoint number in the file is either not numeric or is less than 1 → The system rejects the invalid checkpoint number, sets it to the default value (CST-CHKP-DEFAULT), and displays an invalid checkpoint message
[File Has Data?]
The file read operation encounters an end-of-file condition indicating no data is available → The system sets the checkpoint interval to the default value and displays an invalid checkpoint message to notify operators
[Checkpoint Number Valid?]
The checkpoint number is evaluated for validity → If the number is not numeric OR is less than 1, use the default checkpoint interval and display invalid checkpoint message, otherwise use the file's checkpoint interval
[Display Error Message]
The table access operation was unsuccessful → The system must display an error message indicating that the CCN sequence number table CW was not found along with the return code
[Set Error Message for Missing Table]
The GCCTBIO operation returns an unsuccessful status → The system creates an error message stating 'CCN SEQUENCE NUMBER TABLE CW NOT FOUND RC=' concatenated with the specific return code from the failed operation
[Terminate Processing Due to Configuration Error]
The system cannot obtain the required purge day configuration settings → The system performs abnormal termination processing to safely shut down the application
[Set Error Message]
The system prepares for shutdown processing → The error message is set to indicate that GCX131 received an IMS shutdown request
[Terminate Processing with Error]
The system initiates shutdown termination → The system performs abnormal termination processing to gracefully shut down

Module: GCX131A 1 Consolidated Epic Story

Epic: GCX131A Complete EDI Specification Extracted from Legacy

Contains 25 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX131A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize retrieval parameters]
Database access parameters need to be set up → The system sets accept status to 'GE' and initializes status code and log root segment data structures

Core Acceptance Criteria

[3:Checkpoint Validation]
The checkpoint file is empty (end of file reached) → Assign the default checkpoint value and display invalid checkpoint message to console
[9:IMS Shutdown Detection]
The system detects an IMS shutdown request → Display shutdown message to console, set error message, and initiate abnormal program termination
[Use default checkpoint frequency]
The checkpoint file is read and contains no data (AT END condition) → The system sets the checkpoint number to the default value (CST-CHKP-DEFAULT) and displays a message indicating the use of default checkpoint
[Accept configured checkpoint frequency]
The checkpoint number is numeric and greater than or equal to 1 → The system accepts the configured checkpoint value and displays a message confirming the checkpoint frequency
[Use checkpoint value from file]
The checkpoint number is numeric AND the checkpoint number is greater than or equal to 1 → The system uses the checkpoint number from the file and displays a message showing the configured checkpoint value
[Accept checkpoint number as valid]
The checkpoint number is numeric and greater than or equal to 1 → The checkpoint number is accepted as valid and a checkpoint frequency message is displayed
[Display shutdown message]
The system processes the shutdown condition → A shutdown message is displayed to the console
[Trigger system abend]
The system needs to terminate abnormally → The Z999-ABEND procedure is performed to handle abnormal termination
[Display shutdown message]
The system needs to notify about the shutdown → A shutdown request message is displayed to the console
[Force program termination]
The system needs to terminate due to shutdown request → An abnormal termination procedure is executed
[Display Shutdown Message]
The system processes the shutdown condition → A shutdown notification message is displayed to the console indicating that GCX131A received the shutdown request
[Initiate Program Termination]
The system needs to terminate the program → The abnormal termination process is initiated to gracefully shut down the program
[Display Deletion Summary Report]
The system needs to report processing results → The system displays the total count of deleted log root records with the message 'NUMBER OF LOG ROOT DELETED : [count]' to the console

Structural Validations

[3:Checkpoint Validation]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ Use the default checkpoint value and display invalid checkpoint message to console
[Is checkpoint value valid?]
The checkpoint number is not numeric → The system rejects the value, sets the checkpoint number to default (CST-CHKP-DEFAULT), and displays an invalid checkpoint message
[Is checkpoint value valid?]
The checkpoint number is less than 1 → The system rejects the value, sets the checkpoint number to default (CST-CHKP-DEFAULT), and displays an invalid checkpoint message
[File contains data?]
The checkpoint file read operation reaches end of file (no data found) → The system sets the checkpoint number to the default checkpoint value and displays a message indicating the use of default checkpoint
[Checkpoint value is numeric and > 0?]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ The system sets the checkpoint number to the default checkpoint value and displays a message indicating the use of default checkpoint due to invalid data
[Set checkpoint to default value]
The checkpoint file is empty (AT END condition is true) → The checkpoint number is set to the default checkpoint value and an invalid checkpoint message is displayed
[Is checkpoint number numeric?]
The checkpoint number is not numeric → The checkpoint number is set to the default checkpoint value and an invalid checkpoint message is displayed
[Is checkpoint number greater than zero?]
The checkpoint number is less than 1 → The checkpoint number is set to the default checkpoint value and an invalid checkpoint message is displayed
[Set error message]
The system prepares for abnormal termination → The shutdown message is moved to the error message field in CCCOM
[Set error message]
The system needs to record the shutdown reason → The shutdown request message is stored in the error message field
[Set Error Message]
The system prepares for termination processing → The error message field is populated with the IMS shutdown notification text

Module: GCX132 1 Consolidated Epic Story

Epic: GCX132 Complete EDI Specification Extracted from Legacy

Contains 16 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX132 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Display Purge Time Parameter]
Initializing system parameters → The system should display the purge time value with message 'PURGE TIME FROM ADADMIN RECORD IS:' followed by GCSTBRT-AD-PURGE-DAYS-US
[Display Warning Time Parameter]
Initializing system parameters → The system should display the warning time value with message 'WARNING TIME FROM ADADMIN RECORD IS:' followed by GCSTBRT-AD-WARNING-DAYS-US
[Store Calculated Purge Date]
The calculated purge date is available → The system should store the calculated date in WS-PURGE-DATE and display a message showing all records created before this date will be purged
[Display Bond Warning Cutoff Date]
The system displays the bond warning information → A message is shown indicating 'BOND WARNING ON ALL BONDS OPENED BEFORE:' followed by the calculated cutoff date
[Display Release Report Date Message]
The system completes the date calculation process → The system displays a message indicating all manual releases after the calculated date will be reported
[Display Day21 Expiry Date for Reference]
The system needs to provide visibility into the calculated threshold date → A message is displayed showing 'REPORTING ALL 60 DAY EXPIRIES AFTER:' followed by the calculated Day21 date
[Display Day30 Expiry Cutoff Message]
The system completes the Day30 date calculation process → The system should display a message indicating all 30-day expiries will be reported after the calculated cutoff date
[Is Master Record?]
If the master record indicator flag → If the record is not a master record, it is immediately eligible for purging, otherwise additional deletion status validation is required
[Format Waybill Date from YY/MM/DD Index]
The system prepares bond report information → The waybill date index is parsed into year, month, and day components and formatted for display

Structural Validations

[Set Error Message: ADADMINID NOT FOUND]
The ADADMINID record cannot be found in GCSTBRT table → The system should set error message 'ADADMINID NOT FOUND IN GCSTBRT' in CC-ERROR-MESSAGE
[Handle Date Calculation Error]
The date calculator returns an error status → The system should create an error message containing the original date and amount values and Execute system termination
[Date Calculation Successful?]
The system checks the DTCAL-SUCCESS flag from the date calculation service → If successful, the calculated date is accepted; if failed, an error message is generated and processing is terminated
[Handle Date Calculation Error]
The DTCAL-SUCCESS flag indicates failure → An error message containing 'ISCDTCAL ERROR:' with the original date and amount is created and the system performs abnormal termination
[Handle Date Calculation Error]
The system detects the calculation failure → The system creates an error message containing the original date and calculation amount, then terminates processing
[Handle Calculation Error and Terminate Process]
The date calculation service returns an error status → An error message is constructed containing 'ISCDTCAL ERROR:', the original date, and the calculation amount, and the process is terminated
[Handle Date Calculation Error]
A date calculation error occurs → The system should format an error message with the original date and amount parameters and terminate processing with an abend

Module: GCX132A 1 Consolidated Epic Story

Epic: GCX132A Complete EDI Specification Extracted from Legacy

Contains 2 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX132A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

None explicitly identified in logic extraction.

Structural Validations

[3:Retrieve USRT Record]
The USRT record lookup is performed → If no USRT record is found, the program should terminate with an error message indicating the CCN was not found
[Record Not Found Error]
The USRT record is not found in the database → An error message is constructed stating the CCN was not found in GCSUSRT and the program abends

Module: GCX132B 1 Consolidated Epic Story

Epic: GCX132B Complete EDI Specification Extracted from Legacy

Contains 61 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX132B EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[4:Initialize Message Processing]
The system prepares for message processing → Message text is cleared, message counter is set to 3, and input files are opened for processing
[Initialize Warning Days from Administration Table]
The program accesses the GCSTBRT administration table → The system retrieves the warning days value from the administration segment and stores it for processing
[Initialize Message Text Areas]
The system performs message area initialization → The system clears all message text fields to spaces
[Initialize Message Structure]
The system initializes the message structure → All message components including user codes, text areas, and status flags are cleared to their default states
[Initialize New Message Page]
A new message page needs to be created → The system initializes new message destination parameters
[Initialize Communication Interface]
The send message process is initiated → The communication interface (CCISCOM) is called and initialized with the communication control block

Core Acceptance Criteria

[7:Generate Warning Report]
The notification data needs to be added to the warning report → The notification data is moved to the message text lines at the current counter position and the message counter is incremented by 1
[8:Manage Message Pagination]
The message line counter exceeds 699 lines → The current message is sent via Merlin, counter is reset to 3, and a new message destination is initialized with the previous Merlin user ID
[9:Send Merlin Messages]
The recipient user ID is 'OM01247' → The message is routed to 'USBOND' destination file with cleared copy user code, otherwise it is routed to 'IN' destination file
[10:Handle Message Delivery Failures]
The message delivery status is not successful → The original recipient ID is moved to keywords field, user codes are cleared, recipient is changed to 'OM01247', and message delivery is attempted again
[6:Validate Merlin User ID]
The user ID is not found in EMTZ database (status code is not space) → The system sets 'OM01247' as previous Merlin user, displays user not found message, and manages message buffer by sending existing message if buffer has 3 lines or initializing new destination
[6:Validate Merlin User ID]
The user ID is found in EMTZ database → The system updates previous Merlin user to current notification user and manages message buffer by sending existing message if buffer has 3 lines or initializing new destination with the validated user ID
[Set Initial Message Line Counter to 3]
The system initializes message processing → The system sets the message line counter to 3 to account for header and separator lines
[Extract Warning Days Configuration]
The system processes the table data → The system moves the table data to GCSTBRT-AD-SEGMENT and extracts GCSTBRT-AD-WARNING-DAYS-US value to EMI-DAYS for warning day calculations
[Set Default Checkpoint Number to 500]
The system detects a non-numeric checkpoint value → Set the checkpoint number to default value 500 and display invalid checkpoint warning message
[Display Checkpoint Number Being Used]
The checkpoint processing is complete → Display message 'GCX132B CHECKPOINTING AT [checkpoint-number]' to the console
[Clear Message Text Area]
The system prepares to create a new message structure → All message text areas are cleared to spaces to remove any previous content
[Set Initial Message Line Counter to 3]
The message structure is being initialized → The message line counter is set to 3 to account for header lines
[Set Message Header Line 1 MSG-LINE-LIBEL]
The system sets up the message header → The first message line is populated with the standard message label (MSG-LINE-LIBEL)
[Set Message Separator Line 2 MSG-LINE-SEP]
The system completes message structure initialization → The second message line is populated with the standard separator (MSG-LINE-SEP)
[Query Merlin Database EMTZ]
The system queries the Merlin EMTZ database segment using the user ID as the search key → The system performs a database lookup to verify user existence
[Set Default User OM01247]
The system needs to assign a fallback user for message routing → Set the previous user ID (PREV-MERLIN) to the default value 'OM01247'
[Use Original User ID]
The system needs to assign the user for message processing → Set the previous user ID (PREV-MERLIN) to the current notification user ID (MAN-NOTIFY)
[New Merlin User ID?]
The current Merlin user ID is different from the previously processed user ID (PREV-MERLIN) → The system validates the new user ID in the EMTZ segment and switches context to the new user
[Switch to New User Context]
The user ID lookup is successful (status code is space) → Set the previous Merlin ID to the current notification user ID (MAN-NOTIFY)
[Message Lines > 699?]
The message line counter (MERLIN-CNT) exceeds 699 lines → Send the current message via MERLIN system, reset counter to 3, and initialize new message destination with the previous Merlin user
[Switch to New User Context]
The third message line (EMI-TEXT-LINES (3)) is not empty → Send the current message via MERLIN system before initializing new destination for the new user
[Create New Message Page]
Message initialization is required → Set the destination user code to the previous Merlin user, set message counter to 3, reset sequence number to 0, and initialize message template with header and separator lines
[Add Bond Data to Report Line]
The data needs to be added to the message buffer → Move the notification data to the current message line position (EMI-TEXT-LINES at MERLIN-CNT index)
[Increment Line Counter]
The data addition is complete → Increment the message line counter (MERLIN-CNT) by 1
[Message Line Count > 699?]
The message line counter (MERLIN-CNT) exceeds 699 lines → Send the current message, reset the line counter to 3, and initialize a new message destination with the current user
[Create New Message Page]
There are existing message lines in the buffer (EMI-TEXT-LINES (3) NOT = SPACES) → Send the current message via MERLIN system and initialize a new message buffer
[Add Bond Data to Current Report Line]
The message buffer has capacity for additional lines → Copy the bond notification data to the current message line position and increment the line counter
[Line Count > 699?]
The line count exceeds 699 lines → The system triggers message pagination process
[Send Current Message Page]
The pagination process is triggered → The system sends the current message page via MERLIN system
[Reset Line Counter to 3]
The system prepares for a new message page → The message line counter (MERLIN-CNT) is reset to 3
[Set Message Headers]
Message headers need to be established → The system sets message label (MSG-LINE-LIBEL) in line 1 and separator (MSG-LINE-SEP) in line 2
[Set Recipient for New Page]
The recipient needs to be assigned to the new page → The system assigns the previous MERLIN user (PREV-MERLIN) to the message recipient field (EMI-TO-USERCODES)
[Continue Adding Bond Records]
The system is ready to process the next notification record → The current notification data (NOTIN-DATA) is added to the message buffer at the current line position and the line counter is incremented
[Increment Message Sequence Number]
The message transmission process begins → The message sequence number (EMI-SEQ) is incremented by 1
[Is Recipient Default User OM01247?]
The recipient user code is evaluated → If the recipient is 'OM01247', route to 'USBOND' destination and clear copy user code, otherwise route to 'IN' destination
[Call EMCSEND3 to Send Message]
The message transmission is executed → EMCSEND3 is called with sender information, destination filename, recipient details, subject, keywords, message text, and transmission parameters
[Message Send Successful?]
The message delivery status is not successful → Store the original recipient in keywords, clear recipient fields, set recipient to default user 'OM01247', and retry message transmission via EMCSEND3
[Increment Checkpoint Counter]
The message transmission process completes → The checkpoint call counter (CHKP-CALL) is incremented by 1
[Message Delivery Successful?]
If the delivery status → If delivery failed (return status is not successful), initiate failure handling process, otherwise complete delivery
[Capture Original Recipient ID]
The system begins failure handling → Store the original recipient ID in the keywords field for tracking purposes
[Clear Recipient Fields]
The system prepares for message redirection → Clear both the primary recipient field and copy recipient field
[Set Default User OM01247 as Recipient]
The system sets up message redirection → Assign 'OM01247' as the new recipient for the failed message
[Resend Message to Default User]
The system initiates message retry → Send the message to the default recipient using the same message sending service
[Display Shutdown Message]
The shutdown condition is confirmed → Display 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132B' message to console
[Display Shutdown Message on Console]
The shutdown condition is confirmed → Display 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132B' message on the system console

Structural Validations

[3:Process Checkpoint File]
The checkpoint file cannot be read:
the checkpoint value is not numeric
→ The system sets checkpoint number to default value 500 and displays invalid checkpoint warning message
[Display Invalid Checkpoint Message]
The system detects an invalid checkpoint condition → Display warning message 'INVALID CHECKPOINT - DEFAULT TO 500' to the console
[Clear User Codes and Status Flags]
The system initializes user codes and status information → All user codes (TO, COPY) and return status flags are set to spaces to clear previous values
[User ID Found in Database?]
If the query status code → If the status code is not space (indicating user not found), proceed with error handling, otherwise use the validated user ID
[Display User Not Found Message]
The system needs to notify about the invalid user ID → Display a console message indicating the user ID was not found along with the specific user ID value
[Switch to New User Context]
The user ID lookup fails (status code is not space) → Set the previous Merlin ID to 'OM01247' and display 'FROM MERLIN ID NOT FOUND' message with the invalid user ID
[Switch to New User Context]
The user ID lookup is performed in the EMTZ segment → If the user ID is not found, display an error message and default to 'OM01247', otherwise accept the new user ID
[Check Current Message Line Count]
The system checks the current message line counter (MERLIN-CNT) → The line count value is available for pagination decision
[Log Error Message]
The system needs to log the shutdown event → Set error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132B' and call error logging service
[Log Error Message to Error Handler]
The error logging process is initiated → Log the shutdown request message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132B' to the error handling system

Module: GCX132C 1 Consolidated Epic Story

Epic: GCX132C Complete EDI Specification Extracted from Legacy

Contains 118 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX132C EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[5:Initialize Message Structure]
Initializing message structure for a recipient → Clear all message fields, set standard message header in line 1, set standard separator in line 2, and prepare for content starting from line 3
[Initialize New Message Structure]
Message structure initialization is required → The system clears all message fields, sets standard message header in line 1, sets standard separator in line 2, and prepares for content starting from line 3
[Initialize New Message Structure]
The system needs to prepare for messages to the new user → The system clears all message fields, sets the standard message header in line 1, sets the standard separator in line 2, and prepares for content starting from line 3
[Initialize Communication Interface]
The send message process is initiated → The communication interface (CCISCOM) is called and initialized with system communication parameters
[Initialize New Message Structure]
The system needs to prepare for the next message batch → The message structure should be cleared and reinitialized with standard header template and the same destination user should be maintained
[Initialize Communication Interface]
The system begins the message send process → The communication interface (CCISCOM) is called and initialized with proper communication parameters
[Initialize Communication Interface]
The message sending process begins → The communication interface is initialized by calling CCISCOM

Core Acceptance Criteria

[8:Handle User ID Changes]
The current user ID is different from the previous user ID → If the message buffer has content in line 3, send the current message before switching users, then initialize new message destination for the new user and set message counter to 3
[9:Manage Message Capacity]
The message counter exceeds 699 lines → Send the current message, reset counter to 3, initialize new message destination for the same user
[10:Add Notification Data]
Processing a notification record → Add the notification data to the message line at the current counter position and increment the counter by 1
[12:Send Merlin Messages]
Sending a message through the messaging system → If recipient is 'OM01247', route to 'USMAN' destination and clear copy usercode, otherwise route to 'IN' destination
[13:Handle Send Failures]
The message delivery status indicates failure → Redirect the message to 'OM01247' system administrator, include original recipient in keywords, clear recipient and copy fields, and attempt delivery again
[11:Send Final Messages]
All notification records have been processed → If message buffer line 3 contains data, send the accumulated message before closing files
[Set Administration Table Flags for AD Configuration]
The system performs administration data retrieval → The GCSTBRT administration data is retrieved and stored in the administration segment variable
[Clear Message Buffer]
The system initializes message buffers → All message text areas are cleared to spaces
[Set Message Line Counter]
The system initializes message tracking counters → The Merlin message counter is set to 3 to reserve first two lines for headers
[Store Configuration Data in Program Segment]
The data retrieval operation is successful → The system moves the retrieved configuration data from GCWTBIO-GCTAB to GCSTBRT-AD-SEGMENT for program use
[Display 'Invalid Checkpoint - Default to 500']
The system sets checkpoint to default value 500 → A warning message 'INVALID CHECKPOINT - DEFAULT TO 500' is displayed to the console
[Display Final Checkpoint Number]
Checkpoint processing is complete → A message displaying 'GCX132C CHECKPOINTING AT' followed by the checkpoint number is shown on console
[Clear User Code Fields]
The initialize new destination process is executed → The recipient user code field and copy recipient user code field are cleared to spaces
[Clear Message Text Area]
The initialize new destination process is executed → The message text area is cleared to spaces
[Clear Return Status Flag]
The initialize new destination process is executed → The message return status flag is cleared to spaces
[Set Header Line 1 - Label]
The initialize new destination process sets up the message template → The first message line contains the standard message label from MSG-LINE-LIBEL
[Set Header Line 2 - Separator]
The initialize new destination process sets up the message template → The second message line contains the standard separator from MSG-LINE-SEP
[Query Merlin Database EMTZ]
The system sets the user ID as search key and performs a database lookup in the EMTZ segment → The system retrieves user information if found or returns a not found status
[User ID Not Found - Set Default User OM01247]
The validation fails to locate the user ID → The system assigns 'OM01247' as the default user ID for message processing
[User Found in Merlin Database?]
The database status code is not blank indicating user not found → Display user not found message with the user ID and set previous user to default error handler OM01247
[Set Current User as Valid]
The database status code is blank indicating successful user lookup → Set the notification user ID as the previous user for continued processing
[Continue Processing with Valid User]
Message processing continues with the validated user → If message buffer line 3 is not empty then send current message and initialize new destination, otherwise just initialize new destination with the user ID and reset message counter to 3 and sequence to 0
[Continue Processing with Default User]
Message processing continues with the default user → If message buffer line 3 is not empty then send current message and initialize new destination, otherwise just initialize new destination with the default user ID and reset message counter to 3 and sequence to 0
[Set EMTZ Search Key to User ID]
The system prepares to validate the user ID → The user ID is assigned as the search key for EMTZ segment lookup
[Execute EMTZ Database Query]
The system executes the database query → A database lookup is performed against the EMTZ segment to retrieve user information
[User ID Different from Previous?]
The current notification user ID is compared with the previous user ID → If the user IDs are different, initiate user validation and message handling process, otherwise continue with current user
[Set Default User 'OM01247']
The user validation fails → The system sets 'OM01247' as the previous user ID for message processing
[Continue with Current User]
The user validation succeeds → The system assigns the notification user ID to the previous user ID for message processing
[Accumulated Messages Exist?]
The system checks the third message line (EMI-TEXT-LINES slot 3) for content → If the third message line is not empty, accumulated messages exist and must be sent, otherwise proceed to initialize new message structure
[Send Accumulated Messages]
A user ID change occurs → The system sends all accumulated messages using the Merlin messaging system
[Set User as Message Recipient]
New message structure is being initialized → The system assigns the previous user ID to the first position of message recipient codes
[Reset Message Counter to 3]
Message counter needs to be set for content insertion → The system sets the message counter (MERLIN-CNT) to 3, which is the starting position for message content after header and separator lines
[Reset Message Sequence to 0]
Message sequence tracking needs to be reset → The system sets the message sequence number (EMI-SEQ) to 0 for the new user
[Set Default User OM01247]
The user ID validation fails → The system sets 'OM01247' as the previous user ID and displays a console message indicating the user ID was not found
[Existing Messages to Send?]
The system checks the third message line (EMI-TEXT-LINES slot 3) for existing content → If the third message line is not empty (not spaces), existing messages need to be sent, otherwise proceed with new message initialization
[Send Accumulated Messages]
The system needs to switch to a new user → The system performs the send message operation to deliver all accumulated messages for the current user
[Set User as Message Recipient]
The system needs to set the message recipient → The system assigns the previous user ID (either validated current user or default OM01247) to the first position of the message recipient codes
[Reset Message Counter to 3]
The system prepares for adding message content → The system sets the message line counter (MERLIN-CNT) to 3, which is the first available position after the standard header lines
[Reset Message Sequence to 0]
The system prepares the message sequencing → The system sets the message sequence number (EMI-SEQ) to 0 to start fresh numbering for the new user
[Increment Message Sequence Number]
The message send process begins → The message sequence number (EMI-SEQ) is incremented by 1
[Set Destination to USMAN]
The message routing is determined → The destination filename is set to USMAN and the copy usercode is cleared
[Set Destination to IN]
The message routing is determined → The destination filename is set to IN
[Execute Message Send]
The message transmission is executed → The EMCSEND service is called with all message parameters including sender, destination, recipient, subject, keywords, and message text
[Record Failed Recipient in Keywords]
The system processes the delivery failure → The original recipient ID is moved to keywords field, recipient fields are cleared, and the default recipient OM01247 is set for retry
[Retry Message Send to Default User]
The retry mechanism is executed → The EMCSEND service is called again with OM01247 as recipient and original recipient preserved in keywords
[Increment Checkpoint Counter]
The message transmission is complete → The checkpoint call counter (CHKP-CALL) is incremented by 1
[Clear Recipient User Code]
The system begins message initialization process → The recipient user code field is cleared to spaces
[Clear Copy User Code]
The system begins message initialization process → The copy recipient user code field is cleared to spaces
[Clear Message Text Area]
The system begins message initialization process → All message text lines are cleared to spaces
[Clear Return Status Flag]
The system begins message initialization process → The return status flag is cleared to spaces
[Set Header Label Line]
The system sets up the message template → The first message line contains the standard message label from MSG-LINE-LIBEL
[Set Header Separator Line]
The system sets up the message template → The second message line contains the standard separator from MSG-LINE-SEP
[Check Message Line Count]
The message line counter exceeds 699 lines → The current message should be sent immediately and the line counter should be reset to 3 for the next message
[Continue Processing]
Notification data needs to be added to the current message → The notification data should be placed in the current message line position and the message line counter should be incremented by 1
[Add Notification Data - Append notification data to message text lines and increment line counter]
The notification data needs to be added to the message → The notification data is placed in the message text line at the current counter position and the line counter is incremented by one
[Final Messages Exist in Buffer?]
The system checks if there are accumulated messages in the third line of the message buffer (EMI-TEXT-LINES slot 3) → If messages exist in the buffer (EMI-TEXT-LINES slot 3 is not empty spaces), send the accumulated messages via the messaging system before program termination
[Setup Communication Interface]
The send message process is initiated → The communication interface is properly configured for message transmission
[Increment Message Sequence]
The message sequence tracking is updated → The message sequence number is incremented by 1
[Is User OM01247?]
The recipient user code is OM01247 → The message destination is set to USMAN and copy user code is cleared
[Set Destination to USMAN Clear Copy User]
Message destination parameters are being configured → The destination filename is set to USMAN and the copy user code is cleared to spaces
[Set Destination to IN]
Message destination parameters are being configured → The destination filename is set to IN
[Send Message via EMCSEND]
The message transmission is initiated → The message is sent through the EMCSEND messaging service with all required parameters
[Send Successful?]
The message transmission status is not successful → The failed message handling process is initiated
[Store Failed User in Keywords]
The failure handling process begins → The original recipient user code is stored in the message keywords field for tracking
[Redirect to OM01247 User]
The message redirection process is executed → The recipient is changed to OM01247 and user codes are cleared
[Set Destination to USMAN]
The destination parameters are being set for the retry → The destination filename is set to USMAN for administrative handling
[Retry Send Message]
The retry send process is initiated → The message is sent again through EMCSEND with the administrative destination
[Increment Checkpoint Counter]
The message send process completes → The checkpoint call counter is incremented by 1
[Set Destination to USMAN]
The recipient user ID is OM01247 (default/error user) → Set the message destination to USMAN and clear any copy user code
[Set Destination to IN]
The recipient user ID is not OM01247 (regular business user) → Set the message destination to IN for standard user delivery
[Clear Copy User Code]
The destination is set to USMAN → Clear the copy user code to ensure no additional recipients receive the system message
[Increment Message Sequence Number]
The system processes the message send operation → The message sequence number (EMI-SEQ) is incremented by 1
[Is Recipient OM01247?]
The recipient is evaluated for routing determination → If recipient is 'OM01247' then destination is set to 'USMAN', otherwise destination is set to 'IN'
[Set Destination to USMAN]
The system determines the message destination → The destination filename is set to 'USMAN' and copy usercode is cleared
[Set Destination to IN]
The system determines the message destination → The destination filename is set to 'IN'
[Execute EMCSEND Call]
The system executes the message send operation → EMCSEND service is called with communication interface, sender code, destination filename, recipient code, copy recipient, subject, keywords, message text, and return status parameters
[Capture Failed Recipient ID]
The system processes the send failure → The original recipient usercode is moved to the keywords field for tracking purposes
[Redirect Message to Default User OM01247]
The system redirects the failed message → Recipient and copy recipient fields are cleared, and primary recipient is set to 'OM01247'
[Increment Checkpoint Counter]
The system finalizes the message processing → The checkpoint call counter (CHKP-CALL) is incremented by 1
[Complete Message Send Operation]
The system finalizes the message send operation → The message send operation is marked as complete and control returns to the calling process
[Increment Message Sequence Number]
The message sending process is initiated → The message sequence number (EMI-SEQ) is incremented by 1
[Check Recipient User Code]
The recipient user code is OM01247 → The destination filename is set to USMAN and copy user code is cleared to spaces
[Set Destination to IN]
The recipient user code is not OM01247 → The destination filename is set to IN
[Execute EMCSEND Call with All Parameters]
The message transmission is executed → EMCSEND is called with communication interface, sender code, destination filename, recipient code, copy recipient code, subject, keywords, text, and return status flag
[Store Failed User in Keywords]
The message send status indicates failure → The original recipient user code is moved to EMI-KEYWORDS for tracking purposes
[Clear Recipient Fields]
Preparing for message retry → EMI-TO-USERCODE and EMI-COPY-USERCODE are cleared to spaces
[Set Default User OM01247 as New Recipient]
Preparing to retry the message delivery → OM01247 is set as the new recipient in EMI-TO-USERCODES(1)
[Retry EMCSEND Call to Default User]
Retrying the message transmission → EMCSEND is called again with the same parameters but with OM01247 as the recipient
[Increment Checkpoint Counter]
The message sending process finishes → CHKP-CALL counter is incremented by 1
[Send Successful?]
The message send operation fails (EMI-RETURN-STATUS-FLAG is not SUCCESSFUL) → The system must preserve the original recipient ID in the keywords field, clear the recipient and copy recipient fields, set the default user OM01247 as the new recipient, and retry sending the message to the default user
[Preserve Original Recipient in Keywords]
The system is preparing to redirect the message to the default administrator → The original recipient ID from EMI-TO-USERCODES(1) must be moved to the EMI-KEYWORDS field to preserve the original destination information
[Clear Recipient Fields]
The system is preparing to set new recipient information for redirection → Both EMI-TO-USERCODE and EMI-COPY-USERCODE fields must be cleared to spaces
[Set Default User OM01247 as Recipient]
The system is setting up the redirection target for the failed message → The default administrator user ID OM01247 must be assigned to EMI-TO-USERCODES(1) as the new recipient
[Retry Send to Default User]
The system is ready to retry the message send operation → The EMCSEND service must be called again with the updated recipient information to attempt delivery to the default administrator
[Display Shutdown Message]
The system processes the shutdown request → Display 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132C' message and log error message
[Close All Files]
The system prepares for termination → Close CHKP-FILE and NOTIN-FILE to ensure data integrity
[Close CHKP-FILE]
The program reaches normal termination point without receiving an IMS shutdown request → The checkpoint file must be closed followed by the notification file closure
[Emergency Close CHKP-FILE]
An IMS shutdown request is received with status code 'XD' → Both checkpoint file and notification file must be immediately closed before program termination
[IMS Shutdown Request?]
A checkpoint call returns with status code 'XD' indicating an IMS shutdown request → The system must log the shutdown request, close all files, and terminate the program immediately

Structural Validations

[4:Process Checkpoint File]
The system attempts to read the checkpoint file and the file is at end or contains non-numeric data → The system assigns checkpoint number 500 as the default value and displays an invalid checkpoint message
[File Empty or Missing?]
The checkpoint file is missing or empty (AT END condition) → The checkpoint number is set to 500 and invalid checkpoint flag is set to 'Y' and error message is displayed
[Checkpoint Data is Numeric?]
The checkpoint data (IN-CHKP) is evaluated for numeric content → If numeric, the checkpoint number is set from file data, otherwise checkpoint number is set to 500 and error message is displayed
[User ID Found in Database?]
The system checks the database query status code → If status code is SPACE (successful), the user ID is valid; if status code is not SPACE, the user ID is invalid
[Display Error Message to Console]
The system cannot locate the user ID → The system displays 'FROM MERLIN ID NOT FOUND' message with the invalid user ID to the console
[Query EMTZ Segment for User ID]
The system queries the EMTZ segment using the user ID as search key → The system determines if the user ID exists based on the database response status
[User ID Found in Merlin?]
The system performs a lookup in the EMTZ segment using the user ID as key → If the lookup returns a status code other than space, the user ID is not found and system uses default user OM01247, otherwise the user ID is valid
[User ID Found in Database?]
The system performs a lookup in the EMTZ segment using the user ID as the key → If the lookup returns a status code other than space, the user ID is considered not found, otherwise the user ID is valid
[User ID is Invalid - Display Error Message]
The system determines the user ID is invalid → Display error message 'FROM MERLIN ID NOT FOUND' with the invalid user ID to console
[Send Successful?]
If the send operation result → If return status flag equals SUCCESSFUL then proceed to checkpoint increment, otherwise initiate error handling process
[Re-execute EMCSEND for Error Handling]
The system attempts error recovery → EMCSEND service is called again with the redirected message parameters including communication interface, sender code, destination filename, recipient code, copy recipient, subject, keywords, message text, and return status
[Message Send Successful?]
The message send operation completes → The system checks if EMI-RETURN-STATUS-FLAG equals SUCCESSFUL

Module: GCX132D 1 Consolidated Epic Story

Epic: GCX132D Complete EDI Specification Extracted from Legacy

Contains 183 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX132D EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Empty B1 Segment]
The system processes the B1 lookup result → Initialize an empty B1 segment structure
[Initialize Merlin Message Structure]
The system prepares the Merlin message structure → The GCX105-INPUT structure is initialized to clear any previous data
[Initialize Empty BK Segment]
Handling the missing broker data → Initialize GCSTBRT-BK-SEGMENT to empty/default values
[Initialize Empty B1 Segment]
The table access returns unsuccessful status (return flag not equal to '0') → The B1 segment structure is initialized to empty/default values
[Initialize Broker Message Structure]
The system prepares the broker message structure → The GCX108-INPUT structure is initialized to clear any previous values
[Initialize Notification Message]
The system prepares to send the notification → The GCX108 input structure is initialized and the internet address from B1 segment is moved to the internet field
[Initialize Message Structure]
The system prepares to create an internet notification message → The GCX108-INPUT message structure is initialized to clear any previous data
[Initialize Fax Message]
The system initializes fax message parameters → The GCX108 input structure is cleared and prepared for fax data
[Initialize Message Pointer]
The message pointer needs to be initialized → The message pointer should be set to null to indicate no existing message reference
[Initialize N9 Counter to Zero]
The system begins N9 segment processing → The N9 counter is set to zero to start sequential processing
[Initialize Shipment Counter]
The system prepares to process N9 reference numbers → The N9 counter is set to zero to begin sequential processing
[Initialize N9 Counter to Zero]
The system prepares to process multiple N9 reference entries → The N9 counter is set to zero to begin sequential processing
[Initialize N9 Counter to Zero]
The system begins processing the N9 segments → The N9 counter is set to zero to start iterating through available segments

Core Acceptance Criteria

[9:Notify Broker System]
The cargo SCAC is not CPRS or EDI was not sent electronically or broker is unknown or not required → The system skips broker notification processing for this cargo
[12:Create Audit Log Entry]
The audit log entry is created → The system records the cargo CCN, sets security byte to high values, marks as US cargo deletion, sets action code to 'ZZZ', includes message 'PRELIMINARY MANIFEST > 60 DAYS - DELETED', records sending transaction as 'GCX132D', captures user ID, and timestamps with current date and time
[14:Process EDI Transmission]
The port is valid and cargo type is Export or US-CAN-US or Multi-Transit → The system uses GCCS309E processing, otherwise uses standard GCCS309 processing
[15:Notify Interchange Hub]
The station index lookup in the IH table is performed → If the station index is found in the IH table, the system creates an interchange hub notification with record type as US-CARGO, status as 'DELETED', and includes car ID, waybill, and CCN information
[16:Extract Shipment Reference]
N9 segments are available for the cargo → The system searches through up to 20 N9 segments and extracts the reference number where the qualifier equals 'CN' as the shipment ID
[Use Default Value]
The system determines the checkpoint value is unusable → The system assigns the default checkpoint value and displays an invalid checkpoint message to the console
[Abort Processing]
The system cannot proceed without the cargo details → Processing is aborted and system error handling is invoked
[Call Email Send Service]
Email transmission is required → The system should call the EMCSEND2 service with all configured parameters including from user code, destination filename, to user code, copy user code, subject, keywords, text, and return status flag
[Call Email Send Function EMCSEND2]
The email send function is called → The system calls EMCSEND2 with sender code, destination, recipient, copy recipient, subject, keywords, message text, status flag, and segment information
[Broker Config Found?]
The broker configuration is not found → Initialize broker segment to spaces and proceed to set default notification methods
[Retrieve Additional Broker Details from B1 Table]
The system needs additional broker details → Query B1 table using same sequence ID, and if found use the data, otherwise initialize B1 segment to spaces
[BK Record Found?]
The BK table lookup returns a non-zero status → Initialize an empty BK segment and continue processing
[Store BK Configuration]
The system processes the lookup result → Move the table segment data to the BK segment structure for further processing
[Store B1 Configuration]
The system processes the B1 lookup result → Move the table segment data to the B1 segment structure
[Set Cargo CCN Key in Message]
The system prepares the Merlin deletion message → The cargo's US-CCN key is copied to the GCX105-TRAIN-OR-US-CCN field in the message
[Set Security Level to High Value]
The system sets the security parameters → The GCX105-SECURITY-BYTE is set to HIGH-VALUES to indicate maximum security level
[Mark Message as Delete Action]
The system sets the cargo type indicator → The GCX105-US-CARGO flag is set to TRUE to indicate this is a US cargo operation
[Mark Message as Delete Action]
The system sets the action code → The GCX105-ACTION-CODE is set to 'ZZZ' to indicate a deletion action
[Prepare Message for Transmission]
The system sets the message text → The GCX105-MESSAGE is set to 'PRELIMINARY MANIFEST > 60 DAYS - DELETED' to explain the deletion reason
[Prepare Message for Transmission]
The system sets the transaction identifier → The GCX105-SENDING-TRANSACTION is set to 'GCX132D' to identify the source program
[Prepare Message for Transmission]
The system sets the user identification → The GCX105-ACF2-ID is set to the CC-ACF2-USERID from the common communication area
[Prepare Message for Transmission]
The system sets the timestamp information → The GCX105-DATE is populated with CC-MACHINE-CENTURY in positions 1-2 and CC-MACHINE-DATE in positions 3-6
[Prepare Message for Transmission]
The system sets the time information → The GCX105-TIME is set to CC-MACHINE-TIME from the common communication area
[Calculate Message Length]
The system calculates transmission parameters → The EXCI-COMM-LL is computed as GCT1051E-MSG-LGTH plus 4 bytes for the length field
[Calculate Message Length]
The system calculates the total call data length → The EXCI-CALL-DATA-LEN is computed as the length of EXCI-COMMAREA-HDR plus GCT1051E-MSG-LGTH
[Send Message via EXCI Interface]
The system initiates message transmission → The CSIEXCI program is called with the prepared message data and communication parameters
[Set Success Status]
The system updates the return status → The CC-RETURN-CODE is set to RC-SUCCESS in the common communication area
[Set Failure Status]
The system updates the return status → The CC-RETURN-CODE is set to RC-FAIL in the common communication area
[Prepare Deletion Message]
The system prepares to send internet notification → The system should initialize GCX108-INPUT structure and move the internet address to GCX108-INTERNET field
[Send Internet Notification]
The system is ready to send the internet notification → The system should Execute D200-SPAWN-GCT1081E-PRINT to execute the internet notification
[Call CSIEXCI to Send Fax]
The system invokes the external fax service → The system should call CSIEXCI program to transmit the fax notification
[BK Record Found?]
No matching broker configuration record is found → Initialize empty BK segment with default values
[B1 Record Found?]
No matching supplementary configuration record is found → Initialize empty B1 segment with default values
[Load BK Segment Data]
Processing the retrieved broker data → Move the table segment data to GCSTBRT-BK-SEGMENT for further processing
[Move B1 Data to Work Segment]
The table access returns successful status (return flag equals '0') → The retrieved B1 table data is moved from work table segment to B1 segment structure
[BK Configuration Found?]
The BK table lookup returns no results → Initialize empty GCSTBRT-BK-SEGMENT configuration and continue processing
[B1 Configuration Found?]
The B1 table lookup returns no results → Initialize empty GCSTBRT-B1-SEGMENT configuration and continue processing
[Set Cargo CCN Key in Message]
Preparing the Merlin notification message → The cargo's US-CCN key is copied to the GCX108-US-CCN field in the message
[Set Security Level to High Value]
Setting the security level for the message → The GCX108-SECURITY-BYTE is set to HIGH-VALUE to indicate high security clearance
[Mark Message as Delete Action]
Preparing the notification message → The GCX108-DELETE flag is set to TRUE to indicate this is a deletion notification
[Prepare Message for GCT1081E Transaction]
Preparing for transaction processing → The GCX108-INPUT is moved to GCT1081E-MSG and the transaction name is set to GCT1081E
[Calculate Message Length]
Calculating the communication parameters → EXCI-COMM-LL is computed as GCT1081E-MSG-LGTH plus 4, and EXCI-CALL-DATA-LEN is computed as the length of EXCI-COMMAREA-HDR plus GCT1081E-MSG-LGTH
[Call CSIEXCI to Send Message]
Transmitting the message via CSIEXCI → The CSIEXCI program is called with the prepared message parameters to send the notification
[Set Success Status]
Recording the transmission result → RC-SUCCESS is moved to CC-RETURN-CODE to indicate successful completion
[Set Failure Status]
Recording the transmission failure → RC-FAIL is moved to CC-RETURN-CODE to indicate transmission failure
[Set US CCN Key from Cargo Record]
The system prepares the notification message structure → The cargo's US CCN key must be set as the primary identifier in the notification message
[Set Security Byte to High Value]
The system sets the security parameters for the message → The security byte must be set to high value to indicate maximum security clearance
[Set Message Type to DELETE]
The system prepares the message action type → The message type must be set to DELETE to indicate cargo removal
[Prepare Message Structure for GCT1081E]
The system formats the notification message → The message must be structured according to GCT1081E format with all required fields populated
[Calculate Message Length]
The system prepares for message transmission → The message length must be calculated as GCT1081E message length plus 4 bytes for communication header
[Set Transaction Name to GCT1081E]
The system sets the transaction identifier → The transaction name must be set to GCT1081E to identify it as a broker notification transaction
[Prepare Communication Data]
The system prepares the communication data structure → The GCT1081E message content must be moved to the communication data area and the total call data length must be calculated including the communication header
[Get Internet Address from B1 Table]
The system needs to send internet notification → The internet address is retrieved from the B1 table segment and used for notification
[Send Internet Notification via GCT1081E]
The system sends the internet notification → The notification is delivered via GCT1081E transaction with the cargo deletion details
[Set US CCN Key from Cargo Record]
The system creates an internet deletion notification message → The cargo's US-CCN key is assigned to the notification message US-CCN field
[Set Security Byte to High Value]
The system sets security parameters for the message → The security byte is set to high-value to indicate maximum security level
[Set Message Type to DELETE]
The system prepares the notification message type → The message type is set to DELETE to indicate this is a deletion notification
[Move Internet Address to Message]
The system prepares an internet deletion notification → The broker's internet address from B1 table is assigned to the notification message
[Prepare Message for Transmission]
The system prepares the message for transmission → The GCX108-INPUT data is moved to the GCT1081E-MSG transmission structure
[Calculate Message Length]
The system prepares transmission parameters → The communication length is calculated as GCT1081E message length plus 4 bytes for header, and call data length is calculated as communication area header length plus GCT1081E message length
[Set Broker Fax Number]
The system prepares the fax message → The broker's fax number is assigned to the fax notification field
[Set Cargo Key Information]
The system prepares cargo information for fax notification → The cargo US-CCN key is assigned to the fax message and security byte is set to high value
[Set Delete Action Flag]
The system sets the action type for the notification → The delete flag is set to true in the fax message
[Send Fax Notification]
The system executes the fax notification process → The GCT1081E print transaction is spawned to send the fax notification
[Set Cargo Control Number in Message]
The fax message structure is being prepared → The cargo control number from the cargo record should be set in the message US-CCN field
[Set Security Level to High Value]
The message security level needs to be established → The security byte should be set to high value to indicate maximum security clearance required
[Mark Message Type as DELETE]
The message type indicator needs to be set → The message should be marked as DELETE type to indicate this is a deletion notification
[Move Input Data to Message Structure]
The final message structure needs to be populated → The complete input data should be moved to the message structure for transmission
[Clear Accept Status]
The processing status needs to be initialized → The accept status should be cleared to blank spaces to indicate ready for processing
[Calculate Message Length]
The communication parameters need to be established → The communication length should be calculated as message length plus 4 bytes for header information
[Move Message Data to Communication Area]
The data needs to be prepared for external communication → The message data should be moved to the communication data area using the calculated message length
[Calculate Total Data Length]
The total communication data length needs to be determined → The call data length should be calculated as the sum of communication area header length and message length
[Add Deletion Message: 'PRELIMINARY MANIFEST > 60 DAYS - DELETED']
Adding the deletion reason message → The GCX105-MESSAGE is set to 'PRELIMINARY MANIFEST > 60 DAYS - DELETED' to document the deletion reason
[Format Audit Message Structure]
Preparing the audit message for transmission → The GCX105-INPUT is moved to GCT1051E-MSG to format the message for the transaction system
[Send Audit Entry to Transaction System]
Sending the audit entry to the transaction system → The CSIEXCI program is called with the formatted audit message to transmit it to the external system
[Set Audit Message Text]
Creating the audit message → The message (GCX105-MESSAGE) must be set to 'PRELIMINARY MANIFEST > 60 DAYS - DELETED'
[Prepare Transaction Message]
Preparing to send to the transaction system → The audit input structure (GCX105-INPUT) must be moved to the transaction message structure (GCT1051E-MSG)
[Send to Transaction System via EXCI]
Sending the audit entry to the transaction system → The system must call 'CSIEXCI' with the transaction name 'GCT1051E' and the prepared message data
[Mark Audit Entry Complete]
Updating the completion status → The system return code (CC-RETURN-CODE) must be set to RC-SUCCESS
[Add Deletion Message Text]
The deletion reason needs to be documented → The message must be set to 'PRELIMINARY MANIFEST > 60 DAYS - DELETED' to indicate the business rule that triggered the deletion
[Format Complete Audit Message]
The audit message needs to be prepared for transmission → The complete GCX105-INPUT structure must be moved to the audit message format GCT1051E-MSG
[Prepare Message for Audit System]
The message needs to be sent to the external audit system → The system must prepare the message for EXCI transmission by setting the transaction name to GCT1051E, calculating message length, and configuring communication parameters
[Process EDI Transmission - Determine and call appropriate EDI processing based on cargo type (export/transit)]
If cargo type against port validity status → Enhanced EDI processor (GCCS309E) is called for valid ports with export, US-Canada transit, or multi-transit cargo types, otherwise standard EDI processor (GCCS309) is called
[Set Delete Action Flag]
EDI transmission processing begins → The delete action flag is set to true in the EDI work area
[Set GCX107 Transmission Flag]
EDI processing flags are being configured → The GCX107 transmission flag is set to true in the EDI work area
[Move Cargo Key to Work Area]
EDI work area is being prepared for transmission → The cargo's US-CCN key is moved to the EDI work area US-CCN key field
[Valid Port AND Export Cargo?]
The port is valid and the cargo is classified as export movement (M1109) → The enhanced EDI processor GCCS309E is selected for processing
[Valid Port AND US-Canada Transit?]
The port is valid and the cargo is classified as US-Canada-US movement (M1201) → The enhanced EDI processor GCCS309E is selected for processing
[Valid Port AND Multi-Transit?]
The port is valid and the cargo is classified as multi-transit movement (M1201) → The enhanced EDI processor GCCS309E is selected for processing
[Call Enhanced EDI Processor GCCS309E]
The cargo has a valid port and is classified as export, US-Canada transit, or multi-transit → The enhanced EDI processor GCCS309E is called with the configured work area
[Call Enhanced EDI Processor GCCS309E]
The port is valid AND the cargo is export type → The system calls the enhanced EDI processor GCCS309E to handle the cargo deletion
[Call Enhanced EDI Processor GCCS309E]
The port is valid AND the cargo is US-Canada-US transit type → The system calls the enhanced EDI processor GCCS309E to handle the cargo deletion
[Call Enhanced EDI Processor GCCS309E]
The port is valid AND the cargo is multi-transit type → The system calls the enhanced EDI processor GCCS309E to handle the cargo deletion
[Is Export Cargo?]
If cargo type for EDI processing → The system checks if cargo is marked as export type (M1109-EXPORT) to determine processing path
[Is US-Canada-US Transit?]
If cargo transit type for EDI processing → The system checks if cargo is marked as US-Canada-US transit type (M1201-US-CAN-US) to determine processing path
[Is Multi-Transit?]
If cargo transit type for EDI processing → The system checks if cargo is marked as multi-transit type (M1201-MULTI-TRANSIT) to determine processing path
[Call Enhanced EDI Processor GCCS309E]
The system needs to process EDI transmission for the cargo → The system invokes the enhanced EDI processor GCCS309E with cargo deletion action and GCX107 transmission type
[Call Standard EDI Processor GCCS309]
The system needs to process EDI transmission for the cargo → The system invokes the standard EDI processor GCCS309 with cargo deletion action and GCX107 transmission type
[Look up Station in IH Table]
The system needs to notify the interchange hub of cargo deletion → The system looks up the station index in the IH table using the station index from the cargo record
[Set Record Type to US Cargo]
The system prepares the interchange hub notification → The system sets the record type to US Cargo in the notification record
[Set Status to DELETED]
The system sets the cargo status → The system sets the status to 'DELETED' in the notification record
[Get Car ID from Cargo Record]
The system prepares interchange hub notification data → The system assigns the car ID number index from the cargo record to the notification car ID field
[Get Waybill Number from Cargo Record]
The system prepares interchange hub notification data → The system assigns the first 15 characters of the waybill number index from the cargo record to the notification waybill field
[Get CCN Key from Cargo Record]
The system prepares interchange hub notification data → The system assigns the US CCN key from the cargo record to the notification CCN field
[Send Notification to Interchange Hub]
The system is ready to send the notification → The system calls the interchange hub interface program with the prepared notification data
[Station Found in IH Table?]
The lookup returns a successful result (return flag equals '0') → The system proceeds with creating the interchange hub notification
[Set Cargo Status to DELETED]
The system prepares the interchange hub notification → The system sets the record type to US-CARGO and the CCN status to 'DELETED'
[Extract Car ID from Cargo Record]
The system prepares interchange hub notification data → The system copies the car ID number index to the interchange hub car ID field
[Extract Waybill Number from Cargo Record]
The system prepares interchange hub notification data → The system copies the first 15 characters of the waybill number index to the interchange hub waybill field
[Extract CCN Key from Cargo Record]
The system prepares interchange hub notification data → The system copies the US-CCN key to the interchange hub CCN field
[Get N9 Segment Data for Shipment Reference]
The system calls the database to retrieve N9 segment data using the US-CCN key → The system successfully retrieves the N9 segment data if it exists
[Extract Shipment ID from N9 CN Qualifier]
The system iterates through 20 N9 reference entries and finds a qualifier equal to 'CN' → The system copies the corresponding reference number to the interchange hub shipment ID field
[Send Deletion Notification to Interchange Hub]
The system calls the interchange hub interface program → The system transmits the deletion notification to the interchange hub
[Use Cargo CCN Key to Access N9 Segments]
The system needs to access N9 reference segments → The system uses the US-CCN key to retrieve the corresponding N9 segment data from GCSUSS02
[Loop Through 20 N9 Segments Maximum]
The system processes N9 segments → The system iterates through a maximum of 20 N9 segments, incrementing the counter for each segment processed
[Extract Reference Number as Shipment ID]
The system processes the reference number → The system moves the N902 reference number to the shipment ID field in the hub notification record
[Use Cargo Manifest Key as Search Key]
The system needs to extract shipment reference information → The cargo manifest key is used as the search key to retrieve N9 segment data from GCSUSS02
[Retrieve N9 Segment Data from GCSUSS02]
The system attempts to retrieve N9 segment data → The system calls the database interface to get N9 segment records from GCSUSS02 using the cargo key
[Loop Through N9 Reference Records]
The system processes N9 reference records → The system increments the counter and processes each record sequentially for a maximum of 20 iterations
[Store Shipment ID for Interchange Notification]
The system prepares interchange notification data → The shipment ID is moved to the interchange notification shipment ID field
[Use US CCN Key to Access GCSUSS02]
The system needs to retrieve N9 segment data from GCSUSS02 → The system uses the US CCN key to access the GCSUSS02 database and sets accept status to 'GE'
[Counter < 20?]
The system processes N9 reference entries sequentially → Continue processing while counter is less than 20, otherwise complete N9 processing
[Retrieve N9 Segments from GCSUSS02]
The system needs to retrieve N9 reference segments → The system calls CIMS to get N9 segments from GCSUSS02 using the cargo US-CCN key
[Process Next N9 Segment]
The system processes N9 segments → The system increments the N9 counter by 1 and processes up to 20 N9 segments maximum
[Reference Qualifier = 'CN'?]
The system examines the reference number qualifier → If the N901 reference qualifier equals 'CN', identify this as a shipment reference, otherwise continue to next segment
[Extract Shipment ID from Reference Number]
The system processes this shipment reference segment → The system moves the N902 reference number value to the shipment ID field for interchange notification
[More N9 Segments to Process?]
An N9 segment has been processed → If the counter is less than 20, continue processing the next N9 segment, otherwise complete N9 processing
[Checkpoint Successful?]
The checkpoint operation returns a non-space status code indicating failure or shutdown request → The system displays a shutdown message and terminates the program
[Display Shutdown Message]
The system detects the shutdown request → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132D' is displayed on the console
[Terminate Program]
The system processes the shutdown request → The program execution is terminated through the error handling routine
[Display Shutdown Message]
Handling checkpoint failure → The system should display 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132D' message to the console
[Terminate Program]
Terminating the program due to checkpoint failure → The system should call the error handling routine to terminate the program

Structural Validations

[2:Read Checkpoint Configuration]
The file is not found or the checkpoint number is not numeric or less than 1 → The system sets the checkpoint number to the default value and displays an invalid checkpoint message
[6:Validate Port Location]
The port location ID field is blank or contains only spaces → The system displays a message indicating the location ID is blank and skips port validation
[Set Default Checkpoint Value]
The checkpoint file is empty or at end of file → The system sets the checkpoint number to the default value and displays an invalid checkpoint message
[Set Error: US-CCN Not Found]
The cargo record does not exist in the database → The error message 'US-CCN NOT FOUND IN GCSUSRT' is set in the system error field
[Set Error: US-CCN Not Found]
The database status indicates the record was not found → The system sets an error message 'US-CCN NOT FOUND IN GCSUSRT' and initiates error handling procedures
[Location ID Available?]
The system checks if GCUSRT-P401-LOCATION-ID is not blank spaces → The system proceeds to validate the location ID against the SE table if available, otherwise displays a blank location message
[Display Location ID Blank Message]
The system attempts to validate the port location → The system displays 'GCUSRT-P401-LOCATION-ID IS BLANK' message
[Log Email Error]
Error logging is required → The system should move the return status flag to the error message code and set the error message in the common communication area
[Log Error Message]
Error handling is required → The system moves the return status flag to error message code, sets the error message, and calls the error handler
[Is EDI Sent Electronically?]
The system checks EDI transmission status → If EDI was not sent electronically, skip broker notification process
[Is Broker Known and Required?]
The system checks broker requirement status → If broker is unknown or not required, skip broker notification process
[Is EDI Sent Electronically?]
The system validates EDI transmission status → The cargo must have EDI sent electronically to proceed with broker notification, otherwise skip broker notification
[Is Broker Required?]
The system validates broker requirement → The broker must not be unknown or not required to proceed with broker notification, otherwise skip broker notification
[Transmission Successful?]
The system checks the transmission result → The transmission is considered successful if EXCI-RC-RESP equals ZERO and EXCI-RC-RESP2 equals ZERO and EXCI-RC-ABCODE equals SPACE and EXCI-RC-MSGLEN equals ZERO
[Log Transmission Error]
The system logs the error → An error message is displayed showing 'GCX132D, EXCI ERROR, EIBRESP=' followed by EXCI-RC-RESP, ', RESP2=' followed by EXCI-RC-RESP2, and ', ABEND-CODE=' followed by EXCI-RC-ABCODE
[Display Error Details]
The system displays additional error details → An error message is displayed showing 'GCX132D, EXCI ERR MSG=' followed by the error message content from EXCI-ERROR-MSG for the length specified in EXCI-RC-MSGLEN
[Call Error Handler]
The system initiates error handling → The CERR program is called with the common communication area to handle the error condition
[Fax Send Successful?]
The system receives response codes from the fax service → The system should consider transmission successful only if EXCI-RC-RESP equals zero, EXCI-RC-RESP2 equals zero, EXCI-RC-ABCODE is space, and EXCI-RC-MSGLEN equals zero
[Display Error Message]
The system processes the transmission failure → The system should display error message with EXCI response codes and abend code, display additional error message if available, set return code to fail, and call error handler
[Is EDI Sent Electronically?]
The system validates EDI transmission status → If EDI was not sent electronically, skip broker notification process
[Is Broker Required?]
The system validates broker requirement → If broker is unknown or not required, skip broker notification process
[Is EDI Sent Electronically?]
The system validates EDI transmission status → The cargo must have EDI sent electronically to proceed with broker notifications, otherwise skip broker notification process
[Is Broker Required?]
The system validates broker requirement → The broker must not be unknown or not required to proceed with broker notifications, otherwise skip broker notification process
[Message Sent Successfully?]
Checking the transmission results → The message is considered successful if EXCI-RC-RESP equals ZERO and EXCI-RC-RESP2 equals ZERO and EXCI-RC-ABCODE equals SPACE and EXCI-RC-MSGLEN equals ZERO
[Display Error Details]
Processing the transmission failure → Error details including EXCI-RC-RESP, EXCI-RC-RESP2, and EXCI-RC-ABCODE are displayed, and if EXCI-RC-MSGPTR is not NULL, the error message content is also displayed
[Call Error Handler]
Handling the transmission error → The CERR program is called with CCCOM to process the error according to standard error handling procedures
[Audit Entry Successful?]
Checking the transmission result → If EXCI-RC-RESP equals ZERO and EXCI-RC-RESP2 equals ZERO and EXCI-RC-ABCODE equals SPACE and EXCI-RC-MSGLEN equals ZERO, then the transmission is considered successful
[Handle Audit Error]
The transmission validation indicates failure → The system displays error information, sets return code to RC-FAIL, and calls CERR for error handling
[Log Error Message]
Logging the error details → The system must display error information including EXCI response codes, abend code, and any error message text to SYSERR
[Call Error Handler]
Handling the transaction failure → The system must set CC-RETURN-CODE to RC-FAIL and call 'CERR' with the system context
[Call Standard EDI Processor GCCS309]
The cargo does not qualify for enhanced processing due to invalid port or non-qualifying movement type → The standard EDI processor GCCS309 is called for processing
[Call Standard EDI Processor GCCS309]
The port is invalid:
the cargo is not export type AND not US-Canada-US transit AND not multi-transit
→ The system calls the standard EDI processor GCCS309 to handle the cargo deletion
[Is Port Valid?]
The system processes the cargo for EDI transmission → The system checks if the port location ID is valid by looking up the SE table and sets the port validation flag accordingly
[Is Reference Qualifier 'CN'?]
If the reference qualifier → The system checks if the N901 reference number qualifier equals 'CN'
[N9 Data Found?]
If the database response → If the status code is spaces (successful), continue processing; otherwise skip N9 processing
[N9 Segment Data Found?]
The system checks the database response status → If status code is spaces (successful), proceed with N9 processing, otherwise skip N9 processing
[N9 Segments Found?]
The system receives the response from the database call → If the status code is spaces (successful), continue processing N9 segments, otherwise skip N9 processing
[Set Error Message]
Setting error information for termination → The system should move 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132D' to the error message field

Module: GCX132E 1 Consolidated Epic Story

Epic: GCX132E Complete EDI Specification Extracted from Legacy

Contains 15 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX132E EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[9:Perform Checkpoint Processing]
Checkpoint processing is initiated → If shutdown request is received during checkpoint, display shutdown message and terminate processing, otherwise reset the non-commits counter to zero
[10:Handle Shutdown Requests]
A shutdown request is received (status code 'XD') → Display message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132E' and terminate processing gracefully
[Display Shutdown Message on Console]
The system processes the shutdown request → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132E' is displayed on the console
[Terminate Processing - Abend]
The system needs to terminate processing → The abend processing routine is performed
[Call IMS GHU Function]
The system needs to retrieve the A2RT record from the database → The system should call the IMS GHU function to access the A2RT database segment
[Display Shutdown Message]
System processes the shutdown request → The system displays 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132E' message and sets error message
[Terminate Processing]
Shutdown request processing continues → The system performs abend processing to terminate
[Display Shutdown Message to Console]
The shutdown condition is confirmed → Display message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132E' to the operations console
[Terminate Processing Due to Shutdown]
All shutdown handling steps are complete → Terminate the program execution through abend processing
[Handle Shutdown Request]
The checkpoint returns a shutdown request status code 'XD' → Display shutdown message to console and terminate the program with shutdown notification

Structural Validations

[1:Read Checkpoint Configuration]
The checkpoint file is accessed → If no checkpoint amount is found, display error message 'INVALID CHECKPOINT AMOUNT IN JCL' and terminate processing, otherwise store the checkpoint amount for use
[Error: Invalid Checkpoint Configuration]
No configuration record is found during the read operation → The system sets an error message indicating 'INVALID CHECKPOINT AMOUNT IN JCL'
[Non-Committed Operations > Checkpoint Threshold?]
The current non-committed operations count is greater than the checkpoint threshold amount → The system should execute checkpoint processing before proceeding with deletion
[Set Error Message for Shutdown]
The system prepares for shutdown processing → The error message is set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132E'
[Set Error Message for Shutdown]
The shutdown processing continues → Set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX132E'

Module: GCX133 1 Consolidated Epic Story

Epic: GCX133 Complete EDI Specification Extracted from Legacy

Contains 39 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX133 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Status Code and Train Record Area]
The system prepares for database access → The database status code is cleared and the train root segment area is initialized to empty values
[Initialize Status Codes]
The system begins the database operation process → The system sets the accept status to 'GEGB' and clears all status codes to ensure clean operation state

Core Acceptance Criteria

[13:Archive Dependent Records]
Dependency archival occurs → All train equipment dependency segments are retrieved and written to history file until no more dependencies exist
[14:Perform Checkpoint]
Checkpoint execution occurs → System checkpoint is performed and if shutdown request is received then program displays shutdown message and terminates
[Display Checkpoint Interval]
The checkpoint value IN-CHKP-NUM is numeric and greater than or equal to 1 → The message 'GCX133 CHECKPOINTING AT' followed by IN-CHKP value must be displayed to console
[Retrieve Purge Configuration from Admin Table]
Administrative table access is performed → The GCCTBIO program must be called to retrieve GCSTBRT table data and if successful, GCWTBIO-GCTAB must be moved to GCSTBRT-AD, otherwise an error message about table not found must be generated and program must abend
[Set Current System Date for Processing]
Date initialization occurs during startup → CC-MACHINE-CENTURY and CC-MACHINE-DATE-X from CCCOM must be concatenated into TIMEDIFF-DATE1 and TIMEDIFF-TIME1 must be set to ZEROES
[File Found? -> Use Default Checkpoint Interval]
The file read operation results in an end-of-file condition indicating no data is available → The system sets the checkpoint interval to the predefined default value and displays a message indicating the default is being used
[Terminate Program]
The system cannot proceed without the required configuration → The system performs abnormal termination by calling the error handling routine
[Use Configured Checkpoint Value]
The checkpoint number is numeric AND the checkpoint number is greater than or equal to 1 → The system uses the configured checkpoint value and displays the checkpoint configuration message
[Terminate Processing Due to Missing Configuration]
The system determines that processing cannot continue without the configuration → The system performs an abnormal termination procedure to stop processing
[Calculate Days Between Current Date and Creation Date]
The age calculation is performed → Use the CTIMDIFF program to calculate the number of days difference and store the result in TIMEDIFF-NBR-DAYS
[Days > Purge Days Threshold?]
The record age is compared against the retention policy → If the number of days (TIMEDIFF-NBR-DAYS) is greater than the purge days threshold (GCSTBRT-AD-PURGE-DAYS-US), set the record as eligible for purge, otherwise set it as not eligible for purge
[Move Train Report Data to History Record]
The system prepares the history record for writing → The train root segment data is copied to the history record data field (WS-HIST-DATA)
[Move Dependent Data to History Record]
The system prepares to archive the dependent record → The dependent equipment data is copied to the history record data field (WS-HIST-DATA)
[Copy Train Report Root Segment to History Data]
The system prepares the history record → The train root segment is copied to the history data field
[Write Root Segment to History File]
The system writes the archive data → The history record is written to the history file
[Move Dependent Equipment Data to History Record]
The system processes the dependent equipment record for archival → The dependent equipment segment data is moved to the history record data area
[Archive Dependent Records - Write all dependent segments to history file]
The system processes dependent equipment records for the train → All dependent equipment segments are written to the history file until no more dependent records exist
[Get First Dependent Segment]
The system needs to archive dependent equipment records → The first dependent equipment segment is retrieved using the next parent database operation
[Dependent Segment Found?]
The system checks the operation status → If status indicates no more dependent records exist, processing stops; otherwise continue with archival
[Move Dependent Segment to History Record]
The system prepares the data for history archival → The dependent equipment segment data is moved to the history record data area
[Write Dependent Segment to History File]
The system writes the record to storage → The dependent equipment record is written to the history file
[Get Next Dependent Segment]
The system continues processing dependent records → The next dependent equipment segment is retrieved using the next parent database operation
[Position to First Dependent Record]
The system needs to access the first dependent equipment record → The system positions to the first dependent equipment segment and initializes status for processing
[Call IMS Database with GNP Command]
A request is made to get the next dependent segment → The system calls the database management system using GNP command with the dependent segment structure and qualified search argument
[Store Return Status Code]
The database operation completes → The system stores the returned status code in the dependent indicator variable for processing flow control
[Display Shutdown Message]
The shutdown condition is confirmed → The system displays a shutdown message to the console, sets an error message, and calls the termination routine
[Call Database Function to Get Next Record]
The system needs to move to the next train report record in the database → The system calls the database management system to retrieve the next train report record using GHN (Get Hold Next) operation on the GCSUTRT segment
[Execute GHN Command on GCSUTRT Segment]
The GHN database operation is executed → The system sets accept status to 'GEGB', initializes the status code and train root segment, and calls the database management system with GHN command using the GCUT-PCB and GCUTR-TRAIN-ROOT-SEGMENT parameters

Structural Validations

[3:Read Checkpoint Configuration]
Checkpoint configuration is read → If file is missing or checkpoint number is not numeric or less than 1, then default checkpoint value is used and message is displayed, otherwise valid checkpoint number is used and confirmed message is displayed
[Use Default Checkpoint Value]
The system attempts to read checkpoint configuration → CST-CHKP-DEFAULT must be moved to IN-CHKP-NUM and a message 'INVALID CHECKPOINT - DEFAULT TO' with the default value must be displayed to console
[Use Default Checkpoint Value]
The checkpoint value IN-CHKP-NUM is not numeric or is less than 1 → CST-CHKP-DEFAULT must be moved to IN-CHKP-NUM and a message 'INVALID CHECKPOINT - DEFAULT TO' with the default value must be displayed to console
[Checkpoint Value Valid? -> Invalid - Not Numeric or Less Than 1]
The checkpoint value is either not numeric or is less than 1 → The system rejects the invalid value, applies the default checkpoint interval, and displays a message indicating the default is being used due to invalid configuration
[Display Error Message]
The system detects the failure condition → The system constructs an error message indicating that the CCN sequence number table was not found and includes the return code from the failed operation
[Set Default Checkpoint Value]
The checkpoint file read operation reaches end of file condition → The system assigns the default checkpoint value and displays an invalid checkpoint message
[Is Checkpoint Number Valid?]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ The system assigns the default checkpoint value and displays an invalid checkpoint message
[Display Error: Configuration Table Not Found]
The system detects that the configuration table was not found → An error message is constructed indicating that the CCN sequence number table was not found along with the return code, and this message is prepared for error handling
[Clear Dependent Segment Data Area]
The database operation environment has been initialized → The system clears the train equipment dependent segment data area to ensure no residual data remains

Module: GCX133A 1 Consolidated Epic Story

Epic: GCX133A Complete EDI Specification Extracted from Legacy

Contains 26 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX133A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Search Parameters]
The system prepares to execute a database search for train records → The system sets accept status to 'GE' for exact match search AND initializes the status code AND clears the train root segment data structure

Core Acceptance Criteria

[4:US Train Record Retrieval]
The system attempts to retrieve the corresponding US train record → The system should Execute a database lookup using the key to find the train root segment
[8:IMS Shutdown Handling]
The shutdown request needs to be processed → The system should display a shutdown message and initiate abnormal termination procedures
[Display Program Version with Compile Date]
The program continues initialization → A message containing 'GCX133A AS OF :' followed by the compilation date is displayed to the console
[Display Configured Value Message]
The checkpoint number is numeric AND greater than or equal to 1 → The system displays 'GCX133A CHECKPOINTING AT' followed by the checkpoint value
[Use File Checkpoint Value]
The checkpoint number is numeric AND the checkpoint number is greater than or equal to 1 → The system uses the checkpoint number from the file and displays a message showing the checkpoint value being used
[Set Up Search Parameters]
The system prepares to search for the corresponding train record in the database → The accept status is set to 'GE' for Get Equal operation, status code is initialized, and the train root segment structure is cleared
[Search for US Train Record in Database]
The system executes the database search operation → A CIMS call is made with GHU function to retrieve the train root segment from GCSUTRT database using the specified key
[Hold Record for Processing]
The record retrieval is confirmed as successful → The train record data is held in the GCUTR-TRAIN-ROOT-SEGMENT structure and WS-ROOT-FOUND flag is set to indicate successful retrieval
[Execute Database Search]
The system executes the database search operation → The system calls the database interface to Execute a Get Hold Unique operation on the train root segment using the specified key
[Execute Delete Command for US Train Record]
The delete command is executed against the database → The system calls the database interface to Execute the deletion operation using the DLET function for the US Train root segment
[Display IMS Shutdown Message]
The system processes the shutdown condition → A shutdown notification message is displayed to the console indicating that GCX133A received the shutdown request
[Trigger Abend Processing]
The system needs to terminate due to shutdown request → Abend processing is triggered to Execute cleanup and terminate the program abnormally
[Display Shutdown Message]
The system needs to notify about the shutdown → A shutdown message should be displayed indicating that GCX133A received an IMS shutdown request
[Trigger Abend Process]
The system needs to terminate abnormally due to shutdown request → The abend process should be triggered to Execute cleanup and terminate the program
[Display Shutdown Message to Console]
The system processes the shutdown condition → A shutdown message 'IMS SHUSTDOWN REQUEST RECEIVED BY GCX133A' is displayed to the console
[Initiate Abend Processing]
The system needs to terminate abnormally due to shutdown request → The system performs abend processing routine to terminate the program
[Display Total Count of Deleted US Train Records]
All train records have been processed → The system displays a message showing the total count of deleted US Train records in the format 'NUMBER OF US TRAIN DELETED : [count]'

Structural Validations

[2:Checkpoint Configuration Setup]
The checkpoint file is empty or cannot be read → The system should use the default checkpoint value and display an invalid checkpoint message
[2:Checkpoint Configuration Setup]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ The system should use the default checkpoint value and display an invalid checkpoint message
[Display Default Message]
The checkpoint file is empty:
the checkpoint data is invalid
→ The system displays 'INVALID CHECKPOINT - DEFAULT TO' followed by the default checkpoint value
[File Has Data?]
The checkpoint file is read and contains no data (AT END condition) → The system sets the checkpoint number to the default checkpoint value and displays a message indicating invalid checkpoint with default value
[Checkpoint Value Valid?]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ The system sets the checkpoint number to the default checkpoint value and displays a message indicating invalid checkpoint with default value
[Set Error Message for Shutdown]
The system prepares for error handling → The error message is set to indicate that an IMS shutdown request was received by GCX133A
[Set Error Message]
The system needs to record the shutdown condition → The error message should be set to indicate IMS shutdown request received by GCX133A
[Set Error Message for Shutdown]
The system prepares for abnormal termination → The error message 'IMS SHUSTDOWN REQUEST RECEIVED BY GCX133A' is assigned to the common communication area

Module: GCX134 1 Consolidated Epic Story

Epic: GCX134 Complete EDI Specification Extracted from Legacy

Contains 7 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX134 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[System Shutdown Requested?]
The system receives an 'XD' status code indicating a shutdown request → The program displays a shutdown message and terminates gracefully
[7:Handle System Shutdown]
The shutdown condition is detected → A shutdown message is displayed and the program terminates without further processing
[Age > 7 Days?]
The record age is greater than 7 days → The record is identified as exceeding retention policy and marked for deletion
[Process Shutdown Request]
The system processes the shutdown request → The system displays shutdown notification message, calls error handling routine, and terminates program execution
[Handle Graceful Shutdown]
The shutdown status is detected → A shutdown message is displayed, error handling is called, and the program terminates
[Display Shutdown Message]
The shutdown processing begins → A shutdown notification message is displayed to inform operators
[Display Total Deleted Records Count]
The program reaches the end of processing → The system displays a message 'RCDS DELETED' followed by the total count of deleted records to the console

Structural Validations

None explicitly identified in logic extraction.

Module: GCX135 1 Consolidated Epic Story

Epic: GCX135 Complete EDI Specification Extracted from Legacy

Contains 21 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX135 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Retrieve First Bond Record]
The system attempts to retrieve the first bond record using the starting index value → If a bond record is found, processing continues AND the cargo read counter is incremented OR if no bond record is found, the system terminates with an error message 'UNABLE TO RETREIVE FIRST BOND INDEX'
[6:Identify Arrival Bonds]
The system processes the arrival bond → The export bond indicator is set to 'A' AND SPLC segment information is retrieved AND bond information is written for the primary SPLC code AND if additional SPLC code 1 exists, bond information is written for it AND if additional SPLC code 2 exists, bond information is written for it AND if additional SPLC code 3 exists, bond information is written for it AND if additional SPLC code 4 exists, bond information is written for it
[7:Identify Export Bonds]
The system processes the export bond → The export bond indicator is set to 'E' AND SPLC segment information is retrieved AND port-specific location code mapping is applied
[9:Find SPLC Information]
The system searches the SPLC table using the location name → If a matching location name is found in the SPLC table, the corresponding SPLC name and all SPLC codes are retrieved OR if no matching location is found, the SPLC segment is cleared
[13:Perform Checkpoint Processing]
The system executes checkpoint operations → If a shutdown request is received, the system terminates with message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX135' OR if no shutdown request, the checkpoint counter is reset to zero
[Read Next SPLC Record from Database]
A database call is made to retrieve the next SPLC record → The system calls the database interface with 'GEGB' accept status and retrieves SPLC segment data using unqualified search criteria
[Get First Bond Record]
The system attempts to retrieve the first bond record using the starting index value → If a bond record is found, increment the cargo read counter and proceed to processing, otherwise terminate with an error message
[Perform Checkpoint]
Checkpoint processing is initiated → Execute checkpoint function and reset the checkpoint counter to zero, and if shutdown request is received, terminate processing with appropriate message
[US Cargo Proceed Status AND Arrival Notification?]
The US cargo proceed status is true AND the arrival notification of proceeding status is true → The bond should be marked as arrival bond type 'A' and proceed to processing
[Clear SPLC Information]
The table search completes without finding a match → The SPLC segment information is cleared to spaces
[Extract CCN from Bond Record]
The system extracts bond details → The Customer Control Number (CCN) from the US segment should be moved to the working storage CCN field
[Extract Waybill Number from Bond Record]
The system extracts bond details → The waybill number index from RT072 segment should be moved to the working storage waybill number field
[Extract Bond Number from Bond Record]
The system extracts bond details → The bond number index from RT074 segment should be moved to the working storage bond number field
[Extract Destination Name from Bond Record]
The system extracts bond details → The location ID1 name from M1203 segment should be moved to the working storage bond destination field
[Extract SPLC Code from SPLC Segment]
The system extracts bond details → The SPLC code from the SD segment should be moved to the working storage SPLC code field
[Extract Destination Schedule ID from Bond Record]
The system extracts bond details → The location ID1 from M1203 segment should be moved to the working storage bond destination schedule field
[Extract Car ID Number from Bond Record]
The system extracts bond details → The car ID number index from RT073 segment should be moved to the working storage car ID field
[Terminate Program Due to Shutdown]
A shutdown request status code 'XD' is received from the checkpoint operation → The system should terminate the program with an appropriate shutdown message

Structural Validations

[Set Error Message: Unable to Retrieve First Bond Index]
The bond record retrieval is unsuccessful → The system sets the error message to 'UNABLE TO RETREIVE FIRST BOND INDEX'
[Terminate Program with Error]
The system cannot proceed without the initial bond data → The system terminates the program execution with the error condition
[First Bond Found?]
The retrieval operation completes → If the status indicates success, continue to process the bond record, otherwise display error message 'UNABLE TO RETREIVE FIRST BOND INDEX' and terminate processing

Module: GCX135A 1 Consolidated Epic Story

Epic: GCX135A Complete EDI Specification Extracted from Legacy

Contains 57 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX135A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
Program initialization is performed → The current program name is saved, module name is set as current program, and end-of-file flags are set to 'N' for both manifest and train message files
[Open Input Files - Open manifest file, AAR 76 message file, and checkpoint file for reading]
The beginning process is initiated → Both manifest file end-of-file flag and AAR 76 message file end-of-file flag must be set to 'N' to indicate files are not at end
[Open Input Files - Open manifest file, AAR 76 message file, and checkpoint file for reading]
File opening process begins → The checkpoint file must be opened for input operations
[Open Input Files - Open manifest file, AAR 76 message file, and checkpoint file for reading]
File opening process continues → The manifest file must be opened for input operations
[Open Input Files - Open manifest file, AAR 76 message file, and checkpoint file for reading]
File opening process continues → The AAR 76 message file must be opened for input operations
[Open Input Files - Open manifest file, AAR 76 message file, and checkpoint file for reading]
File opening process includes output files → Both the output report file and arrival file must be opened for output operations
[Initialize Transaction Message Structure]
The system begins preparing the transaction message → The transaction message structure is initialized to clear any previous data
[Initialize Return Code Pointer]
The system initializes call parameters → The external system return code message pointer must be set to NULL to ensure clean initialization

Core Acceptance Criteria

[7:Match Records by SPLC Code]
SPLC codes are compared → If SPLC codes match, proceed to car matching; if manifest SPLC is less than train SPLC, read next manifest record; if manifest SPLC is greater than train SPLC, read next train message record
[10:Match Car IDs]
Car IDs are compared → If car IDs match, process the cargo arrival; if manifest car ID is less than train car ID, read next manifest record; if manifest car ID is greater than train car ID, read next train message record
[Import Cargo?]
The export bond indicator is evaluated → If export bond equals 'A', process as import cargo arrival; otherwise process as export cargo arrival
[13:Spawn Arrival Transaction]
The transaction is spawned → The transaction is submitted to the external system GCT1121E for processing and checkpoint call counter is incremented
[Set Train 76 File EOF Flag to 'N']
File processing initialization begins → The train message file end-of-file flag must be set to 'N' to indicate active processing state
[Display Invalid Checkpoint Message]
The system sets default checkpoint number due to empty file → The message 'INVALID CHECKPOINT - DEFAULT TO 500' is displayed to console
[Display Current Checkpoint Number]
The checkpoint number has been determined (either from file or default) → The message 'GCX135A CHECKPOINTING AT [checkpoint-number]' is displayed to console
[Display Invalid Checkpoint Message]
The checkpoint data fails numeric validation → The system should display 'INVALID CHECKPOINT - DEFAULT TO 500' message to the console
[Display Final Checkpoint Number]
The final checkpoint number has been determined → The system should display 'GCX135A CHECKPOINTING AT [checkpoint_number]' message to the console
[Read Record from TRN76-FILE into Working Storage]
The system attempts to read a record from the AAR 76 message file → The record data is loaded into WS-TRAIN-76-MSGS working storage area
[Set SPLC Code and Car ID to High Values]
The system processes the end-of-file condition → The system sets WS-TRN76-SPLC-CD and WS-TRN76-CAR to HIGH-VALUES to maintain proper sort sequence
[Add Leading Zeros to Left Positions]
Leading zero padding is applied → Positions 5 and 6 of the car ID edit field are set to zero
[Car IDs Match? WS-MAN-CAR-ID = WS-TRN76-CAR]
The system compares the manifest car ID with the AAR 76 car ID → If the car IDs are equal, proceed to cargo type processing; otherwise route to appropriate file reading based on car ID comparison
[Set Arrival Date from Train Message]
Processing import cargo arrival for a matched record → The arrival date from the train message is set as the event date in the transaction
[Set Arrival Time from Train Message]
Processing import cargo arrival for a matched record → The arrival time from the train message is set as the event time in the transaction
[Prepare Transaction Message]
The transaction is ready for submission → The transaction input structure is moved to the message format
[Submit Arrival Transaction to External System]
The transaction needs to be processed by external system → The transaction is submitted to the external system via CSI-SPAWN-GCT1121E
[Set Event Date from Train Arrival Date]
The export arrival transaction is being prepared → The event date is set to the train arrival date from the message
[Set Event Time from Train Arrival Time]
The export arrival transaction is being prepared → The event time is set to the train arrival time from the message
[Prepare Transaction Message]
The transaction message needs to be prepared for transmission → The formatted input data is moved to the transaction message structure
[Call External Arrival System GCT1121E]
The transaction needs to be processed by the external system → The GCT1121E external system is called to process the export cargo arrival
[Set Event Date from Train Arrival]
Processing an arrival transaction → The event date is set to the train arrival date from the train message
[Set Event Time from Train Arrival]
Processing an arrival transaction → The event time is set to the train arrival time from the train message
[Prepare Message for External System]
Preparing for external system communication → The transaction input structure is moved to the message format for system GCT1121E
[Call External System GCT1121E]
Submitting the transaction for processing → The external system GCT1121E is called to process the cargo arrival transaction
[Set Event Date from Train Arrival]
Processing a cargo arrival transaction → The event date in the transaction message is set to the train arrival date
[Set Event Time from Train Arrival]
Processing a cargo arrival transaction → The event time in the transaction message is set to the train arrival time
[Set CCN from Manifest]
Creating a cargo arrival transaction → The CCN from the manifest is assigned to the transaction message
[Move Prepared Structure to Message Buffer]
Preparing to send the transaction for processing → The prepared transaction structure is moved to the message buffer
[Transaction Message Ready for Spawn]
The cargo arrival transaction is fully prepared → The transaction message is ready to be spawned to external processing systems
[Calculate Message Length]
The system calculates the communication area length → The communication length must be computed as the message length plus 4 bytes for the header
[Prepare Message Data]
The system prepares data for external system transmission → The message data from GCT1121E-MESSAGE must be moved to the external communication data area using the calculated message length
[Set Communication Area Length]
The system configures the call data length parameter → The call data length must be computed as the sum of the communication area header length and the GCT1121E message length
[Display Call Parameters for Audit]
The system needs to create an audit trail of the external call → The system must display the external program name, transaction name, message length, communication length, communication data, call data length, return code, and application ID for audit tracking
[Display Message Length]
The system needs to log audit information for the transaction → The message length (GCT1121E-MSG-LGTH) should be displayed to the console for tracking
[Display Communication Data]
The system needs to log audit information for the transaction → The communication data content (EXCI-COMM-DATA) should be displayed to the console for tracking
[Display Shutdown Message]
The system processes the shutdown request → The system should display the message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035' to the console
[Display Shutdown Message]
Shutdown processing begins → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX035' is displayed to the console
[Log Shutdown Request]
Error logging is initiated → The shutdown request message is logged to the error handling system
[Close Files - Close all input and output files at program completion]
The program reaches the ending section for file closure → All four files (Manifest File, AAR 76 Message File, Error Report File, and Arrival Report File) must be closed in sequence

Structural Validations

[Display Invalid Checkpoint Message]
The system sets default checkpoint number due to invalid data → The message 'INVALID CHECKPOINT - DEFAULT TO 500' is displayed to console
[File Empty or Read Error?]
The checkpoint file is empty or cannot be read → Set the checkpoint number to default value 500 and display an invalid checkpoint message
[Checkpoint Data is Numeric?]
The checkpoint data is checked for numeric validity → If the data is numeric, use the checkpoint value from file, otherwise set checkpoint number to default value 500 and display invalid checkpoint message
[Display Invalid Checkpoint Message]
The invalid checkpoint flag is set to 'Y' due to file read failure → The system should display 'INVALID CHECKPOINT - DEFAULT TO 500' message to the console
[End of File Reached?]
The file pointer reaches the end of the AAR 76 message file → The system sets the end-of-file indicator WS-TRN76-EOF to 'Y'
[Is Car ID Less Than Full Length?]
Position 13 of the car ID edit field contains spaces → The car ID is identified as requiring formatting with leading zero padding
[Log Error Message]
The system continues shutdown processing → The system should move the shutdown message to the error message field and call the 'CERR' error handling program
[Log Error Message]
Error logging is performed → The shutdown request message is moved to the error message field and logged via 'CERR' call

Module: GCX135B 1 Consolidated Epic Story

Epic: GCX135B Complete EDI Specification Extracted from Legacy

Contains 64 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX135B EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Open Message Input File]
The initialization process begins → The system opens the MSG-FILE for input processing
[Initialize New Report Page Headers]
The header initialization process is triggered → The system clears all message fields and populates the first 3 lines with standard report headers (WS-OUT-HDR1, WS-OUT-HDR2, WS-OUT-HDR3)
[Initialize Communication Interface]
The email preparation process begins → The communication interface is initialized using CCISCOM program
[Initialize Communication System]
The system begins message transmission preparation → The communication system interface is initialized using CCISCOM with CCCOM and ISCOM parameters

Core Acceptance Criteria

[1:Program Initialization]
The system initializes → The compile date is displayed, message file is opened for reading, message text buffer is cleared, and line counter is set to 4 to reserve space for headers
[2:Message File Processing]
The system processes message records → Records are read sequentially and processed until end of file is reached
[End of File?]
A read operation encounters end of file → The end of file switch is set to 1 and processing continues to final report check
[Buffer Full?]
The current line counter exceeds 699 lines → The current report is transmitted, line counter is reset to 4, and report headers are reinitialized
[4:Report Header Generation]
Report initialization is performed → All message fields are cleared, and the first three lines are populated with standard report headers
[5:Detail Line Formatting]
The message is processed for reporting → The output detail line is cleared and populated with CCN, CAR-ID, BOND, PORT-CD, and A-E values in their respective output positions
[7:Email Message Preparation]
Message preparation is initiated → Communication system is initialized, recipient is set to 'OM01247', destination filename is set to 'IN', and copy recipient is cleared
[8:Message Transmission]
Report transmission is executed → The report is sent via EMCSEND with all message components including recipient, destination, subject, and formatted text content
[Any Remaining Data?]
The system checks for remaining report content → If line 4 of the message text contains data (not spaces), final report transmission is initiated
[10:Final Report Transmission]
Final processing is performed → The remaining report content is transmitted through the messaging system
[11:Resource Cleanup]
Program termination is initiated → The message file is closed and the program returns control to the calling system
[Set Message Counter to 4]
The initialization process begins → The system sets MERLIN-CNT to 4 to start detail lines after the three header lines
[Clear Return Status Flag]
The 2430-INITIALISE routine executes → The system sets EMI-RETURN-STATUS-FLAG to spaces
[Read Next Cargo Message Record]
The system attempts to read the next cargo message record → The cargo message record is read into the working storage message record structure
[End of File Reached?]
The end of file condition is encountered during the read operation → The end of file switch is set to 1 to indicate no more records are available
[Set End of File Flag]
The AT END condition is triggered → The SW-EOF flag is set to 1 to indicate end of file processing
[Process Cargo Message Record]
The end of file flag (SW-EOF) != 1 → The warning report processing is performed for the cargo message record
[Continue to Next Record]
The current record processing is complete → The system returns to read the next cargo message record from the file
[Extract CCN from Message]
The system processes the message record for warning report generation → The CCN field from the message record is extracted and moved to the corresponding output CCN field
[Extract Car ID from Message]
The system processes the message record for warning report generation → The Car ID field from the message record is extracted and moved to the corresponding output Car ID field
[Extract Bond Number from Message]
The system processes the message record for warning report generation → The Bond number field from the message record is extracted and moved to the corresponding output Bond field
[Extract Port Code from Message]
The system processes the message record for warning report generation → The Port Code field from the message record is extracted and moved to the corresponding output Port Code field
[Extract Arrival/Export Indicator from Message]
The system processes the message record for warning report generation → The Arrival/Export indicator field from the message record is extracted and moved to the corresponding output A-E field
[Format All Fields into Output Detail Line]
The system completes field extraction for a cargo message record → The formatted output detail line is moved to the report text at the current line counter position and the line counter is incremented by 1
[Clear Email Message Areas]
The report header generation process starts → All email message fields (TO-USERCODE, COPY-USERCODE, TEXT, RETURN-STATUS-FLAG) are cleared to spaces
[Set First Header Line WS-OUT-HDR1 to Position 1]
The first header line needs to be positioned → WS-OUT-HDR1 content is placed in EMI-TEXT-LINES position 1
[Set Second Header Line WS-OUT-HDR2 to Position 2]
The second header line needs to be positioned → WS-OUT-HDR2 content is placed in EMI-TEXT-LINES position 2
[Set Third Header Line WS-OUT-HDR3 to Position 3]
The third header line needs to be positioned → WS-OUT-HDR3 content is placed in EMI-TEXT-LINES position 3
[Clear Output Detail Line]
The detail line formatting process begins → The output detail line workspace is cleared to spaces to ensure proper field alignment
[Format CCN to Output Position]
The detail line is being formatted for the warning report → The Customer Control Number is moved from the message record to the corresponding output position in the detail line
[Format Car ID to Output Position]
The detail line is being formatted for the warning report → The Carrier ID is moved from the message record to the corresponding output position in the detail line
[Format Bond Number to Output Position]
The detail line is being formatted for the warning report → The Bond Number is moved from the message record to the corresponding output position in the detail line
[Format Port Code to Output Position]
The detail line is being formatted for the warning report → The Port Code is moved from the message record to the corresponding output position in the detail line
[Format Arrival/Export Indicator to Output Position]
The detail line is being formatted for the warning report → The Arrival/Export Indicator is moved from the message record to the corresponding output position in the detail line
[Move Formatted Line to Report Buffer]
The formatted line needs to be added to the warning report → The formatted detail line is moved to the report buffer at the position indicated by the current line counter
[Line Count > 699?]
The line count (MERLIN-CNT) is greater than 699 → The system triggers report transmission and buffer reset process
[Set Recipient User Code to 'OM01247']
The recipient information is being configured → The primary recipient user code is set to 'OM01247'
[Set Destination Filename to 'IN']
The destination configuration is being set → The destination filename is set to 'IN'
[Clear Copy User Code]
The copy recipient configuration is being set → The copy user code field is cleared to spaces
[Prepare Email Structure with: - From User Code - Destination - Recipients - Subject - Keywords - Formatted Report Content]
The email transmission is initiated → The complete email message is sent using EMCSEND program with all specified components
[Set Recipient Address to 'OM01247']
The system configures message recipients → The primary recipient is set to user code 'OM01247' in the first position of the recipient list
[Set Destination as 'IN']
The system configures the destination routing → The destination filename is set to 'IN' with proper spacing formatting
[Clear Copy Recipients]
The system sets up message recipients → The copy recipient field is cleared to spaces to ensure no additional recipients receive copies
[Send Email with Report Content]
The system executes the message transmission → The report is sent via EMCSEND with sender code, destination filename, recipient list, copy recipients, subject, keywords, report content, and return status tracking
[Send Email with Report Content]
The transmission return status indicates failure (not SUCCESSFUL) → The error status code is moved to the error message field and logged via the CERR error handling system
[Transmission Successful?]
The transmission return status flag indicates failure (not equal to SUCCESSFUL) → The system should detect the transmission failure and proceed to error handling
[Check Buffer for Remaining Data]
The system checks the fourth line of the email text buffer for any remaining data → If the fourth line contains data (is not spaces), the system proceeds to send the final report; otherwise it terminates normally
[Prepare Email Message Structure]
The system prepares to send the final report → The communication system is initialized by calling the CCISCOM interface
[Set Recipient to OM01247]
The system sets up the recipient information → The recipient user code is set to 'OM01247' as the primary recipient
[Call Email Send Service]
The system calls the email send service → The EMCSEND service is invoked with all required parameters including sender, destination, recipient, subject, and message text
[Email Send Successful?]
The system checks the return status from the email service → If the return status flag does not indicate success, the system proceeds to log the transmission error; otherwise it continues to program termination
[Close Message Input File]
The system completes processing all warning reports → The message input file must be closed to release system resources
[Terminate Program Execution]
The cleanup operations are finished → The program execution must be terminated and control returned to the calling system

Structural Validations

[3:Cargo Message Validation]
The record is not an end of file indicator → The record is processed through the warning report generation logic
[Transmission Success?]
The transmission status is evaluated → If the return status flag indicates success, processing continues; if not successful, error handling is initiated
[9:Error Handling]
The return status flag indicates failure → The error status is moved to the error message code and logged through the error handling system
[Move Error Status to Error Message Code]
The system processes the transmission failure → The error return status flag should be moved to the error message code field for identification
[Set Error Message in Communication Area]
The system prepares error information for logging → The error message should be set in the communication control area for proper error context
[Call Error Logging Routine]
The system needs to log the transmission failure → The CERR error logging service should be called with the communication control area containing error details
[Log Transmission Error]
The system processes the transmission failure → The error status is moved to the error message code field and the error logging service is called to record the failure

Module: GCX135C 1 Consolidated Epic Story

Epic: GCX135C Complete EDI Specification Extracted from Legacy

Contains 21 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX135C EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[1:Program Initialization]
The program initializes → The error file should be opened for input and message counter should be set to 4
[2:Setup Report Headers]
The system initializes report headers → The current date should be obtained, century should be set to '20' if year is less than 70 otherwise '19', and three header lines should be populated in the message structure
[4:Format Warning Report Lines]
The system processes the error record → The customer control number should be moved to arrival CCN, the destination should be moved to arrival bond destination, the formatted arrival record should be added to the message lines at the current counter position, and the message counter should be incremented by 1
[5:Manage Report Pagination]
The message counter exceeds 699 → The current message batch should be sent, the counter should be reset to 4, and the report headers should be reinitialized
[6:Send Report via Merlin]
The system sends the report via Merlin → The recipient should be set to 'OM01247', the destination filename should be set to 'IN', and the message should be transmitted using the messaging service
[8:Process File Completion]
The system checks for remaining report data → If message text line 4 is not empty, the final message batch should be sent
[Clear Report Text Area]
Initialization process begins → The message text area is cleared to spaces to ensure no residual data
[Set Report Line Counter to 4]
Setting up the message structure → The line counter is set to 4 to account for header lines that will be added to each message batch
[Add Formatted Line to Report]
The system adds the line to the warning report → The formatted arrival record is placed at the current counter position in the message batch
[Increment Report Line Counter]
The system completes processing of one error record → The report line counter is incremented by 1 to track the total number of records in the current batch
[Set Destination User Code to 'OM01247']
The destination user code needs to be specified → The destination user code is set to 'OM01247'
[Set Destination Filename to 'IN']
The destination filename needs to be specified → The destination filename is set to 'IN'
[Clear Copy User Code]
The copy user code field needs to be configured → The copy user code is set to spaces (cleared)
[Send Report via Merlin System]
The report transmission is requested → The report is sent via the EMCSEND messaging service with all required parameters
[Send Operation Successful?]
The return status indicates the send operation was not successful → The system captures the error status and prepares error message for logging

Structural Validations

[7:Handle Send Errors]
The message send operation is not successful → An error should be logged with the return status information
[Send Report via Merlin System]
The transmission status indicates failure (not successful) → An error message is logged using the error handling service
[Check Merlin Send Status]
The system checks the return status from the send operation → The system determines if the transmission was successful or failed
[Capture Error Status Code]
The system processes the failure → The error status code is captured and stored for error message formatting
[Format Error Message]
The system formats the error information → The error status code is formatted into a structured error message
[Log Error Message]
The system initiates error logging → The error message is logged through the CERR error handling system

Module: GCX135D 1 Consolidated Epic Story

Epic: GCX135D Complete EDI Specification Extracted from Legacy

Contains 51 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX135D EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[2:Open Input Files]
File opening process is initiated → Both manifest file and train 76 message file should be opened for input processing
[Initialize File Processing Flags]
The system begins the initialization process → Both manifest file end-of-file flag and AAR 76 message file end-of-file flag must be set to 'N' to indicate files are not yet at end
[Open AAR 76 Message File for Reading]
The system needs to access train message data → The AAR 76 message file must be opened for input operations
[Initialize Return Code Pointer]
The system initializes call parameters → The return code message pointer must be set to null
[Initialize Return Code Message Pointer]
The return code message pointer is initialized → The pointer should be set to NULL to ensure clean state

Core Acceptance Criteria

[5:Read Initial AAR 76 Message Record]
The first train message record is read → If data exists, load the record into working storage, otherwise set end-of-file flag and set car ID to high values
[More Records to Process?]
Checking for continuation of processing loop → Continue processing if both manifest and train message files have not reached end-of-file
[7:Match Car IDs?]
Car ID comparison is performed → Records match when manifest car ID equals train message car ID
[9:Process Export for Arrived Cargo]
Export arrival processing is triggered → Execute export parameter setup and trigger external export transaction processing
[14:Handle Non-CPRS Manifests]
Non-CPRS manifest processing is performed → Display informational message showing car ID, manifest CCN, and train destination for the TRN 76 event
[15:Read Next Manifest Record]
Next manifest record reading is performed → Read the next manifest record and set end-of-file flag with high values for car ID if no more records exist
[16:Read Next AAR 76 Record]
Next train message record reading is performed → Read the next train message record and set end-of-file flag with high values for car ID if no more records exist
[Car ID Comparison]
File advancement decision is made → If manifest car ID is less than train message car ID, advance manifest file; otherwise advance train message file
[17:Close All Files]
File closing process is initiated → Close manifest file, train message file, and output file
[Display Process Start Message with Date/Time]
The program initialization starts → A start message is displayed showing the process name, current machine date, and current machine time
[Read Record from TRN76-FILE into Working Storage]
The system attempts to read an AAR 76 message record → The record is read into WS-TRAIN-76-MSGS working storage area
[Set EOF Flag to 'Y']
No more AAR 76 message records can be read → The WS-TRN76-EOF flag is set to 'Y' to indicate end of file status
[Is Car ID Less Than Full Length?]
Position 13 of the car ID edit field contains spaces → The car ID is identified as requiring zero-padding formatting
[Add Zero to Position 5 and Add Zero to Position 6]
The system adds leading zeros → Zero is placed in position 5 and zero is placed in position 6 of the car edit field
[Format Manifest Car ID with Leading Zeros]
The 13th position of the car edit field is empty (spaces) → Shift all digits one position to the right and pad with leading zeros in positions 5 and 6
[Process CPRS Export Arrival]
Export arrival processing is triggered → Initialize export message with current date/time, manifest CCN, record type 'UC', action code 'CEX', port code from manifest, and spawn GCT1121E transaction
[Log Non-CPRS Event Information]
The system processes the non-CPRS manifest → The system displays an informational message containing car ID, manifest CCN, and TRN 76 destination
[Configure Export Transaction Details]
Security configuration is required → The system sets the security byte to high values
[Set Train/CCN from Manifest]
Export message parameters are being set → The system moves the manifest CCN to the export message train or US CCN field
[Set Record Type as 'UC']
Record type needs to be specified → The system sets the record type code to 'UC'
[Set Port Code from Manifest Bond Destination]
Port code is being configured → The system moves the manifest bond destination schedule to the export port code field
[Call External Export System]
External export processing is required → The system calls the external export system (GCT1121E) to process the export arrival
[Calculate Communication Data Length]
The system prepares the communication parameters → The communication length must be calculated as message length plus 4 bytes for header
[Prepare Export Message Data]
The system prepares data for external transmission → The message data must be moved to communication data area with proper length boundaries
[Set Call Parameters]
The system calculates total call data length → The call data length must equal the sum of communication area header length and message length
[Display Export Data for Tracking]
The system processes the export request → The first 90 characters of communication data must be displayed with tracking identifier
[Prepare Message for External System]
The message needs to be prepared for external system processing → The export input structure is moved to the message format and acceptance status is cleared for external transaction processing
[Set Security Parameters]
Security parameters need to be established → The security byte is set to high values to indicate maximum security level
[Prepare Message for External System]
The message needs to be prepared for external system communication → The complete input structure is moved to the external message format
[Calculate Message Length]
The message length needs to be calculated for the external call → The communication length is computed as the message length plus 4 bytes for header information
[Call External Export System GCT1121E]
The external export system needs to be notified of the arrival → The GCT1121E external transaction is spawned to process the export arrival event
[Calculate Communication Data Length]
The communication data length is calculated → The length should be the message length plus 4 bytes for header information
[Prepare Message Data for Transmission]
The message data is prepared for external system call → The message content should be moved to the communication data area with the specified message length
[Set Communication Area Length]
The communication area length is calculated → The length should be the sum of communication area header length and the export message length
[Display Transaction Data for Logging]
The transaction data needs to be logged → The first 90 characters of the communication data should be displayed with identifier 'DELLDISP EXCI-COMM-DATA:'
[Execute External Transaction via CSIEXCI]
The external export transaction is executed → The CSIEXCI program should be called with transaction parameters including program name, return code area, data length, application ID, communication area, and system context
[Display Non-CPRS Information]
The manifest company control number system identifier != 'CPRS' → Display an informational message showing the car ID, manifest number, and AAR 76 event destination location
[Show Car ID]
Formatting the informational message → Include the manifest car ID in the display message
[Show Manifest Number]
Formatting the informational message → Include the manifest company control number in the display message
[Show AAR 76 Event Location]
Formatting the informational message → Include the AAR 76 train event destination location in the display message
[Read Next Record from AAR 76 Message File]
The system needs to read the next AAR 76 message record → The system reads the next record from the AAR 76 message file into the working storage area
[End of File Reached?]
The system encounters the end of the AAR 76 message file → The system sets the end-of-file flag to 'Y' to indicate no more records are available
[Set AAR 76 Car ID to High Values for Processing Control]
The AAR 76 end-of-file flag is set to 'Y' → The system sets the AAR 76 car ID field to high values to maintain proper record matching sequence
[Close All Files - Close manifest, AAR 76 message, and output report files]
The system reaches the ending phase of processing → The manifest file, AAR 76 message file, and export report file are all closed in sequence

Structural Validations

[8:Validate CPRS Manifest?]
Company validation is performed on the manifest → The manifest qualifies for export processing if the company control number ID equals 'CPRS'
[Check if Position 13 is Empty]
The system checks position 13 of the car edit field → If position 13 contains spaces, the car ID requires padding with leading zeros

Module: GCX135E 1 Consolidated Epic Story

Epic: GCX135E Complete EDI Specification Extracted from Legacy

Contains 44 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX135E EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The AAR 76 message processing module is invoked → The current program name is saved and the module name is set as the active program identifier
[Open Input and Output Files - Open TRN76 input file for reading and TRN76 output file for writing]
The file processing initialization is triggered → The TRN76 input file is opened for reading and the TRN76 output file is opened for writing to enable message processing
[Open Input and Output Files - Open TRN76 input file for reading and TRN76 output file for writing]
The system prepares to read TRN76 messages → The end-of-file indicator is set to 'N' to indicate that file processing has not reached the end

Core Acceptance Criteria

[3:Read First AAR 76 Message Record]
Initial record read is performed → First AAR 76 message is loaded into working storage or end-of-file indicator is set if file is empty
[4:Write Original Record to Output]
Record processing begins → The original message record is written to the output file
[5:Determine Car Type]
Car type determination is performed → Car initial and car number (positions 3-10) are extracted, container indicator is set to 'C' if 4th character of car initial is 'U', and external car type lookup is performed
[8:Process Check Digit Result]
Check digit result processing occurs → If check digit is valid, proceed to container ID update; otherwise display invalid check digit error message
[11:Read Next AAR 76 Message Record]
Next record read is performed → Next AAR 76 message is loaded into working storage or end-of-file indicator is set to 'Y' if no more records exist
[13:Close Input and Output Files]
File processing termination occurs → Input and output files are closed and program name is restored to original value
[Start Reading First Record]
The processing begins → The end-of-file indicator is set to 'N' to indicate more records are expected
[Container Not Eligible - Invalid Car Number Format]
The car number does not start with '0000' → Display invalid container error message with the complete car information to system error output
[Extract Car Initialization from Message]
The system processes the message for car type determination → The car initialization code is extracted from the message and stored in the car type work area
[Extract Car Number from Message]
The system processes the message for car type determination → Positions 3 through 10 of the car number are extracted from the message and stored in the car type work area
[Car Init 4th Character = 'U'?]
The fourth character of the car initialization code is 'U' → The container flag is set to 'C' to indicate this is a container car
[Check Digit Calculation Valid?]
If the check digit validation result → If check digit is valid, process the check digit result, otherwise display invalid check digit error message
[Update Container ID with Modified Equipment Number]
Finalizing the container correction → The work container ID is moved to replace the original car data in the message
[Update Container ID with Modified Equipment Number]
Finalizing the container ID update → The work container ID is moved to replace the original car number in the message
[Is Check Digit Valid?]
The check digit validity is evaluated → If check digit is valid then proceed with check digit processing, otherwise display invalid check digit error message
[Is Calculated Check Digit Valid?]
If the check digit validity flag → If valid, process the check digit result, otherwise display invalid check digit error message
[Container ID Formatted Successfully]
The formatting process completes → The work container ID replaces the original car data in the message record
[Close Input and Output Files]
All TRN76 message processing has been completed → The system closes both the TRN76 input file and TRN76 output file

Structural Validations

[Car Type Determination Successful?]
The system checks the car type determination flag indicator → If flag indicator equals '0' then car type determination is successful and container processing continues, otherwise display error message with flag indicator and car ID
[Car Number Starts with '0000'?]
The system examines the first four positions of the car number → If car number starts with '0000' then container is eligible for check digit calculation, otherwise display invalid container error message
[Container Not Eligible - Display Error Message]
The car type determination flag indicator != '0' → Display error message showing the flag indicator value and the associated car ID to system error output
[Display Error Message]
The car type determination process fails → An error message is displayed showing the failure flag and the container ID that caused the error
[Car Type Call Successful?]
The car type lookup flag indicator is evaluated → If flag equals '0' then proceed to container type validation, otherwise display error message and skip container processing
[Display Error Message for Car Type Call]
The car type lookup flag indicator != '0' → Display error message showing the flag indicator value and the container car ID
[Display Invalid Check Digit Error]
The system processes the invalid check digit → Display error message 'INVALID CHECK DIGIT FOR CAR -' followed by the car ID
[Display Invalid Container Format Error]
The system validates container format → Display error message 'INVALID CONTAINER FOR CHECK DIGIT CALC -' followed by the car number
[Container Number starts with '0000'?]
The system checks if the first 4 positions of the car number are '0000' → If the car number starts with '0000', proceed with check digit calculation, otherwise display an invalid container error message
[Check Digit Valid?]
If the calculation result → If the check digit is valid, process the valid check digit, otherwise display an invalid check digit error message
[Display Invalid Check Digit Error]
The calculated check digit is determined to be invalid → Display an error message indicating 'INVALID CHECK DIGIT FOR CAR' along with the car ID
[Display Invalid Container Error]
The car number does not start with '0000' → Display an error message indicating 'INVALID CONTAINER FOR CHECK DIGIT CALC' along with the car information
[Invalid Check Digit - Display Error Message]
If the check digit value → Error messages are displayed showing the invalid car information and check digit value
[Invalid Check Digit Found]
The check digit does not match valid patterns (single digit or character ten) → Display error messages indicating invalid check digit and the problematic car information
[Display Error Message]
Processing the invalid check digit → Error messages are displayed showing the car information and the invalid check digit value
[Display Error Message]
The check digit validation fails → Error messages are displayed showing the invalid car number and check digit value
[Mark Check Digit as Invalid]
The calculated check digit is neither a single character (second position space) nor equals ten → Display error messages showing the invalid check digit and original container information
[Display Error Message for Car Type Determination Failure]
Error handling is required → Display error message showing the flag indicator value and the car ID that failed
[Display Error Message for Invalid Check Digit]
Error handling is required → Display error message indicating invalid check digit for the specific car
[Car Type Call Successful?]
The car type flag indicator equals '0' → The car type lookup is considered successful and processing can continue, otherwise an error message must be displayed
[Display Invalid Check Digit Error]
The system processes the invalid result → Display error message indicating invalid check digit for the specific car
[Display Invalid Container Format Error]
The system attempts check digit processing → Display error message indicating invalid container format for check digit calculation
[Display Error Message]
The check digit format validation fails → An error message is displayed showing the invalid check digit and original car information

Module: GCX136 1 Consolidated Epic Story

Epic: GCX136 Complete EDI Specification Extracted from Legacy

Contains 95 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX136 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize IMS Call Parameters]
The train record retrieval process is initiated → The accept status should be set to 'GEGB' and status code should be cleared along with train root segment initialization
[Initialize route checking variables]
The system prepares to check route segments → Route checking subscripts are set to 1 and 2, and route found flag is set to false
[Initialize Routing Segment as Not Found]
The system initializes the search process → The routing segment found flag is set to false
[Initialize Route Search Variables]
The system prepares to analyze route information → Route search variables and segment counters are initialized to starting values

Core Acceptance Criteria

[15:Check Shipment Status]
Shipment status is evaluated → Apply suffix '-D' for damaged cars, '-I' for immediate export with zero value, '-R' for in-transit or returned goods with zero value
[Port is 3801 or 0901?]
Port routing requirements are checked → If port is 3801 or 0901, proceed to check interchange routing rules
[19:Check Interchange Routing]
Interchange routing is checked → If route shows CPRS to CSXT via DET, set interchange to CSXT, if route shows CPRS to NS via DET or BUFF, set interchange to NS, apply flat car routing inheritance
[21:Generate Car Detail Report]
Car detail report is generated → Write car record with car ID, type, load status, calculated value, APHIS charge, haulage status, and interchange information, followed by summary record with port '9999'
[Set Checkpoint to Input Value]
The checkpoint number is numeric AND the checkpoint number is greater than or equal to 1 → The system sets the checkpoint call value to the input checkpoint number and displays a confirmation message with the checkpoint value
[Display Date Source Message]
The date source is established → An appropriate message is displayed indicating whether the date came from the file, was blank and defaulted, or the file was missing
[Date Valid?]
The date validation fails (VALDT-SUCCESS is false) → The system sets error message 'PROCESS DATE CONVERSION FAILED' and performs abnormal termination
[More VI Entries to Process?]
The system checks for more entries to process → Processing continues until VI counter 1 equals segment number end AND VI counter 2 equals displacement within segment end
[Set VI-CNT1 counter to 1]
The system initializes VI table segment processing → The VI-CNT1 counter should be set to 1 to start processing from the first segment
[Counter > 100?]
VI counter exceeds 100 → Reset counter to 1 and increment segment number by 1
[Set Sequence ID from VI Code]
Setting sequence ID for database call → Use VI code from current segment and counter position as sequence ID
[Retrieve Next Train Record from GCSUTRT]
A request is made to retrieve the next train record from GCSUTRT database → The system calls CIMS with GN function to get the next train root segment record and updates the processing status
[Call IMS Database 'CIMS' with GN Function]
A database call is made to retrieve train records → The system should call CIMS with GN function using GCUT-PCB, train root segment, and SSAU-UTRT parameters
[Call GCSUSRT Database]
Executing database query for car shipment details → CIMS should be called with GU function, GCUS-PCB, GCSUSRT segment, and USRT-SSAQ qualifier
[Use RR Fee Values]
The system processes the car for fee calculation → The system assigns RR-EMPTY value for empty cars, RR-LOADED value for loaded cars or residue cars exceeding threshold, and RR-EMPTY-RESIDUE value for residue cars below threshold
[Use CN Fee Values]
The system processes the car for fee calculation → The system assigns CN-EMPTY value for empty cars, CN-LOADED value for loaded cars or residue cars exceeding threshold, and CN-EMPTY-RESIDUE value for residue cars below threshold
[Use VI Table Fee Values]
The system processes the car for fee calculation → The system assigns VI-EMPTY value for empty cars, VI-LOADED value for loaded cars or residue cars exceeding threshold, and VI-EMPTY-RESIDUE value for residue cars below threshold
[Is Immediate Export?]
If the shipment type → Return true if the shipment is classified as immediate export, false otherwise
[Set status as Immediate Export '-I' Set fees to zero]
The system processes the immediate export classification → Set car type suffix to '-I' and set the car value to zero
[Is Transport Export?]
If the shipment type for transport export → Return true if the shipment is classified as transport export, false otherwise
[Is In-Transit or Returned Goods?]
If the shipment classification → Return true if shipment is in-transit or returned goods, false otherwise
[Immediate Export shipment?]
The shipment is classified as immediate export (88-GCUSRT-M1201-IMM-EXPORT is true) → Set car type suffix to '-I' and set car value to zero
[Transport Export shipment?]
The shipment is classified as transport export (88-GCUSRT-M1201-TRANSP-EXPORT is true) → Set car type suffix to '-T' and proceed to check Canadian transit status
[In-Transit or Returned Goods?]
The shipment is classified as in-transit (88-GCUSRT-M1201-IN-TRANSIT is true) or returned goods (88-GCUSRT-M1109-RTNED-GOODS is true) → Set car type suffix to '-R' and set car value to zero
[Port is 3801 or 0901?]
The port code is either 3801 or 0901 → The system initiates the interchange routing check process
[Retrieve Routing Segment 13 Data]
The system calls the routing data retrieval function → Routing segment 13 data is retrieved and routing data found status is determined
[Check route segments sequentially]
The system checks route segments with subscript not exceeding 9 and route not yet found → Each route segment is processed in sequence until completion criteria is met
[Route SCAC is CPRS?]
The route SCAC code in the current segment equals 'CPRS' → The system proceeds to check the next SCAC code for valid interchange partners
[Next SCAC is CSXT with DET destination?]
The next route SCAC is 'CSXT' and the R260 destination code is 'DET' → CSXT is set as the interchange railroad and route is marked as found
[Next SCAC is NS with DET or BUFF destination?]
The next route SCAC is 'NS' and the R260 destination code is either 'DET' or 'BUFF' → NS is set as the interchange railroad and route is marked as found
[Set interchange railroad to found SCAC]
Either CSXT with DET or NS with DET/BUFF route is found → The corresponding SCAC code is assigned as the interchange railroad
[Mark route as found]
The route assignment is completed → The route found flag is set to true to stop further route segment processing
[Move to next route segment]
The system needs to check the next available route segment → Both route checking subscripts are incremented by 1, and if next segment is empty, subscript is set to 10 to end processing
[Set interchange railroad in car data]
The route processing is completed successfully → The interchange railroad code is moved to the car's data interchange railroad field
[Car is container on flat car?]
The car's container indicator equals 'C' → The system marks this as an interchange flat car and saves the route for potential inheritance
[Mark as interchange flat car and save route]
The route assignment is completed → The interchange flat car flag is set to true and the route is saved for inheritance
[Clear interchange railroad data]
The routing check process completes without finding valid routing → The car's interchange railroad field is set to spaces
[Current car is empty flat and previous was interchange flat?]
The current car's container indicator is spaces (empty flat) and the interchange flat car flag is true → The saved flat car route is applied to the current car's interchange railroad field
[Apply saved flat car route to current car]
The route inheritance condition is met → The saved flat car route is moved to the current car's interchange railroad field
[Reset flat car indicators]
The route inheritance logic has been applied or skipped → The interchange flat car flag is set to false to reset for the next car
[Set Search Parameters for GCSUSS13]
The system prepares to search for routing segment data → The search parameters are set with customer control number, record type '13', and sequence '0001'
[Set Record Type to '13' and Sequence to '0001']
Database search parameters are being configured → Record type is set to '13' and sequence number is set to '0001'
[Call Database to Retrieve GCSUSS13 Segment]
The system executes the database retrieval request → The customer shipment routing segment data is retrieved from GCSUSS13
[Routing Segment Found?]
The system checks the retrieval result status → The system determines if routing segment data is available for processing
[Set Routing Segment Found Flag]
The system processes the successful retrieval result → The routing segment found flag is set to true
[More Route Segments to Check?]
If the current segment counter against maximum segments → The system determines if more route segments need to be processed
[Extract Route Information from Current Segment]
The system processes the current route segment → Route information is extracted from the current segment position
[Get SCAC Code and R260 Location from Route]
The system parses the route data → SCAC railroad code and R260 location code are extracted from route information
[Set Route Found with Second SCAC Code]
The system processes the matched routing criteria → The second SCAC code is set as the interchange railroad and route found flag is set to true
[Move to Next Route Segment]
The system prepares to process the next route segment → Segment counters are incremented to point to the next route information
[Route Found?]
If the overall route search results → The system determines if a valid interchange railroad route was found
[Set Interchange Railroad Code]
The system finalizes the routing determination → The matched railroad code is assigned to the interchange railroad field
[Clear Interchange Railroad Code]
The system finalizes the routing determination → The interchange railroad field is cleared or set to spaces
[Extract Route Information from Current Segment]
The system processes the route segment → The route information from the current segment position and next segment position should be extracted into separate work areas for analysis
[Get SCAC Code and R260 Location from Route]
The system processes the route information → The SCAC codes and R260 location codes should be separated and made available for routing logic evaluation
[First SCAC is 'CPRS'?]
The first SCAC code is evaluated → If the first SCAC code equals 'CPRS', proceed with CPRS-specific routing logic, otherwise move to the next route segment
[Second SCAC is 'CSXT' and R260 is 'DET'?]
The second SCAC code and R260 location are evaluated → If the second SCAC code is 'CSXT' and R260 location is 'DET', set the route as found with CSXT as the interchange railroad
[Second SCAC is 'NS' and R260 is 'DET' or 'BUFF'?]
The second SCAC code and R260 location are evaluated → If the second SCAC code is 'NS' and R260 location is either 'DET' or 'BUFF', set the route as found with NS as the interchange railroad
[Set Route Found with Second SCAC Code]
The route assignment is processed → The second SCAC code should be assigned as the interchange railroad and the route found flag should be set to true
[Get Route Info from Current Position]
Route information needs to be extracted from the routing segments → The system extracts SCAC code and R260 location from current position into WS-ROUTE-INFO-ONE and from next position into WS-ROUTE-INFO-TWO
[First SCAC = 'CPRS'?]
The first SCAC code is evaluated for routing decisions → The system identifies if WS-ROUTE-SCAC-ONE equals 'CPRS' to proceed with CPRS-specific routing logic
[Move to Next Route Segment]
The system needs to check the next route segment → The system increments WS-SUB by 1 and WS-SUB2 by 1 to move to next route segment positions
[End Route Check]
Either a matching route is found (WS-ROUTE-FOUND) or all route segments have been processed (WS-SUB > 9) → The system terminates the route checking loop and completes the route analysis
[Check SCAC codes and destinations for routing decisions]
The first SCAC code is 'CPRS' AND the second SCAC code is 'CSXT' AND the destination is 'DET' → Set the interchange railroad to 'CSXT' and mark the route as found
[Check SCAC codes and destinations for routing decisions]
The first SCAC code is 'CPRS' AND the second SCAC code is 'NS' AND the destination is either 'DET' or 'BUFF' → Set the interchange railroad to 'NS' and mark the route as found
[Move to Next Route Segment Pair]
No interchange railroad determination can be made from current segment → Increment to next route segment pair and continue analysis if more segments are available
[More Route Segments Available?]
All route segments have been processed:
a valid interchange railroad has been determined
→ Terminate the route analysis process
[Set Car Type and Suffix]
The system determines car type suffix → The car type suffix is set to '-I' and the car value is set to zero
[Set Car Type and Suffix]
The system determines car type suffix and checks destination → The car type suffix is set to '-T', and if the destination is a Canadian border port, suffix changes to '-C' and value is set to zero
[Set Port Information]
The system sets port data for the car record → The origin station code from the train root segment is recorded as the car's port information
[Set Interchange Railroad]
The routing shows CPRS (Canadian Pacific Railway Service) to CSXT with route code 'DET' → The interchange railroad is set to 'CSXT'
[Set Interchange Railroad]
The routing shows CPRS to NS with route code 'DET' or 'BUFF' → The interchange railroad is set to 'NS'
[Set Interchange Railroad]
The inter flat car flag is set and the current car has no container indicator → The interchange railroad is set to the flat route value and the inter flat car flag is reset
[Display Shutdown Message]
Shutdown processing begins → The system displays 'IMS SHUSTDOWN REQUEST RECEIVED BY GCX136' message to the console

Structural Validations

[File Found?]
The checkpoint file is empty or not found (AT END condition) → The system sets the checkpoint call value to default 1000 and displays an invalid checkpoint message
[Checkpoint Number Valid?]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ The system sets the checkpoint call value to default 1000 and displays an invalid checkpoint message
[Display Error and Terminate]
The date calculation fails (DTCAL-SUCCESS is false) → The system sets error message 'PROCESS DATE CONVERSION FAILED' and performs abnormal termination
[Display Error: Process Date Conversion Failed]
The validation returns failure status → The system displays 'PROCESS DATE CONVERSION FAILED' error message and terminates the program
[Display Error: Process Date Conversion Failed]
The calculation returns failure status → The system displays 'PROCESS DATE CONVERSION FAILED' error message and terminates the program
[Abend - VI Entry Not Found]
The GCCTBIO return flag does not equal SUCCESSFUL → The system sets error message to 'VI ENTRY NOT FOUND' and performs abend processing
[VI Entry Not Found Error]
VI record is not found in database → Set error message to 'VI ENTRY NOT FOUND' and Execute abend procedure
[Display Error - VI Entry Not Found]
The VI table entry is not found or the lookup is unsuccessful → The system displays an error message indicating VI entry not found and terminates processing
[Display Error - VI Entry Not Found]
The table lookup operation fails to find the entry → The system sets error message to 'VI ENTRY NOT FOUND' and performs abend procedure
[Set Error - Car Type Not Found]
The system calculates user fees for the car → The system sets car type to '??' and fee value to zero, and displays an error message
[Car Type Found in VI Table? → Set Car Type = '??' and Fee = ZEROS]
The car type lookup fails → Set the car type to '??' and fee to zero, and display error message
[Set Error - Car Type Not Found]
The system attempts to assign fee values → The system displays an error message 'CAN NOT FIND VI ENTRY', shows the problematic car type, marks the car type as '??', and sets the fee value to zero
[Set Fee = ZERO and Mark Car Type as '??']
The fee calculation process is executed → The car fee is set to zero, the car type is changed to '??', and an error message is displayed
[More Route Segments Available?]
The system checks for more route segments to process → If the next route segment contains spaces or low-values, set WS-SUB to 10 to end processing, otherwise continue with more segments available
[Set Error Message for Shutdown]
Error message needs to be set for shutdown → The system sets the error message to 'IMS SHUSTDOWN REQUEST RECEIVED BY GCX136'
[Terminate Program with Error]
Program termination is required → The system performs abnormal termination (Z999-ABEND) to stop processing
[Call Error Handler]
Error termination processing occurs → The system error handler is called with error message details

Module: GCX136A 1 Consolidated Epic Story

Epic: GCX136A Complete EDI Specification Extracted from Legacy

Contains 39 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX136A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program]
The initialization process begins → All cargo counters for qualified, exception, haulage, interchange, cost, and APHIS categories are set to zero for both port-level and grand total tracking, and all empty residue counters are also initialized to zero
[Initialize All Cargo Counters to Zero]
Port context has been established → All cargo counters including qualified loaded, qualified empty, exception loaded, exception empty, haulage, NS interchange, CSXT interchange, and APHIS cargo should be set to zero
[Initialize Grand Total Counters to Zero]
Regular counters have been initialized → All grand total counters including qualified loaded, qualified empty, exception loaded, exception empty, haulage, NS interchange, CSXT interchange, cargo cost, APHIS cargo, and APHIS cost should be set to zero
[Initialize Empty Residue Counters to Zero]
Grand total counters have been initialized → All empty residue counters including qualified cargo threshold exceeded, qualified cargo, exception cargo threshold exceeded, exception cargo, haulage cargo, NS interchange cargo, CSXT interchange cargo, and cost cargo should be set to zero
[Initialize Empty Residue Grand Total Counters to Zero]
Empty residue cost accumulators have been initialized → All empty residue grand total counters including qualified loaded, qualified empty, exception loaded, exception empty, haulage, NS interchange, CSXT interchange, cost cargo, cost threshold exceeded, and APHIS cost should be set to zero
[Initialize All Counters to Zero]
The system initializes cargo counters → All qualified cargo, exception cargo, haulage cargo, interchange cargo, cost cargo, APHIS cargo, and grand total counters are set to zero, and all empty residue counters are also set to zero

Core Acceptance Criteria

[7:Count CSXT Interchange Cargo]
Processing the cargo record → If load/empty indicator is 'R', increment empty residue CSXT interchange counter, otherwise increment regular CSXT interchange counter
[8:Count NS Interchange Cargo]
Processing the cargo record → If load/empty indicator is 'R', increment empty residue NS interchange counter, otherwise increment regular NS interchange counter
[19:Write Empty Residue Grand Totals]
Completing the empty residue report → A grand total header is written followed by accumulated totals for all empty residue cargo categories including qualified, exception, haulage, interchange, and cost totals
[Write Column Headers Line 2]
The system writes the second column header line → The fourth header line containing column headers for haulage and interchange categories is written to the report file and email text
[CSXT Interchange Type = 'CSXT']
The cargo load/empty indicator is 'R' → Count as empty residue CSXT interchange cargo, otherwise count as regular CSXT interchange cargo
[NS Interchange Type = 'NS']
The cargo load/empty indicator is 'R' → Count as empty residue NS interchange cargo, otherwise count as regular NS interchange cargo
[Check Cargo Interchange Type]
The cargo interchange field equals 'CSXT' → The system proceeds to classify the cargo based on load/empty status
[Count as Empty Residue CSXT Interchange]
The load/empty indicator is 'R' (residue) → The system increments the empty residue CSXT interchange counter
[Count as Regular CSXT Interchange]
The load/empty indicator is not 'R' (not residue) → The system increments the regular CSXT interchange counter
[Cargo Record with NS Interchange]
The system processes the cargo record → The cargo record is identified as NS interchange cargo and ready for load/empty status evaluation
[Count as Empty Residue NS Interchange Cargo]
The system processes the cargo classification → The empty residue NS interchange cargo counter is incremented by 1
[Count as Regular NS Interchange Cargo]
The system processes the cargo classification → The regular NS interchange cargo counter is incremented by 1
[Is Load/Empty Status = 'R' Empty Residue?]
The load/empty indicator equals 'R' → The cargo is classified as empty residue NS interchange, otherwise it is classified as regular NS interchange
[Move NS Interchange Count]
The system populates interchange count fields → The NS interchange cargo count should be moved to the output line and added to the grand total for NS interchange cargo
[Move CSXT Interchange Count]
The system populates interchange count fields → The CSXT interchange cargo count should be moved to the output line and added to the grand total for CSXT interchange cargo
[Add NS Interchange Count to Grand Total]
The system writes the report line for that port → The NS interchange cargo count must be added to the grand total accumulator WS-GRD-NS-INTER-CARGO
[Add CSXT Interchange Count to Grand Total]
The system writes the report line for that port → The CSXT interchange cargo count must be added to the grand total accumulator WS-GRD-CSXT-INTER-CARGO
[Save NS Interchange Cargo Count]
The empty residue data is being saved → The NS interchange cargo count is moved to the output record and accumulated to grand totals
[Save CSXT Interchange Cargo Count]
The empty residue data is being saved → The CSXT interchange cargo count is moved to the output record and accumulated to grand totals
[Move NS Interchange Total to Output]
The system formats grand total data → The NS interchange total is moved to the grand total output line
[Move CSXT Interchange Total to Output]
The system formats grand total data → The CSXT interchange total is moved to the grand total output line
[Move NS Interchange Count to Display]
The system formats NS interchange cargo totals → The grand total empty residue NS interchange cargo count is moved to the display field
[Move CSXT Interchange Count to Display]
The system formats CSXT interchange cargo totals → The grand total empty residue CSXT interchange cargo count is moved to the display field
[Clear Email Parameters]
The email transmission process is initiated → All email parameter fields (keywords, recipient codes, copy codes) are cleared to spaces
[Call EMCSEND3 Email Utility]
Executing the email transmission → The EMCSEND3 utility is called with sender information, destination, recipients, subject, content, and message specifications
[Check Email Status]
Completing the email process → The communication interface is properly closed using ISCCCOM
[Continue Normal Processing]
The email return status flag equals 0 (success) → The system continues with normal processing flow
[Trigger Program Termination]
The email return status flag != 0 (failure) → The system triggers program termination procedures

Structural Validations

[21:Handle Email Errors]
The email return status flag is not zero → The program performs error handling procedures to manage the email failure
[Email Sent Successfully?]
Evaluating the transmission result → If the email return status flag equals 0, the transmission is considered successful, otherwise it indicates failure
[Trigger Error Handling]
Processing the failed transmission → The system error handling procedure 9999-ABEND is executed
[Check Email Return Status]
The system checks the email return status flag → The system evaluates whether the transmission was successful or failed
[Call Error Handler]
Program termination procedures are initiated → The system calls the external error handler routine

Module: GCX136D 1 Consolidated Epic Story

Epic: GCX136D Complete EDI Specification Extracted from Legacy

Contains 40 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX136D EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[15:Classify Export Shipments]
Classifying the shipment for export processing → If customer record is not found, set suffix to '-D'. If customer has immediate export flag, set suffix to '-I' and value to zero. If customer has transport export flag, set suffix to '-T' and proceed to Canadian transit check
[22:Perform Checkpoint Processing]
Checkpoint processing is performed at regular intervals → Execute checkpoint operation and if system shutdown is detected, terminate processing with appropriate message
[Use Checkpoint Number from File]
The checkpoint number is numeric AND the checkpoint number is greater than or equal to 1 → The system uses the checkpoint number from the file and displays the checkpointing frequency message
[Read Select File]
The select file is opened and read → If the select file cannot be read, use current machine date and display 'DATE-FILE MISSING USING CURRENT' message
[Is Date Valid?]
The system checks the validation result → If validation is successful, proceed to date calculation setup; otherwise, set error message and terminate
[Date Calculation Successful?]
The system checks the calculation result → If calculation is successful, update processing date with new calculated date; otherwise, set error message and terminate
[Terminate Processing]
The system handles the error condition → The system performs abnormal termination to stop further processing
[Call GCX004LD to Load VI Table Structure]
The system calls the table loading service → VI table structure is loaded with segment and displacement end pointers established
[Set Segment Counter to 1, Displacement Counter to 0]
Processing counters are initialized → Segment counter is set to 1 and displacement counter is set to 0
[Displacement Counter > 100?]
The displacement counter value is evaluated → If displacement counter is greater than 100, segment processing is complete, otherwise continue with current segment
[Reset Displacement to 1, Increment Segment Counter]
Segment advancement is required → Displacement counter is reset to 1 and segment counter is incremented by 1
[Retrieve VI Table Entry for Current Segment/Displacement]
The system retrieves a VI table entry using table ID and sequence ID → VI table entry data is retrieved from the database using GCCTBIO service
[More Segments/Displacements to Process?]
Processing continuation is evaluated → If segment counter equals segment end AND displacement counter equals displacement end, processing is complete, otherwise continue
[VI Table Loading Complete]
VI table loading concludes → VI table processing is marked as complete and control returns to calling process
[Reset Displacement to 1, Increment Segment Counter]
Segment boundary reset is required → Displacement counter is reset to 1 and segment counter is incremented by 1
[Set Sequence ID from Current Segment/Displacement]
Configuring table lookup sequence key → Sequence ID is set from VI table code array using current segment and displacement indices
[Retrieve Customer Shipment Details]
Customer shipment details are available → Customer export flags (immediate export, transport export, in-transit, returned goods) and location information are made available for further processing
[Mark as Immediate Export]
The customer shipment record has immediate export flag set to true → The car type suffix should be set to '-I' and the car value should be set to zero
[Set Car Type Suffix to '-I']
The immediate export classification is confirmed → The car type suffix should be set to '-I'
[Set Car Value to Zero]
The immediate export processing is applied → The car value should be set to zero
[Immediate Export Shipment?]
The customer record indicates immediate export status (88-GCUSRT-M1201-IMM-EXPORT is true) → Classify the shipment as immediate export type
[Assign '-I' Classification Code]
The system processes the export classification → Assign car type suffix as '-I' and set the car value to zero
[Transportation Export Shipment?]
The customer record indicates transportation export status (88-GCUSRT-M1201-TRANSP-EXPORT is true) → Classify the shipment as transportation export type
[In-Transit or Returned Goods?]
The customer record indicates in-transit status (88-GCUSRT-M1201-IN-TRANSIT is true):
returned goods status (88-GCUSRT-M1109-RTNED-GOODS is true)
→ Classify the shipment as in-transit or returned goods type
[Set Value to Zero - Immediate Export '-I']
The customer record indicates immediate export status → The car type suffix is set to '-I' and the car value is set to zero
[Keep Current Car Value]
The car does not qualify for empty COFC, immediate export, Canadian transit, in-transit/returned goods, or commodity exemption → The car retains its original calculated value without any suffix modifications
[Set Car Value to Zero - Immediate Export]
The value override logic is executed → The car value must be set to zero regardless of car type or loaded status
[Display Shutdown Message]
The system prepares to terminate processing → A shutdown notification message is displayed to the console and error message is set
[Process Date Conversion Failed]
Date validation fails:
date calculation fails
→ Set error message to 'PROCESS DATE CONVERSION FAILED' and Execute program termination
[VI Table Entry Not Found]
The table lookup operation is not successful → Set error message to 'VI ENTRY NOT FOUND' and Execute program termination
[IMS Shutdown Request]
An IMS shutdown request is received → Display shutdown message to console AND set error message to 'IMS SHUSTDOWN REQUEST RECEIVED BY GCX136D' AND Execute program termination

Structural Validations

[File Found?]
The checkpoint file is not found or is empty → The system sets checkpoint frequency to default value of 1000 and displays invalid checkpoint message
[Checkpoint Number Valid?]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ The system sets checkpoint frequency to default value of 1000 and displays invalid checkpoint message
[Selection Date is Blank/Spaces?]
The selection date field contains spaces or is blank → Use current machine date as processing date and display 'BLANK SELECTION DATE USING CURRENT' message
[Set Error Message: Date Conversion Failed]
The system handles the failure condition → An error message 'PROCESS DATE CONVERSION FAILED' is set in the error message field
[Display Error: VI Entry Not Found]
GCCTBIO-RETURN-FLAG is not SUCCESSFUL → Error message 'VI ENTRY NOT FOUND' is set and system terminates processing
[Display VI Entry Not Found Error]
Error handling is triggered → Error message 'VI ENTRY NOT FOUND' is set and system abend procedure is performed
[Displacement > 100?]
Displacement counter value is greater than 100 → Segment boundary limit is exceeded and requires reset
[Display VI Entry Not Found Error, Terminate Processing]
Table access service indicates entry was not found → VI entry not found error message is displayed and processing is terminated
[Invalid Checkpoint Configuration]
The checkpoint file is empty:
the checkpoint number is not numeric
the checkpoint number is less than 1
→ Set checkpoint call value to 1000 and display invalid checkpoint message to console

Module: GCX136E 1 Consolidated Epic Story

Epic: GCX136E Complete EDI Specification Extracted from Legacy

Contains 5 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX136E EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[14:Send Email Notification]
Email notification process is initiated → Send the report to user 'DEA0021' with the report title as subject and full report content as message body using EMCSEND2 service
[Continue Processing]
The email return status indicates successful transmission → The system continues with normal processing flow

Structural Validations

[Date File Available?]
The date file read operation is completed → If no data is found, an 'INVALID DATE' error message is set and the program abends, otherwise processing continues with the retrieved date
[Check Email Send Status]
The system checks the transmission result → The email return status flag is evaluated for success or failure
[Log Error Message]
The email return status indicates transmission failure → The error status is logged and the error handling routine is invoked

Module: GCX137 1 Consolidated Epic Story

Epic: GCX137 Complete EDI Specification Extracted from Legacy

Contains 35 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX137 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Segment 03 Structure]
The system begins shipper information retrieval process → The segment 03 data structure is initialized to empty state
[Initialize Segment 07 Structure]
The system begins segment 07 processing → The segment 07 structure is initialized to empty state
[Initialize Segment 10 Structure]
The system begins segment 10 processing for additional description → The segment 10 structure is initialized to empty state

Core Acceptance Criteria

[6:Extract Shipper Information]
Accessing shipper data using segment type '03' → If shipper segment is found successfully, use the shipper name; otherwise use blank spaces
[11:Extract Commodity Description]
Accessing commodity description segments → Retrieve description from segment type '07' if available, retrieve additional description from segment type '10' if available, and combine descriptions for reporting
[Display Invalid Checkpoint Message]
Default checkpoint values are being applied → An invalid checkpoint message with the default value must be displayed to the console
[Display Checkpoint Setting]
The checkpoint value is accepted for use → A confirmation message showing the checkpoint value must be displayed to the console
[Use Checkpoint Number from File]
The checkpoint number is numeric AND the checkpoint number is greater than or equal to 1 → The system uses the checkpoint number from the file and displays a confirmation message showing the checkpoint value
[Set CCN Key from Cargo Record]
The system prepares to lookup shipper information → The CCN key from the cargo record is assigned to the segment lookup key
[Set Record Type to '03']
Setting up the database lookup parameters → The record type is set to '03' to identify shipper segment
[Retrieve Segment 03 Record]
The system executes the database retrieval operation → The system attempts to retrieve the corresponding shipper segment record
[Extract Shipper Name from N102 Field]
The database lookup returns a valid record with no error status → The shipper name is extracted from the N102 field and assigned to the working storage shipper field
[Set CCN Key for Segment 07]
The system prepares to retrieve segment 07 data → The CCN from the cargo record is assigned as the lookup key for segment 07
[Set Record Type to '07']
Setting up the segment lookup parameters → The record type is set to '07' to identify commodity description segment
[Set Sequence to '0001']
Specifying the sequence for data retrieval → The sequence number is set to '0001' to get the first segment occurrence
[Read Segment 07 Data]
The system executes the data retrieval operation → The system attempts to read segment 07 data using the configured parameters
[Extract Long Description from Segment 07]
The system processes the retrieved segment 07 data → The long description field is extracted and stored for commodity description
[Set Description to Spaces]
The system cannot locate segment 07 information → The commodity description is set to spaces indicating no description available
[Set CCN Key for Segment 10]
The system prepares to retrieve segment 10 data → The CCN from the cargo record is assigned as the lookup key for segment 10
[Set Record Type to '10']
Setting up the segment 10 lookup parameters → The record type is set to '10' to identify additional commodity information segment
[Read Segment 10 Data]
The system executes the data retrieval operation → The system attempts to read segment 10 data using the configured parameters
[Extract Additional Description from Segment 10]
The system processes the retrieved segment 10 data → The additional description field is extracted and stored for commodity information
[Set Additional Description to Spaces]
The system cannot locate segment 10 information → The additional commodity description is set to spaces indicating no additional information available
[Combine Descriptions into Final Description]
The system has extracted descriptions from both segments → The descriptions are combined into a final comprehensive commodity description
[Combine Description Fields]
The system combines description information → The descriptions are merged into a single comprehensive description field
[Display Shutdown Request Message]
Checkpoint failure is detected → The system should display 'IMS SHUTDOWN REQUEST RECEIVED BY GCX137' message to the console
[Terminate Program]
Error handling procedures are executed → The system should Execute program termination through the abend routine
[Display Total Cargo Records Count]
The program reaches the ending phase and needs to display processing statistics → The system displays a formatted message showing the total number of US cargo records that were read and processed
[Display Processing Statistics]
The cleanup process begins → The system displays the total number of US cargo records read with the message 'NUMBER OF US CARGO READ : [count]'

Structural Validations

[File Found and Readable?]
The checkpoint file cannot be found or read (AT END condition occurs) → The system sets the checkpoint number to the default value and displays an invalid checkpoint message
[Is Checkpoint Number Numeric and >= 1?]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ The system sets the checkpoint number to the default value and displays an invalid checkpoint message
[Is Record Date Numeric]
The record date contains non-numeric characters → The system displays an error message with the CCN key and invalid date, then skips processing this record
[Calculate Days Between Dates]
The system validates the date format → If the date is not numeric, skip processing of this record and display an error message with the CCN key and invalid date
[Set Error Message]
Error handling is initiated → The system should set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX137'

Module: GCX138 1 Consolidated Epic Story

Epic: GCX138 Complete EDI Specification Extracted from Legacy

Contains 228 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX138 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Equipment Segment]
The system sets up for equipment processing → The system initializes the equipment segment structure to clear previous data
[Initialize GCSUSRT Segment]
The system begins car equipment processing → The GCSUSRT segment area is initialized to empty state

Core Acceptance Criteria

[2:Train Direction Classification]
Position 23 of the train root segment equals 'T' → The train direction is classified as 'NORTHBOUND', otherwise it is classified as 'SOUTHBOUND'
[5:Car Record Processing]
Processing cars in an equipment segment → Process up to 50 cars per segment or until equipment ID is spaces, whichever comes first
[20:Car Type Classification]
The GCSUSRT segment indicates haulage service → Classify as haulage car and assign to haulage line, updating unit assignment if not already express
[20:Car Type Classification]
Route segments show CPRS to CSXT or CSXT to CPRS interchange through DET → Assign car to CSXT line, otherwise if route shows CPRS to NS or NS to CPRS interchange through DET, assign to NS line
[15:Spine Car Processing]
The car has 5 articulated segments → Count as 1 spine car and calculate 2.5 additional car lengths, for 4 segments count 2.0 additional lengths, for 3 segments count 1.5 additional lengths
[17:Articulated Double-Stack Car Processing]
The car has 5 articulated segments → Count as 1 double-stack car and calculate segment count additional car lengths, for 4 segments use 4 count, for 3 segments use 3 count
[52:Train Detail Totals Report Generation]
Generating the detail totals report → Display total locomotive count, aggregated loaded/empty/high car counts by railroad line, and special car type counts (3/4/5 segment spine and double-stack cars) with rounded values
[Check Position 23 of Train Record]
The system examines position 23 of the train root segment record → If the indicator at position 23 equals 'T', the tunnel report direction is set to 'NORTHBOUND', otherwise it is set to 'SOUTHBOUND'
[Is Train Record Type?]
The record type is a train record (HIST-DATA-KEY equals WS-US-CPRS) → The system moves the record data to train root segment for port extraction
[Extract Port from GCUTR-SECX-POR-PORT-CP]
Processing the train record in mainline section → The system moves GCUTR-SECX-POR-PORT-CP to WS-PORT for port identification
[Move Data to Train Root Segment]
The system processes the train header record → The system moves the history data to the train root segment structure
[Determine Car Type Classification]
The routing shows CPRS to CSXT or CSXT to CPRS through DET interchange → The car should be assigned to CSXT line
[Determine Car Type Classification]
The routing shows CPRS to NS or NS to CPRS through DET interchange → The car should be assigned to NS line
[Process Spine Car]
The car has 5 articulated segments → Count as 1 SL-5 car and calculate 2.5 articulated count (0.5 × 5)
[Process Spine Car]
The car has 4 articulated segments → Count as 1 SL-4 car and calculate 2.0 articulated count (0.5 × 4)
[Process Spine Car]
The car has 3 or other articulated segments → Count as 1 SL-3 car and set articulated count to 1.5
[Process Double-Stack Car]
The car has 5 articulated segments → Count as 1 DL-5 car and use segment count of 5
[Process Double-Stack Car]
The car has 4 articulated segments → Count as 1 DL-4 car and use segment count of 4
[Process Double-Stack Car]
The car has 3 or other articulated segments → Count as 1 DL-3 car and set segment count to 3
[Process Double-Stack Car]
The segment count is calculated → Add the segment count to additional car length and subtract 1 from the total
[More Cars in Train?]
The current car position is less than or equal to 50 and more cars exist → Continue processing the next car in sequence
[End Car Processing]
50 cars have been processed or no more cars exist in the segment → End the car processing loop and return to main train processing
[Perform Routing Analysis]
The system needs to determine railroad assignment → The system performs routing segment analysis to identify CSXT or NS interchange patterns, otherwise uses empty car indicator for line assignment
[CPRS-CSXT via Detroit?]
The first route SCAC is CPRS and second route SCAC is CSXT and the junction code is DET → The routing is classified as CPRS-CSXT Detroit interchange
[CPRS-NS via Detroit?]
The first route SCAC is CPRS and second route SCAC is NS and the junction code is DET → The routing is classified as CPRS-NS Detroit interchange
[CSXT-CPRS via Detroit?]
The first route SCAC is CSXT and second route SCAC is CPRS and the junction code is DET → The routing is classified as CSXT-CPRS Detroit interchange and treated as CSXT interchange
[NS-CPRS via Detroit?]
The first route SCAC is NS and second route SCAC is CPRS and the junction code is DET → The routing is classified as NS-CPRS Detroit interchange and treated as NS interchange
[Assign CSXT Carrier]
The system assigns carrier responsibility and the car is not expressway or haulage type → The car is assigned to CSXT carrier line and CSXT unit subscription if unit subscription is not already expressway or haulage
[Assign NS Carrier]
The system assigns carrier responsibility and the car is not expressway or haulage type → The car is assigned to NS carrier line and NS unit subscription if unit subscription is not already expressway or haulage
[Use Default CPRS Carrier]
The system performs default carrier assignment → The car is assigned to the empty car indicator value for that car position, or subscription 1 if the empty car indicator is 0 or less
[Retrieve Articulated Segment Count]
The system needs articulated car segment information → The articulated segment count is extracted from the UMLER specification data
[Perform Routing Analysis]
The system needs to determine final carrier assignment → The system initiates routing analysis to check for interchange patterns
[Check Route Segments for Detroit Interchange]
If consecutive routing segment pairs → The system checks for CPRS-CSXT or CPRS-NS interchange patterns through Detroit location
[CPRS-CSXT Detroit Route?]
A route segment shows CPRS to CSXT or CSXT to CPRS with Detroit location code → The system identifies this as a CSXT interchange route
[Set CSXT Carrier]
The CSXT interchange pattern is confirmed → The system assigns CSXT subscription to line subscription and conditionally updates unit subscription if not already set to express or haulage
[CPRS-N&S Detroit Route?]
A route segment shows CPRS to NS or NS to CPRS with Detroit location code → The system identifies this as an NS interchange route
[Set N&S Carrier]
The NS interchange pattern is confirmed → The system assigns NS subscription to line subscription and conditionally updates unit subscription if not already set to express or haulage
[Keep CPRS Carrier]
No Detroit interchange patterns are found or no routing segments exist → The system maintains the default CPRS carrier assignment
[CPRS to CSXT via Detroit?]
The first route segment shows CPRS as origin carrier AND the second route segment shows CSXT as destination carrier AND the routing location is Detroit → Set the CSXT interchange flag to true and mark route as found
[CPRS to N&S via Detroit?]
The first route segment shows CPRS as origin carrier AND the second route segment shows NS as destination carrier AND the routing location is Detroit → Set the NS interchange flag to true and mark route as found
[CSXT to CPRS via Detroit?]
The first route segment shows CSXT as origin carrier AND the second route segment shows CPRS as destination carrier AND the routing location is Detroit → Set the CSXT interchange flag to true and mark route as found
[N&S to CPRS via Detroit?]
The first route segment shows NS as origin carrier AND the second route segment shows CPRS as destination carrier AND the routing location is Detroit → Set the NS interchange flag to true and mark route as found
[Assign Car to CSXT Unit]
The car assignment process is executed → Assign the car to CSXT line subscription AND if the current unit subscription is not expressway or haulage, assign the car to CSXT unit subscription
[Assign Car to N&S Unit]
The car assignment process is executed → Assign the car to NS line subscription AND if the current unit subscription is not expressway or haulage, assign the car to NS unit subscription
[Continue to Next Segment]
The route checking process continues → Move to the next route segment pair and repeat the interchange detection process
[Move to Next Car Position]
More equipment segments exist in the train → Read the next equipment segment and reset car position to 1
[Read Container Routing Data]
Routing assignment is needed for the container car → Lookup container routing data using the US CCN key from the equipment segment
[Move to Next Car Position]
The system needs to check for following trailers → The car position is incremented by 1 or a new record is read if at end of current segment
[Count as SL-5 Spine Car]
The UMLER articulated segment count equals '5' → Increment the SL-5 spine car counter by 1
[Count as SL-4 Spine Car]
The UMLER articulated segment count equals '4' → Increment the SL-4 spine car counter by 1
[Count as SL-3 Spine Car Set Billing Factor = 1.5]
The spine car has three or fewer articulated segments → Increment the SL-3 spine car counter by 1 AND set the articulated count to 1.5 for billing purposes
[Calculate Articulated Count = 0.5 × Segment Count]
The segment count is 4 or 5 → Calculate articulated count as 0.5 multiplied by the segment count for billing purposes
[Move to Next Car Position]
The system needs to check for associated containers → Move to the next car position in the equipment segment OR read next record if at end of current segment
[Additional Car Length Calculation Add Articulated Count - 1]
The articulated count exceeds 1 segment → Add the articulated count to additional car length totals for the assigned carrier AND subtract 1 from the additional car length to account for the base car unit
[Perform Routing Analysis]
Routing analysis is required to determine carrier assignment → The system executes routing check procedures to identify CSXT or NS interchange patterns
[Use Empty Car Routing]
Default routing assignment is required → The system assigns the empty car routing indicator with minimum value of 1 if zero
[Calculate Additional Car Length]
The articulated segment count is greater than 1 → The system adds the segment count to additional car length totals and subtracts 1 from both line and train additional car length totals
[CPRS to CSXT via Detroit?]
The first SCAC is 'CPRS', second SCAC is 'CSXT', and junction is 'DET' → Set the car as CSXT interchange and assign to CSXT classification
[CPRS to N&S via Detroit?]
The first SCAC is 'CPRS', second SCAC is 'NS', and junction is 'DET' → Set the car as NS interchange and assign to NS classification
[CSXT to CPRS via Detroit?]
The first SCAC is 'CSXT', second SCAC is 'CPRS', and junction is 'DET' → Set the car as CSXT interchange and assign to CSXT classification
[N&S to CPRS via Detroit?]
The first SCAC is 'NS', second SCAC is 'CPRS', and junction is 'DET' → Set the car as NS interchange and assign to NS classification
[Apply Interchange Classification]
The car is not expressway or haulage type → Assign the car to the detected railroad classification and update unit assignment if not already set to express or haulage
[Use Default CPRS Classification]
All routing analysis attempts have been exhausted → Assign the car to default CPRS classification using empty car indicator or classification 1
[Perform Routing Analysis]
The system needs to determine railroad assignment → The system performs routing analysis to check for Detroit interchange routes
[Detroit Interchange Route Found?]
The route shows CPRS to CSXT through DET or CSXT to CPRS through DET → The system identifies this as a CSXT interchange route
[Detroit Interchange Route Found?]
The route shows CPRS to NS through DET or NS to CPRS through DET → The system identifies this as an NS interchange route
[Set CSXT Classification]
The container is not expressway or haulage service → The system assigns the container to CSXT line subscription and updates unit subscription to CSXT unless already expressway or haulage
[Set N&S Classification]
The container is not expressway or haulage service → The system assigns the container to NS line subscription and updates unit subscription to NS unless already expressway or haulage
[Use Empty Car Routing Default]
The system needs to assign a railroad classification → The system uses the empty car routing indicator for the current car position, defaulting to subscription 1 if the indicator is less than 1
[Get Articulated Segment Count from UMLER]
The system needs to determine segment count for car length calculations → The system should retrieve the articulated segment count from UMLER equipment data and store it for processing
[Add 1 to DL-5 Counter]
The articulated segment count equals 5 → The system should increment the DL-5 counter by 1 to track five-segment articulated cars
[Add 1 to DL-4 Counter]
The articulated segment count equals 4 → The system should increment the DL-4 counter by 1 to track four-segment articulated cars
[Add 1 to DL-3 Counter Set Segment Count = 3]
The articulated segment count is 3 or any other value → The system should increment the DL-3 counter by 1 and set the segment count to 3 for standardized calculations
[Lookup Car Routing Data]
The system needs to determine carrier classification → The system should lookup routing data using the car's CCN key from the GCSUSRT segment
[Determine Routing Classification]
The system needs to determine carrier assignment → The system should analyze routing segments to identify CSXT or NS interchange patterns through DET location
[Use Empty Car Routing Default to CPRS if Invalid]
No specific CSXT or NS interchange routing is found → The system should use the empty car routing indicator for the current car position, defaulting to CPRS classification if the indicator is less than 1
[Calculate Additional Car Length Add Segment Count Subtract 1 for Base]
The segment count is greater than 1 → The system should add the full segment count to additional car length totals for both the carrier line and train, then subtract 1 to account for the base single car unit already counted
[Get Articulated Segment Count]
The car has 5 articulated segments → Increment the DL-5 counter by 1
[Segment Count = 4?]
The car has 4 articulated segments → Increment the DL-4 counter by 1
[Increment DL-3 Counter Set Segment Count = 3]
The car has 3 or fewer articulated segments → Increment the DL-3 counter by 1 and set segment count to 3
[Perform Routing Analysis]
Routing analysis is performed → Determine appropriate carrier assignment based on routing segments
[Calculate Additional Car Length Add Segment Count Subtract 1 for Base]
The segment count is greater than 1 → Add segment count to additional car length totals and subtract 1 for base car length
[Call GCSA2RT Database]
The system performs a database lookup using the car's US CCN key with record type '13' and sequence '0001' → The system retrieves routing segment information from GCSA2RT database
[CPRS-CSXT Detroit Route?]
The system checks if first segment SCAC is 'CPRS', second segment SCAC is 'CSXT', and route code is 'DET' → If all conditions match, classify as CSXT interchange routing
[CPRS-NS Detroit Route?]
The system checks if first segment SCAC is 'CPRS', second segment SCAC is 'NS', and route code is 'DET' → If all conditions match, classify as NS interchange routing
[CSXT-CPRS Detroit Route?]
The system checks if first segment SCAC is 'CSXT', second segment SCAC is 'CPRS', and route code is 'DET' → If all conditions match, classify as CSXT interchange routing
[NS-CPRS Detroit Route?]
The system checks if first segment SCAC is 'NS', second segment SCAC is 'CPRS', and route code is 'DET' → If all conditions match, classify as NS interchange routing
[Apply CSXT Classification]
The system assigns railroad classification → Set line subscription to CSXT and update unit subscription to CSXT unless already set to express or haulage
[Apply NS Classification]
The system assigns railroad classification → Set line subscription to NS and update unit subscription to NS unless already set to express or haulage
[Use Default CPRS Classification]
The system needs to assign a railroad classification → Use the empty car indicator to determine line subscription, defaulting to CPRS (subscription 1) if no indicator is available
[Set Articulated Count = 2.5]
The UMLER articulated count equals 5 → The system adds 1 to the 5-segment spine car counter (WS-SL-5)
[Set Articulated Count = 2.0]
The UMLER articulated count equals 4 → The system adds 1 to the 4-segment spine car counter (WS-SL-4)
[Set Articulated Count = 1.5]
The UMLER articulated count is not 4 and not 5 → The system adds 1 to the 3-segment spine car counter (WS-SL-3) and sets the articulated count to 1.5
[Double-Stack Car Processing]
The UMLER articulated count equals 5 → The system adds 1 to the 5-segment double-stack counter (WS-DL-5)
[Double-Stack Car Processing]
The UMLER articulated count equals 4 → The system adds 1 to the 4-segment double-stack counter (WS-DL-4)
[Double-Stack Car Processing]
The UMLER articulated count is not 4 and not 5 → The system adds 1 to the 3-segment double-stack counter (WS-DL-3) and sets the segment count to 3
[Add Segment Count to Additional Car Length]
The segment count or articulated count is processed → The system adds the segment count to the railroad-specific additional car length counter and the train additional car length total, then subtracts 1 from both totals
[Lookup Container Routing Data]
The system performs routing lookup using the container's US CCN key → The system retrieves container routing data from GCSUSRT segment or marks as not found if key is spaces or low-values
[Haulage Container?]
The system checks the haulage indicator in the routing segment → The system classifies the container as haulage if the haulage flag is set
[Analyze Route Segments]
The system analyzes route segments for carrier interchange patterns → The system performs route segment checking to identify CSXT or NS interchange patterns
[CPRS-CSXT Detroit Route?]
The system finds route segments with CPRS-CSXT or CSXT-CPRS interchange through Detroit → The system identifies this as a CSXT interchange route and sets CSXT interchange flag
[Set CSXT Routing]
The system assigns routing classification → The system assigns CSXT line subscription and sets unit subscription to CSXT unless already expressway or haulage
[CPRS-N&S Detroit Route?]
The system finds route segments with CPRS-NS or NS-CPRS interchange through Detroit → The system identifies this as an NS interchange route and sets NS interchange flag
[Set N&S Routing]
The system assigns routing classification → The system assigns NS line subscription and sets unit subscription to NS unless already expressway or haulage
[GCSUSRT Found AND Haulage Flag Set?]
The GCSUSRT segment is found and the haulage flag is set to true → The car should be classified as HAULAGE type with haulage subscription assignment and unit subscription updated if not already express
[Check Route Segments for Detroit Interchange]
The routing analysis process is initiated for CPRS cars → The system should retrieve route segment information from GCSA2RT type 13 records and check up to 9 route segments for interchange patterns
[CPRS-CSXT Route via Detroit?]
A route segment shows CPRS to CSXT interchange through Detroit (DET) or CSXT to CPRS interchange through Detroit → The car should be classified as CSXT type with CSXT subscription assignment and unit subscription updated if not express or haulage
[CPRS-N&S Route via Detroit?]
A route segment shows CPRS to NS interchange through Detroit (DET) or NS to CPRS interchange through Detroit → The car should be classified as NS type with NS subscription assignment and unit subscription updated if not express or haulage
[Remain as CPRS Car]
No CSXT or NS interchange through Detroit is found in the routing segments → The car should remain classified as CPRS type with default subscription assignment
[Get Route Segment Pair]
The system processes route segments sequentially from 1 to 9 → Two consecutive route segments are extracted as a pair for interchange pattern matching
[Extract SCAC Codes and Junction]
The system parses each route segment → SCAC codes for both segments and junction code (R260) are extracted for interchange pattern matching
[CPRS->CSXT via DET?]
First SCAC is CPRS, second SCAC is CSXT, and junction is DET → Set CSXT interchange flag and assign car to CSXT line classification
[CPRS->NS via DET?]
First SCAC is CPRS, second SCAC is NS, and junction is DET → Set NS interchange flag and assign car to NS line classification
[CSXT->CPRS via DET?]
First SCAC is CSXT, second SCAC is CPRS, and junction is DET → Set CSXT interchange flag and assign car to CSXT line classification
[NS->CPRS via DET?]
First SCAC is NS, second SCAC is CPRS, and junction is DET → Set NS interchange flag and assign car to NS line classification
[Assign CSXT Line Classification]
The system assigns line classification for the car → Car line subscription is set to CSXT and unit subscription is set to CSXT unless it's already express or haulage
[Assign N&S Line Classification]
The system assigns line classification for the car → Car line subscription is set to NS and unit subscription is set to NS unless it's already express or haulage
[Use Default Empty Car Routing]
The system needs to assign a line classification → Use the empty car indicator for the current car position, defaulting to classification 1 if the indicator is less than 1
[Is Car CPRS Carrier?]
The car's line subscription equals CPRS subscription value → Route segment analysis is initiated to check for interchange patterns
[CPRS to CSXT via Detroit?]
The first segment SCAC is CPRS and the second segment SCAC is CSXT and the route location is DET → CSXT interchange flag is set and route is marked as found
[CPRS to N&S via Detroit?]
The first segment SCAC is CPRS and the second segment SCAC is NS and the route location is DET → NS interchange flag is set and route is marked as found
[CSXT to CPRS via Detroit?]
The first segment SCAC is CSXT and the second segment SCAC is CPRS and the route location is DET → CSXT interchange flag is set and route is marked as found
[N&S to CPRS via Detroit?]
The first segment SCAC is NS and the second segment SCAC is CPRS and the route location is DET → NS interchange flag is set and route is marked as found
[Set Car to CSXT Carrier]
The car is not classified as expressway or haulage → The car's line subscription is set to CSXT and unit subscription is updated if not already expressway or haulage
[Set Car to N&S Carrier]
The car is not classified as expressway or haulage → The car's line subscription is set to NS and unit subscription is updated if not already expressway or haulage
[Keep Default CPRS Carrier]
No valid interchange patterns are detected or route data is not found or car is not CPRS carrier → The car retains its default CPRS carrier assignment
[Get Routing Data from GCSA2RT]
The system attempts to retrieve routing data from GCSA2RT with record type 13 and sequence 0001 → Routing segment data is obtained for further route analysis, or empty data is returned if no routing information exists
[CPRS-CSXT Detroit Route?]
The first segment shows CPRS as origin carrier and second segment shows CSXT as destination carrier with Detroit (DET) as the interchange point → The car is classified as CSXT interchange traffic
[CPRS-NS Detroit Route?]
The first segment shows CPRS as origin carrier and second segment shows NS as destination carrier with Detroit (DET) as the interchange point → The car is classified as NS interchange traffic
[CSXT-CPRS Detroit Route?]
The first segment shows CSXT as origin carrier and second segment shows CPRS as destination carrier with Detroit (DET) as the interchange point → The car is classified as CSXT interchange traffic
[NS-CPRS Detroit Route?]
The first segment shows NS as origin carrier and second segment shows CPRS as destination carrier with Detroit (DET) as the interchange point → The car is classified as NS interchange traffic
[Assign CSXT Line Classification]
The system assigns line classification for the car → The car is classified under CSXT line and unit assignment is updated to CSXT unless it's already assigned to Express or Haulage
[Assign NS Line Classification]
The system assigns line classification for the car → The car is classified under NS line and unit assignment is updated to NS unless it's already assigned to Express or Haulage
[CPRS-CSXT Detroit Route?]
The route contains CPRS to CSXT or CSXT to CPRS segments with Detroit (DET) as the interchange point → The car should be identified as having CSXT interchange routing
[CPRS-N&S Detroit Route?]
The route contains CPRS to NS or NS to CPRS segments with Detroit (DET) as the interchange point → The car should be identified as having NS interchange routing
[Classify as CSXT Empty]
The car classification process is executed → The car should be classified under CSXT carrier with appropriate line subscription and unit assignment
[Classify as N&S Empty]
The car classification process is executed → The car should be classified under NS carrier with appropriate line subscription and unit assignment
[Classify as CPRS Empty]
The car classification process is executed → The car should be classified under CPRS carrier with appropriate line subscription
[Get Segment Count from UMLER]
Segment count is needed for additional car length calculation → Assign the UMLER articulated value to the segment count variable
[Segment Count > 1?]
Additional car length calculation is required → Increment DL-5 counter for reporting
[Segment Count > 1?]
Additional car length calculation is required → Increment DL-4 counter for reporting
[Segment Count > 1?]
Additional car length calculation is required → Set segment count to 3 and increment DL-3 counter for reporting
[Calculate Additional Length = Segment Count]
Additional car length needs to be calculated for billing → Add the segment count to carrier additional car length and train additional car length, then subtract 1 from both totals
[Accumulate Articulated Car Segment Counts]
Detail totals are being accumulated → The additional car length for the train is added to the overall additional car length total
[Round Spine Car Segments SL-3, SL-4, SL-5]
Detail report values are being prepared → Each spine car segment count (SL-3, SL-4, SL-5) is rounded to the nearest whole number and accumulated to totals
[Round Double-Stack Segments DL-3, DL-4, DL-5]
Detail report values are being prepared → Each double-stack car segment count (DL-3, DL-4, DL-5) is rounded to the nearest whole number and accumulated to totals
[Round Spine Car Segment Totals]
Generating the detail report → Each spine car segment type count is rounded using banker's rounding and added to respective spine car totals
[Round Double-Stack Car Segment Totals]
Generating the detail report → Each double-stack car segment type count is rounded using banker's rounding and added to respective double-stack car totals
[Record Type Check]
The system checks the record data key against the US CPRS identifier → If the data key matches US CPRS identifier, classify as train header record and initialize train root segment, otherwise classify as car equipment record and initialize equipment segment
[Perform Detroit Interchange Routing]
The system checks routing segments for Detroit interchange patterns → The system examines up to 9 routing segments to identify CPRS-CSXT or CPRS-NS interchange routes through Detroit
[Set CSXT Routing]
The routing shows CPRS to CSXT through Detroit or CSXT to CPRS through Detroit → The system assigns the car to CSXT classification and sets unit assignment to CSXT unless already assigned to expressway or haulage
[Set N&S Routing]
The routing shows CPRS to NS through Detroit or NS to CPRS through Detroit → The system assigns the car to NS classification and sets unit assignment to NS unless already assigned to expressway or haulage
[Default to CPRS Routing]
No haulage, CSXT interchange, or NS interchange routing is identified → The system assigns the car to CPRS classification as the default routing
[Save Current Car State]
The car processing is completed → The system saves the current line subscription, container indicator from the car record, and load indicator to working storage for future reference
[CPRS-CSXT via Detroit?]
The first route SCAC is 'CPRS' and the second route SCAC is 'CSXT' and the junction code is 'DET' → Set the route as found and mark as CSXT interchange
[CPRS-NS via Detroit?]
The first route SCAC is 'CPRS' and the second route SCAC is 'NS' and the junction code is 'DET' → Set the route as found and mark as NS interchange
[CSXT-CPRS via Detroit?]
The first route SCAC is 'CSXT' and the second route SCAC is 'CPRS' and the junction code is 'DET' → Set the route as found and mark as CSXT interchange
[NS-CPRS via Detroit?]
The first route SCAC is 'NS' and the second route SCAC is 'CPRS' and the junction code is 'DET' → Set the route as found and mark as NS interchange
[Set CSXT Interchange Flag / Set NS Interchange Flag]
CSXT interchange is detected → Assign the car to CSXT railroad classification and set unit assignment to CSXT if not already expressway or haulage
[Get Next Route Segment Pair / Continue to Next Segment]
The current segment pair does not match any interchange pattern → Continue processing the next sequential segment pair until all segments are processed or an interchange is found
[Extract First Route Info / Extract Second Route Info / Parse SCAC Codes and Junction]
Route information extraction is performed → Parse the first route segment for SCAC code and junction, parse the second route segment for SCAC code and junction, and make the information available for interchange pattern matching
[CPRS to CSXT via Detroit?]
The first route SCAC is 'CPRS' and the second route SCAC is 'CSXT' and the interchange point is 'DET' → The system should set the CSXT interchange flag to true and mark the route as found
[CPRS to N&S via Detroit?]
The first route SCAC is 'CPRS' and the second route SCAC is 'NS' and the interchange point is 'DET' → The system should set the Norfolk Southern interchange flag to true and mark the route as found
[CSXT to CPRS via Detroit?]
The first route SCAC is 'CSXT' and the second route SCAC is 'CPRS' and the interchange point is 'DET' → The system should set the CSXT interchange flag to true and mark the route as found
[N&S to CPRS via Detroit?]
The first route SCAC is 'NS' and the second route SCAC is 'CPRS' and the interchange point is 'DET' → The system should set the Norfolk Southern interchange flag to true and mark the route as found
[Assign Car to CSXT Carrier]
The CSXT interchange flag is set to true → The system should assign the car to CSXT railroad line and set unit assignment to CSXT if not already assigned to expressway or haulage
[Assign Car to N&S Carrier]
The Norfolk Southern interchange flag is set to true → The system should assign the car to Norfolk Southern railroad line and set unit assignment to NS if not already assigned to expressway or haulage
[Is Car CPRS?]
The car's line subscription equals CPRS subscription value → The car is identified as requiring Detroit interchange routing analysis
[Retrieve Routing Information from GCSA2RT]
The system looks up routing information using the car's US CCN key with record type 13 and sequence 0001 → The routing segment data is retrieved for interchange analysis
[CPRS to CSXT via Detroit?]
The first route segment shows CPRS and second shows CSXT with Detroit location code → The car is classified for CSXT interchange routing
[CPRS to N&S via Detroit?]
The first route segment shows CPRS and second shows NS with Detroit location code → The car is classified for NS interchange routing
[CSXT to CPRS via Detroit?]
The first route segment shows CSXT and second shows CPRS with Detroit location code → The car is classified for CSXT interchange routing
[N&S to CPRS via Detroit?]
The first route segment shows NS and second shows CPRS with Detroit location code → The car is classified for NS interchange routing
[Apply CSXT Classification]
The car is not classified as expressway or haulage → The car's line subscription is set to CSXT and unit subscription is updated to CSXT unless already set to expressway or haulage
[Apply N&S Classification]
The car is not classified as expressway or haulage → The car's line subscription is set to NS and unit subscription is updated to NS unless already set to expressway or haulage
[Keep Default CPRS Classification]
No CSXT or NS interchange routing is detected → The car retains its default CPRS classification
[Haulage Car?]
The car is classified as a haulage car → The car should be assigned to haulage unit with priority over other routing rules
[CPRS Car?]
The car line assignment is CPRS → The system should Execute routing segment analysis to determine carrier interchange
[CPRS-CSXT Detroit Route?]
The routing segments show CPRS to CSXT or CSXT to CPRS interchange through Detroit → The car should be identified for CSXT unit assignment
[CPRS-N&S Detroit Route?]
The routing segments show CPRS to NS or NS to CPRS interchange through Detroit → The car should be identified for NS unit assignment
[Current Unit = EXPRESS or HAULAGE?]
The current unit assignment is express or haulage → The existing priority unit assignment should be preserved
[Set New Unit]
The current unit assignment is not express or haulage → The car should be assigned to the appropriate interchange carrier unit (CSXT or NS)
[Accumulate Articulated Car Segment Totals]
Detail totals are being accumulated → The segment counts for spine cars and double-stack cars are added to their respective total counters
[Apply Banker's Rounding to Spine Car Segments]
Detail report values are being prepared → Each spine car segment type count is rounded using banker's rounding algorithm
[Apply Banker's Rounding to Double-Stack Segments]
Detail report values are being prepared → Each double-stack car segment type count is rounded using banker's rounding algorithm
[Write Detail Report Line]
Detail report generation is requested → A formatted report line is written containing all carrier-specific car counts and segment totals
[Articulated Car Segment Totals - Spine Cars]
Detail report generation processes spine car segments → The spine car counts are rounded and added to the corresponding segment type totals (SL-3, SL-4, SL-5) for overall reporting
[Articulated Car Segment Totals - Double-Stack Cars]
Detail report generation processes double-stack car segments → The double-stack car counts are rounded and added to the corresponding segment type totals (DL-3, DL-4, DL-5) for overall reporting
[Apply Rounding to Additional Car Length]
The additional car length total needs to be displayed in the totals report → The system applies rounding logic to convert fractional additional car lengths to whole numbers and moves the result to display format
[Write Separator Line]
A visual separator is needed before the articulated segment totals → The system writes a separator line to delineate the sections in the report
[Process Spine Car Segment Totals]
The articulated segment totals section is being generated → The system prepares SL-3, SL-4, and SL-5 spine car segment counts for rounding and display
[Apply Rounding to SL-3 Segments]
The SL-3 count needs to be displayed in the totals report → The system applies rounding logic to convert fractional SL-3 counts to whole numbers and moves the result to display format
[Apply Rounding to SL-4 Segments]
The SL-4 count needs to be displayed in the totals report → The system applies rounding logic to convert fractional SL-4 counts to whole numbers and moves the result to display format
[Apply Rounding to SL-5 Segments]
The SL-5 count needs to be displayed in the totals report → The system applies rounding logic to convert fractional SL-5 counts to whole numbers and moves the result to display format
[Process Double-Stack Segment Totals]
The articulated segment totals section is being generated → The system prepares DL-3, DL-4, and DL-5 double-stack segment counts for rounding and display
[Apply Rounding to DL-3 Segments]
The DL-3 count needs to be displayed in the totals report → The system applies rounding logic to convert fractional DL-3 counts to whole numbers and moves the result to display format
[Apply Rounding to DL-4 Segments]
The DL-4 count needs to be displayed in the totals report → The system applies rounding logic to convert fractional DL-4 counts to whole numbers and moves the result to display format
[Apply Rounding to DL-5 Segments]
The DL-5 count needs to be displayed in the totals report → The system applies rounding logic to convert fractional DL-5 counts to whole numbers and moves the result to display format
[Write Articulated Segment Headers]
The articulated segment section needs headers before data output → The system writes blank header, articulated totals headers, and separator to format the articulated segment section
[Write Second Totals Line with Segment Data]
The second totals line needs to be written to the report → The system writes the formatted totals line containing spine car segments (SL-3, SL-4, SL-5) and double-stack segments (DL-3, DL-4, DL-5)
[Calculate SL-3 Spine Car Totals with Rounding]
Generating the articulated car segment totals section of the report → The SL-3 spine car count is rounded using banker's rounding and moved to the summary display field
[Calculate SL-4 Spine Car Totals with Rounding]
Generating the articulated car segment totals section of the report → The SL-4 spine car count is rounded using banker's rounding and moved to the summary display field
[Calculate SL-5 Spine Car Totals with Rounding]
Generating the articulated car segment totals section of the report → The SL-5 spine car count is rounded using banker's rounding and moved to the summary display field
[Calculate DL-3 Double-Stack Totals with Rounding]
Generating the articulated car segment totals section of the report → The DL-3 double-stack car count is rounded using banker's rounding and moved to the summary display field
[Calculate DL-4 Double-Stack Totals with Rounding]
Generating the articulated car segment totals section of the report → The DL-4 double-stack car count is rounded using banker's rounding and moved to the summary display field
[Calculate DL-5 Double-Stack Totals with Rounding]
Generating the articulated car segment totals section of the report → The DL-5 double-stack car count is rounded using banker's rounding and moved to the summary display field
[Write Separator Line]
Transitioning to the articulated car segment totals section → A separator line is written to the report to visually separate the sections
[Write Articulated Segment Headers]
Beginning the articulated segment totals section of the report → A blank line is written, followed by articulated segment headers, then another separator line
[Write Second Totals Line with Segment Counts]
Outputting the articulated segment totals line of the report → The formatted totals line containing SL-3, SL-4, SL-5 spine car counts and DL-3, DL-4, DL-5 double-stack counts is written to the report
[Write Final Separators and Blank Lines]
Completing the train detail totals section of the report → A separator line is written followed by a blank line to properly close the totals section

Structural Validations

[Valid Route Segments?]
The system examines consecutive route segment pairs → Route segments are valid if both current and next route info fields are not spaces or low-values, otherwise segments are invalid and analysis stops
[GCSUSRT Record Found?]
The system attempts to retrieve GCSUSRT segment data → The system determines if a valid GCSUSRT record exists for further processing
[Routing Segments Found?]
The system retrieves GCSA2RT routing data → The system determines if valid routing segments exist for interchange evaluation
[Route Segments Valid?]
The current route segment or next route segment is empty or contains low-values → Skip route processing and exit the routing check procedure
[Container Has Routing Data?]
The container has a valid US CCN key that is not spaces or low-values AND GCSUSRT segment is found → Container has routing data available for carrier classification
[Routing Found?]
The routing analysis identifies valid CSXT or NS interchange patterns → The system uses the identified routing for carrier classification
[Valid Route Segment Pair?]
Two consecutive route segments are examined → If either segment is empty or contains low-values, skip to next segment pair, otherwise process the segment pair
[Valid Route Segment Pair?]
The system examines consecutive route segment pairs for valid data → If both segments in a pair contain data (not spaces or low-values), extract routing information, otherwise skip to next pair or exit if no more segments
[Valid Route Segments?]
The system checks if either segment is spaces or low-values → If either segment is invalid, terminate route search and use default routing, otherwise proceed with SCAC code extraction
[Valid Segment Pair?]
Either the current segment or the next segment contains spaces or low-values → The segment pair is considered invalid and analysis terminates
[Routing Data Found?]
The system checks the status of the routing data retrieval → Route segment analysis proceeds if data is found, otherwise routing analysis is terminated
[Valid Segment Pair?]
The system checks if both segments contain non-space and non-low-values data → Route analysis continues if both segments are valid, otherwise the route search is terminated
[Route Segments Valid?]
The first route segment is empty, low-values, or the second route segment is empty or low-values → The routing process should terminate and mark route as not found
[Route Info Empty or Low-Values?]
Either route segment contains spaces or low-values → The system should exit route validation and stop processing remaining segments
[Routing Data Found?]
The system checks if valid routing data was returned → The car either proceeds to route segment analysis or defaults to CPRS classification
[Valid Route Segments?]
Both current and next route segments are not spaces or low-values → The route segments are considered valid for interchange classification

Module: GCX138A 1 Consolidated Epic Story

Epic: GCX138A Complete EDI Specification Extracted from Legacy

Contains 28 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX138A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[3:Checkpoint Validation]
The checkpoint number is numeric and greater than or equal to 1 → A confirmation message with the checkpoint value is displayed
[Use Configured Checkpoint Value]
The value is numeric AND the value is greater than or equal to 1 → The configured checkpoint frequency is used and a confirmation message is displayed
[Display Invalid Checkpoint Message]
The default value assignment is complete → The system displays a message indicating invalid checkpoint and the default value being used
[Display Checkpoint Configuration Message]
The system validates the checkpoint number as acceptable → The system displays a confirmation message showing the checkpoint frequency that will be used
[Use Default Checkpoint Value]
The system attempts to read the checkpoint file and reaches end of file → The system assigns the default checkpoint value and displays an invalid checkpoint message
[Display Invalid Checkpoint Message]
The system switches to default checkpoint value → A message is displayed indicating invalid checkpoint and the default value being used
[Display Checkpoint Configuration]
The checkpoint value is ready for use in processing → A confirmation message is displayed showing the checkpoint value that will be used
[Set Unqualified SSA Flag]
Database search parameters are being configured → Unqualified SSA flag is set to 'Y' to enable unqualified segment search
[Call Database Interface GCCTBIO]
System needs to execute database access → GCCTBIO interface is called with communication area, PCB flags, function code, table literal, key values, and work segment
[Extract Table Key from Segment]
System processes the retrieved segment data → First 20 characters of table segment are moved to GCSTBRT key value field
[Execute Delete Operation]
The deletion operation is executed → The system calls the table segment handler to Execute the deletion
[Display Shutdown Message]
The system receives shutdown request during checkpoint processing → The system displays shutdown message and prepares error message for termination
[Terminate Program]
The system processes shutdown request → The system calls error handling routine to terminate the program
[Display Shutdown Message]
The shutdown notification process executes → A message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX138' must be displayed to the console
[Trigger Program Abend]
Program termination is triggered → The program must execute abend procedure to terminate processing gracefully
[Execute Database Reposition Call]
The database reposition call is executed → The database operation should be performed through the table segment interface

Structural Validations

[3:Checkpoint Validation]
The file is empty or at end of file → The default checkpoint value is used and an invalid checkpoint message is displayed
[3:Checkpoint Validation]
The checkpoint number is not numeric or is less than 1 → The default checkpoint value is used and an invalid checkpoint message is displayed
[Set Checkpoint to Default Value 500]
The file read operation encounters end of file condition (no data found) → The checkpoint frequency is set to the default value and an invalid checkpoint message is displayed
[Checkpoint Number Valid?]
The value is either not numeric:
the value is less than 1
→ The checkpoint frequency is set to the default value and an invalid checkpoint message is displayed
[Is Checkpoint Number Numeric?]
If the checkpoint number is numeric → If the checkpoint number is not numeric, the system uses the default checkpoint value and displays an invalid checkpoint message
[Is Checkpoint Number > 0?]
If the checkpoint number is greater than zero → If the checkpoint number is less than 1, the system uses the default checkpoint value and displays an invalid checkpoint message
[Set Error Message: DELETE FAILED]
The system detects the deletion failure → The system sets error message to 'DELETE FAILED' and calls the error handler
[Set Error Message]
The system detects the failure → The error message is set to 'DELETE FAILED'
[Call Error Handler]
Error handling is required → The system calls the error handler program 'CERR'
[Set Error Message]
Error message assignment occurs → The error message must be set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX137' for error handling
[Handle Reposition Error]
The system processes the repositioning failure → Error message is set to 'REPOSITION FAILED' and error handling routine is called
[Handle Reposition Error]
The reposition error is detected → An error message 'REPOSITION FAILED' should be set and error handling should be invoked

Module: GCX138B 1 Consolidated Epic Story

Epic: GCX138B Complete EDI Specification Extracted from Legacy

Contains 63 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX138B EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize DS Segment Structure]
Creating a new DS segment → The DS segment structure is initialized with spaces to ensure clean data structure
[Initialize DS Segment Count to Zero]
Setting up the DS segment count field → The DS segment count is set to zero
[Initialize New KS Segment Structure]
The system prepares the KS segment structure → The KS segment area is cleared to spaces
[Initialize Segment Count to Zero]
The system initializes segment fields → The segment count field is set to zero

Core Acceptance Criteria

[2:Read Checkpoint Configuration]
The checkpoint number is numeric and greater than or equal to 1 → A message displaying the checkpoint value is shown
[4:Process Table Entries by Type]
The table ID is evaluated → SD entries are processed as DS segments and SK entries are processed as KS segments
[5:Build DS Segment from SD Entry]
Building the DS segment → Table ID is set to 'DS', port code is copied from SD entry, segment count is set to zero, and port name is copied from SD entry
[7:Build KS Segment from SK Entry]
Building the KS segment → Table ID is set to 'KS', city code is copied from SK entry, segment count is set to zero, and name is copied from SK entry
[6:Insert DS Segment]
The insertion is successful (status code is spaces) → The DS inserted count is incremented by 1
[8:Insert KS Segment]
The insertion is successful (status code is spaces) → The KS inserted count is incremented by 1
[13:Display Processing Statistics]
Termination procedures are executed → The number of entries read, DS segments inserted, and KS segments inserted are displayed
[Display Invalid Checkpoint Message]
The system applies the default checkpoint value → An invalid checkpoint message is displayed showing the default value being used
[Display Checkpoint Configuration Message]
The system confirms the checkpoint frequency → A message is displayed showing the checkpoint frequency that will be used
[Save Key Value for Repositioning]
The key value needs to be preserved for repositioning → The first 20 characters of the table segment are saved as the repositioning key
[Evaluate Table ID]
If the table ID field of the entry → The entry is routed to DS segment processing if table ID equals 'SD', or routed to KS segment processing if table ID equals 'SK'
[Route to DS Segment Processing Table ID = 'SD']
The system routes the entry for processing → The DS segment building process is performed for the entry
[Route to KS Segment Processing Table ID = 'SK']
The system routes the entry for processing → The KS segment building process is performed for the entry
[Copy Current SD Segment Data]
The system begins DS segment creation process → The current SD segment data is copied to preserve the original information
[Set DS Table ID to 'DS']
Setting up the DS segment identification → The DS table ID field is set to 'DS'
[Copy Port Code from SD to DS]
Building the DS segment from SD data → The port code from the SD entry is copied to the DS segment port code field
[Copy Port Name from SD to DS]
Completing the DS segment data population → The port name from the SD entry is copied to the DS segment port name field
[Prepare DS Segment for Insertion]
Finalizing the DS segment creation process → The DS segment is moved to the working storage area ready for insertion
[Move DS Segment to Working Storage]
The system prepares to insert the DS segment → The DS segment data is moved to working storage for processing
[Execute Insert Operation]
The system executes the insert operation → The DS segment is inserted into the database table and database call counter is incremented
[Increment DS Insertion Counter]
The insertion status indicates success → The DS insertion counter is incremented by 1
[Set Insert Function Code to ISRT]
The insert operation is initiated → The function code is set to ISRT to indicate an insert operation
[Execute Table Segment Insert]
The table segment insert is executed → The table access module is called to Execute the insert operation
[Insert Successful?]
The operation return status is evaluated → If return flag equals 0 then insert is successful, otherwise insert failed
[Load Current SK Segment Data]
The system begins building the KS segment → The current SK segment data is loaded into the working table segment area
[Set Table ID to 'KS']
The system sets up the segment structure → The table ID field is set to 'KS'
[Copy City Code from SK to KS]
A KS segment is being built from the SK data → The city code from the SK segment is copied to the KS segment city code field
[Copy City Name from SK to KS]
A KS segment is being built from the SK data → The city name from the SK segment is copied to the KS segment name field
[Prepare KS Segment for Processing]
The system completes the KS segment creation → The completed KS segment is moved to the working table segment area
[Execute Database Insert Operation]
The database insert operation is executed through the table access module → The KS segment is inserted into the database table
[Increment DLI Calls Counter]
The insert operation completes regardless of success or failure → The DLI calls counter is incremented by 1
[Increment KS Insertion Counter]
The insert success condition is met → The KS inserted count is incremented by 1
[Execute Database Insert Call]
The database insert is executed → The table segment access routine is called to Execute the insert operation
[Handle IMS Shutdown Request]
The system detects the checkpoint failure → An IMS shutdown request message is set and the system initiates termination process
[Handle Checkpoint Failure]
The system detects checkpoint failure → An IMS shutdown request message is set and the system prepares for abnormal termination
[Call GCCTBIO Database Routine]
Database access is required → GCCTBIO routine is called with communication area, PCB flag, SSA flag, function code, table identifier, key values, segment data, and return flag
[Pass Segment Data]
Segment data needs to be passed → WS-TABLE-SEGMENT is passed containing the segment data
[Save Entry Key for Repositioning]
The entry key needs to be preserved for potential repositioning → The first 20 characters of the table segment are moved to both the entry key value and the repositioning key storage
[Display DS Segments Inserted Count]
The system displays processing statistics → The total count of DS segments inserted is displayed with descriptive label
[Display KS Segments Inserted Count]
The system displays processing statistics → The total count of KS segments inserted is displayed with descriptive label
[Insert Operation Failed?]
The system checks the insertion operation return status → The system identifies whether the insertion operation failed or succeeded

Structural Validations

[2:Read Checkpoint Configuration]
The checkpoint file cannot be read or is at end of file → The checkpoint number is set to the default value and a message is displayed
[2:Read Checkpoint Configuration]
The checkpoint number is not numeric or is less than 1 → The checkpoint number is set to the default value and a message is displayed
[Insert Successful?]
The system checks the insertion result status → The insertion is considered successful if the status code is spaces (blank)
[Insert Error is Duplicate Key?]
The system checks the error type → If the error is a duplicate key (status code 'II'), the error is ignored, otherwise error handling is invoked
[Call Error Handler]
The error requires handling → The error handler is called with the message 'INSERT FAILED'
[Call Error Handler]
Error handling is required → Set error message to 'INSERT FAILED' and call the error handler module
[Insert Successful?]
The operation return status is evaluated → If the status code is spaces then the insert is considered successful, otherwise it failed
[Duplicate Key Error?]
The failure status code is evaluated → If the status code is 'II' then it indicates a duplicate key error, otherwise it is a different type of insert failure
[Log Insert Failure Error]
The insert failure is not due to duplicate key → An 'INSERT FAILED' error message is logged through the error handling module
[Log Insert Failure Error]
Error logging is required → The error message is set to 'INSERT FAILED' for proper error reporting
[Set Error Message: 'REPOSITION FAILED']
Error message needs to be set → The error message should be set to 'REPOSITION FAILED'
[Call Error Handler]
Error handling is required → The error handler routine should be called to process the error
[Set Error Message to 'INSERT FAILED']
The system processes the insert failure → The system sets the error message to 'INSERT FAILED'
[Call Error Handler]
The system needs to handle the insert failure → The system calls the error handler program 'CERR'
[Set Error Message: 'REPOSITION FAILED']
Setting error message for reposition failure → Error message is set to 'REPOSITION FAILED'
[Call Error Handler]
Calling error handler for reposition failure → Error handler routine is invoked to process the reposition failure
[Set Error Message: REPOSITION FAILED]
The system detects the failure condition → The error message is set to 'REPOSITION FAILED' to indicate the specific failure type
[Call Error Handler]
The system needs to handle the error condition → The error handler routine is called to process the failure

Module: GCX139 1 Consolidated Epic Story

Epic: GCX139 Complete EDI Specification Extracted from Legacy

Contains 237 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX139 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize FDA and N9-ED Flags to 'N']
The system begins processing N9 reference segments → The FDA flag is set to 'N' and the N9 export documentation flag is set to 'N' as default values
[Initialize Reference Counter]
The system begins processing N9 reference entries → The reference counter (N9-CNT) is initialized to zero
[Initialize Export Documentation Flags]
The system begins processing N9 segments for export qualifiers → FDA flag is set to 'N' and N9 export documentation flag is set to 'N' and export documentation found indicators are set to not found
[Initialize Empty BK Segment]
BK table record is not found → An empty BK segment is initialized with default values
[Initialize Empty B1 Segment]
B1 table record is not found → An empty B1 segment is initialized with default values
[Initialize reference counter]
The system begins processing N9 reference segments → The reference counter (N9-CNT) is initialized to zeros
[Initialize FDA and N9-ED Flags to 'N']
The system starts processing N9 segments for a cargo manifest → FDA flag is set to 'N' and N9 export documentation flag is set to 'N' to indicate no regulatory requirements initially found
[Initialize Sequence Counter to 5]
The additional party segment search is initiated → The sequence counter is set to 5 to begin processing from the fifth party segment

Core Acceptance Criteria

[4:Cargo Record Filtering - Filter records based on transport type, skip broker bond records, and apply notification suppression flags]
If the cargo for processing eligibility → The system processes only immediate transport or transport export cargo and skips all other transport types and broker bond records
[20:Generate Deletion Audit Log - Create audit trail entry for manifest deletion with appropriate message]
The system processes cargo deletion → The system adds cargo CCN to audit trail, increments audit counter, and generates audit message for manifest deletion with delete pending status
[22:Notify Broker of Cargo Deletion - Send notifications to brokers for CPRS cargo sent electronically]
The system processes broker notifications for deletion → The system retrieves broker information from BK and B1 tables, and sends notifications via Merlin, Internet, or Fax based on broker preferences, defaulting to Fax for office code 99
[25:Notify Interchange Handler of Deletion - Send deletion notifications to interchange handlers using station index]
The system processes interchange handler notifications → The system retrieves IH table information using station index, sets cargo record type and deletion status, retrieves N9 shipment information, and calls interchange handler notification service
[Use Default Checkpoint Value]
Default checkpoint configuration is applied → Set checkpoint interval to system default value and display invalid checkpoint message to console
[Read Next SD Table Record]
A request is made to read the next SD table record → The system should execute a database call to retrieve the next available SD table segment and update the status code accordingly
[Extract Location Name]
The system processes the configuration data → The location name should be extracted from the SD segment and prepared for storage in the memory table
[Extract Arrival Days Limit]
The system processes the timing configuration data → The arrival days limit should be extracted from the SD segment and prepared for storage
[Extract Export Days Limit]
The system processes the timing configuration data → The export days limit should be extracted from the SD segment and prepared for storage
[Read Next US Cargo Record]
The system requests the next cargo record from GCSUSRT segment → The system retrieves the next available cargo record and updates processing counters
[Database Call Count > Checkpoint Interval?]
The database call counter is compared against the checkpoint interval parameter → The system determines whether checkpoint processing is required based on the counter exceeding the interval
[Extract Party Information - Get shipper, consignee, notify parties, and broker information from cargo segments]
Party information extraction is performed using segment records 03 with sequences 0001, 0002, 0003, 0004 and additional sequences 5-49 → The system should capture shipper ID, name, city and province, consignee ID, name, city and province, notify party 1 and 2 details with ID, name, city and province, and identify payer of freight from any segment with payer of freight entity code
[Extract Cargo Physical Details - Capture quantity, commodity codes, descriptions, weight, and manifest unit information]
Physical details extraction is performed using segment record 07 → The system should capture manifest quantity, released quantity, manual release date, commodity code ID, commodity description, manifest unit code, weight, and weight unit code
[Process FDA Regulatory Qualifiers - Handle N9 segments with 2K qualifier to set FDA flags based on reference patterns]
An N9 segment has qualifier '2K' AND the reference number positions 5-6 equal 'PN' → The FDA flag should be set to 'P' for pharmaceutical, otherwise set to 'Y' for general FDA requirements
[Process Export Documentation Qualifiers - Extract export numbers and permits from N9 segments with export qualifiers]
An N9 segment has a valid export qualifier (AE, AH, AM, AT, AW, AX, AY, AZ, EX, FT, IT, SN, TE, TF, TM, TP, TS, TT, TU, TW, TX, TY, TZ) → The N9-ED flag should be set to 'Y' and the export number should be captured from the reference number field
[Extract Payer of Freight Information - Identify and capture payer of freight details from multiple N3 segments across sequence numbers]
Additional segments from sequence 5 to 49 are processed AND an entity ID code indicates payer of freight → The payer of freight name should be captured and stored in the flat file record
[Process Export Permit and Documentation References - Extract export permits and documentation numbers from N9 segments with EP qualifiers]
An N9 segment has qualifier 'EP' → The export permit number should be captured from the reference number field
[Extract CCN - US Cargo Control Number]
The system processes cargo identification data extraction → The US Cargo Control Number is extracted and assigned to the report CCN field
[Extract Car ID from Index]
The system processes cargo identification data extraction → The car identification number is extracted from the index and assigned to the report car ID field
[Extract Bill of Lading Type Code]
The system processes cargo identification data extraction → The bill of lading type code is extracted and assigned to the report bill type field
[Extract In-Bond Type Code]
The system processes cargo identification data extraction → The in-bond type code is extracted and assigned to the report bond type field
[Extract Bond Destination Location]
The system processes cargo identification data extraction → The primary location name is extracted and assigned to the report bond destination field
[Extract Foreign Destination Location]
The system processes cargo identification data extraction → The secondary location name is extracted and assigned to the report foreign destination field
[Entry Number Available?]
The system checks for entry number availability → If entry number exists and is not spaces, use entry number as bond identifier, otherwise use in-bond control number as bond identifier
[Use Entry Number as Bond Identifier]
The system determines bond identifier selection → The entry number is extracted and assigned to the report bond field
[Use In-Bond Control Number as Bond Identifier]
The system determines bond identifier selection → The in-bond control number is extracted and assigned to the report bond field
[Extract Bond Owner Information]
The system processes cargo identification data extraction → The bond owner information is extracted and assigned to the report bond owner field
[Extract Bond Start Date]
The system processes cargo identification data extraction → The bond start date is extracted and assigned to the report bond start date field
[Extract Border Crossing Location]
The system processes cargo identification data extraction → The border crossing location name is extracted and assigned to the report border crossing field
[Extract Broker Information]
The system processes cargo identification data extraction → The broker data is extracted and assigned to the report broker field
[Extract Broker Bond Number]
The system processes cargo identification data extraction → The broker QP bond number is extracted and assigned to the report broker bond field
[Extract Broker C4 Flag]
The system processes cargo identification data extraction → The broker C4 flag is extracted and assigned to the report broker C4 field
[Extract Shipper Information - Sequence 0001]
The system reads cargo segment record type 03 sequence 0001 for shipper information → The system extracts shipper entity ID, name, city, province, and CHOP code and populates the corresponding report fields
[Extract Consignee Information - Sequence 0002]
The system reads cargo segment record type 03 sequence 0002 for consignee information → The system extracts consignee entity ID, name, city, province, and CHOP code and populates the corresponding report fields
[Extract First Notify Party - Sequence 0003]
The system reads cargo segment record type 03 sequence 0003 for first notify party information → The system extracts notify party 1 entity ID, name, city, and province and populates the corresponding report fields
[Is Payer of Freight?]
The notify party entity ID code indicates payer of freight designation → The system captures the notify party name as the payer of freight name in the report
[Extract Second Notify Party - Sequence 0004]
The system reads cargo segment record type 03 sequence 0004 for second notify party information → The system extracts notify party 2 entity ID, name, city, and province and populates the corresponding report fields
[Process Additional Notify Parties - Sequences 0005-0049]
The system iterates through cargo segments 03 with sequence numbers from 0005 to 0049 and the segment contains data → The system checks each additional notify party for payer of freight designation and captures the name if found
[Read Commodity Segment GCSUSS07]
The system reads the commodity segment GCSUSS07 using record type '07' and sequence '0001' → The commodity segment data is retrieved and made available for further processing
[Extract STCC Commodity Code]
The system processes the commodity information → The STCC commodity code from field GCUS-N1005-COMM-CDE-ID position 01 is extracted and stored in the report structure
[Extract Commodity Description]
The system processes the commodity information → The commodity long description from field GCUS-N1002-LONG-DESC is extracted and stored in the report structure
[Populate Physical Details in Report]
The system populates the report structure → All physical details including STCC code, description, quantities, weight, and unit codes are stored in their respective report fields
[Set C4 Flag from Line Release Number]
The line release number field is evaluated → If line release number is not spaces, set CPRS-C4 flag to 'Y', otherwise set to 'N'
[Process FDA Flag - 2K Qualifier]
The reference number is examined for FDA requirements → If reference number positions 5-6 contain 'PN', set FDA flag to 'P' for Prior Notice, otherwise set to 'Y' for FDA Required
[Process Export Documentation - Valid Export Qualifier]
The qualifier is identified as a valid export documentation type → Set N9-ED flag to 'Y' and extract the reference number as the export number
[Process Export Permit - EP Qualifier]
The EP qualifier is identified → Extract the reference number as the export permit number
[Read N9 Reference Segments]
Processing N9 segments for regulatory flags → Continue processing segments until maximum occurrences reached or both FDA flag is found and N9-ED flag is found, or segment data is spaces or low-values
[Extract Payment Method from BX03-SHIP-METH-PAY]
The system reads the payment segment (record type '02', sequence '0001') and the segment is found successfully → The payment method is extracted from the BX03-SHIP-METH-PAY field and stored in the report record
[Process FDA Reference - 2K Qualifier]
The qualifier code is '2K' indicating FDA reference → The system sets the FDA found flag to true and processes the reference number for FDA requirements
[Process Export Documentation - Valid Export Qualifier]
The qualifier code is a valid export qualifier (one of the predefined export documentation codes) → The system sets the N9 export documentation found flag to true and extracts the export number
[Extract Export Permit Number from N902-REF-NUM]
The system processes the EP qualifier reference → The export permit number is extracted from the N902-REF-NUM field and stored in the export permit number field
[Both FDA and Export Documentation Found?]
Both FDA reference has been found and export documentation reference has been found → The system terminates the N9 processing loop early to avoid unnecessary processing
[PACT Bypass Enabled?]
If the PACT arrival flag (GCT3-PACT-ARR-FLAG) → If PACT arrival flag equals 'Y', display skip message and end processing; otherwise proceed with automatic arrival
[Display Auto Arrival Skipped Message]
Automatic arrival processing is being skipped → A message 'AUTO ARRIVAL SKIPPED FOR CCN - [cargo control number]' is displayed and arrival processing ends
[Location Has Custom Arrival Days?]
If arrival time configuration → If SD arrival days field contains spaces or is not numeric, use default; otherwise use the custom arrival days value
[Prepare Arrival Transaction Message]
The system creates the arrival transaction message → The US CCN key from the cargo record must be assigned to the transaction train or US CCN field
[Set Record Type to US Cargo 'UC']
The system sets the transaction record type → The record type code must be set to 'UC' to indicate US cargo processing
[Running Environment?]
The system determines how to send the transaction → If running in BPE environment, route to EXCI interface; otherwise route to IMS message queue for TPE environment
[Send Transaction via EXCI Interface]
The arrival transaction needs to be sent → The transaction must be formatted for EXCI communication and transmitted using the CSIEXCI program with proper transaction name, message length, and communication data
[Send Transaction via IMS Message Queue]
The arrival transaction needs to be sent → The transaction must be sent using IMS CHNG, WRITMSGL, and PURG calls through the alternate PCB
[Set Failure Return Code]
The system finalizes the failed transaction processing → The return code must be set to failure status to indicate processing error
[Immediate Transport?]
The system checks if the cargo is classified as immediate transport (88-GCUSRT-M1201-IMM-TRANSP) → If the cargo is immediate transport, the system skips export processing and ends the check
[Already Exported?]
The system checks the cargo status description (GCUSRT-RT10B-CPCARGO-STAT-DSC) → If the status is 'MNL-EXP' or 'AUT-EXP' or 'EXPORT', the system skips export processing and ends the check
[Immediate Transport?]
The system checks if the cargo is classified as immediate transport → If the cargo is immediate transport, the system skips export processing
[Set Security Parameters for Export Transaction]
The system prepares the export transaction message → The security byte must be set to high-values to establish proper transaction authorization
[Set Action Code to 'CEX' - Cargo Export]
The system defines the transaction action type → The action code must be set to 'CEX' to indicate cargo export processing
[Running Environment?]
The system determines the processing environment → If running in BPE environment, use EXCI interface; otherwise use IMS message queue for TPE environment
[Send Transaction via EXCI Interface - BPE Environment]
The transaction needs to be sent → The system must call CSIEXCI program with transaction name GCT1121E and properly formatted message data
[Send Transaction via IMS Message Queue - TPE Environment]
The transaction needs to be sent → The system must use CIMS calls with CHNG, WRITMSGL, and PURG functions to send the message through ALT-PCB
[CPRS Cargo Sent Electronically?]
The system checks if cargo SCAC is CPRS and EDI was sent electronically → Broker notification process is initiated if both conditions are true, otherwise broker notification is skipped
[Lookup Interchange Handler Config]
The system looks up interchange handler configuration using station index in IH table → If IH configuration is found, interchange handler notification process is initiated
[Extract Shipment Reference Info]
The system retrieves cargo segment 02 record 0001 and processes N9 reference qualifiers → Shipment ID is extracted from N902 field where N901 qualifier equals 'CN' for up to 20 iterations
[Send IH Deletion Notification]
The system prepares IH notification → GCCIH is called with cargo record type, DELETED status, car ID, waybill, CCN, and shipment ID
[Generate Deletion Audit Log]
The system generates audit log → A GCT1051E transaction is created with US cargo type, ZZZ action code, and message 'MANIFEST IN DELPEND STATUS - DELETED'
[Update Cargo Record]
The system updates the cargo record → GCCUSIO is called with GCSUSRT segment, REPL function, and index not used flag to replace the cargo record
[Send External Deletion Transaction]
The system determines external notification requirements based on valid port and cargo type (export, US-CAN-US, or multi-transit) → GCCS309E is called for valid port cargo types, otherwise GCCS309 is called with delete action and GCX107 transmission flags
[Set Audit Message 'MANIFEST IN DELPEND STATUS - DELETED']
The audit message is being set for the deletion log → The message 'MANIFEST IN DELPEND STATUS - DELETED' is assigned to the audit entry
[Running Environment?]
The system checks the current runtime environment → IF the system is running in BPE environment THEN route to EXCI transmission ELSE route to IMS message transmission
[Send Audit via EXCI External CICS Interface]
The audit transmission is initiated via EXCI → The audit message is formatted for EXCI transmission AND the GCT1051E transaction is invoked AND the audit data is sent through the external CICS interface
[Send Audit via IMS Message Processing]
The audit transmission is initiated via IMS → The audit message is prepared for IMS processing AND the message is written to the alternate PCB AND the message is purged to complete transmission
[Move Input Data to Transaction Message]
The system prepares to send the broker notification → The input data is moved to the transaction message structure for processing
[Running Environment?]
The system checks the runtime environment configuration → If running in BPE environment, use EXCI interface; if running in TPE environment, use IMS message queue
[Send Transaction via EXCI Interface - BPE Environment]
The transaction needs to be transmitted → The transaction is sent using EXCI interface with proper transaction name and message data
[Send Transaction via IMS Message Queue - TPE Environment]
The transaction needs to be transmitted → The transaction is sent using IMS message queue with proper message formatting
[Set Success Return Code]
All EXCI response indicators show zero values and no abend code → The system return code is set to success status
[Write Message to IMS Queue]
The broker print transaction needs to be queued for processing → The message is written to the IMS message queue with proper message code and length
[Purge Message Queue]
The message transmission is complete → The IMS message queue is purged to finalize the transaction
[Lookup Interchange Handler Configuration]
The system needs to notify interchange handlers of cargo deletion → The system looks up IH table configuration using the station index from the cargo record
[Set Record Type to US Cargo]
Preparing deletion notification message for interchange handler → Set the record type to US cargo identifier in the notification message
[Set CCN Status to DELETED]
Preparing the deletion notification message → Set the CCN status field to 'DELETED' in the notification message
[Extract Car ID from Cargo Index]
Preparing interchange handler deletion notification → Extract the car ID number from the cargo record index and include it in the notification message
[Extract Waybill Number from Cargo Index]
Preparing interchange handler deletion notification → Extract the first 15 characters of waybill number from the cargo record index and include it in the notification message
[Extract CCN from Cargo Record]
Preparing interchange handler deletion notification → Extract the US CCN key from the cargo record and include it in the notification message
[Get Shipment Reference Information]
Additional shipment reference information is needed for interchange handler notification → Retrieve N9 reference segments using CCN key with record type '02' and sequence '0001'
[Search N9 Segments for CN Qualifier]
Searching for shipment identification references → Iterate through up to 20 N9 reference entries and identify those with reference number qualifier equal to 'CN'
[Extract Shipment ID Reference]
Processing CN qualified reference entries → Extract the reference number from CN qualified entries and assign it as the shipment ID in the notification message
[Send Deletion Notification to Interchange Handler]
All notification data has been compiled → Send the complete notification message to the interchange handler system using the GCCIH interface
[Set Up Cargo Record Key for N9 Segment Access]
The system needs to access N9 reference segments → The cargo key is set to the US CCN key, record type is set to '02', and sequence is set to '0001'
[Access N9 Reference Segments - Record Type 02, Sequence 0001]
The system attempts to retrieve N9 reference segments → The system calls the database access routine to fetch N9 segments with record type '02' and sequence '0001'
[Process Up to 20 N9 Reference Entries]
The system processes N9 entries → The system performs the processing loop exactly 20 times, incrementing the counter by 1 each iteration
[Call Email Service EMCSEND2]
The system needs to send cargo deletion notifications → The EMCSEND2 external service must be called with all configured parameters including sender code, destination filename, recipient code, copy recipient, subject, keywords, message text, return status flag, and item type
[Loop Through N9 Segments]
The system processes N9 segments sequentially from index 1 to maximum occurrences → Each N9 segment should be evaluated for FDA regulatory qualifiers until all segments are processed or FDA and export documentation flags are both found
[Qualifier = '2K'?]
The reference qualifier equals '2K' → Process this segment for FDA regulatory requirements, otherwise skip to next segment
[Reference Pattern Contains 'PN'?]
The reference number contains 'PN' in positions 5-6 → Set FDA flag to 'P' for prior notice requirement, otherwise set FDA flag to 'Y' for general FDA requirement
[Set FDA Flag to 'P' - Prior Notice]
The FDA prior notice pattern is identified → The FDA flag should be set to 'P' and FDA found status should be set to true
[Set FDA Flag to 'Y' - FDA Required]
The FDA regulatory qualifier is identified without prior notice requirement → The FDA flag should be set to 'Y' and FDA found status should be set to true
[Read N9 Segment Data from GCSUSS02]
The system needs to process export documentation from N9 segments → N9 segment data is retrieved from record type '02' sequence '0001' using the cargo's US CCN key
[More N9 Segments to Process?]
If whether to continue processing more segments → Processing continues if index is less than or equal to maximum N9 occurrences and current N9 data is not spaces or low values and either FDA is not found or export documentation is not found
[Get N9 Reference Qualifier]
The system needs to identify the type of export reference → The N901 reference qualifier is extracted from the current N9 segment and stored in work field for evaluation
[Display IMS Shutdown Message]
The system processes the shutdown request → Display shutdown message to console and set error message in common area
[Perform Program Termination]
The system initiates program termination → The program performs abend processing to terminate execution
[IMS Shutdown Request Received]
An IMS shutdown request is received (indicated by non-space status code after checkpoint call) → The system displays shutdown message to console, sets error message, closes all open files, calls error handler, and terminates the program
[Move Railroad Initials to Work Field]
Railroad initials are found in the SS table segment → The railroad initials (GCSTBRT-SS-RAILROAD-INITIALS) are moved to the work field (WORK-2ND-NOTIFY)
[Set PACT Arrival Flag Based on Configuration]
The system processes the crossing table lookup result → Set PACT arrival flag based on the crossing table segment configuration and exit the lookup process
[Prepare Audit Message Structure]
The audit message needs to be formatted for transmission → The GCX105 input structure is moved to the GCT1051E message format
[Running in BPE Environment?]
The system needs to determine the transmission method → If running in BPE environment, use EXCI transaction method, otherwise use IMS message method
[Send Audit via EXCI Transaction]
Audit transmission is initiated via EXCI → The CSIEXCI program is called with the audit message data and transaction parameters
[Calculate Message Length]
Message length calculation is required → The communication area length is computed as GCT1051E message length plus 4 bytes, and call data length includes EXCI header plus message length
[Set Transaction Name to GCT1051E]
Transaction name needs to be specified → The EXCI transaction name is set to GCT1051E
[Set Success Return Code]
Return code needs to be set → The return code in CCCOM control block is set to RC-SUCS (success)
[Set Failure Return Code]
Return code needs to be updated → The return code in CCCOM control block is set to RC-FAIL (failure)
[Send Audit via IMS Message]
Audit transmission is initiated via IMS → The audit message is sent through IMS using CHNG, WRITMSGL, and PURG calls with ALT-PCB2
[Change to Alt PCB]
PCB change is required → The system calls CIMS with CHNG function using ALT-PCB2 and GCT1051E message
[Write Message via WRITMSGL]
Audit message needs to be written to queue → WRITMSGL is called with ALT-PCB2, message code, message content, message length, and module name
[Purge Message Queue]
Message transmission needs to be completed → CIMS is called with PURG function using ALT-PCB2 to purge the message queue
[Store BK Segment Data]
BK table record is found → The retrieved BK segment data is stored for further processing
[Store B1 Segment Data]
B1 table record is found → The retrieved B1 segment data is stored for notification processing
[Set up cargo record key for N9 segment retrieval]
The system needs to retrieve N9 segments for shipment reference extraction → The cargo record key is set to the US CCN key, record type is set to '02', and sequence is set to '0001'
[Read N9 segments from cargo record]
The system attempts to read N9 segments from the cargo database → The system calls the database access function to retrieve the N9 segment data
[Loop through up to 20 N9 reference segments]
The system processes N9 reference segments → The system performs exactly 20 iterations, incrementing the counter by 1 each time
[Check N9 qualifier = 'CN'?]
The system checks the N9 reference number qualifier at the current counter position → If the qualifier (GCUS-N901-REF-NUM-QUAL) equals 'CN', proceed to extract the reference number, otherwise continue to the next segment
[Extract reference number as shipment ID]
The system extracts the shipment reference information → The reference number (GCUS-N902-REF-NUM) at the current counter position is moved to the shipment ID field (GCWIH-SHIPMENT-ID)
[Extract Party Information - Get shipper, consignee, notify parties, and broker information from cargo segments]
The system reads segment 03 with sequence 0001 for shipper information → Shipper entity ID, name, city, province, and CHOP code are extracted and stored for flat file output and PACT validation
[Extract Party Information - Get shipper, consignee, notify parties, and broker information from cargo segments]
The system reads segment 03 with sequence 0002 for consignee information → Consignee entity ID, name, city, province, and CHOP code are extracted and stored for flat file output and PACT validation
[Extract Party Information - Get shipper, consignee, notify parties, and broker information from cargo segments]
The system reads segment 03 with sequence 0003 for first notify party → First notify party entity ID, name, city, and province are extracted and if the party is payer of freight, the name is also stored in payer field
[Extract Party Information - Get shipper, consignee, notify parties, and broker information from cargo segments]
The system reads segment 03 with sequence 0004 for second notify party → Second notify party entity ID, name, city, and province are extracted and if the party is payer of freight, the name is also stored in payer field
[Extract Payer of Freight Information - Identify and capture payer of freight details from multiple N3 segments across sequence numbers]
The system processes each segment to identify payer of freight entities → The payer of freight name is captured from any segment where the entity is identified as payer of freight
[Extract Cargo Physical Details - Capture quantity, commodity codes, descriptions, weight, and manifest unit information]
The system reads the commodity information → STCC code, commodity description, and CPRS C4 flag based on line release number are extracted and stored
[Process FDA Regulatory Qualifiers - Handle N9 segments with 2K qualifier to set FDA flags based on reference patterns]
The system finds an N9 segment with qualifier '2K' → FDA flag is set to 'P' if reference number contains 'PN' in positions 5-6, otherwise set to 'Y', and FDA found flag is set to true
[Process Export Documentation Qualifiers - Extract export numbers and permits from N9 segments with export qualifiers]
The system finds N9 segments with valid export qualifiers or EP qualifier → N9-ED flag is set to 'Y' and export number is captured for valid export qualifiers, and export permit number is captured for EP qualifier
[Extract Payment and Reference Information - Get payment method and process N9 reference segments for export permits]
The system reads the payment information and segment is found → Payment method is extracted from the ship method pay field
[Read Commodity Segment Data]
The system reads commodity segment data using CCN key with record type 07 and sequence 0001 → The commodity segment GCSUSS07 is retrieved for further processing
[Extract STCC Code and Description]
The system extracts STCC code and description → The commodity code ID from position 01 is assigned as STCC code and the long description is extracted for the output record
[Read Shipper Information Segment]
The system reads shipper information using CCN key with record type 03 and sequence 0001 → The shipper segment GCSA2RT is retrieved for shipper data extraction
[Extract Shipper Details and Location]
The system extracts shipper details and location → Shipper entity ID, name, city, province code, and CHOP code are extracted and assigned to output record and work variables
[Read Consignee Information Segment]
The system reads consignee information using CCN key with record type 03 and sequence 0002 → The consignee segment GCSA2RT is retrieved for consignee data extraction
[Extract Consignee Details and Location]
The system extracts consignee details and location → Consignee entity ID, name, city, province code, and CHOP code are extracted and assigned to output record and work variables
[Read First Notify Party Segment]
The system reads first notify party information using CCN key with record type 03 and sequence 0003 → The first notify party segment GCSA2RT is retrieved for notify party data extraction
[Extract First Notify Party Details]
The system extracts first notify party details → Notify party entity ID, name, city, and province are extracted, and if entity is payer of freight, the name is also assigned to payer of freight field
[Read Second Notify Party Segment]
The system reads second notify party information using CCN key with record type 03 and sequence 0004 → The second notify party segment GCSA2RT is retrieved for notify party data extraction
[Extract Second Notify Party Details]
The system extracts second notify party details → Second notify party entity ID, name, city, and province are extracted, and if entity is payer of freight, the name is also assigned to payer of freight field
[Search Additional Segments for Payer of Freight]
The system searches additional segments from sequence 5 to 49 for payer of freight → Each segment is read and if the entity is designated as payer of freight, the name is assigned to the payer of freight field
[Extract Quantity and Release Information]
The system extracts quantity and release information → Manifest quantity, released quantity, and manual release date are extracted and assigned to the output record
[Read Payment Method Segment]
The system reads payment method segment using CCN key with record type 02 and sequence 0001 → The payment method segment GCSUSS02 is retrieved for payment information extraction
[Extract Payment Method Information]
The system extracts payment method information and the segment read was successful → The shipping method payment code is extracted and assigned to the payment method field in the output record
[Process N9 Reference Segments]
The system processes N9 reference segments up to maximum occurrences or until both FDA and export documentation are found → Each N9 segment is evaluated for qualifier type and processed accordingly until all segments are processed or both flags are found
[Set FDA Flag Based on 2K Qualifier]
If the 2K qualifier reference number → FDA flag is set to 'P' if reference number positions 5-6 equal 'PN', otherwise set to 'Y', and FDA found status is set to true
[Set Export Documentation Flag]
The system processes export qualifier types → Export documentation flag is set to 'Y', export number is extracted from reference number, and export documentation found status is set to true
[Extract Export Permit Numbers]
The system processes EP qualifier type → Export permit number is extracted from the reference number and assigned to the export permit number field
[Extract Disposition Information]
The system extracts disposition information → Disposition code and disposition date are extracted and assigned to the output record
[Set FDA and N9-ED Status to Not Found]
The system prepares to search for regulatory documentation requirements → FDA status is set to not found and N9 export documentation status is set to not found
[Loop Through N9 Segments in GCSUSS02]
The system processes N9 segments sequentially → Processing continues until maximum occurrences are reached or N9 data is spaces or low-values or both FDA and export documentation requirements are found
[Process 2K Qualifier - FDA Related]
If the N9 reference qualifier → The segment is processed for FDA regulatory requirements determination
[Process Export Qualifiers - AE, AF, AM, AT]
If the N9 reference qualifier → The segment is processed for export documentation requirements
[Both FDA and N9-ED Found?]
Both FDA status is found and N9 export documentation status is found → N9 processing is completed without processing remaining segments
[Loop Through N9 Reference Segments]
Processing FDA requirements and FDA has not been found yet → The system should continue processing each N9 segment sequentially until FDA is found or maximum segments are reached
[Reference Number Position 5-6 = 'PN'?]
Characters at positions 5-6 of the reference number equal 'PN' → The cargo requires Prior Notice FDA processing
[Set FDA Flag to 'P' - Prior Notice Required]
Prior Notice requirement is identified → The FDA flag should be set to 'P' indicating Prior Notice is required
[Set FDA Flag to 'Y' - FDA Required]
General FDA requirement is identified → The FDA flag should be set to 'Y' indicating FDA requirements apply
[Set FDA Found Flag]
FDA flag has been set to either 'P' or 'Y' → The FDA found control flag should be set to prevent processing additional segments
[Loop Through N9 Reference Segments]
Processing export documentation requirements → The system should loop through each N9 segment from index 1 up to the maximum occurrences by sequence until either all segments are processed or the segment data is spaces or low-values or both FDA and export documentation flags are found
[Extract Reference Qualifier from N901]
The system needs to identify the type of reference qualifier → The N901 reference number qualifier should be moved to the export qualifier work field for evaluation
[Set Export Documentation Flag to 'Y']
The system processes the export documentation requirement → The export documentation found indicator should be set to true and the export documentation flag should be set to 'Y'
[EP Qualifier Export Permit?]
The system checks for export permit qualifiers → If the qualifier is 'EP', the system should process it as an export permit number, otherwise continue to the next segment
[Extract Export Permit Number from N902]
The system processes the export permit information → The N902 reference number should be moved to the export permit number field in the report record
[Valid Export Qualifier? AE, AF, AM, AT]
The system processes FDA documentation requirements → The FDA found indicator should be set to true, and if the 5th and 6th characters of the N902 reference number are 'PN', the FDA flag should be set to 'P', otherwise the FDA flag should be set to 'Y'
[Read Shipper Segment - Record 03, Sequence 0001]
The system processes record type 03 with sequence 0001 for shipper information → The shipper entity ID, name, city, and state/province are extracted and stored in the report structure
[Read Consignee Segment - Record 03, Sequence 0002]
The system processes record type 03 with sequence 0002 for consignee information → The consignee entity ID, name, city, and state/province are extracted and stored in the report structure
[Read First Notify Party - Record 03, Sequence 0003]
The system processes record type 03 with sequence 0003 for first notify party information → The first notify party entity ID, name, city, and state/province are extracted and stored in the report structure
[Read Second Notify Party - Record 03, Sequence 0004]
The system processes record type 03 with sequence 0004 for second notify party information → The second notify party entity ID, name, city, and state/province are extracted and stored in the report structure
[Search Additional N3 Segments - Sequences 5 through 49]
The system iterates through sequences 5 to 49 for additional party information → Each additional segment is examined for payer of freight designation until found or all segments are processed
[Is Current Party Payer of Freight?]
The party entity identifier indicates payer of freight role → The party name is captured as the payer of freight name in the report
[Extract Shipper CHOP Code for PACT Processing]
The system reads the party segment data → The system extracts and stores the shipper CHOP code for PACT arrival checking
[Extract Consignee CHOP Code for PACT Processing]
The system reads the party segment data → The system extracts and stores the consignee CHOP code for PACT arrival checking
[Read N3 Segment Data for Current Sequence]
The system reads the party segment data for the current sequence → The party segment data is retrieved and made available for party type evaluation
[Is Party Type = Payer of Freight?]
If the party type indicator in the segment → The system identifies if this party is designated as a payer of freight based on the entity identification code
[Extract Payer of Freight Name]
The system extracts the party name from the segment → The payer of freight name is captured from the party name field in the segment
[Store Payer Name in Report Field]
The system updates the report data structure → The payer of freight name is stored in the report's payer name field for inclusion in the flat file output
[Increment Sequence Counter by 1]
The system prepares to continue to the next party segment → The sequence counter is incremented by 1 to move to the next party segment number
[Check N3 Segment for Notify Party 1 - Sequence 3]
The system processes the notify party 1 segment and the entity identification code equals 'PF' (Payer of Freight) → The system captures the entity name from field N102 and stores it as the payer of freight name
[Check N3 Segment for Notify Party 2 - Sequence 4]
The system processes the notify party 2 segment and the entity identification code equals 'PF' (Payer of Freight) → The system captures the entity name from field N102 and stores it as the payer of freight name
[Loop Through Additional N3 Segments - Sequences 5 to 49]
The system processes each additional segment and finds an entity identification code equal to 'PF' (Payer of Freight) → The system captures the entity name from field N102 and stores it as the payer of freight name
[Process Export Permit and Documentation References - Extract export permits and documentation numbers from N9 segments with EP qualifiers]
Processing N9 segments and the reference number qualifier N901 equals 'EP' for export permit → Extract the export permit number from N902 reference field and store it in the export permit number field of the report record
[Extract Reference Number Qualifier from N901 Field]
The reference number qualifier in field N901 is evaluated → Check if the qualifier equals 'EP' to identify export permit documentation
[Extract Export Permit Number from N902 Reference Field]
The export permit number needs to be extracted → Move the reference number from field N902 to the export permit number field in the report record

Structural Validations

[15:Check Export Processing Eligibility - Process cargo with ARRIVED status, skip immediate transport, and verify export status]
If cargo for export processing → The system processes cargo only if bond save date is numeric, cargo is not immediate transport, and cargo status is not already MNL-EXP, AUT-EXP, or EXPORT
[Transport Type Check]
The system checks the cargo transport type → Only immediate transport or transport export cargo should be processed, all other transport types should be skipped
[Transaction Successful?]
The system checks the transaction result → If EXCI response code is zero AND response2 is zero AND abend code is space AND message length is zero, then the transaction is successful; otherwise it failed
[Log Error Message]
The system handles the error condition → Error details including EXCI response codes, response2, abend code, and any error messages must be displayed to system error output for troubleshooting
[Validate Transaction Response]
The system receives the response → The transaction is successful if EXCI response code is zero, response2 is zero, abend code is space, and message length is zero
[Log Error Message to System Error Log]
The system detects the failure condition → Error details including EXCI response codes and any error messages must be displayed to system error log
[Is Cargo CPRS and Sent Electronically?]
The system checks broker notification eligibility → Cargo must be CPRS type and have been sent electronically to proceed with broker notification
[Location ID Available?]
The system checks the P401-LOCATION-ID field in the cargo record → If the location ID is not spaces, proceed to extract location ID for SE table lookup, otherwise display location ID blank message and skip deletion process
[Display Location ID Blank Message]
The P401-LOCATION-ID field is spaces or empty → Display 'GCUSRT-P401-LOCATION-ID IS BLANK' message to indicate missing location information
[Audit Successful?]
The system checks the transmission result → IF the response code is zero AND response2 is zero AND abend code is space AND message length is zero THEN mark as successful ELSE mark as failed
[Display Error Message Log Audit Failure]
The error condition is being handled → An error message is displayed with the response codes AND IF an error message pointer exists THEN the detailed error message is displayed AND the return code is set to failure status
[Is Cargo CPRS and Sent Electronically?]
The system checks if cargo is CPRS and was sent electronically → The cargo qualifies for broker notification only if both conditions are met
[Is Broker Required?]
If broker requirement → Cargo must not have broker status of UNKNOWN or NOT REQUIRED to proceed with broker notification
[Is Cargo CPRS and Sent Electronically?]
The system checks broker notification eligibility → Cargo must be CPRS type AND have been sent electronically to proceed with broker notification
[Validate EXCI Response Code]
The system receives a response from the EXCI call → The response code, response2 code, abend code, and message length are validated for success indicators
[Display Error Message and Set Failure Code]
EXCI response shows non-zero response codes or abend code is present → Error messages are displayed with response details and return code is set to failure status
[IH Configuration Found?]
The system checks if valid configuration was retrieved → If configuration is not found (return flag not equal to '0'), skip interchange handler notification, otherwise proceed with notification setup
[Log Error Message]
The email service returns a non-successful status → The error status code must be moved to the error message code field and the standard error handling procedure must be called to log the failure
[More N9 Segments Available?]
The index is within maximum occurrences limit and the N9 data is not spaces or low-values and FDA/export documentation processing is not complete → Continue processing the next N9 segment, otherwise terminate the loop
[EXCI Call Successful?]
Response validation is performed → If EXCI response is zero, response2 is zero, abend code is space, and message length is zero, then the call is successful
[Display EXCI Error Details]
Error handling is required → Display EXCI error message with response codes and abend code, and if error message pointer is not null, display the error message content
[Is Cargo CPRS and Sent Electronically?]
The system checks if cargo is CPRS type and was sent electronically → The cargo is eligible for broker notification processing only if both conditions are met
[N9 segments found?]
The database access operation completes → If the status code is spaces (successful), proceed with N9 processing, otherwise skip N9 processing
[Set FDA Flag to 'P' - Prior Notice]
The reference number contains 'PN' in positions 5-6 → FDA flag is set to 'P' to indicate prior notice requirement and FDA status is set to found
[Set FDA Flag to 'Y' - FDA Required]
The reference number does not contain 'PN' in positions 5-6 → FDA flag is set to 'Y' to indicate FDA requirement and FDA status is set to found
[Set N9-ED Flag to 'Y' - Export Documentation Required]
The system processes the export qualifier → N9 export documentation flag is set to 'Y', export number is extracted from reference number, and N9-ED status is set to found
[Extract Export Permit Number]
The system processes the EP qualifier → Export permit number is extracted from the reference number field
[N9 Qualifier = '2K'?]
The N9 reference qualifier equals '2K' → The segment should be processed for FDA requirement determination
[Sequence Counter ≤ 49?]
The sequence counter is evaluated for continuation of processing → Processing continues if the sequence counter is less than or equal to 49, otherwise processing terminates
[Segment Data Available?]
The system checks for the existence of party segment data at the current sequence → Processing continues if segment data is available and not spaces, otherwise the search terminates
[Segment Data Available?]
The system attempts to read a segment and the segment data is spaces or empty → The system stops processing additional segments and completes the payer of freight extraction

Module: GCX139A 1 Consolidated Epic Story

Epic: GCX139A Complete EDI Specification Extracted from Legacy

Contains 2 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX139A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

None explicitly identified in logic extraction.

Structural Validations

[Date Calculation Error]
Date calculation fails or returns unsuccessful status → System logs 'ISCDTCAL ERROR' message and invokes error handling procedure
[Date Conversion Error]
Date conversion fails with error code not equal to '0' → System logs 'ISCDATECV ERROR' message and invokes error handling procedure

Module: GCX142 1 Consolidated Epic Story

Epic: GCX142 Complete EDI Specification Extracted from Legacy

Contains 59 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX142 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Determine Source Screen]
The message ID is evaluated for routing → If message ID is train menu screen, process train menu input; if message ID is train selection screen, process train selection; if message ID is train background, process background display; otherwise return to menu screen with unknown spawn error
[7:Process Train Selection Screen]
User performs an action or enters input → If invalid PF key, display invalid key message; if selection not available, display not available message; if input field empty, require train ID; if input changed, validate new train ID; if page back, show first page; if page forward, process next page; if line selected, process selection
[8:Handle Page Forward Navigation]
The page forward action is evaluated → If the last train ID on current screen is empty, display last page message; otherwise calculate the starting point for next page and retrieve next set of records
[21:Handle Train Not Found]
No matching train is found → Display train not found message and set cursor highlighting on the input field to indicate the error condition
[Route to Train Menu Processing]
The message ID equals the train menu screen module constant → The system performs train menu processing
[Route to Train Selection Processing]
The message ID equals the train selection screen module constant → The system performs train selection processing
[Route to Background Display Processing]
The message ID equals the train background module constant → The system performs background display processing
[Set Menu Screen as Default]
The message ID does not match any known screen module constants → The output selection code is set to menu screen
[Clear Input Field]
The message ID does not match any known screen module constants → The input field is cleared to spaces
[Store Selected Index Type]
The system needs to store the index type for future reference → Store the selected index type in the message index number field for communication with other system components
[Set Train Not Found Message]
No more matching train records are available in the database → The system sets the train not found message identifier
[Process Train ID Validation]
User requests page backward navigation → System validates and reads train ID and displays first page message
[Process Train ID Validation]
User presses page backward PF key → System validates and reads train ID, then displays first page message
[Check if Last Train ID on Screen is Empty]
The train ID in the last screen position (maximum screen number) is empty or contains spaces → Display last page message and terminate forward navigation process
[Calculate Time Complement for Proper Sequencing]
The system needs to calculate the database search key for proper time sequencing → Calculate time complement by subtracting the time work value from the maximum complement value (NINES-COMP2) and store in the appropriate train key position
[Display 'Last Page' Message]
The system determines that the last page has been reached → Set system message to indicate last page status
[Check if Last Line Has Train ID]
The system checks the last line of the maximum screen number for train ID availability → If the train ID field is empty (spaces), indicate no more trains are available and display last page message, otherwise proceed with pagination
[Parse Hour from Time String]
The system needs to parse the hour component → Extract characters 7-8 from the time string and move to hour work field
[Parse Minutes from Time String]
The system needs to parse the minutes component → Extract characters 10-11 from the time string and move to minutes work field
[Store Extracted Information for Next Page]
The system needs to create a database key for next page navigation → Calculate time complement by subtracting time work from nines complement and move the result to the first 4 positions of the database key train field
[Parse Hour and Minute Components]
The system needs to process the time for database search → The system parses the time string to extract hour component from positions 7-8 and minute component from positions 10-11
[Calculate Time Complement Value]
The system needs to create a database search key → The system calculates the time complement by subtracting the combined time value from the maximum complement value (NINES-COMP2)
[Parse Hour from Position 7-8]
System needs to process the hour component for time calculations → System extracts characters at positions 7-8 from the time string and stores them as the hour component
[Parse Minutes from Position 10-11]
System needs to process the minutes component for time calculations → System extracts characters at positions 10-11 from the time string and stores them as the minutes component
[Parse Hour from Time Display]
The system processes the time components for pagination → The system moves the hour portion from positions 7:2 of the split line to the time work hour field
[Parse Minutes from Time Display]
The system processes the time components for pagination → The system moves the minute portion from positions 10:2 of the split line to the time work minute field
[Calculate Time Complement Value]
The system calculates the pagination key → The system computes the time complement as NINES-COMP2 minus the TIME-WORK value
[Set Train ID for Display]
The system processes the train selection for display → Move the train ID from the selected line to the input message field and clear the rest of the message
[Extract Train ID from Selected Line]
The selected line contains train information → The system moves the train ID from the selected line to the input message field
[Set Output for Train Display]
The system prepares to navigate to train details → The system sets the output selection code to train foreground spawn and clears the rest of message area
[Accept Valid Line Selection]
The selected line contains train identification data (not spaces) → The system moves the train ID to input field, clears rest of message, sets foreground spawn code, and pushes selection code to stack
[Call Stack Management Program GCCSTACK]
The stack operation parameters are prepared with output selection code and current selection code → The GCCSTACK program is called with communication control, message area, output selection code, current selection code, and return code parameters
[Set Default Index to 3-position]
The index number field in the input message is empty (spaces) → The system sets the index switch to '3' to use 3-position train ID format
[Use Provided Index Number]
The index number field in the input message contains a value (not spaces) → The system uses the provided index number for train ID format selection
[Get Estimated Departure Date from Train List]
The system needs to format train times for display → The estimated departure date is extracted from GCWB4TL-P402-EDA and moved to TL-DATE for processing
[Get Estimated Time of Arrival from Train List]
The system needs to format train times for display → The estimated time of arrival is extracted from GCWB4TL-P405-ETA and moved to TL-TIME for processing
[Database Call Successful?]
The database call returns a non-successful status code → The system sets a train not found message and highlights the input field with cursor attribute
[Set Train Not Found Message]
No matching train record is found → The system sets the train not found system message number
[Highlight Input Field with Cursor]
The train not found message has been set → The system sets the input field attribute to cursor non-protected alphabetic high display
[Clear Train Root Segment]
The system needs to prepare for reading the next train record → The train root segment structure is cleared to spaces to ensure clean data retrieval
[Call Database with GN Command]
The system executes a Get Next (GN) database operation → The database call is made using CIMS with GN command, PCB, train segment, and SSA qualifier parameters

Structural Validations

[4:Validate Train ID Input Field]
The input field validation is performed → If the input field is valid, proceed to select index type and read train data; otherwise display appropriate error message
[10:Process Line Selection]
The line selection is processed → If selection is not alphabetic and within valid range and corresponds to a train with data, launch train foreground display; otherwise display invalid item message
[Set Unknown Spawn Error Message]
The message ID does not match any known screen module constants → The system message number is set to unknown spawn error
[Set Error Message and Cursor]
No matching train is found or validation fails → System sets train not found message and highlights the input field with cursor attribute for user correction
[Set Invalid PF Key Message, Display Invalid PF Key Message]
User presses an invalid PF key → System displays invalid PF key message
[Set PF Key Not Available Message]
User presses a PF key that is not available → System displays PF key not available message
[Clear Train Lines Display]
Input field is empty or contains only spaces → System clears train lines display, sets train ID required message, and positions cursor to input field
[Display PF Key Not Available Message]
User presses a PF key that is not available for current operation → System displays PF key not available message
[Clear Train Lines Display]
Input field is empty or contains only spaces → System clears train lines display, shows train ID required message, and sets cursor to input field
[Display Invalid Item Error]
The system needs to inform the user of the invalid selection → Set system message to invalid item error and highlight the input line attribute
[Is Input Alphabetic?]
The system checks if the input contains alphabetic characters → If input is alphabetic, mark as invalid and set error message, otherwise proceed with numeric processing
[Set Invalid Item Error]
The system needs to indicate invalid input to the user → Set the system message to invalid item error
[Justification Successful?]
The justification return flag indicates failure (not successful) → The system sets invalid item error message and highlights the input field with cursor
[Line Number Within Valid Range?]
The line number is less than the first page number or greater than the maximum screen number → The system sets invalid item error message and highlights the input field with cursor
[Accept Valid Line Selection]
The selected line contains no train identification data (spaces only) → The system sets invalid item error message and highlights the input field with cursor
[Log Error Message for Invalid Selection Code]
The system detects the failure condition → An error message is constructed containing the failure description and the invalid selection code value
[Call Error Handler CERR]
The error message has been prepared → The CERR error handling program is called with the communication control block containing the error details

Module: GCX143 1 Consolidated Epic Story

Epic: GCX143 Complete EDI Specification Extracted from Legacy

Contains 78 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX143 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Process Function Selection]
The message ID equals the train display error screen modifier → Process from train error screen, otherwise process normal train display
[5:Process Page Navigation]
The page backward key is processed → Display train records and set system message to 'first page'
[9:Navigate to Train Details]
The selected line contains a valid train ID (not spaces) → Set the train ID in message field, clear rest of message, and navigate to train foreground screen
[Check Message ID]
If the message ID against the train display error screen modifier constant → If the message ID equals the train display error screen modifier, route to train error screen processing, otherwise route to normal train display processing
[Route to Display Train Processing]
The system needs to display train information normally → Execute the display train processing function to retrieve and present train data
[Process Page Backward Request]
User selects page backward PF key → System processes train display and sets first page message
[Set Last Page Message]
Last screen line contains no train ID (is empty) → System sets last page message and exits page forward processing
[Set Last Page Message]
Database status indicates no records found → System sets last page message to inform user no more pages are available
[Clear Train Root Segment Buffer]
The system prepares to access train data from the database → The train root segment buffer is cleared to spaces to ensure no residual data affects the retrieval
[Last Line on Current Page Empty?]
The train ID in the last display line (maximum screen number position) is checked → If the train ID is empty (spaces), display 'Last Page' message and stop processing, otherwise proceed to get more records
[Display 'Last Page' Message]
The system determines there are no additional train records to display → Set the system message to 'Last Page' and terminate the page forward process
[Records Found?]
The database access status is checked → If the status code is spaces (successful), proceed to format new display lines, otherwise display 'Last Page' message
[Display 'Last Page' Message]
The database status indicates no records found → Set the system message to 'Last Page' to inform user they have reached the end
[Set First Page Message]
The PF key pressed equals page backward key → The system processes train display and sets the first page message number
[Page Backward Request]
User presses page backward function key (PAGE-BCK) → System displays first page of train records and sets first page message
[Set Last Page Message]
System determines last record on current page is empty or next page retrieval fails → System sets last page message to inform user they are at the end
[Records Found for Next Page?]
No records are found or retrieval fails → System sets last page message indicating no more records are available
[Clear Train Record Buffer]
The system prepares to access train data from the database → The train root segment buffer is cleared to spaces
[Get Next by Index]
The system needs to retrieve the next train record by index using sequential access → The system clears the train root segment, sets greater than operator, and calls IMS database with GN command to get the next record
[Get by Index]
The system needs to retrieve a specific train record by index using direct access → The system clears the train root segment, sets equal operator, and calls IMS database with GU command for index-based retrieval
[Get by Key]
The system needs to retrieve a specific train record by primary key → The system clears the train root segment and calls IMS database with GU command using the primary key
[Set Last Page Message]
The last displayed train ID is empty indicating no more records exist → Set system message to 'last page' and terminate page forward processing
[Clear Train Record Segment]
The system prepares to access train data → The train record segment is cleared to spaces to ensure no residual data remains
[Train Records Found?]
The system checks for available records → If records are found, continue with display processing, otherwise show no train error message
[Clear Train Root Segment Buffer]
The system initiates the retrieve first train record process → The train root segment buffer is cleared to spaces to remove any residual data
[Set Operator to Greater Than '>']
The system needs to retrieve the first train record from the database → The database operator is set to greater than '>' to initiate sequential retrieval from the beginning
[Call Database Interface CIMS with GN Command]
The system executes the train record retrieval → The CIMS database interface is called with GN command, train PCB, train root segment, and qualified SSA parameters
[Clear Train Root Segment]
The system prepares to execute a database operation → The train root segment is cleared to spaces to ensure clean data retrieval
[Execute IMS Get Next Call]
The system executes the get next database operation → The database management system is called to retrieve the next available train record using the configured parameters
[Clear Train Root Segment]
The system needs to prepare the train root segment for data retrieval → The train root segment is cleared of any existing data
[Execute IMS Get Next Call]
The system executes the IMS Get Next call for train records → The next sequential train record is retrieved from the database and the operation status is returned
[Set Train ID for Navigation]
The system processes the valid train selection → The system moves the train ID from the selected line to the message input field and clears the rest of the message area
[Justification Successful?]
The justification return flag indicates processing failure → The system sets invalid item error message and applies cursor highlighting to the input line attribute
[Move Train ID to Input Field]
The user selects a line containing a train ID that is not spaces → The system moves the train ID from the selected line to the input message field
[Clear Rest of Message]
The train ID has been moved to the input field → The system clears the rest of the message field to spaces
[Call GCCSTACK Service with Parameters]
The stack management service needs to be called → The GCCSTACK service should be invoked with communication area, message filler, output selection code, current selection code, and return code parameters
[Clear Train Root Segment Buffer]
The system prepares to query the train database → The train root segment buffer is cleared to spaces to ensure no residual data affects the query
[Call Database Interface CIMS with GN Operation]
The system executes the database retrieval operation → The CIMS database interface is called with GN operation, train PCB, train root segment, and qualified SSA parameters
[Clear Train Root Segment]
The system prepares to retrieve a specific train record → The train root segment data structure is cleared to spaces
[Execute Database Call with Equal Operator]
The system executes the database retrieval operation → A database call is made using GU operation with the train root segment and qualified search criteria
[Clear Train Root Segment Buffer]
The system prepares for train record retrieval → The train root segment buffer is cleared to spaces
[Set Last Page Message]
The last line on screen is empty indicating no more records are available → System should set last page message and terminate page forward processing
[Set Last Page Message - No More Records]
Database status indicates no records found (status not is empty) → System should set last page message to inform user that no more records are available
[Execute GN Call with Index Qualification]
The system executes a Get Next operation by index → The train root segment is cleared, greater than operator is set, and database call is executed with index qualification to retrieve the next available train record
[Execute GU Call with Index Qualification]
The system executes a Get Unique operation by index → The train root segment is cleared, equal operator is set, and database call is executed with index qualification to retrieve the specific train record
[Execute GU Call with Direct Key]
The system executes a Get Unique operation by direct key → The train root segment is cleared and database call is executed with direct key qualification to retrieve the specified train record
[Line Number is Valid - Continue Processing]
The line number is within the valid range (greater than or equal to first page and less than or equal to maximum screen number) → The system continues processing the line selection without setting error messages
[Check Database Status After Train Record Retrieval]
The database status code indicates no records were found (status code is not spaces) → The system sets a no train error message, clears the input field, and redirects to the train menu screen
[Clear Input Field]
The system is preparing to redirect the user → The system clears the message input field by setting it to spaces
[Set Output to Train Menu Screen]
The system needs to provide the user with navigation options → The system sets the output select code to navigate to the train menu screen

Structural Validations

[4:Validate PF Key Selection]
The PF key is an invalid selection → Set system message to 'PF key invalid'
[4:Validate PF Key Selection]
The PF key selection is not available → Set system message to 'PF not available'
[15:Manage Screen Pagination]
The last displayed train ID on current screen is empty → Set system message to 'last page' and stop navigation
[8:Justify Numeric Input]
The input contains alphabetic characters → Set system message to 'item invalid' and highlight the input field
[8:Justify Numeric Input]
The input is not alphabetic → Justify the number to 2 digits with zero fill, and if justification fails, set 'item invalid' message and highlight field
[18:Validate Input Line Numbers]
The line number is less than first page or greater than maximum screen number → Set system message to 'item invalid' and highlight the input field
[9:Navigate to Train Details]
The selected line does not contain a valid train ID (is spaces) → Set system message to 'item invalid' and highlight the input field
[19:Handle No Train Error Records]
No train records are found (database status indicates error) → Set system message to 'no train error', clear input field, and navigate to train menu screen
[Route to Train Error Screen Processing]
The system needs to handle error screen specific logic → Execute the train error screen processing function to handle user interactions and error conditions
[Set Invalid PF Key Error Message]
User selects an invalid PF key option → System sets invalid PF key error message for display
[Set PF Key Not Available Error Message]
User selects a PF key function that is not available → System sets PF key not available error message for display
[Set Invalid PF Key Error Message]
The PF key pressed equals invalid PF key selection code → The system sets the invalid PF key error message number
[Set Selection Not Available Error Message]
The PF key pressed equals selection not available code → The system sets the PF key not available error message number
[Display No Train Error Records Message]
Error handling is triggered → A no train error message is set and input field is cleared
[Is Input Numeric?]
The system checks if the input contains alphabetic characters → The system sets an invalid item error message and highlights the input field with error attributes if alphabetic characters are found
[Formatting Successful?]
The formatting operation return flag is checked → The system sets an invalid item error message and highlights the input field if formatting was not successful
[Line Number Within Valid Range?]
The system validates the line number against the valid range → The system sets an invalid item error message and highlights the input field if the line number is less than the first page number or greater than the maximum screen number
[Selected Line Has Train ID?]
The system checks if the selected line contains train ID data → The system sets an invalid item error message and highlights the input field if the selected line does not contain train ID data (contains spaces)
[Is Input Alphabetic?]
The input contains alphabetic characters → The system sets an invalid item error message and applies error highlighting to the input field
[Log Stack Error Message]
The system detects the stack operation failure → An error message is constructed containing failure details and current selection code, and error handling service is called
[Log Error Message for Invalid Selection Code]
Error logging is required → An error message should be constructed containing 'GCCSTACK FAILED WITH INVALIDE CUR-SEL-CODE:' followed by the invalid selection code value
[Call Error Handler]
Error handling is required → The CERR error handler should be called with the communication area containing the error message
[Check if Last Line on Screen is Empty]
The last line on the current screen display is empty (contains spaces) → System should prevent forward navigation and display last page message
[Log Stack Management Error]
Stack management error occurs → An error message is constructed with the failure details and current selection code, and the error handling service is called
[Line Number < First Page?]
The line number is less than the first page number → The system sets an invalid item error message and highlights the input field with error attributes
[Line Number > Max Screen Number?]
The line number is greater than the maximum screen number → The system sets an invalid item error message and highlights the input field with error attributes
[Set Invalid Item Error Message]
The line number is outside the valid range → The system sets the invalid item error message number and applies error display attributes to the input field
[Set No Train Error Message]
The system needs to inform the user about the absence of train data → The system sets the system message number to indicate no train error

Module: GCX144 1 Consolidated Epic Story

Epic: GCX144 Complete EDI Specification Extracted from Legacy

Contains 20 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX144 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[2:Copy Input to Output Message]
Message processing begins → The input message content is copied to the output message
[Is message from new train menu module?]
The system checks the message source → If the message ID equals new training menu module ID, proceed with training menu validation, otherwise proceed with alternative processing
[Is PF key ENTER?]
The system checks the function key pressed → If the PF key is ENTER, proceed with enter key validation, otherwise check for other key types
[Is PF key Selection Not Available?]
The system validates the function key type → If the PF key indicates selection not available, process unavailability message, otherwise treat as invalid function key
[Is message NOT from main menu module?]
The system checks if the message is also not from main menu module → If the message is not from main menu module, clear the input field, otherwise proceed without clearing
[8:Clear Input Field for Non-Main Menu]
The system processes the message → The input field is cleared by setting it to space
[9:Restore Program Control]
The system prepares to return control → The saved program name is restored to the current program context
[Transfer Complete Input Message Content to Output Message]
The system begins processing the message for display → The complete input message content must be transferred to the output message without modification
[Set output select code to train menu screen]
The system begins processing any input message → The output select code is set to the training menu screen as the default display
[Does message ID equal New Train Menu Module ID?]
The system checks if the message ID equals the new train menu module identifier (CST-NEW-TRAIN-MENU-MOD) → The system determines if the message is from the new train menu module and proceeds with appropriate validation or skips train menu specific processing
[Message is from New Train Menu Module - Proceed with validation]
The message ID equals CST-NEW-TRAIN-MENU-MOD → The system proceeds to validate the PF key actions within the training menu context
[Message is NOT from New Train Menu Module - Skip train menu processing]
The message ID does not equal CST-NEW-TRAIN-MENU-MOD → The system skips training menu specific validation and checks if additional input field clearing is required based on the source module
[Set Invalid Enter Message]
The validation determines the enter key press is not allowed → The system moves the ENTER-INVALID code to SYSTEM-MSG-NUM to indicate the error condition
[Set Selection Not Available Message Number]
The PF key pressed indicates selection not available → The system sets the selection not available message number for display to the user
[Clear Input Field]
The message ID != the main menu module ID → The input field should be cleared by setting it to spaces

Structural Validations

[5:Process Enter Key Validation]
The system validates the key press → The system message is set to Enter Invalid error
[6:Process Selection Not Available]
The system processes the selection not available condition → The system message is set to not available message number
[7:Process Invalid Function Key]
The system validates the function key → The system message is set to PF key invalid error
[Enter Key Detected]
The user presses the Enter key (GCMSG-PF-KEY equals ENTER-VALUE) → The system sets an invalid enter message (ENTER-INVALID) to the system message number
[Set Invalid PF Key Error Message]
The PF key pressed is not ENTER-VALUE and not SEL-NOT-AVAILABLE → The system sets PF-KEY-INVALID as the system message number to indicate an invalid function key was pressed

Module: GCX145 1 Consolidated Epic Story

Epic: GCX145 Complete EDI Specification Extracted from Legacy

Contains 85 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX145 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Train Root Segment]
The search operation is initiated → The train root segment should be cleared to spaces to ensure clean data retrieval

Core Acceptance Criteria

[2:Process Select Function Router]
Message ID is train menu module type → Process from train menu is executed
[2:Process Select Function Router]
Message ID is train selection module type → Process from train selection is executed
[2:Process Select Function Router]
Message ID is train display module type → Process from train display is executed
[2:Process Select Function Router]
Message ID does not match any known module types → Output is set to menu screen, system message is set to unknown spawn error, and input field is cleared
[5:Process From Train Selection]
Input field is empty or contains only spaces → Train lines are cleared, system message is set to enter selection, and input field attribute is set to cursor display
[5:Process From Train Selection]
Page backward PF key is pressed → Validate and read train ID process is executed and system message is set to first page
[7:Process Select Line]
Selected line contains a valid train ID → Train ID is moved to input field, rest of message is cleared, output select code is set to train foreground spawn, and push output select code process is executed
[Route to Train Menu Processing]
The message ID equals the train menu module constant → The system performs train menu processing
[Route to Train Selection Processing]
The message ID equals the train selection module constant → The system performs train selection processing
[Route to Train Display Processing]
The message ID equals the train display module constant → The system performs train display processing
[Set Menu Screen as Default]
The message ID does not match any known module constants → The output select code is set to menu screen
[Clear Train Lines Display, Show Enter Selection Message]
Input field is empty (GCMSG-INPUT-FIELD equals SPACES) → System clears train lines display, shows enter selection message, and sets cursor attribute for input
[Go to First Page, Show First Page Message]
User requests page back navigation (GCMSG-PF-KEY equals PAGE-BCK) → System validates and reads train ID, then displays first page message
[Input Field Empty?]
Input field is empty (spaces) → System clears train lines display, shows enter selection message, and sets cursor attribute for input
[PF Key = Page Back?]
User presses page backward function key → System validates and reads train ID input and displays first page message
[Clear All Train Line Fields]
Input field is empty (spaces) → System clears all train lines display and shows enter selection message with cursor positioned for input
[Extract Last Displayed Train Details]
User requests forward page navigation → Extract the input field value to 6-position format AND set index switch AND store index number in message
[Display 'Last Page' Message]
System determines end of data has been reached → Set system message to 'Last Page' indicator
[Last Train ID on Page Empty?]
The system checks the train ID in the last position of the current screen display → If the last train ID is empty (spaces), the system identifies this as the last page and displays a last page message
[Parse Hour from Time String]
The system needs to parse the hour component for time calculations → The system extracts characters 7-8 from the split line and assigns them to the time work hour field
[Parse Minutes from Time String]
The system needs to parse the minutes component for time calculations → The system extracts characters 10-11 from the split line and assigns them to the time work minutes field
[Calculate Time Complement]
The system needs to calculate a time complement for database ordering → The system computes the time complement by subtracting the time work value from the nines complement value
[Parse Hour Component from Position 7-8]
The system needs to extract the hour component for time complement calculation → The system should extract characters at positions 7-8 from the time string and store them as the hour component
[Parse Minute Component from Position 10-11]
The system needs to extract the minute component for time complement calculation → The system should extract characters at positions 10-11 from the time string and store them as the minute component
[Parse Hour Component from Position 7-8]
System needs to calculate time complement for pagination → System extracts characters at positions 7-8 from time string as hour component
[Parse Minute Component from Position 10-11]
System needs to calculate time complement for pagination → System extracts characters at positions 10-11 from time string as minute component
[Last Record on Screen Empty?]
System checks the train ID of the last record on the current screen (at maximum screen number position) → If the last record's train ID is empty (spaces), system displays last page message and stops navigation; otherwise system proceeds with page forward processing
[Extract Last Record Details]
System processes the page forward request → System extracts the input field to 6-position format, sets the index switch, and stores the index number in the message structure
[More Trains Available?]
System evaluates if more trains can be displayed → If more trains are available (WS-MORE-TRAIN is true), system proceeds to display new records; otherwise system shows last page message
[Set Last Page Message]
User attempts to navigate forward beyond available data → System sets last page message to inform user they have reached the end of available records
[Retrieve Selected Train ID]
The selected line contains a train ID → The system moves the train ID from the selected line to the input message field and clears the rest of the message
[Retrieve Train Record Data]
The database query returns a successful result → The train record data is moved from the database result to the working storage train segment
[Display Train Not Found Message]
A train not found condition occurs → The system displays a train not found message and highlights the input field to indicate the error
[Format Complete Equipment ID]
The system finalizes equipment ID formatting → The complete formatted equipment ID is available in WORK-CARID2
[Extract Characters 7-12 from CARID1 - Validate and extract second segment of equipment ID with position-specific character handling]
The system needs to format the equipment ID for display as lead unit information → Extract characters 1-4 from CARID1 and place them in positions 1-4 of CARID2, extract characters 7-12 from CARID1 and place them in positions 5-10 of CARID2, then move the formatted CARID2 to the lead unit display field
[Accept Valid Selection]
The system checks if the selected line contains a valid train ID → If train ID exists, move it to input field and set foreground spawn code for processing, otherwise display invalid item error message and highlight the input field
[Move Retrieved Data to Train Segment]
Train data is retrieved from database → The retrieved train data should be moved to the train root segment structure for further processing
[Clear Train Root Segment]
The system begins the search process → The train root segment storage area is cleared to spaces
[Move Retrieved Train Record to Working Storage]
A train record is found in the database → The train record is moved from the database result area to the train root segment working storage
[Clear Train Root Segment]
The system begins the equal search process → The train root segment data structure is cleared to spaces to remove any previous data
[Move Retrieved Data to Train Segment]
Train data is available in the database result set → The retrieved train data is moved to the train root segment for application use
[Set System Message - Train Not Found]
The system needs to inform the user of the search failure → The system message number is set to the train not found message constant
[Move Retrieved Data to Train Root Segment]
The system processes the search results → The retrieved train data is moved from the database result to the train root segment
[Set Train Not Found Message]
The system handles the search failure → The system sets a train not found message and highlights the input field with cursor attribute
[Clear Train Root Segment]
The system begins the process to get the next train ID by index → The train root segment is cleared to prepare for new data retrieval
[Move Retrieved Data to Train Segment]
The system processes the retrieved data → The retrieved train data is moved to the train root segment for further processing
[Get Input Port Number from Message Field]
The system needs to process the port number input → The input field value is extracted and prepared for formatting

Structural Validations

[5:Process From Train Selection]
PF key pressed is invalid for selection → System message is set to PF key invalid error
[5:Process From Train Selection]
Selection is not available → System message is set to PF not available error
[6:Process Page Forward]
Last train ID on current screen is empty or spaces → System message is set to last page and processing stops
[6:Process Page Forward]
No more trains are available for display → System message is set to last page
[7:Process Select Line]
Input line field is alphabetic or justification fails → System message is set to item invalid and input line attribute is set to cursor high display
[7:Process Select Line]
Input line number is less than first page or greater than maximum screen number → System message is set to item invalid and input line attribute is set to cursor high display
[7:Process Select Line]
Selected line does not contain a train ID → System message is set to item invalid and input line attribute is set to cursor high display
[8:Push Output Select Code]
Stack operation fails with invalid current selection code → Error message is constructed with failure details and CERR program is called
[10:Read Train By Index]
No more trains are available or train is not found → System message is set to train not found and input field attribute is set to cursor high display
[17:Get Train ID By Index]
Train is not found or port does not match → System message is set to train not found and input field attribute is set to cursor high display
[Set Unknown Caller Error Message]
The system cannot identify the calling module → The system message number is set to indicate spawning by unknown caller
[Validate Train Port Number Format]
The system processes the train port number for validation → The system moves the input field to a 6-position work field, sets the index switch to 6-position mode, and stores the index switch value in the message index number field
[Set Error Message - Train Not Found]
No matching train records are found for the specified port number → The system sets an error message indicating that the train was not found and highlights the input field for user correction
[Display Invalid Function Key Message]
User presses an invalid function key (GCMSG-PF-KEY equals INV-PFKEY-SELECTION) → System displays invalid function key message (CST-PF-KEY-INVALID)
[Display Function Not Available Message]
User requests a function that is not available (GCMSG-PF-KEY equals SEL-NOT-AVAILABLE) → System displays function not available message (CST-PF-NOT-AVAILABLE)
[PF Key = Invalid Selection?]
User presses an invalid function key for selection → System displays invalid PF key message to user
[PF Key = Selection Not Available?]
User presses a function key for a selection that is not available → System displays PF not available message to user
[Last Train ID on Current Page Empty?]
User requests to navigate to the next page forward AND the train ID in the last screen position is empty → Display 'Last Page' message and prevent forward navigation
[Is Input Numeric?]
The input contains alphabetic characters → The system displays an invalid item error message and highlights the input field
[Is Line Number Valid Range?]
The line number is less than the first page number or greater than the maximum screen number → The system displays an invalid item error message and highlights the input field
[Does Selected Line Have Train Data?]
The selected line does not contain train ID data (train ID is spaces) → The system displays an invalid item error message and highlights the input field
[Is Input Alphabetic?]
The input contains alphabetic characters → The system sets an invalid item error message and highlights the input field with high display attribute
[Justification Successful?]
The justification return flag indicates failure → The system sets an invalid item error message and highlights the input field with high display attribute
[Is Line Number Within Valid Range?]
The line number is less than the first page number or greater than the maximum screen number → The system sets an invalid item error message and highlights the input field with high display attribute
[Log Stack Error Message]
The system needs to log the error details → An error message is constructed containing the failure reason and the invalid current selection code value
[Call Error Handler]
The system needs to handle the navigation stack failure → The error handler service is called to process the error condition
[Train Record Found?]
The system checks the query results → If no train record is found, the system sets train not found status and displays appropriate error message
[Is Input Alphabetic?]
The input contains alphabetic characters → The system sets an invalid item error message and highlights the input field
[Justification Successful?]
The justification service returns a failure status → The system sets an invalid item error message and highlights the input field
[Within Valid Range?]
The line number is less than first page or greater than maximum screen number → The system sets an invalid item error message and highlights the input field
[Is Input Numeric?]
The system checks if the input contains alphabetic characters → If input is alphabetic, display invalid item error message and highlight the input field
[Justification Successful?]
The system checks the justification return status → If justification failed, display invalid item error message and highlight the input field, otherwise proceed with the justified number
[Within Valid Range - 1 to Max Screen Lines?]
The system validates if the line number is between first page (1) and maximum screen number → If the line number is outside the valid range, display invalid item error message and highlight the input field
[Set Invalid Item Error]
The system processes the validation failure → Set the system message to invalid item error
[Set Train Not Found Error Message]
Error handling is triggered → System message should be set to train not found error code and input field error attribute should be set to highlight the problematic field
[Set Error Status - Train Not Found]
The system handles the error condition → The status code is set to 'GE' and the system message is set to train not found
[Port Matches Expected Port?]
The system validates the train record's port information → If the train's port matches the expected port, the record is accepted as valid, otherwise the system indicates no more valid records are available

Module: GCX147 1 Consolidated Epic Story

Epic: GCX147 Complete EDI Specification Extracted from Legacy

Contains 598 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX147 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Status Counters]
The system begins counting equipment by status categories → All status counters (total equipment, released, documents not required, proceeding, held by CCRA, held for documents, manual haul documents) are set to zero
[Initialize Status Counters]
The system begins calculating equipment statistics → All status counters (total equipment, released, documents not required, proceeding, held by CCRA, held for documents, manual haul documents) are set to zero
[Initialize Status Counters]
The system begins processing equipment status calculations → All status counters (total equipment, released, documents not required, proceeding, held by CCRA, held for documents, manual haul documents) are set to zero

Core Acceptance Criteria

[2:Train List Reading and Validation]
The user's ACF2 user ID does not have access to the specified SCAC code → The system displays 'invalid SCAC access' message and returns to train report display screen
[3:Train Database Retrieval]
The train has more than 2500 equipment items → The system generates an error message indicating 'MORE THAN 2500 EQUIP' and terminates processing
[13:Equipment Addition Function]
The user's change authorization level is not 'S' (Super) or 'U' (Update) → The system displays 'not authorized' message and prevents the addition operation
[13:Equipment Addition Function]
The train already has the maximum number of equipment items (500) → The system displays 'maximum 500 equipment' message and prevents the addition
[14:Equipment Deletion Function]
The user's change authorization level is not 'S' (Super) or 'U' (Update) → The system displays 'not authorized' message and prevents the deletion operation
[14:Equipment Deletion Function]
The user's delete authorization level is not 'S' (Super) or 'U' (Update) → The system displays 'not authorized' message and prevents the deletion operation
[14:Equipment Deletion Function]
A user attempts to delete individual equipment without line selection → The system displays 'border crossing' message and prevents individual equipment deletion
[16:Train Arrival Processing]
The user's arrival authorization level is not 'S' (Super) or 'U' (Update) → The system displays 'not authorized' message and prevents the arrival processing
[16:Train Arrival Processing]
The train is not in acknowledged status → The system displays 'train not acknowledged' message and prevents arrival processing
[20:EDI Transaction Resend]
The user's re-add authorization level is not 'S' (Super) and function is 'Z' → The system displays 'not authorized' message and prevents the resend operation
[20:EDI Transaction Resend]
The train is not in resend status and function is not 'Z' with proper authorization → The system displays 'not resend' message and prevents the EDI operation
[22:EDI Transaction Processing]
A user attempts to process EDI transactions for the train → The system displays 'train not arrived' message and prevents EDI processing
[19:AEI Block Management]
The user's add authorization level is not 'S' (Super) or 'U' (Update) → The system displays 'not authorized' message and prevents the AEI block operation
[19:AEI Block Management]
The train is already marked as arrived → The system displays 'arrived' message and prevents AEI block status changes
[12:Display Input Processing]
The train is more than 30 days old and user is not a super user → The system displays 'more than 24 hours' message and prevents modification
[User Has SCAC Access?]
The system calls SCAC authorization service with user ID and SCAC code → If access is invalid, the system displays 'Invalid SCAC Access' error message, sets cursor to input field with high intensity display, and redirects to train report display screen
[Train List Found?]
The system searches for the train list in the database using equal operation → If the train is not found, the system displays 'Train Not Found' error message, sets cursor to input field with high intensity display, sets train not found flag, and redirects to train report display screen
[SCAC Access Valid?]
The system calls GCCSCAC module to validate user access for the provided SCAC code → If SCAC access is invalid, display error message 'invalid SCAC access' and set output to train report display screen
[Too Many Equipment Records?]
The train has more than 2500 equipment records → The system generates a system error with message 'MORE THAN 2500 EQUIP' and performs abend procedure
[Train Not Found]
The database returns a not found response → The system sets the train not found flag, displays appropriate error message, and sets the display screen output
[Execute Cargo Data Retrieval]
The system executes the cargo data retrieval operation → The cargo data segments are fetched and cargo found status is set
[Execute Station Information Lookup]
The system executes the station information lookup operation → The station segment data is retrieved and return status is set
[Execute Equipment Type Lookup]
The system executes the equipment type lookup operation → The equipment type description is retrieved from vehicle information segment
[Update Database Records]
The system executes the cargo update operation → The cargo segments are updated in database and broker notification is triggered if CCN is not idler type
[Route to Train Selection Display]
The message ID is CST-CDA-TRAIN-SELECTION-MOD or CST-CDA-TRAIN-CROSSING-MOD or CST-CDA-TRAIN-DISPLAY-ERR-MOD → The system clears the function field, sets line number to 1, processes display train, and sets output to train report display screen
[Route to Train Display Control]
The message ID is CST-CDA-TRAIN-DISPLAY-MOD → The system processes control display input
[Route to Cargo Display Return]
The message ID is CST-CDA-CARGO-DISPLAY-MOD1 or CST-CDA-CARGO-DISPLAY-MOD2 or CST-CDA-CARGO-DISPLAY-MOD3 → The system processes return from cargo display
[Route to Update Screen Return]
The message ID is CST-CDA-TRAIN-UPDATE-MOD → The system sets output to train report update screen and processes return from update
[Route to Print Confirmation Return]
The message ID is CST-CDA-TRAIN-PRT-CONFIRM-MOD or CST-CDA-TRAIN-DEL-CONFIRM-MOD → The system sets output to train print confirmation screen and processes return from print confirmation
[Route to Log Display Return]
The message ID is CST-LOG-DISPLAY-MOD → The system sets output to train report display screen and processes return from log
[Route to Menu Screen]
The message ID does not match any known message types → The system sets output to menu screen, displays spawn by unknown message error, and clears input field
[Check AEI Block Status]
The train has AEI block status enabled → Display 'AEI BLOCK' message to user
[Count Equipment by Status Categories]
Train display processing occurs → Count and display totals for equipment, released, documents not required, proceeding, held by CCRA, held for documents, and manual haul documents
[Check AEI Block Status]
The train has AEI block status enabled → Display 'AEI BLOCK' message on the screen
[Count Equipment by Status Categories]
Processing equipment for status display → Count total equipment, released items, items needing documentation, proceeding items, items held by CCRA, items held for documents, and manual haulage documents
[User Has Authorization?]
The system validates the user's authorization level → If user authorization is 'S' or 'U', allow the operation, otherwise display authorization error message
[Turn AEI Block OFF]
User executes AEI block toggle function → Set AEI block status to off, display 'TRAIN AEI UNBLOCKED' message, and clear function field
[Turn AEI Block ON]
User executes AEI block toggle function → Set AEI block status to on, display 'TRAIN AEI BLOCKED' message, and clear function field
[Create Log Entry for Block Change]
The system processes the status change → Create a log entry with train ID, action code 'ZZZ', and appropriate message for block or unblock action
[Return/Transit]
Cargo status is 'RETURN' or manifest stations differ and status allows proceeding → Increment the proceed counter by one
[EDI Transaction Resend]
User security level is 'S' (Super) or 'U' (Update) for change operations → System processes EDI transaction resend, otherwise displays not authorized message
[More than 30 Days?]
Time difference is more than 29 days and user is not a super user → System displays 'More than 24 hours' restriction message and prevents modification
[Add Equipment Function]
User security level is 'S' (Super) or 'U' (Update) for change operations → System processes add equipment operation, otherwise displays not authorized message
[Delete Equipment Function]
No line is selected and user has 'S' or 'U' delete authorization, or line is selected and user has 'S' or 'U' change authorization → System processes delete operation, otherwise displays not authorized message
[Modify Equipment Function]
User security level is 'S' (Super) or 'U' (Update) for change operations → System processes modify operation, otherwise displays not authorized message
[Train Arrival Function]
User has 'S' or 'U' arrival authorization and train is acknowledged (or user is super user) → System processes arrival confirmation, otherwise displays appropriate error message
[AEI Block Function]
User has 'S' or 'U' add authorization and train has not arrived → System toggles AEI block status, otherwise displays not authorized or already arrived message
[Process EDI Resend Request]
User security level is 'S' (Super) or 'U' (Update) → System processes the EDI transaction, otherwise displays not authorized message
[Process Add Equipment]
User security level is 'S' (Super) or 'U' (Update) → System processes the add equipment function, otherwise displays not authorized message
[Process Delete Equipment]
For individual equipment deletion, user has 'S' or 'U' change authorization, or for full train deletion, user has 'S' or 'U' delete authorization → System processes the deletion, otherwise displays not authorized message
[Process Modify Equipment]
User security level is 'S' (Super) or 'U' (Update) → System processes the modification function, otherwise displays not authorized message
[Process Train Arrival]
User has 'S' or 'U' arrival authorization and train is acknowledged → System processes the arrival function, otherwise displays appropriate error message
[Process AEI Block Toggle]
User has 'S' or 'U' add authorization and train has not arrived → System toggles the AEI block status, otherwise displays not authorized or arrived message
[Date Validation?]
The train's estimated date of arrival is more than 30 days old and user is not a super user → System displays 'More than 24 hours' restriction message and prevents the operation
[User Authorization?]
User's security level does not meet the minimum required authorization for the function → System displays 'Not Authorized' message and prevents the function execution
[Validate EDI Resend Authorization]
The system checks user authorization level for EDI resend operations → If user has Super ('S') or Update ('U') change authorization, grant access to EDI resend function, otherwise deny access and display authorization error message
[Validate Equipment Add Authorization]
The system checks user authorization level for equipment add operations → If user has Super ('S') or Update ('U') change authorization, grant access to add equipment function, otherwise deny access and display authorization error message with high intensity field attributes
[Validate Equipment Delete Authorization]
The system checks user authorization level for equipment delete operations → If deleting individual equipment and user has Super ('S') or Update ('U') change authorization, or if deleting entire train and user has Super ('S') or Update ('U') delete authorization, grant access, otherwise deny access and display authorization error message
[Validate Equipment Modify Authorization]
The system checks user authorization level for equipment modify operations → If user has Super ('S') or Update ('U') change authorization, grant access to modify equipment function, otherwise deny access and display authorization error message with high intensity field attributes
[Validate Train Arrival Authorization]
The system checks user authorization level for train arrival operations → If user has Super ('S') or Update ('U') arrival authorization, grant access to arrival function, otherwise deny access and display authorization error message with high intensity field attributes
[Validate AEI Block Authorization]
The system checks user authorization level for AEI block operations → If user has Super ('S') or Update ('U') add authorization, grant access to AEI block function, otherwise deny access and display authorization error message with high intensity field attributes
[Validate Train Delete Authorization]
The system checks user authorization level for train delete operations → If user has Super ('S') or Update ('U') delete authorization, grant access to train delete function, otherwise deny access and display authorization error message with high intensity field attributes
[Validate SCAC Access]
The system validates SCAC access by calling authorization service with user ID and SCAC code → Access is granted if SCAC authorization is valid, otherwise access is denied with invalid SCAC access message
[Check Add Function Authority, Check Modify Function Authority]
The system checks if user security level is 'S' (Super) or 'U' (Update) → Function is allowed if user has 'S' or 'U' authorization, otherwise access is denied with not authorized message
[Check Delete Function Authority]
The system checks if user security level is 'S' (Super) or 'U' (Update) for train deletion → Function is allowed if user has 'S' or 'U' authorization, otherwise access is denied with not authorized message
[Check Arrival Function Authority]
The system checks if user security level is 'S' (Super) or 'U' (Update) for arrival operations → Function is allowed if user has 'S' or 'U' authorization, otherwise access is denied with not authorized message
[Check AEI Block Function Authority]
The system checks if user security level is 'S' (Super) or 'U' (Update) for AEI operations → Function is allowed if user has 'S' or 'U' authorization, otherwise access is denied with not authorized message
[Check Resend Function Authority]
The system checks if user security level is 'S' (Super) for resend operations or 'S' level for re-add operations → Function is allowed if user has appropriate authorization level, otherwise access is denied with not authorized message
[Calculate Date Difference]
The system calls TIMEDIFF function with date parameters → The difference in days is calculated and stored for policy enforcement
[Valid Equipment Type?]
Equipment type validation is performed through car type service → The system should validate the equipment type code and reject invalid types with equipment type error message
[Equipment Addition Request]
The user authorization level is not 'S' (Super) or 'U' (Update) → The system should reject the request and display 'not authorized' error message
[Equipment Addition Request]
The user's authorization level is not 'S' (Super User) or 'U' (Update User) → The system should deny the request and display a not authorized error message
[Cargo Available for Assignment?]
The cargo has manual status and linehaul flag set → The system should display error message '0369' and prevent the assignment
[User Authorization Check]
User authorization level is checked → System allows deletion only if user has 'S' or 'U' delete authorization, otherwise shows not authorized message
[User Authorization Check]
User authorization level is checked → System allows deletion only if user has 'S' or 'U' change authorization, otherwise shows not authorized message
[Set Equipment Status to Delete]
Deletion process is executed → System sets equipment action code to delete, sets train resend flag, marks modification as done, and displays confirmation message
[Show Delete Confirmation Screen]
Full train deletion is requested → System displays delete confirmation screen with train deletion message and sets appropriate screen attributes
[Train Resend Status]
A user attempts to delete equipment without specifying a line selection → The system displays border crossing error message and prevents the deletion operation
[Set Equipment Status to Deleted]
The deletion operation is processed → The system sets the equipment action code to delete, marks the train for resend, and displays confirmation message
[Mark Equipment for Deletion]
The system processes the equipment deletion → The system marks the equipment with delete action code, sets train resend flag, sets modification done flag, and displays confirmation message
[Equipment Marked for Deletion?]
Selected equipment is NOT marked with delete action code → System displays 'Undo not possible' error message and highlights line selection field
[Display Success Message]
Updating user interface → System displays 'Undo successful' confirmation message
[User Has Arrival Authorization?]
The system checks the user's arrival authorization level in the user segment → If the user has 'S' (Super) or 'U' (Update) authorization level, allow the function to proceed, otherwise display 'Not Authorized' error message and return to train display
[Generate Arrival Log Entry]
The system generates the log entry → Create a log entry with train ID, action code 'ZZZ', message 'TRAIN ARRIVED', and mark it as a Canadian train event
[Display Success Message]
The system completes the arrival process → Display 'Arrival Successful' message to confirm the operation completed successfully
[User Authorized for Arrival?]
The user's arrival authorization level is not 'S' (Super) or 'U' (Update) → The system displays error message 'Not Authorized' and highlights the function field with error attributes
[Set Current Date/Time as Default]
The system displays the arrival confirmation screen → The system populates the date/time fields with current machine century, year, month, day, hour, and minute values and displays message 'Enter Arrival Date/Time'
[Update Train Status to Arrived]
The confirmation request is processed → The system sets train arrival status to 'Yes', records the entered arrival date and time, sets modification flags, and displays success message 'Arrival Successful'
[Spawn Train Arrival Notifications]
The system completes the arrival update → The system creates log information with train ID, sets action code to 'MAA', generates arrival message 'TRAIN ARRIVED', spawns log entry transaction, and spawns arrival notification transaction with city name and arrival date/time
[Input Date > Current Date?]
The input date century is greater than current system century:
(input date century equals current system century AND input date is greater than current system date)
(input date century equals current system century AND input date equals current system date AND input time is greater than current system time)
→ The system rejects the input with future arrival date time not allowed message
[Search Public ID Information]
Searching for public ID information → If public ID is not found, display error message 'Public ID not found'
[Calculate Equipment Status Counters]
Calculating status counters → Count total equipment, released items, proceeding items, held by CCRA, held for documents, and manual haulage documents based on cargo status
[Send Report via Communication System]
Transmitting the report → Send report via EMCSEND system and handle transmission errors with appropriate error messages
[Setup FAX Transmission]
Setting up FAX transmission → Configure EXTFAX as destination, set FAX number from station information, and set Merlin ID as copy destination
[Search Station Information]
Searching for station information using train origin station → Retrieve station segment data for FAX number validation
[Count Equipment by Status]
Processing each equipment item in train → Count total equipment, released items, proceeding items, held by CCRA, held for documents, and manual haulage documents based on cargo status
[Send FAX Copy]
Processing FAX transmission → Set FAX destination as external FAX system and include station FAX number as copy recipient
[Create Transaction Log]
Creating transaction log → Log print action with train ID, CA train type, TPR action code, and train identification
[Station Found?]
System searches for station information using CP train from station code → If station information is not found, system displays station error message
[Set AEI Block ON]
User requests AEI block function → Set AEI block status to ON and display 'AEI BLOCKED' message
[Set AEI Block OFF]
User requests AEI block function → Set AEI block status to OFF and display 'AEI UNBLOCKED' message
[Create Log Entry - Block]
The system processes the block operation → Create log entry with train ID, action code 'ZZZ', and message indicating AEI block activation
[Create Log Entry - Unblock]
The system processes the unblock operation → Create log entry with train ID, action code 'ZZZ', and message indicating AEI block deactivation
[User Authorized for Resend?]
The system checks the user's security level for resend operations → The user must have 'S' (Super User) authorization level to proceed with resend operations
[Search Public ID Configuration]
The system searches for public ID configuration in the admin tables → The system must successfully locate the public ID configuration to proceed with EDI processing
[Check for Deleted Equipment in Train]
The system iterates through all equipment items in the train → The system identifies which equipment items have deletion action codes and sets deletion flags accordingly
[Train Has Equipment?]
The system checks the total equipment count in the train → If equipment count is zero, mark train for deletion; otherwise mark train as sent and ready for EDI transmission
[Set Train as Sent]
The system updates the train status → Set the train sent flag to true to indicate successful EDI transmission
[Retrieve Merlin Configuration]
The system retrieves Merlin configuration using the public Merlin ID → The system must successfully locate valid Merlin configuration to proceed with report generation
[Generate Train Report]
The system generates the train report → Create detailed report including train header, equipment list, status summary, and formatting for Merlin transmission
[Auto FAX Enabled?]
The system checks FAX configuration settings → If station FAX flag is 'Y' OR admin auto FAX is 'Y', prepare FAX transmission setup
[Setup FAX Transmission]
The system sets up FAX transmission → Set FAX destination to 'EXTFAX', configure station FAX copy ID as recipient, and prepare for transmission
[Send EDI Transaction]
The system sends the EDI transaction → If train is deleted, send with 'D' action code; if function is 'Z', send with 'A' action code; otherwise send with 'C' action code for changes
[Send FAX if Required]
The system checks if FAX transmission is required → If station FAX flag is 'Y' OR admin auto FAX is 'Y', execute FAX transmission via EMCSEND
[Log Train Sent Success]
The system logs the successful operation → Display 'US Train Sent' success message and create log entry with train ID and 'TD' action code
[User Has Resend Authorization?]
The system checks user authorization level for resend operations → Access is granted only if user has 'S' (Super) authorization or 'Z' function with 'S' re-add authorization, otherwise display not authorized message
[Search Public ID for Admin Settings]
System needs administrative configuration for processing → Retrieve public ID settings from administrative table, if not found display public ID not found error
[Check All Equipment for Deletions]
System processes equipment for EDI transaction → Check each equipment item deletion status and set deletion flag if any equipment is not marked for deletion
[Create Special Delete Transaction]
System processes EDI transaction → Create special delete transaction using GCCS358C module with delete action code and bypass EDI send flag
[Process Equipment List Updates]
System processes each equipment item → For ADD actions validate and add to final list, for DELETE actions remove from train and update cargo assignments
[Send EDI Transaction via Communication]
System sends transaction via GCCS358C module → Use 'D' action code for deleted trains, 'A' for force resend function, or 'C' for change operations, and handle FAX transmission if enabled
[Create Transaction Log Entry]
System creates audit trail → Generate log entry with train ID, action code, and processing details for audit purposes
[Create Transaction Log Entry]
The cargo assignment process is complete → The system should create a log entry with action code 'CAT', cargo type as 'CA-CARGO', and the input train ID as the message
[User Has Resend Authorization?]
The system checks user authorization level for resend operations → The system allows resend only if user has 'S' (Super) authorization or 'Z' function with 'S' re-add authorization, otherwise displays not authorized message
[Search Public ID for Admin Settings]
The system searches for public ID administrative settings → The system retrieves admin configuration if found, otherwise displays public ID not found error
[Check for Deleted Equipment in Train]
The system scans all equipment in the train list → The system identifies if all equipment has delete action code set and processes accordingly
[Create Special Manifest for Deleted Train]
The system checks if the train has arrived status → The system prevents EDI processing and displays train not arrived error if train has already arrived
[Update Train Equipment List]
The system processes equipment additions and deletions → The system validates each equipment change, updates cargo assignments, and creates transaction logs for valid changes
[Auto FAX Enabled?]
The system checks station FAX flag or auto FAX configuration → The system configures FAX destination if auto FAX is enabled (SC-FAX-FLAG = 'Y' or AD-AUTO-FAX = 'Y')
[Send EDI Transaction via GCCS358C]
The system calls external EDI processor GCCS358C → The system transmits EDI transaction and receives success or failure status from the EDI processor
[Send FAX Report if Configured]
The system processes FAX transmission → The system sends the train report to configured FAX destination using EMCSEND service
[Create Transaction Log Entry]
The system creates transaction log entry → The system records train ID, action code, and success message in the transaction log
[User Has Resend Authority?]
The system validates user authorization → User must have 'S' (Super) authorization level for resend or 'S' level for re-add function, otherwise display not authorized message
[Search Public ID for Admin Settings]
The system searches for public ID configuration → The system calls GCCTBIO to retrieve admin settings and validates the return status
[All Equipment Deleted?]
If deletion flags → If any equipment item is not marked for deletion, set bypass EDI send flag to false, otherwise set to true
[Send EDI Transaction via GCCS358C]
The system sends EDI transaction → The system calls GCCS358C with appropriate action code (A for add, C for change, D for delete) and foreground processing flag
[Send FAX Report if Configured]
The system processes FAX transmission → The system calls EMCSEND procedure to transmit the report via FAX
[Create Transaction Log Entry]
The system creates log entry → The system moves log information and spawns GCT1051E with train ID, action code, and appropriate message
[Set Success Message]
The system sets completion message → The system displays train sent success message for non-deleted trains or appropriate deletion message for deleted trains
[Resend Consist Flag Set?]
The resend consist flag is not set to true → The system should skip all EDI transaction processing and proceed to end
[Set Action Code to 'D' - Delete]
The train status indicates it has been deleted → The system should set the EDI action code to 'D' for delete operation
[Set Action Code to 'A' - Add]
The function code is 'Z' indicating a resend operation → The system should set the EDI action code to 'A' for add operation
[Set Action Code to 'C' - Change]
The function code is not 'Z' resend operation → The system should set the EDI action code to 'C' for change operation
[Call GCCS358C EDI Module]
The system is ready to transmit EDI data → The system should call the GCCS358C module with the train list data
[Execute FAX Communication Send]
The station FAX flag is set to 'Y' or the auto FAX flag is set to 'Y' → The system should execute the FAX communication send process
[User Has Resend Authorization?]
The system checks if the user has resend authorization (GCSTBRT-US-CTF-RE-ADD equals 'S' for Super User) or if the function is 'Z' with proper authorization → The system either allows EDI processing to continue or displays authorization error message
[Set EDI Action Code Based on Train Status]
If train deletion status (GCWB4TL-DELETED-YES) and function type → The system assigns action code 'D' for deleted trains, 'A' for resend function 'Z', or 'C' for change operations
[Call GCCS358C EDI Module]
The system calls GCCS358C module with CCCOM, GCWS358C-ADD-PARM, and GCWB4TL-TRAIN-LIST parameters → The system processes the EDI transaction and returns success or failure status
[Auto FAX Enabled?]
The system checks if station FAX flag (GCSTBRT-SC-FAX-FLAG) equals 'Y' or administrative auto FAX (GCSTBRT-AD-AUTO-FAX) equals 'Y' → The system either executes FAX communication via EMCSEND or continues without FAX processing
[Set Action Code to 'D' for Delete]
The train status indicates it has been deleted → The EDI action code should be set to 'D' to represent a delete operation
[Set Action Code to 'A' for Add]
The function type is 'Z' indicating a resend operation → The EDI action code should be set to 'A' to represent an add operation
[Set Action Code to 'C' for Change]
The function type is not 'Z' (not a resend operation) → The EDI action code should be set to 'C' to represent a change operation
[Call EDI Transaction Processing]
The action code is set and foreground processing is enabled → The EDI transaction processing module GCCS358C should be called with the train list data
[Create Transaction Log Entry]
The transaction logging is triggered → The system should create a log entry with action code 'CAT', cargo type as 'CA-CARGO', and the train input field as the message
[Backward Page Request]
User requests backward page navigation (PAGE-BCK) → If function is set to maximum position, set line to 1 and show first page message, otherwise calculate previous page by subtracting 12 from current save item position
[Delete All Train List Request]
A user attempts to delete equipment without line selection → The system should display border crossing message and prevent the deletion operation
['N' = No Permission, 'D' = Display Only]
Any deletion operation is requested → The system should deny authorization and display not authorized error message
[Display Confirmation Message]
Providing user feedback → The system displays a confirmation deletion message and clears the line selection and function fields
[Equipment Currently Deleted?]
The selected equipment is not currently marked for deletion → The system displays an undo not possible error message and highlights the line selection field
[Mark Train as Modified]
All restoration operations are completed → The system sets the modification flag to indicate train changes and displays undo success message
[Display Success Message]
The system processes the completion of undo operation → The system clears the line selection field, function field, and displays undo success message
[Display Success Message]
All arrival processing steps complete without errors → The system displays message 'Arrival successful' to confirm the operation completed
[Create Arrival Log Entry]
The system processes the arrival confirmation → The system creates log entry with train ID, sets log type as CA train, sets message as 'TRAIN ARRIVED', and sets action code as 'ZZZ'
[Spawn Arrival Notifications]
The system completes arrival processing → The system spawns notification message with train ID, sets message type as CA train, sets action code as 'MAA', includes city name from station, and includes arrival date and time
[Search Public ID Information]
The system searches for public ID information → The system retrieves administrative segment data using ADMINID key
[Search Station Name Information]
The system searches for station name information → The system retrieves station segment data using train origin station code
[Calculate Equipment Status Counters]
The system processes all equipment on the train → The system calculates totals for equipment, released, proceeding, held by CCRA, held for documents, and manual haulage documents
[Display Success Message]
The system confirms successful transmission → The system displays print success message and creates transaction log entry
[Invalid Container Move]
The equipment being moved is a container → Display error message 'Invalid move container' and prevent the move
[Container to Container List]
The target position is within a container list → Display error message 'In container list' and prevent the move
[Manual Linehaul Cargo?]
The cargo has both manual status and linehaul designation → Display error message '0369' and set invalid add flag to prevent processing
[Manual Linehaul Not Allowed]
The cargo has manual status AND linehaul designation → The system displays error message '0369' and marks validation as invalid
[Process Equipment Addition Request]
System checks user authorization level → System should allow addition only if user has 'S' (Super) or 'U' (Update) authorization level, otherwise display not authorized message
[Mark Train for Resend]
System updates train status → System should set train resend flag to true and modification done flag to true to indicate train requires EDI retransmission
[Train Not Found]
If the operation result as NOT-FOUND → The train not found flag is set, input field attributes are highlighted, appropriate screen is selected, and train not found message is displayed
[Delete Function Initiated, Delete Type?]
User does not have 'S' or 'U' authorization level for change operations → System displays not authorized message, sets function attribute to protected, and returns to train display
[Delete Type?]
User attempts to delete individual equipment without line selection → System displays border crossing message and prevents deletion operation
[Delete Type?]
User does not have 'S' or 'U' authorization level for delete operations → System displays not authorized message, sets function attribute to protected, and returns to train display
[Display Success Message]
System completes deletion operation → System displays confirm delete train message, sets output to train display screen, clears function field, and processes train display
[Moving Container?]
Selected equipment is identified as a container type → System displays error message 'Cannot move container' and prevents the movement operation
[Moving to Container Position?]
Target position is designated for container equipment → System displays error message 'Cannot move to container list' and prevents the movement
[Mark Train for Resend]
Position modification is completed → System sets train resend flag to indicate train data has been modified and requires retransmission
[Count Equipment by Status Categories]
The system processes each equipment item for status counting → Equipment is counted in appropriate categories: total equipment count increases by 1 for non-empty equipment IDs, released status for RELEASE or CSA-DLV cargo, manual haul documents for haulage and manual cargo, held by CCRA for HOLD or AGI-HOLD cargo, proceeding for RETURN cargo or different origin/destination stations, held for documents for same origin/destination with no broker entry, and documents not required for equipment without cargo
[Search Station Name Information]
The system needs station information for the report header → Station configuration is retrieved using the train's origin station code, and if successful, station segment data including FAX configuration is made available
[Set Report Width and Format]
The system sets up report formatting parameters → Report width is set to 80 characters, item sequence numbers are cleared, and communication parameters are initialized for proper report formatting
[Add FAX Header with Number]
The system determines FAX transmission is required (FAX print flag is 'Y' or station FAX flag is 'Y' or auto-FAX is 'Y') → A FAX header line is added to the report with the station's Canadian FAX number, and the line counter is incremented
[Page Break Needed?]
The system checks if a page break is needed before adding equipment details → A new page is started if line count exceeds 59 lines for first page or 57 lines for subsequent pages when FAX printing is enabled
[Send Report via Communication]
The system sends the report via communication system → Report is transmitted using EMCSEND3 with from-user, destination, to-user, copy-user, subject, and content parameters, and transmission status is evaluated for success, from-user not found, to-user not found, or invalid filename errors
[Calculate Equipment Status Totals]
If the cargo status and conditions → The equipment is categorized as: Released (if status is RELEASE or CSA-DLV), Manual Haul Documents (if haulage and manual haulage), Held by CCRA (if status is HOLD or AGI-HOLD), Proceeding (if status is RETURN or different from/to stations without error/reject/deleted status), Held for Documents (if same from/to station and no broker entry), or Held by CCRA (for all other cases)
[Create Status Summary Line]
The system creates the status summary for the report → A status line is added containing total equipment, released, documents not required, proceeding, held by CCRA, held for documents, and manual haul documents counts
[Create End of Message Marker]
The system finalizes the report structure → An end-of-message marker is added and the line counter is set to 4
[Send Report via Communication]
The system sends the report → The report is transmitted via EMCSEND3 communication system, and if FAX is required (station FAX flag 'Y' or auto-FAX enabled), FAX transmission is initiated through EMCSEND call
[Train Arrival Log Action: ZZZ]
A log entry is created for train arrival → The log entry is marked as CA train type with action code ZZZ, train ID is recorded, and message indicates train arrived
[AEI Block Log Action: ZZZ]
A log entry is created for AEI block change → The log entry is marked as CA train type with action code ZZZ, train ID is recorded, and message indicates the specific AEI block action
[Create IMS Transaction]
An IMS transaction is created → The system calls CIMS with CHNG function to create the transaction message
[Write Message to Queue]
The message is written to the queue → The system calls WRITMSGL to write the message with proper message code, content, length and module name
[Purge Transaction]
The transaction is purged → The system calls CIMS with PURG function to clean up the transaction
[Confirm Arrival Processing]
The confirmation is processed → Set train status to arrived, update arrival date/time in train record, mark header as modified, and display arrival success message
[Spawn Special Manifest Transaction]
The system processes the spawn queue → Execute each queued special manifest transaction and display 'CCN Updated' message to indicate special processing occurred
[Equipment Addition Request]
The user authorization level is not 'S' (Super) or 'U' (Update) → The system displays not authorized message and prevents equipment addition
[Mark Train for Resend]
The system completes equipment addition processing → The system sets train resend flag and modification done flag for EDI processing
[Display Success Message]
The system finalizes the addition process → The system displays equipment addition confirmation message and returns to train display screen
[Cargo found in database?]
The cargo has manual status AND linehaul flag is set → The system should reject the addition with error message '0369' and highlight the CCN and equipment fields
[Manual Linehaul Cargo?]
The cargo has manual status and linehaul flag set → Display error message '0369' and mark validation as invalid
[Display Unusable CCN Message]
The system communicates the validation result → The system displays message 'CCN-UNUSABLE' to inform the user that the cargo control number cannot be used
[Z800-NOTIFY-BROKER: Broker Notification]
The broker delivery schedule is consist delivery or immediate delivery and the train has arrived or cargo has arrival indicator → The system skips broker notification
[Load Cargo Segments]
The system processes the retrieved cargo data → The system moves cargo segment data from arrays to working storage variables and sets cargo found status to true
[Update Cargo Information]
The system performs cargo update operation → The system calls GCCCCIO2 with REPL function to update cargo segments and performs broker notification if CCN key is not 6105I type
[Call GCCCCIO2 for Cargo Fetch]
GCCCCIO2 is called with fetch all segments and GU function → Cargo data is retrieved from database segments GCSCCS00, GCSCCRT, GCSCCS52, GCSCCS53, GCSCCS54, GCSCCS55, GCSCCS56
[Load Cargo Segments Data]
Cargo segments data is processed → Move first occurrence of GCSCCS53 and GCSCCS55 array data to respective working segments
[Check Manual Haulage Status]
Cargo linehaul flag is checked → If cargo is manual and linehaul, return validation error with message '0369', otherwise allow assignment
[Call GCCCCIO2 for Update]
GCCCCIO2 is called with replace function and all segments flag → Cargo data is updated in database segments and success status is returned
[Check Primary Broker]
Broker delivery schedule is CONSIST-DELIVERY or IMMEDIATE-DELIVERY → If train has arrived or cargo has arrival indicator 'Y', skip broker notification, otherwise proceed with notification
[Check Primary Broker]
Broker entry status is evaluated → If delivery schedule is CONSIST, IMMEDIATE, DEFAULT, or ARRIVAL with arrived train, and broker entry is spaces or low-values, proceed with notification, otherwise skip
[Send X12 Notification]
Broker X12 usage flag is 'Y' → Call GCCS309C with action modify and notify broker flags set using broker X12 header information
[Call GCCCCIO2 for Cargo Retrieval]
The system calls GCCCCIO2 with fetch all segments flag and get unique function → The cargo data is retrieved and segment data is moved to working storage
[Set Cargo Found Status]
The error number from GCCCCIO2 is spaces (no error) → The cargo found flag is set to true and segment data is processed
[Call GCCCCIO2 for Cargo Update]
The system calls GCCCCIO2 with all segments flag and replace function → The cargo data is updated in the database and segment data is moved to working storage
[Check Train Arrival Status]
The train has already arrived (arrived flag is yes or manual, or cargo arrival indicator is 'Y') → The system skips the broker notification process
[Send X12 EDI Notification]
Broker configuration has X12 usage flag set to 'Y' → The system calls GCCS309C with action code '04', transaction 'GCT0111E', notify broker flag, and X12 broker header information
[Delivery Schedule Check]
The delivery schedule is 'Consist Delivery' or 'Immediate Delivery' and the train has not arrived yet → No notification should be sent and the process should end
[Broker Entry Required?]
The cargo has broker entry information (not spaces or low-values) → No notification should be sent as broker entry already exists
[Send X12 Notification]
The broker configuration has X12 notification enabled ('Y') → System should call GCCS309C program to send X12 notification using broker's X12 header information
[Delivery Schedule Type?]
If the broker delivery schedule type → The system categorizes the schedule as consist delivery, immediate delivery, arrival delivery, or default delivery based on the broker configuration
[Train Arrived for Consist/Immediate?]
The system checks train arrival status → The notification is skipped if the train has arrived, arrived manually, or cargo has arrival indicator set to 'Y'
[Broker Entry Required?]
The system checks if broker notification should proceed → The notification proceeds only if the cargo broker entry field is blank or contains low-values
[X12 EDI Enabled?]
The broker X12 usage flag is set to 'Y' → The system calls GCCS309C module with action modification and broker notification settings using the broker's X12 header information
[Internet Enabled?]
The broker Internet usage flag is set to 'Y' → The system spawns GCT0191E transaction with cargo CCN and broker's Internet address from B1 segment
[Query Broker Table by Name and Port]
The system queries the broker table with broker name, Canadian flag 'C', and the destination port from manifest → The system should retrieve the broker configuration segment for that specific port
[Query Default Broker Settings]
The system queries the broker table with broker name, Canadian flag 'C', and default port '000' → The system should retrieve the default broker configuration segment
[Retrieve Additional Broker Settings]
The system queries the additional broker settings table 'B1' → The system should load the additional broker segment if found, otherwise initialize empty additional settings
[Check Train Arrival Status]
The train has arrived, manually arrived, or cargo has arrival indicator 'Y' → The system should skip broker notification processing
[Skip Notification - Train Not Arrived]
If broker notification requirements → The broker notification process is skipped and control goes to the end of the evaluation
[Continue Processing]
If broker notification requirements → The system continues with broker notification processing through various channels (X12, Merlin, Internet, FAX, Paper)
[Delivery Schedule Type?]
The system needs to determine if broker notification should be sent → The system evaluates the delivery schedule as consist delivery, immediate delivery, default delivery, or arrival delivery and applies the corresponding notification rules
[Delivery Schedule Check]
If delivery schedule for consist delivery or immediate delivery → If delivery schedule is consist delivery or immediate delivery and the train has arrived or is manually arrived or cargo has arrival indicator 'Y', then skip notification processing, otherwise proceed with notification setup
[Setup X12 Broker Header]
The system sets up X12 communication → The system should configure the X12 broker header and call the EDI processing module
[Log Successful Transmission]
The system processes the successful communication → The system should log the transmission, generate a success message, and clear copy user codes
[Container Movement Allowed?]
The system validates the movement request → The system prevents the movement and displays error message 'Invalid move container' because containers cannot be moved independently
[Container Movement Allowed?]
The target position is within a container list sequence → The system prevents the movement and displays error message 'In container list' because equipment cannot be inserted into container sequences
[Maintain Parent-Child Sequence]
The system updates equipment positions → Parent rail cars are positioned immediately before their child containers in the equipment list, preserving the hierarchical relationship
[User Authorized for Arrival?]
The system checks the user's arrival authorization level in user segment → If user authorization level is 'S' (Super) or 'U' (Update), allow the operation, otherwise display not authorized message
[Spawn Arrival Notifications]
The system completes arrival processing → Generate log entry with train arrival message, spawn arrival notification transaction, and display arrival success message
[Display Confirmation Message]
The system provides user feedback → A confirmation message is displayed indicating successful deletion of the equipment
[Block Print Operation]
A user attempts to execute a print function on the train → The system blocks the print operation and displays an invalid print message
[Validate Resend Authorization]
The system checks the user's authorization level → The system allows the operation only if user has 'S' (Super) or 'U' (Update) authorization level, otherwise blocks the operation and displays authorization error
[Clear Resend Flag After Success]
The EDI processing completes without errors → The system clears the resend flag and sets the train status to sent
[Block Unauthorized Resend]
The system validates the user's authorization for resend functions → The system blocks the operation and displays 'Not Authorized' error message
[Process EDI Transaction Resend]
The system processes the EDI transaction resend request → The system generates EDI transactions, sends notifications, updates train status, and creates audit logs
[Current AEI Block Status]
If the current AEI block status → If AEI block is currently ON, turn it OFF and show unblocked message, if AEI block is currently OFF, turn it ON and show blocked message
[Create Log Entry - AEI Unblocked]
The system creates audit trail → Create log entry with train ID, action code 'ZZZ', message indicating AEI unblocked, and spawn logging transaction
[Create Log Entry - AEI Blocked]
The system creates audit trail → Create log entry with train ID, action code 'ZZZ', message indicating AEI blocked, and spawn logging transaction
[Is Container Being Moved?]
The equipment being moved is a container type → System rejects the movement with 'Invalid move container' error message
[Moving Into Container List?]
The target position is designated for container equipment → System rejects the movement with 'In container list' error message
[Update Equipment Order]
Equipment has associated containers → System moves the equipment and all associated containers together, updating their positions in the equipment list and adjusting intermediate equipment positions accordingly
[Mark Train for Resend]
Train data has been modified → System sets train resend flag and modification done flag to indicate changes require transmission
[Mark as Invalid Addition]
The system completes the special manifest processing → Set the invalid addition flag to true, display the CCN update message to inform the user that special processing is required, and exit the normal equipment addition process
[Manual Status with Linehaul?]
The cargo has manual status AND linehaul designation → Display error message '0369' and prevent the equipment addition
[Search Station Information]
The system needs station FAX information → Search the station table using the train's origin station code and retrieve FAX number if successful, otherwise display station error message
[Search Station Name and FAX Info]
The system searches for station information using the train's from station code → If station information cannot be retrieved, display 'Station error' message
[Setup Merlin Database Connection]
The system attempts to connect to EXTFAX Merlin system → If Merlin FAX system is not found, display 'System Merlin FAX error' message
[Retrieve Station Information]
Processing the station lookup results → The system moves the retrieved table segment data to the station segment structure for further processing
[Retrieve Administrative Segment Data]
Administrative data needs to be extracted → The system retrieves the administrative segment data from the search results
[Store Public ID Information]
The system processes the public ID information → The public ID information is stored in the appropriate data structures
[Set Invalid Line Selection Flag]
Any of the range validation conditions are violated → The system should set the invalid line number flag, display item invalid message, reset to current page display, and set line selection error attribute
[Delete Function Initiated]
The system checks the user's authorization level → Delete operation is only permitted for users with 'S' (Super) or 'U' (Update) authorization levels, otherwise access denied message is displayed
[Individual Equipment Delete]
The system validates the train status → Individual equipment deletion is blocked and border crossing message is displayed
[Individual Equipment Delete]
The system checks user's change authorization level → Delete is permitted only for users with 'S' or 'U' change authorization, otherwise not authorized message is displayed
[Full Train Delete Request]
The system checks user's delete authorization level → Delete is permitted only for users with 'S' or 'U' delete authorization, otherwise not authorized message is displayed
[Display Confirmation Message]
The system sets the confirmation message → Confirmation delete train message is displayed to user
[Display Success Message]
The system completes the deletion process → Confirmation delete train success message is displayed and user returns to display screen
[Set Train Resend Flag]
Equipment modification processing completes → The train resend flag is set to indicate the train requires retransmission
[Set Train Resend Flag]
Any equipment movement is completed → The system sets the train resend flag to indicate changes require transmission
[Prepare Transaction Message]
The system prepares the transaction message → The input data is formatted and moved to the appropriate transaction message structure
[Set Communication Parameters]
The system sets communication parameters → The accept status is cleared and PCB is configured for message processing
[Call IMS Transaction Manager]
The system calls IMS transaction manager with CHNG function → The transaction manager is invoked to process the child transaction
[Write Message to Queue]
The system writes the message to queue using WRITMSGL → The message is successfully queued for transaction processing
[Display Arrival Confirmation Screen]
The arrival confirmation screen is displayed → Set arrival function flag, display confirmation message, populate default date/time fields with current system date and time, and set screen attributes
[Create Train Arrival Log Entry]
The system creates audit trail information → Move log information including transaction code, user ID, current date and time, set train type as CA train, set message as 'TRAIN ARRIVED', and set action code as 'ZZZ'
[Generate Arrival Notification Message]
The system generates arrival notification → Set train ID, security byte, CA train flag, action code 'MAA', station name as city, arrival date and time, and spawn the arrival notification transaction
[Display Success Message]
The system finalizes the arrival → Set train arrived flag, set action code 'MAA', display arrival success message, set current line for display, clear function field, and return to train display screen
[Start Equipment Addition at Position]
Equipment addition function is invoked → System allows addition only if user has 'S' (Super) or 'U' (Update) authorization level, otherwise shows not authorized message
[Mark Train for Resend]
Equipment addition is completed successfully → System sets train resend flag and modification done flag to trigger EDI processing
[Check Container Movement Restrictions]
Selected equipment is a container type → System displays error message 'Invalid move container' and prevents the movement
[Check Container Movement Restrictions]
Target position is within a container list sequence → System displays error message 'In container list' and prevents the movement
[Shift Intermediate Equipment Up]
The system shifts intermediate equipment → All equipment between the original position and target position must be moved up one position to fill the gap
[Identify Container Chain]
The system identifies the container chain → All containers immediately following the parent equipment must be identified as part of the movement chain until a non-container equipment is encountered
[Display CCN Unusable Message]
The system communicates the error to the user → A message indicating the cargo control number is unusable is displayed to inform the user of the validation failure
[Reject Container Movement]
The system processes the movement request → The movement is rejected with message 'Invalid move container' and the operation is not allowed
[Immediate Delivery Schedule]
The system processes broker notifications → If the train has arrived or arrived manually or cargo has arrival indicator 'Y', the system skips the notification process
[Send X12 EDI Notification]
The system processes broker notifications → The system calls GCCS309C with action code '04', transaction 'GCT0111E', notify broker flag, and X12 broker header information
[Send Internet Notification]
The system processes broker notifications → The system spawns GCT0191E transaction with cargo CCN, high security level, and internet address from B1 segment
[Check Train Arrival Status]
The system processes broker notifications → The system checks if the train has arrived (GCWB4TL-ARRIVED-YES), arrived manually (GCWB4TL-ARRIVED-MANUAL), or cargo has arrival indicator set to 'Y', and if any condition is true, skips the notification process
[Send X12 Notification]
The broker notification process is executed → The system calls GCCS309C with action code '04', transaction 'GCT0111E', notify broker flag, and the broker's X12 header information
[Check Train Arrival Status]
If notification eligibility → Skip notification if train has already arrived, is manually arrived, or cargo has arrival indicator set to 'Y'
[Has Broker Entry?]
If notification conditions → Process notification only if delivery schedule is consist, immediate, default, or arrival with arrived train, and broker entry is blank or low-values
[Train Arrived and Delivery Schedule Requires Arrival?]
The train has not arrived yet (arrival status is not 'YES' or 'MANUAL') and cargo arrival indicator is not 'Y' → The system should skip broker notification processing
[Train Arrived for Consist/Immediate Delivery?]
The train has arrived status or cargo has arrival indicator set to 'Y' → The system skips broker notification processing
[Broker Entry Required?]
Delivery schedule is consist, immediate, default, or arrival delivery with arrived train AND broker entry is blank or low-values → The system proceeds with broker notification, otherwise skips notification
[Internet Channel Enabled?]
Broker use internet flag is set to 'Y' → The system creates a GCX019 input record with cargo CCN, high-values security, and internet address from B1 segment, then spawns GCT0191E transaction
[Delivery Schedule Check]
Delivery schedule is 'CONSIST-DELIVERY' or 'IMMEDIATE-DELIVERY' and train has arrived or cargo has arrival indicator → Skip notification delivery due to schedule restrictions
[Internet Channel Enabled?]
Broker use internet flag is 'Y' → Send internet notification with CCN, high security level, and internet address from B1 segment
[Configure X12 Broker Header]
The system prepares the X12 notification message → The system should populate the X12 broker header with the broker's X12 header configuration
[Train Already Arrived?]
If notification conditions → The system skips notification if train status is arrived, manually arrived, or cargo has arrival indicator 'Y'
[Send X12 Electronic Notification]
The system processes broker notifications → The system calls GCCS309C with action code '04', transaction 'GCT0111E', notify broker flag, and X12 broker header
[Send Internet Notification]
The system processes broker notifications → The system spawns GCT0191E with cargo CCN, high-values security, and internet address from B1 segment
[Spawn GCT1401E Transaction]
Submitting the customer report transaction → The GCT1401E transaction is spawned through IMS messaging system with proper message formatting and queue management

Structural Validations

[2:Train List Reading and Validation]
The input field for train ID is empty or contains only spaces → The system displays 'absent train' message and returns to train report display screen
[2:Train List Reading and Validation]
The first 4 positions of the train ID are blank or spaces → The system displays 'invalid SCAC blank' message and returns to train report display screen
[3:Train Database Retrieval]
The train ID is not found in the train database → The system displays 'train not found' message and sets train not found status
[3:Train Database Retrieval]
The train is marked as deleted and has no associated equipment → The system generates an error message indicating 'NOT DELETED & NO EQUIP' and terminates processing
[16:Train Arrival Processing]
The train is already marked as arrived and user is not a super user → The system displays 'arrived' message and prevents duplicate arrival processing
[21:Date Validation Processing]
The arrival date/time is in the future compared to current system date/time → The system displays 'future arrival date/time' message and requires correction
[21:Date Validation Processing]
The arrival date/time is before the train's creation date/time → The system displays 'before creation arrival date/time' message and requires correction
[23:Cargo Addition to Train]
The cargo is already assigned to a different train → The system displays 'CCN not available' message and prevents the addition
[23:Cargo Addition to Train]
The cargo bill number does not exist in the cargo system → The system displays 'invalid bill equipment' message and prevents the operation
[23:Cargo Addition to Train]
The equipment ID does not match the cargo's equipment car field → The system displays 'invalid bill equipment' message and prevents the operation
[13:Equipment Addition Function]
No cargo bill number is provided and no containers are specified → The system displays 'empty no CCN' message and prevents the addition
[13:Equipment Addition Function]
A cargo bill number is also provided → The system displays 'no CCN for A' message and prevents the addition
[Train ID Field Empty?]
The train ID input field is empty or contains only spaces → The system displays 'Absent Train' error message and prevents further processing
[SCAC Code Empty?]
The first 4 positions of the train ID are empty or contain only spaces → The system displays 'Invalid SCAC Blank' error message and prevents further processing
[Train List Found?]
No train record is found matching the provided train ID → The system displays 'Train Not Found' error message and sets train not found status
[Too Many Equipment?]
The train contains more than 2500 equipment items → The system displays 'More Than 2500 Equipment' error message and abends the process
[No Equipment and Not Deleted?]
The train has no equipment and is not marked as deleted → The system displays 'Not Deleted & No Equipment' error message and abends the process
[Train ID Provided?]
The input field for train ID is empty or contains only spaces → The system displays 'Absent Train' error message, sets cursor to input field with high intensity display, and redirects to train report display screen
[SCAC Code Provided?]
The first 4 positions of the input field are empty or contain only spaces → The system displays 'Invalid SCAC Blank' error message, sets cursor to input field with high intensity display, and redirects to train report display screen
[Equipment Count Valid?]
The train has more than 2500 equipment items → The system displays 'More than 2500 equipment' error message and performs system abort procedure
[Train Has Equipment?]
The train is not marked as deleted and has no equipment → The system displays 'Not deleted & no equipment' error message and performs system abort procedure
[SCAC Code Provided?]
The input field positions 1-4 are blank or empty → The system displays an invalid SCAC blank error message and returns to the train display screen
[SCAC Access Valid?]
The validation result indicates invalid access (SCAC-ACCESS-INVALID flag is set) → The system sets invalid access error and displays invalid SCAC access message
[Set Invalid Access Error]
The system needs to handle the invalid access condition → The system clears the function field, sets the invalid SCAC access message, sets field attributes for error display, and sets the train display screen as output
[Set Invalid Access Message]
The system processes the invalid access result → The system sets the system message number to INV-SCAC-ACCESS to indicate invalid SCAC access
[Train ID Provided?]
The input field for train ID is empty or contains only spaces → The system displays error message 'absent train' and sets output to train report display screen
[SCAC Code Provided?]
The first 4 positions of the input field are empty or contain only spaces → The system displays error message 'invalid SCAC blank' and sets output to train report display screen
[Display Error: Train Not Found]
The database query returns 'not found' status → The system displays error message 'train not found', sets train not found flag, and sets output to train report display screen
[Train Deleted with No Equipment?]
The train is marked as deleted AND has no equipment records → The system generates a system error with message 'NOT DELETED & NO EQUIP' and performs abend procedure
[Train ID Provided?]
The input field for train ID is empty or contains only spaces → The system displays 'Absent Train' error message and sets train report display screen
[SCAC Code Provided?]
The first 4 positions of the train ID are empty or contain only spaces → The system displays 'Invalid SCAC Blank' error message and sets train report display screen
[Display Error: Train Not Found]
The database query returns 'not found' status → The system sets train not found flag, displays 'Train Not Found' message, and sets train report display screen
[Invalid Parameters]
The database module returns an invalid parameter response → The system generates an error message indicating invalid parameters were passed to the module and terminates processing
[Too Many Equipment Records]
The number of equipment records exceeds 2500 items → The system generates an error message indicating too many equipment records and terminates processing
[No Equipment Found]
The train is not marked as deleted AND has no equipment records → The system generates an error message indicating the inconsistent state and terminates processing
[Set Train Not Found Flag]
The query returns not found, invalid parameters, too many records, or inconsistent equipment state → The system sets the train not found flag, displays error message, and configures display screen attributes
[Train Already Arrived?]
The system checks if the train has already arrived → If train arrival status is 'YES', display train arrived error message and prevent the change
[Train Status Valid?]
Train status indicates the train is marked as deleted → System displays 'Status Deleted' message and prevents the operation
[Print Function]
Train is marked as resend status → System displays invalid print message and prevents printing operation
[Function Code?]
Function code is not one of the valid operations (Add, Delete, Modify, Arrival, Print, Move, AEI Block) → System displays invalid function message and highlights function field
[Train Status?]
The train has been marked as deleted → System displays 'Status Deleted' message and prevents the operation
[Invalid PF Key?]
The PF key pressed is not valid for the current screen context → System displays 'PF Key Invalid' message
[Selection Available?]
The PF key function is not available in the current screen context → System displays 'PF Not Available' message
[Process Print Function]
The train is in resend status → System displays invalid print message and prevents printing
[Function Type?]
The function code is not one of the valid functions (Add, Delete, Modify, Arrival, Print, Move, AEI Block) → System displays 'Invalid Function' message
[Block Function - Display Error Message]
The system processes the function request in display control input → Function is blocked with CST-MORE-24-HOURS error message and function attribute is highlighted
[Equipment Count at Maximum?]
The train already has the maximum allowed equipment quantity (GCWB4TL-EQUIPMENT-MAX) → The system should reject the addition request and display maximum equipment error message
[Valid Line Selection?]
The line selection input is validated for format and content → The system should accept valid line selections and reject invalid ones with appropriate error messages
[Valid Equipment ID?]
The system validates the equipment ID format through GCCCARFM → The system should accept properly formatted equipment IDs and reject invalid formats with error message
[Valid Load/Empty?]
The system validates load/empty status is provided and is valid ('L', 'E', or 'A') and 'A' status has no CCN while 'L' status without CCN has containers → The system should accept valid load/empty combinations and reject invalid ones with specific error messages
[CCN Usable?]
The system checks if the CCN has new bond created flag and finds alternative CCN or determines unusability → The system should use alternative CCN if available or reject unusable CCN with appropriate error message
[Add Equipment to Train Position]
The selected position is a container position → The system should reject the addition and display container list error message
[Equipment Count at Maximum?]
The train already has the maximum number of equipment items (500) → The system should reject the addition request and display maximum equipment limit error message
[Valid Line Selection?]
The line selection input is empty or invalid format → The system should reject the request and display item not selected or item invalid error message
[Valid Line Selection?]
The selected line is less than current save item:
greater than equipment quantity plus one
greater than save item plus maximum screen number minus page limit
→ The system should reject the selection and display item invalid error message
[Valid Line Selection?]
The selected position is within a container list of existing equipment → The system should reject the addition and display 'in container list' error message
[Valid Equipment ID?]
The equipment ID is provided and format validation is performed → The system should decompress and validate the car ID format, rejecting invalid equipment IDs with appropriate error message
[Valid Equipment ID?]
The equipment ID field is empty but other equipment fields contain data → The system should reject the entry and display 'no invalid equipment ID' error message
[Valid Bill Number?]
The equipment ID does not match the equipment car associated with the bill number in cargo system → The system should reject the entry and display invalid bill equipment error message
[Valid Bill Number?]
A bill number (CCN) is also provided → The system should reject the entry and display 'no CCN for A' error message
[Valid Cargo Status?]
The cargo associated with the bill number is already assigned to a different train → The system should reject the addition and display 'US CCN not available' error message
[Valid Cargo Status?]
The cargo status is not one of: BLANK, SENT, ACK, ARRIVED, RETURN, HOLD, AGI-HOLD, RELEASE, CSA-DLV, or MANUAL with HAULAGE → The system should reject the addition and display invalid cargo status error message
[Valid Load/Empty?]
Equipment ID is provided but load/empty status is empty → The system should reject the entry and display 'no load empty status' error message
[Valid Load/Empty?]
The load/empty status is not 'L' (Loaded), 'E' (Empty), or 'A' (Auto) → The system should reject the entry and display invalid load empty status error message
[Valid Load/Empty?]
No bill number is provided AND no container equipment is specified in subsequent positions → The system should reject the entry and display 'empty no CCN' error message
[Cargo Number Usable?]
The cargo bond validation determines the cargo number is unusable → The system should reject the addition and display 'CCN unusable' error message
[Equipment Count at Maximum?]
The current equipment count equals the maximum allowed equipment limit of 500 items → The system should reject the addition request and display an error message indicating maximum equipment limit reached
[Line Selection Valid?]
The line selection input is empty or spaces → The system should reject the input and display an error message indicating item not selected
[Line Within Valid Range?]
The line number is less than the current save item position:
greater than equipment quantity plus one
greater than save item plus maximum screen number minus page limit
→ The system should reject the selection and display an invalid item error message
[Equipment ID Input Received]
The equipment ID field is empty or spaces → System displays 'No Invalid Equipment ID' error message and marks the equipment addition as invalid
[Set Invalid Equipment ID Error]
The formatting call returns an error → System sets 'No Invalid Equipment ID' error message, marks equipment addition as invalid, and highlights the equipment field for user attention
[Cargo Bill Number Provided?]
The cargo bill number field is empty or contains only spaces → The system should reject the assignment and display an error message indicating no bill number was provided
[Error - Border Crossing Restriction]
User attempts to delete equipment without selecting a specific line → System displays border crossing restriction message and prevents deletion
[Validate Line Selection]
Line selection data is validated → System converts non-alphabetic input to justified number format or shows invalid item message if validation fails
[Check Equipment Range]
System checks if line number is within equipment quantity range → System allows deletion if line number is between 1 and total equipment quantity, otherwise shows invalid item message
[Equipment Already Deleted?]
System checks equipment deletion status → System shows already deleted message if equipment is marked for deletion, otherwise proceeds with deletion
[Equipment Already Deleted]
A user attempts to delete the same equipment item again → The system displays already deleted error message and prevents duplicate deletion
[Line Selected?]
No line is selected (line selection field is empty) → System displays 'Item not selected' error message and highlights line selection field
[Valid Line Number?]
Number justification process fails or returns unsuccessful status → System displays 'Item invalid' error message and marks line selection as invalid
[Within Valid Range?]
Selected line number is zero:
selected line number exceeds total equipment quantity
→ System displays 'Item invalid' error message and marks line selection as invalid
[Train Already Acknowledged?]
The system checks if the train acknowledgment flag is set → If the train is not acknowledged, display 'Train Not Acknowledged' error message and return to train display, otherwise proceed with arrival processing
[Line Selection Provided?]
The system detects that a specific line selection has been provided → Display 'Line Selection Not Needed' error message and return to train display
[Line Selection Provided?]
The user has provided a line selection value in the input field → The system displays error message 'Don't need line selection' and highlights the line selection field with error attributes
[Train Already Acknowledged?]
The train acknowledgment flag is not set to true → The system displays error message 'Train Not Acknowledged' and returns to train display screen
[Train Already Arrived?]
The train arrival status is already set to 'Yes' and user is not a super user → The system displays error message 'Already Arrived' and highlights the function field with error attributes
[Valid Date/Time Format?]
The date conversion fails:
the time filler is not a space
the hour/minute fields are not numeric
hour is greater than 23
minute is less than 00
greater than 59
→ The system displays error message 'Invalid Arrival Date/Time' and sets confirmation screen attributes
[Future Date/Time?]
The entered date century is greater than current machine century:
(date century equals current century AND date is greater than current machine date)
(date century equals current century AND date equals current date AND time is greater than current machine time)
→ The system displays error message 'Future Arrival Date/Time' and sets confirmation screen attributes
[Before Train Creation?]
The entered date is less than train creation date:
(entered date equals creation date AND entered time is less than creation time)
→ The system displays error message 'Before Creation Arrival Date/Time' and sets confirmation screen attributes
[Error: Invalid Date/Time Format]
Date conversion fails:
time separator is not space
hour is not numeric
minute is not numeric
hour exceeds 23
minute is less than 00
minute exceeds 59
→ Display invalid arrival date/time error message and reset confirmation screen attributes
[Error: Future Date Not Allowed]
Arrival date century is greater than current machine century:
(arrival date century equals current century AND arrival date is greater than current machine date)
(arrival date century equals current century AND arrival date equals current machine date AND arrival time is greater than current machine time)
→ Display future arrival date/time error message and reset confirmation screen attributes
[Error: Before Creation Date Not Allowed]
Arrival date is less than train creation date:
(arrival date equals train creation date AND arrival time is less than train creation time)
→ Display before creation arrival date/time error message and reset confirmation screen attributes
[Validate Date Format]
The system validates the date format using ISCDATCV function with input format '2' and output format '0' → The system accepts the date if format is valid, otherwise rejects with invalid arrival date time message
[Time Format Valid?]
The system checks if date-time filler is not space AND hour is not numeric:
minute is not numeric
hour is greater than '23'
minute is less than '00'
minute is greater than '59'
→ The system rejects the input with invalid arrival date time message
[Input Date/Time < Train Creation Date/Time?]
The input date is less than train creation date:
(input date equals train creation date AND input time is less than train creation time)
→ The system rejects the input with before creation arrival date time message
[Line Selection Provided?]
A line selection is provided in the input → Display error message 'No line selection needed' and highlight line selection field
[Merlin ID Valid?]
Validating the Merlin ID → If Merlin ID is not found, display error message 'Invalid Merlin ID' and highlight Merlin ID field
[Train Print Selected?]
Validating train print option → If train print option is not valid Y/N, display error message 'Invalid train Y/N' and highlight train list field
[Cargo Print Selected?]
Validating cargo print option → If cargo print option is not valid Y/N, display error message 'Invalid cargo Y/N' and highlight cargo list field
[FAX Print Selected?]
Validating FAX print option → If FAX print option is not valid Y/N, display error message 'Invalid FAX Y/N' and highlight FAX field
[At Least One Option Selected?]
Neither train print nor cargo print is selected → Display error message 'Select train or cargo' and highlight train list field
[Merlin ID or FAX Required?]
No Merlin ID is provided → Display error message 'Need Merlin ID or FAX' and highlight Merlin ID field
[Merlin Access Valid?]
Validating Merlin database access for EXTFAX → If EXTFAX Merlin ID is not found, display error message 'System Merlin FAX error'
[Line Selection Required?]
Line selection field is not empty → Display error message that line selection is not needed for print function
[Validate FAX Number]
Station FAX number is not numeric or equals zero → Display US FAX error message
[Print Options Valid?]
User presses an invalid PF key or confirm request key → System displays invalid PF key message and prevents further processing
[Print Options Valid?]
User selects a PF key that is not available in current screen context → System displays PF key not available message and prevents further processing
[Merlin ID Found?]
System checks Merlin database for the provided ID → If Merlin ID is not found, system displays invalid Merlin ID error message and highlights the Merlin ID field
[Train Print Selected?]
System validates the train print selection field → If train print selection is not Y or N, system displays invalid train Y/N error message and highlights the train list field
[Cargo Print Selected?]
System validates the cargo print selection field → If cargo print selection is not Y or N, system displays invalid cargo Y/N error message and highlights the cargo list field
[FAX Print Selected?]
System validates the FAX print selection field → If FAX print selection is not Y or N, system displays invalid FAX Y/N error message and highlights the FAX field
[Missing Print Selection]
Neither train print nor cargo print is selected as Y → System displays train or cargo selection required error message and highlights the train list field
[Missing Print Selection]
FAX print is not selected as Y → System displays Merlin or FAX required error message and highlights the Merlin ID field
[FAX Number Valid?]
System checks the Canadian FAX number field → If FAX number is not numeric or is zero, system displays US FAX error message
[System FAX Available?]
System searches for EXTFAX Merlin ID in database → If EXTFAX Merlin ID is not found, system displays system Merlin FAX error message
[Count Equipment by Status Categories]
The cargo status is 'RETURN' or the manifest from station differs from manifest to station and status is not error, reject, or deleted → The proceeding counter is incremented by one
[Display Error Message]
System encounters invalid line selection, container restrictions, or other validation errors → Appropriate error message is displayed and line attributes are highlighted for user correction
[Train in Resend Status?]
The system checks if the train is in resend status:
if function is 'Z' with proper re-add authorization
→ The train must be marked as resend OR function must be 'Z' with 'S' level re-add authorization to proceed
[Equipment Updates Valid?]
The system checks for any validation errors during equipment processing → If any equipment validation failed (invalid cargo, duplicate assignments, etc.), stop processing and display appropriate error message
[EDI Send Successful?]
The system checks the transmission result → If EDI transmission failed, display 'Invalid Code GCCE358' error; if successful, proceed with FAX transmission if required
[Train Resend Flag Set?]
User attempts to resend EDI transaction → Processing is allowed only if train resend flag is set OR user performs 'Z' function with proper authorization, otherwise display not resend status message
[Train Already Arrived?]
System checks train arrival status → If train has already arrived, display train not arrived error and stop processing
[Cargo Already Assigned to Train?]
The system attempts to assign the cargo to a new train → If the cargo already has a train ID assigned, the system should reject the assignment with 'cargo not available' error message
[Train Resend Flag Set?]
The system checks if train has resend flag set or user performs 'Z' function with proper authorization → The system processes EDI transaction if resend conditions are met, otherwise displays not resend status message
[Retrieve Merlin Database Configuration]
The system validates the configured Merlin ID → The system proceeds with report generation if Merlin ID is valid, otherwise displays invalid Merlin ID error
[Train Resend Flag Set?]
EDI transaction processing is initiated → The system checks if the train resend flag is set and only proceeds if true, otherwise displays not resend status message
[Public ID Found?]
The system checks the search results → If public ID is not found, display public ID not found message and stop processing
[Train Already Arrived?]
The system checks train arrival status → If train has arrived status set to yes, display train not arrived message and stop processing
[Equipment Updates Valid?]
The system validates update results → If any equipment update is invalid, stop processing and display appropriate error message
[Merlin ID Valid?]
The system validates Merlin ID → If Merlin ID is not found, display invalid Merlin ID message and stop processing
[EDI Send Successful?]
The system checks transmission results → If EDI send is not successful, display invalid code message, otherwise proceed with FAX processing if configured
[Set Error Message - Invalid EDI Code]
The EDI transmission is not successful → The system should set an error message indicating invalid EDI code
[Train Resend Flag Set?]
If the train resend flag is set (GCWB4TL-RESEND) or if function is 'Z' with super user authorization → The system either proceeds with EDI transaction processing or displays not resend error message
[EDI Processing Successful?]
The system checks if GCWS358C-SUCCESSFULL flag is true → The system either proceeds with FAX processing or sets EDI error message
[Check FAX Requirements]
The system checks if train arrival flag (GCWB4TL-ARRIVED-YES) is set → The system displays train not arrived error message and stops EDI processing
[Set EDI Error Message]
The system detects GCWS358C-SUCCESSFULL flag is false → The system sets system message number to CST-GCX147-INV-CODE-GCCE358 indicating EDI processing error
[Cargo Bill Number Exists?]
The cargo bill number (CDA-CCN-KEY) is not provided or is empty → The system should reject the addition and display an invalid bill equipment error message
[Cargo Already Assigned to Train?]
The cargo's CDN-CUS-NORTH-TRAIN-ID field is not empty → The system should reject the assignment and display a cargo not available error message
[Error - Cargo Not on Same Train]
The system detects train ID mismatch → Generate error message indicating cargo not on same train and abort operation
[Currently at First Page?]
Current line position equals first page position → Display first page message and maintain current position
[Position Beyond Equipment Range?]
New line position is greater than total equipment quantity → Display last page message and reset line position to saved item position
[Validate Line Selection Data]
User selects cargo function without providing a line selection → System displays error message 'Item not selected' and highlights line selection field
[Validate Line Selection Data]
Numeric conversion fails → System displays error message 'Item invalid' and sets invalid line number flag
[Check Equipment Range]
Line selection is zero or exceeds total equipment quantity → System displays error message 'Item invalid' and sets invalid line number flag
[Equipment Has Bill Number?]
Selected equipment does not have an associated bill number (CCN key is spaces) → System displays error message 'Need bill number' and highlights line selection field
[Authorization Denied - Not Authorized]
The authorization check fails → The system should set error message CST-GCX147-NOT-AUTHORIZED, highlight function attribute, and return to train display
[Line Selection Valid?]
The line selection field is empty or contains non-numeric characters → The system displays an item not selected or item invalid error message and highlights the line selection field
[Line Within Valid Range?]
The line number is zero, exceeds the total equipment quantity, or falls outside the current page range → The system displays an item invalid error message and refreshes the train display
[Error: No Line Selection Needed]
The user provides a line selection value → The system displays error message 'Don't need line selection' and returns to train display without processing arrival
[Error: Already Arrived]
The train status shows as already arrived and user does not have super user authority → The system displays error message 'Train already arrived' and returns to train display
[Error: Not Authorized]
The user does not have 'S' (Super) or 'U' (Update) authorization level for arrivals → The system displays error message 'Not authorized' and returns to train display
[Error: Already Arrived]
The train has not been acknowledged (ACK flag is not set) → The system displays error message 'Train not acknowledged' and returns to train display
[Error: Invalid Date Format]
The date format is invalid, date time filler is not space, hour is not numeric, minute is not numeric, hour is greater than 23, or minute is less than 00 or greater than 59 → The system displays error message 'Invalid arrival date time' and redisplays confirmation screen for correction
[Error: Future Date Not Allowed]
The entered date century is greater than current system century, or date century equals current century and date is greater than current system date, or date century equals current century and date equals current system date and time is greater than current system time → The system displays error message 'Future arrival date time not allowed' and redisplays confirmation screen for correction
[Error: Before Creation Date]
The entered arrival date is less than train creation date, or arrival date equals train creation date and arrival time is less than train creation time → The system displays error message 'Before creation arrival date time' and redisplays confirmation screen for correction
[Line Selection Provided?]
The user provides a line selection number → The system displays error message that no line selection is needed for print function
[Print Selection Valid?]
Neither train print nor cargo print is selected → The system displays error message requiring selection of either train or cargo printing
[Destination Valid?]
The system validates print destination → The system displays error message requiring either Merlin ID or FAX selection
[Line Selection Provided?]
No line selection is provided in the request → Display error message 'Item not selected' and prevent position change
[Valid Line Number?]
The justification process fails to produce a valid number → Display error message 'Item invalid' and prevent position change
[Within Valid Range?]
The line number is zero or greater than total equipment quantity → Display error message 'Item invalid' and prevent position change
[Set Invalid Equipment ID Error]
The system processes the validation failure → The system should set invalid equipment ID error message and mark the field as invalid
[Load/Empty Status Provided?]
The load/empty status field is not provided or is empty → The system should reject the equipment addition with error message 'No Load/Empty Status'
[Valid L/E/A Status?]
The load/empty status is not 'L', 'E', or 'A' → The system should reject the equipment addition with error message 'Invalid Load/Empty Status'
[Bill Number Provided with 'A'?]
A bill number (CCN) is also provided for the same equipment → The system should reject the equipment addition with error message 'No CCN for A'
[Bill Number Required for Loaded?]
No bill number (CCN) is provided and no container equipment is present in positions 2-11 → The system should reject the equipment addition with error message 'Empty No CCN'
[Container Equipment Present?]
No container equipment is present in positions 2-11 → The system should reject the equipment addition with error message 'Empty No CCN'
[Equipment Addition Request]
Equipment ID is empty but bill number or load/empty status is provided → The system should reject the equipment addition with error message 'No Invalid Equipment ID'
[Equipment Addition Request]
Equipment ID is empty but bill number or load/empty status is not empty → The system should reject the equipment addition with error message 'No Invalid Equipment ID'
[Equipment Addition Request]
The entire equipment table is empty (all spaces) → The system should reject the equipment addition with error message 'No Invalid Equipment ID'
[Cargo Found?]
The system checks if cargo was found in the database → If cargo is not found, display 'Invalid Bill Equipment' error message and set invalid add flag
[Equipment ID Matches Cargo?]
The system compares the input equipment ID with the cargo's equipment ID → If the equipment IDs do not match, display 'Invalid Bill Equipment' error message and set invalid add flag
[Already Assigned to Train?]
The cargo already has a Canadian customs north train ID assigned → Display 'US CCN Not Available' error message and set invalid add flag
[Valid Status?]
The cargo status is not one of: BLANK, SENT, ACK, ARRIVED, RETURN, HOLD, AGI-HOLD, RELEASE, CSA-DLV, or MANUAL with HAULAGE → Display 'Invalid Cargo Status' error message and set invalid add flag
[Equipment Count at Maximum?]
User attempts to add new equipment to the train → System should reject addition if equipment count equals maximum allowed (500 items) and display maximum equipment error message
[Process Equipment Addition]
Equipment validation passes and user confirms addition → System adds equipment to train list, sets modification flags, and displays confirmation message
[Validate PF Key Input]
PF key is not recognized or not available for current context → System displays 'PF Key Invalid' or 'PF Not Available' message
[Within Current Page Range?]
The line selection is less than the current save item:
greater than equipment quantity
greater than save item plus maximum screen number minus page limit
→ The system should reject the selection with 'Item Invalid' error, set invalid line number flag, and redisplay the train information
[Invalid Parameters]
If the operation result as INVALID-PARM → An error message indicating invalid parameters is set and the system abends with the error
[Too Many Equipment Records]
If the operation result as TO-MANY-EQP → An error message indicating too many equipment records is set and the system abends with the error
[No Equipment Found]
If the operation result as NO-EQP → An error message indicating no equipment found for non-deleted train is set and the system abends with the error
[Line Selection Provided?]
User has provided a line selection number → System displays error message indicating line selection is not needed for print function and highlights the line selection field
[User Response?]
User presses invalid PF key → System displays invalid PF key message and maintains confirmation attributes
[Display Error - No Line Selection Needed]
A line selection is provided in the input → Display error message that no line selection is needed for arrival function and highlight the line selection field
[Display Error - Not Authorized]
The user does not have 'S' or 'U' authorization level for arrival operations → Display not authorized error message and highlight the function field
[Train Not Acknowledged]
The train has not been acknowledged in the system → Display error message that train is not acknowledged and return to display screen
[Train Already Arrived?]
The train status shows it has already arrived and user is not a super user → Display error message that train has already arrived and highlight the function field
[Cargo Found in Database?]
The system searches for the cargo in the database using the CCN → If cargo is not found, mark the addition as invalid and display 'Invalid Bill Equipment' error message
[Cargo Status Check]
The system checks if the cargo already has a Canadian customs north train ID assigned → If cargo is already assigned to another train, mark the addition as invalid and display 'US CCN Not Available' error message
[Equipment Count at Maximum?]
The current equipment count equals the maximum allowed equipment limit → The system displays maximum equipment error message and prevents equipment addition
[Waybill Found?]
The waybill system returns no data or error status → The system displays waybill not found error message and prevents automatic equipment addition
[Bond Valid?]
The cargo bond validation fails or cargo becomes unusable due to bond issues → The system displays cargo unusable error message and prevents equipment addition
[Display Error Message]
Any validation rule fails during equipment addition → The system displays specific error message, highlights problematic fields, and maintains current screen state
[Equipment Type 'A' with CCN?]
The equipment has load/empty status 'A' AND a CCN (bill number) is provided → The system should reject the addition with error message 'No CCN for A request' and highlight the load/empty status field
[Load Equipment without CCN or Containers?]
The equipment has load/empty status 'L' AND no CCN is provided AND no containers are specified in positions 2-11 → The system should reject the addition with error message 'Empty equipment needs CCN' and highlight the equipment and load/empty status fields
[Load Equipment without CCN or Containers?]
The equipment has load/empty status 'L' AND no CCN is provided → The system should reject the addition with error message 'Empty equipment needs CCN' and highlight the equipment and load/empty status fields
[Equipment ID provided?]
All equipment container table entries are empty → The system should reject the addition with error message 'No invalid equipment ID' and highlight the equipment field
[Equipment ID provided?]
The equipment ID field is empty → The system should reject the addition with error message 'No invalid equipment ID' and highlight the equipment field
[Valid Equipment ID?]
The equipment ID format validation fails → The system should reject the addition with error message 'No invalid equipment ID' and highlight the equipment field
[Cargo found in database?]
The bill number is not found in the cargo database → The system should reject the addition with error message 'Invalid bill equipment' and highlight the CCN and equipment fields
[Cargo already on train?]
The cargo is already assigned to another train (CDN-CUS-NORTH-TRAIN-ID is not empty) → The system should reject the addition with error message 'US CCN not available' and highlight the CCN and equipment fields
[Load/Empty status provided?]
The load/empty status field is empty → The system should reject the addition with error message 'No load empty status' and highlight the load/empty status field
[Valid Load/Empty status?]
The status is not 'L' (Loaded), 'E' (Empty), or 'A' (Auto) → The system should reject the addition with error message 'Invalid load empty status' and highlight the load/empty status field
[Load Equipment without CCN or Containers?]
The target position already contains container equipment → The system should reject the addition with error message 'In container list' and highlight the equipment, CCN, and load/empty status fields
[Valid equipment type?]
The equipment type validation call fails → The system should reject the addition with error message 'Invalid code car type' and highlight the equipment field
[Cargo found in database?]
The equipment ID does not match the cargo's equipment ID (for first position):
container ID does not match (for other positions)
→ The system should reject the addition with error message 'Invalid bill equipment' and highlight the CCN and equipment fields
[Cargo found in database?]
The cargo status is not BLANK, SENT, ACK, ARRIVED, RETURN, HOLD, AGI-HOLD, RELEASE, CSA-DLV, or (MANUAL AND HAULAGE) → The system should reject the addition with error message 'Invalid cargo status' and highlight the CCN and equipment fields
[Cargo Found in Database?]
The system searches for the cargo record in the database → If cargo is not found, set invalid cargo status error and display 'Invalid Bill Equipment' message
[Set Invalid Status Error]
The cargo current status is not BLANK, SENT, ACK, ARRIVED, RETURN, HOLD, AGI-HOLD, RELEASE, CSA-DLV, or MANUAL with HAULAGE → Set invalid cargo status error flag and display 'Invalid Cargo Status' message to prevent train assignment
[Z800-NOTIFY-BROKER: Broker Notification]
The delivery schedule is consist delivery, immediate delivery, default delivery, or arrival delivery with arrived train, and broker entry is empty or low values → The system proceeds with broker notification process
[Cargo Exists?]
The system checks cargo existence in the database → If cargo is not found, the system displays 'Invalid Bill Equipment' error message and sets invalid add flag to true
[Already Assigned?]
The system checks if cargo has existing train assignment → If cargo CDN CUS North Train ID is not spaces, the system displays 'US CCN Not Available' error message and sets invalid add flag to true
[Equipment Matches?]
The system validates equipment ID against cargo equipment car → If the equipment ID does not match cargo equipment car, the system displays 'Invalid Bill Equipment' error message and sets invalid add flag to true
[Search for Unusable CCN]
GCCCCIO performs GU and GN operations on cargo segments with equipment ID and waybill key matching → If matching CCN found without new bond created flag, use that CCN, otherwise return CCN unusable error
[Broker Entry Required?]
If whether to send broker notification → The system only proceeds with notification if broker entry is spaces or low-values (entry not required)
[Validate Broker Entry Requirements]
The delivery schedule is consist, immediate, default, or arrival delivery with arrived train, AND the broker entry is spaces or low-values → The system should proceed with broker notification setup
[Delivery Schedule Check]
The system validates notification eligibility → Proceed with notification only if delivery schedule is consist delivery, immediate delivery, default delivery, or arrival delivery with arrived train, AND broker entry is blank or low-values, otherwise skip notification
[Validate Merlin User ID]
The system validates the Merlin user ID → If the Merlin ID is not found or invalid, the system should Throw error: and prevent communication
[Valid FAX Number?]
The system validates the FAX number → If the FAX number is not numeric or equals zero, the system should generate a FAX error message
[Log Communication Error]
The system processes the communication error → The system should generate specific error messages for 'from user not found', 'to/copy user not found', or 'invalid filename' errors
[Stack Operation Success?]
Stack operation is executed → If operation fails with invalid current selection code, system generates error message and performs abend procedure
[Validate Current Selection Code]
System validates the selection for cargo navigation → If selected equipment has no bill number (CCN), system displays error message requiring bill number and highlights selection field
[Validate Equipment Addition]
The system validates the equipment addition → An invalid bill/equipment error message is set and the invalid addition flag is set
[Display Error Message: Maximum 500 Equipment Exceeded]
A user attempts to add more equipment → The system should display error message indicating maximum 500 equipment exceeded
[Train Already Acknowledged?]
The system checks if the train acknowledgment flag is set → If train is not acknowledged, display train not acknowledged error message, otherwise proceed with arrival confirmation
[Train Already Acknowledged?]
The system checks train arrival status and user authorization level → If train already arrived and user is not super user, display already arrived error message
[Valid Arrival DateTime?]
The system validates the date time format and business rules → If date format is invalid, or time is not numeric, or time is future dated, or time is before train creation time, display appropriate error message
[Train Arrival Status]
The system checks if the train has arrived → If train has arrived, display error message that train already arrived and return to train display, otherwise allow the AEI block toggle operation
[Display Authorization Error Message]
The authorization check fails → The system should display 'Not Authorized' error message and highlight the function field
[Train Already Acknowledged?]
The train has not been acknowledged and the user is not a super user → The system should display 'Train Not Acknowledged' error message and return to display screen
[Line Selection Valid?]
No line is selected (line selection field is empty) → System rejects the request and displays 'Item not selected' error message
[New Position Valid?]
Target position is the immediate next position after current position → System allows the change without further validation, otherwise validates the position is within acceptable range
[Is Source Equipment a Container?]
The system validates the equipment type for movement eligibility → The system should block the movement, set invalid movement flag, and display container movement error message
[Is Target Position a Container?]
The system validates the target position for equipment placement → The system should block the movement, set invalid movement flag, and display container list error message
[Equipment Count at Maximum?]
User attempts to add new equipment and the current equipment count equals the maximum allowed equipment limit → System displays error message indicating maximum equipment limit reached and prevents equipment addition
[Does Equipment Have Bill Number?]
The equipment has load status 'L' and no bill number (CCN) is provided and no container equipment is specified in positions 2-11 → The system rejects the addition with message 'Empty equipment requires bill number' and highlights the load/empty status field
[Equipment Addition Request with Load Status 'L']
Equipment ID is blank but either bill number (CCN) or load/empty status is provided → The system rejects the addition with message 'Invalid equipment ID' and highlights the equipment ID field
[Cargo Found in Database?]
The bill number does not exist in the cargo database → The system rejects the addition with message 'Invalid bill number for equipment' and highlights both the bill number and equipment ID fields
[Reject Addition - Unusable Bond]
The system cannot find a valid bond for the equipment and waybill combination → The system rejects the equipment addition with message 'Cargo bond is unusable' and sets invalid addition flag
[Equipment and cargo must match]
The equipment ID in the request does not match the equipment ID in the cargo record for items beyond the first position → The system rejects the addition with message 'Invalid bill number for equipment' and highlights both the bill number and equipment ID fields
[Generate Invalid Car Type Error]
Car type validation fails → System generates invalid car type error message
[Cargo Found in Database?]
The system searches for the cargo record in the database using the provided CCN → If the cargo record is not found, display error message 'Invalid Bill Equipment' and prevent the equipment addition
[Already on Another Train?]
The cargo record already has a Canadian customs north train ID assigned → Display error message 'US CCN Not Available' and prevent the equipment addition
[Valid Cargo Status?]
The cargo status is evaluated against valid categories → If status is not BLANK, SENT, ACK, ARRIVED, RETURN, HOLD, AGI-HOLD, RELEASE, CSA-DLV, or (MANUAL with HAULAGE), display error message 'Invalid Cargo Status' and prevent equipment addition
[Check Status Categories]
The equipment ID from the input does not match the equipment car ID in the cargo record → Display error message 'Invalid Bill Equipment' and prevent the equipment addition
[Already on Another Train?]
The cargo record has a Canadian customs north train ID that is not empty → Display error message 'US CCN Not Available' and prevent the equipment addition
[Load/Empty Status Provided?]
The equipment ID is provided but the load/empty status field is empty → The system should reject the addition, display 'No Load/Empty Status' error message, and highlight the load/empty status field
[Valid L/E Status?]
The load/empty status is not 'L', 'E', or 'A' → The system should reject the addition, display 'Invalid Load/Empty Status' error message, and highlight the load/empty status field
[CCN Provided with 'A'?]
A bill number (CCN) is also provided for the same equipment → The system should reject the addition, display 'No CCN for A Request' error message, and highlight the load/empty status field
[CCN Required for 'L'?]
No containers are specified in positions 2 through 11 for this equipment → The system should reject the addition, display 'Empty Equipment Needs CCN' error message, and highlight both the equipment field and load/empty status field
[CCN Required for 'L'?]
No bill number (CCN) is provided for this equipment → The system should reject the addition, display 'Empty Equipment Needs CCN' error message, and highlight both the equipment field and load/empty status field
[Validate Merlin ID in Database]
The system checks the Merlin ID against the database → If the Merlin ID is not found, display error message 'Invalid Merlin ID' and highlight the Merlin ID field
[At Least One Option Selected?]
Neither train print nor cargo print is selected → Display error message 'Must select train or cargo printing' and highlight the train list attribute field
[Need Merlin ID or FAX]
The system validates the print destination requirements → Display error message 'Must provide Merlin ID or select FAX' and highlight the Merlin ID attribute field
[Train Print Selected?]
The value is not 'Y' or 'N' → Display error message 'Invalid train Y/N selection' and highlight the train list attribute field
[Cargo Print Selected?]
The value is not 'Y' or 'N' → Display error message 'Invalid cargo Y/N selection' and highlight the cargo list attribute field
[FAX Print Selected?]
The value is not 'Y' or 'N' → Display error message 'Invalid FAX Y/N selection' and highlight the FAX attribute field
[FAX Number Numeric and Not Zero?]
The station's FAX number is not numeric or equals zero → Display error message 'Invalid US FAX number' and return to print screen
[System FAX Not Available]
The EXTFAX Merlin ID is not found in the database → Display error message 'System Merlin FAX not available' and return to print screen
[Validate FAX Number Format]
The system validates the Canadian FAX number from station data → If FAX number is not numeric or equals zero, display 'US FAX error' message
[Validate Merlin ID in Database]
The system validates the Merlin ID against the database → If the Merlin ID is not found in the database, set error message 'Invalid Merlin ID' and highlight the Merlin ID field
[Train Print Option Valid?]
The system validates the train print option → If the train print option is not a valid Y/N value, set error message 'Invalid Train Y/N' and highlight the train list field
[Cargo Print Option Valid?]
The system validates the cargo print option → If the cargo print option is not a valid Y/N value, set error message 'Invalid Cargo Y/N' and highlight the cargo list field
[FAX Print Option Valid?]
The system validates the FAX print option → If the FAX print option is not a valid Y/N value, set error message 'Invalid FAX Y/N' and highlight the FAX field
[At Least One Print Option Selected?]
Neither train printing nor cargo printing is selected → Set error message 'Must select train or cargo' and highlight the train list field
[FAX Selected but No Merlin ID?]
The system validates print destination requirements → Set error message 'Need Merlin ID or FAX' and highlight the Merlin ID field
[Set Invalid Equipment Error]
The system processes the invalid equipment ID → The system sets invalid equipment error message, highlights the error field, and displays appropriate error message
[Station Not Found Error]
The station table search returns unsuccessful status → The system sets the station customs error message and continues processing without station data
[Invalid FAX Error]
FAX number validation fails (non-numeric or zero) → The system sets US FAX error message and prevents FAX transmission
[Line Selection Empty?]
The line selection input field is empty or contains only spaces → The system sets an error message 'Item Not Selected' and marks the line selection as invalid
[Justification Successful?]
The justification return flag indicates failure → The system sets an error message 'Item Invalid' and marks the line selection as invalid
[Set Invalid Number Flag]
The system processes the failed result → The system should set invalid line number flag and display 'Item Invalid' error message
[Line Selection < Current Page Start?]
The selected line number is less than the current page starting item position → The system should mark the line selection as invalid and display an item invalid message
[Line Selection > Total Equipment?]
The selected line number is greater than the total equipment count → The system should mark the line selection as invalid and display an item invalid message
[Line Selection > Page Maximum?]
The selected line number is greater than the calculated page maximum position → The system should mark the line selection as invalid and display an item invalid message
[Line Selection Provided?]
The system checks if a line selection has been provided → If a line selection is provided, display error message that no line selection is needed for print operations and highlight the line selection field
[Stack Operation Valid?]
Stack management module is called → If operation fails with invalid current selection code, system abends with error message
[Train Already Arrived?]
The system checks the train's current arrival status → If the train is already marked as arrived, display error message and return to train display, otherwise proceed with arrival processing
[Stack Operation Successful?]
The stack management module returns a status → If stack operation failed with invalid current selection code, system generates error message and abends
[Handle Stack Error]
The stack validation detects the error condition → System creates error message with failed selection code details and performs abnormal termination
[Process Rail Car Addition]
The system checks current equipment count → Addition is rejected with 'Maximum 500 equipment' message if the train already has maximum allowed equipment (500 items)
[Broker Entry Required?]
The system determines whether to send broker notifications → The system checks if broker entry is spaces or low-values, and only proceeds with notifications if broker entry is not required
[Valid Delivery Conditions?]
If delivery conditions → The system processes notification only if delivery schedule is consist, immediate, default, or arrival with arrived train, and broker entry is spaces or low-values

Module: GCX151 1 Consolidated Epic Story

Epic: GCX151 Complete EDI Specification Extracted from Legacy

Contains 598 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX151 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[4:Database Indicators Initialization - Initialize database indicators and segments for processing]
Initialization is performed → All database segments should be cleared and all found indicators should be set to not-found status
[Initialize Database Segments]
The system begins database information processing → All database segments (LGRT, LGDP, GCSCCRT, GCSUSRT, GCSUSS07, GCSUSS02, SHIPROOT, FWSWXEQ) are cleared to spaces and car ID is cleared
[Initialize Equipment Cross-Reference]
System processes equipment cross-reference requirements → FWSWXEQ segment should be initialized to spaces/empty values
[Initialize equipment cross-reference segment]
The system processes equipment information → The system should initialize the FWSWXEQ segment to empty values
[Initialize Empty Equipment Cross-Reference]
Equipment cross-reference processing determines no cross-reference is needed → Equipment cross-reference segment is initialized as empty spaces
[Initialize Header Segment to Spaces]
The header building process begins → The header segment should be initialized to spaces to ensure clean data structure
[Initialize Equipment Segment to Spaces]
The equipment segment building process starts → The equipment segment should be initialized to spaces
[Initialize Manifest Segment to Spaces]
The manifest segment building process starts → The manifest segment should be initialized to spaces to ensure clean data structure
[Initialize Entry Port Segment to Spaces]
The entry port segment building process starts → The entry port segment should be initialized to spaces
[Initialize Quantity Segment to Spaces]
The quantity segment building process starts → The quantity segment should be initialized to spaces
[Initialize Event Segment to Spaces]
The event segment building process begins → The event segment should be initialized to spaces to ensure clean data
[Initialize Status Segment to Spaces]
The status building process begins → The status segment is initialized to spaces
[Initialize Broker Segment to Spaces]
The broker segment building process starts → The broker segment should be initialized to spaces to ensure clean data
[Initialize Bond Segment to Spaces]
The bond segment building process starts → The bond segment should be initialized to spaces
[Initialize Shipment Segment Indicators]
The shipment building process starts → Bond indicator is set to No, CSA indicator is set to No, clearance location is set to not required, and SCAC and FSAC codes are cleared
[Initialize Message Type Indicators]
The message analysis process begins → All message type flags are set to not-found state including cargo arrival not found, trucker bond proceed set to no, and FTZ authorization set to no
[Initialize Equipment Segment to Spaces]
The equipment segment building process starts → The equipment segment should be initialized to spaces to ensure clean data structure
[Initialize Manifest Segment]
The manifest segment building process starts → The manifest segment should be initialized to spaces
[Initialize Entry Port Segment to Spaces]
The entry port segment building process begins → The entry port segment should be cleared to spaces to ensure clean data structure
[Initialize Status Segment]
The status segment building process begins → The status segment is initialized with spaces and search key structures are cleared
[Initialize Broker Segment to Spaces]
The broker segment initialization is performed → The broker segment should be cleared to spaces
[Initialize Mexico Manifest Segment]
The system begins building the Mexico manifest segment → The Mexico manifest segment is initialized with spaces to ensure clean data structure
[Initialize Mexico Manifest Segment]
The system begins Mexico manifest segment processing → The Mexico manifest segment is cleared and initialized to spaces
[Initialize CBP Border Hold Segment]
The system begins border hold evaluation → The CBP border hold segment is cleared and hold indicator is set to No
[Initialize Export Control Broker Name Segment]
The validation process begins → The system should initialize the export control broker name segment and set export control not found flag to true
[Initialize waybill segments WB-SEG and WB2-SEG]
The system begins processing waybill segment construction → Both primary waybill segment (WB-SEG) and secondary waybill segment (WB2-SEG) are initialized to spaces
[Initialize waybill segments WB-SEG and WB2-SEG]
The system begins processing waybill data from inquiry database → Both primary waybill segment (WB-SEG) and secondary waybill segment (WB2-SEG) are initialized to spaces
[Initialize Event Segment to Spaces]
The event segment creation process begins → The event segment should be initialized to spaces
[Initialize Bond Indicator to No]
The shipment segment building process starts → Bond indicator is set to No, CSA indicator is set to No, clearance location is set to not required, and SCAC and FSAC codes are set to spaces
[Initialize Canadian Cargo Record Search]
The search initialization is triggered → The system clears all search parameters, sets the segment type to Canadian cargo records, sets the function to get first record, enables waybill index search, and clears the cargo record data structure
[Initialize US Cargo Search Parameters]
The system initializes US cargo search parameters → The GCWUSIO structure is cleared, segment type is set to GCSUSRT, function is set to GU (Get Unique), index type is set to waybill, operator is set to '> ', and the GCSUSRT segment is cleared
[Initialize Mexico Manifest Segment]
The system initializes the Mexico manifest segment (MXMFST-SEG) → The segment should be cleared to spaces and ready for data population
[Initialize Message Category Indicators]
The system initializes message category tracking → Cargo arrival flag is set to not found, trucker bond flag is set to no, FTZ authorization flag is set to no, entry number fields are cleared, and quantity counter is reset to zero
[Initialize Event Indicators]
The system initializes event tracking indicators → Cargo arrival indicator is set to not found AND trucker bond indicator is set to no AND FTZ authorization indicator is set to no AND entry number fields are cleared AND quantity accumulator is reset to zero
[Initialize Authorization Flags]
The system begins processing customs log messages → All authorization flags are set to not found, entry number variables are cleared, and quantity counter is reset to zero
[Initialize Entry Message Variables]
The 1J entry processing begins → All entry message variables are initialized to their default states including cargo arrival not found, trucker bond not authorized, FTZ authorization not granted, and entry numbers and quantities cleared
[Initialize Message Analysis Variables]
Message analysis process begins → All message type flags are set to not found state, entry numbers are cleared, and quantity counter is reset to zero
[Initialize cargo arrival and entry message indicators]
The system begins processing trucker bonds → Cargo arrival indicator is set to not found, trucker bond indicator is set to no, FTZ authorization indicator is set to no, 1J entry numbers are cleared, and 1J quantity is set to zero
[Initialize GCX105 Input Message]
The system prepares to create a trucker bond message → The system initializes GCX105 input structure with spaces and sets high-value security byte
[Initialize GCX105 Input Message]
The system prepares to create a trucker bond message → GCX105 input message structure is cleared and initialized with high-value security byte
[Initialize GCX105 Input Message]
The system prepares to create a trucker bond proceed message → The GCX105 input message is cleared and initialized with high-value security byte, sending transaction code GCT1511E, ACF2 user ID, and current machine date and time
[Initialize GCX105 Input Message]
The system prepares to create a linking message → The system initializes GCX105 input message structure with spaces and sets high-value security byte
[Initialize GCX105 Input Message]
The system initializes the GCX105 input message → All GCX105 input fields are cleared and set to initial state
[Initialize broker name segment]
System begins broker name segment processing → Broker name segment is initialized to empty state
[Initialize waybill segments WB-SEG and WB2-SEG]
Building waybill segment from SHIPROOT data → WB-SEG and WB2-SEG are initialized to spaces
[Initialize GCX105 Input Message]
The system prepares to create a GCX105 input message structure → The message structure is initialized with spaces, security byte set to high-value, and sending transaction set to 'GCT1511E'
[Initialize GCX105 Input Structure]
The message building process begins → The GCX105 input structure should be initialized to spaces
[Initialize Waybill Segments]
Building waybill segment from SHIPROOT data → WB-SEG and WB2-SEG are initialized to spaces to clear any previous data

Core Acceptance Criteria

[2:Message Reading - Read incoming customs log message from GCX105]
The message reading process is executed → The message should be read into GCX151-INPUT-MSG with its length
[3:Log Root Key Extraction - Extract log root key LGRT and log dependent key LGDP from input message]
Key extraction is performed → LGRT key should be extracted from first 25 characters of GCSLGRT segment and LGDP key from first 17 characters of GCSLGDP segment
[5:Customs Log Record Retrieval - Retrieve customs log root GCSLGRT and dependent GCSLGDP records]
Database retrieval is performed → GCSLGRT record should be retrieved using LGRT key and if found and cargo type is US or CA, then GCSLGDP record should be retrieved using LGDP key
[Equipment Valid?]
Equipment validity is evaluated → If equipment is valid, set CSD message send flag to true and proceed with message building, otherwise set flag to not send
[Canadian Cargo Processing?]
Cargo type routing is performed → If Canadian cargo record is found, build Canadian CSD message, otherwise build US CSD message
[15-25:Canadian CSD Message Building - Build all Canadian CSD segments]
Canadian CSD message building is performed → All Canadian CSD segments should be built including header, equipment, waybill, manifest, entry port, quantity, event, status, broker, bond, and shipment segments
[26-40:US CSD Message Building - Build all US CSD segments]
US CSD message building is performed → All US CSD segments should be built including header, equipment, waybill, manifest, entry port, quantity, event, status, broker, bond, shipment, and Mexico manifest segments for Laredo station
[41:CSD Message Transmission - Send complete CSD message to EET3211 transaction]
Message transmission is initiated → The complete CSD message should be sent to EET3211 transaction using CIMS and WRITMSGL calls
[Call READQ to read message from queue]
The system initiates the message reading process → The system calls READQ function to retrieve the message from the queue using CCCOM communication area, GCX151-INPUT-MSG buffer, and GCX151-INPUT-MSG-LENGTH parameter
[Set message length parameter]
The message reading process is initiated → The system sets up GCX151-INPUT-MSG as the message buffer and GCX151-INPUT-MSG-LENGTH as the length parameter for the READQ operation
[Extract LGRT Key from Input Message]
The system processes the input message for log root key extraction → The first 25 characters of the GCSLGRT segment are extracted and stored as the LGRT key
[Extract LGDP Key from Input Message]
The system processes the input message for log dependent key extraction → The first 17 characters of the GCSLGDP segment are extracted and stored as the LGDP key
[Extract Log Root Key from Input Message]
The system processes the input message for database information retrieval → The first 25 characters of the GCSLGRT segment are extracted and stored as the log root key
[Extract Log Dependent Key from Input Message]
The system processes the input message for database information retrieval → The first 17 characters of the GCSLGDP segment are extracted and stored as the log dependent key
[Clear All Database Segments]
The system prepares to retrieve cargo and manifest data → All database segments including LGRT, LGDP, Canadian cargo, US cargo, US manifest, Mexico manifest, shiproot, and equipment cross-reference segments are cleared to spaces
[Extract Log Root Key from Input Message]
The system processes the input message for customs log record retrieval → The first 25 characters of the GCSLGRT segment are extracted and stored as the log root key
[Extract Log Dependent Key from Input Message]
The system processes the input message for customs log record retrieval → The first 17 characters of the GCSLGDP segment are extracted and stored as the log dependent key
[Attempt to Retrieve GCSLGRT Record]
The system queries the GCSLGRT database with the log root key → The system retrieves the corresponding GCSLGRT record if it exists
[Attempt to Retrieve GCSLGDP Record]
The system queries the GCSLGDP database with the log dependent key → The system retrieves the corresponding GCSLGDP record if it exists
[Retrieve Log Root Record GCSLGRT]
The system attempts to retrieve the log root record from GCSLGRT database → The log root record is retrieved and cargo type information becomes available for validation
[Retrieve GCSCCRT record for Canadian cargo]
The system attempts to retrieve the GCSCCRT record using the log root key as the CCN key → The system should successfully retrieve the Canadian cargo record and set the found indicator, or set the not found indicator if the record does not exist
[Set CCN Key for GCSCCRT Record]
The system prepares to retrieve Canadian cargo data → The log root key should be assigned as the CCN key for the GCSCCRT record lookup
[Move Log Root Key to US CCN Key]
The system needs to retrieve US cargo information → The log root key should be moved to the US CCN key field for GCSUSRT record lookup
[Retrieve Equipment Cross-Reference FWSWXEQ]
System needs to retrieve equipment cross-reference data → FWSWXEQ segment should be retrieved using the equipment car information from the appropriate cargo record (Canadian or US) and shiproot key
[Retrieve Equipment Cross-Reference FWSWXEQ]
Equipment cross-reference data is retrieved from FWSWXEQ using equipment ID and waybill root key → Equipment cross-reference segment is populated with retrieved data for further processing
[Set CSD Message Send Flag to TRUE]
Both equipment initial and equipment number are present and not empty → Set the CSD message send flag to TRUE to enable message transmission
[Set CSD Message Send Flag to FALSE]
Either equipment initial or equipment number is missing or empty → Set the CSD message send flag to FALSE to prevent message transmission
[Set CPR Identifier to '=C=P=R=']
The CPR identifier field needs to be populated → The header CPR ID field should be set to '=C=P=R=' to identify the originating railway system
[Set Header Length to '045']
The header length field needs to be specified → The header length should be set to '045' characters as per CSD message format standards
[Set Message Version to '02']
The message format version needs to be identified → The header version should be set to '02' to indicate the current CSD message format version
[Set Source Application to 'CSTMS']
The source application needs to be identified → The header source application should be set to 'CSTMS' to indicate the customs system origin
[Set Source Application Version to '001.001.01']
The source application version needs to be specified → The header source application version should be set to '001.001.01' to indicate the customs system version
[Set Destination Application Message Tag to 'CSTMS_CSD_01']
The destination application message tag needs to be set → The header destination application message tag should be set to 'CSTMS_CSD_01' for proper message routing
[Set Destination Application Version to '01']
The destination application version needs to be specified → The header destination application version should be set to '01' to ensure compatibility with the receiving system
[Set Data Sensitivity Level to '2']
The data sensitivity level needs to be classified → The header data sensitivity should be set to '2' to indicate the appropriate security classification for customs information
[Move Equipment Car Initial to Equipment Segment]
Building the equipment segment for Canadian CSD message → The equipment car initial from the Canadian cargo record should be moved to the equipment segment initial field
[Move Equipment Car Number to Equipment Segment]
Building the equipment segment for Canadian CSD message → The equipment car number from the Canadian cargo record should be moved to the equipment segment number field
[Shiproot Data Available?]
The system checks for available Shiproot data → If Shiproot data is found, use Shiproot as primary data source, otherwise use WB Inquiry database as fallback data source
[TOFC/COFC Indicator Present?]
The system checks the TOFC/COFC indicator and validates bill of lading date availability → If TOFC/COFC indicator is 'C' or 'T' and bill of lading date is not spaces, low-values, or zeroes, then use bill of lading date and time, otherwise use standard waybill date and time
[Idler Car Present?]
The system checks if idler indicator from Shiproot is not spaces → If idler indicator is present, set multi-shipment indicator to 'I' for idler, otherwise retain the original multi-shipment indicator from Shiproot
[Multi-Shipment or Idler?]
The system checks if multi-shipment indicator is 'M' (multi-shipment) or 'I' (idler) → If multi-shipment indicator is 'M' or 'I', then set lead equipment ID from Shiproot car ID
[Build Waybill from Shiproot Data]
The system processes Shiproot information → Populate waybill segment with Shiproot date/time, TOFC/COFC indicator, multi-shipment indicator, origin station number, and original waybill information
[Build Waybill from Inquiry Database]
The system processes WB Inquiry information → Populate waybill segment with inquiry date/time, TOFC/COFC indicator, shiproot key with '01' suffix, origin station number, and original waybill key from inquiry info
[Set Manifest CCN Qualifier to XC]
The CCN qualifier needs to be set → The manifest CCN qualifier should be set to XC to identify it as a Canadian manifest
[Move Master Manifest CCN from Canadian Cargo Record]
Building the manifest segment → The master manifest CCN from the Canadian cargo record should be moved to the manifest CCN field
[Move In-Transit Status to BOL Code]
Building the manifest segment → The in-transit status should be moved to the BOL code field in the manifest segment
[Extract Piece Count from Canadian Cargo Record]
Building the quantity segment for CSD message → The piece count should be extracted from GCCC-PIECE-COUNT field
[Set Piece Count in Quantity Segment]
Building the CSD quantity segment → The piece count should be moved to QTY-PIECE-COUNT-9 field in the quantity segment
[Extract Quantity Qualifier from Canadian Cargo Record]
Building the quantity segment for CSD message → The quantity qualifier should be extracted from GCCC-LADING-QUANTITY-QUALIFIER field
[Set Quantity Qualifier in Quantity Segment]
Building the CSD quantity segment → The quantity qualifier should be moved to QTY-PIECE-COUNT-QUAL field in the quantity segment
[Set Released Quantity Equal to Total Piece Count]
Building the quantity segment → The QTY-PIECE-COUNT-RELEASED should be set to the same value as QTY-PIECE-COUNT
[Set Customs Event ID from Log Dependent Key]
Building the event segment for CSD message → The customs event ID should be set to the log dependent key value
[Calculate Timestamp from Log Dependent Key]
Processing the event timestamp for CSD message → The timestamp should be calculated by subtracting the log dependent key from nine's complement and extracting characters 2-16
[Extract Posted Date from Log Load Date]
Building the event segment posted date → The posted date should be extracted from characters 3-6 of the log load date
[Set Posted Time from Log Load Time]
Building the event segment posted time → The posted time should be extracted from characters 1-6 of the log load time
[Set User ID from ACF2 User Code]
Building the event segment user identification → The event user ID should be set to the ACF2 user code value
[Set Event Description from Log Message]
Building the event segment description → The event description should be set to the log message value
[Get Current Status from Canadian Cargo Record]
Building the status segment → The current status is extracted from the Canadian cargo record and added to the search key
[Map Status Code to CSD Status Code]
The lookup return flag equals '0' → The mapped CSD status code from the control table is assigned to the status segment
[Set Broker Name Qualifier to 'XQ']
The broker name qualifier needs to be set → The broker name qualifier should be set to 'XQ' to indicate Canadian broker data
[Extract Broker Name from Canadian Cargo Record]
The broker name is needed for the CSD message → The broker name should be extracted from GCCC-BROKER-NAME field of the Canadian cargo record
[Move Broker Name to Broker Segment]
The CSD broker segment is being populated → The broker name should be moved to the broker name field in the broker segment
[Extract Broker Entry Number from Canadian Cargo Record]
The broker entry number is needed for the CSD message → The broker entry number should be extracted from GCCC-BROKER-ENTRY field of the Canadian cargo record
[Move Broker Entry Number to Broker Segment]
The CSD broker segment is being populated → The broker entry number should be moved to the broker entry field in the broker segment
[Set Bond Destination Qualifier to CD]
Building the bond segment → The bond destination qualifier should be set to 'CD'
[Move Transit Code to Bond Destination Code]
Building the bond segment → The manifest destination transit code should be moved to the bond destination code field
[Move Station Name to Bond Destination Port Name]
Building the bond segment → The manifest destination station name should be moved to the bond destination port name field
[Check US Cargo Bond Type]
The system checks the cargo bond type → If bond type is immediate transport, use M1203 location for processing, otherwise check manifest type for default processing
[Check Manifest Type]
The system checks manifest type indicators → If manifest type is default OR empty equipment OR returned US goods, use RT04 location name for processing, otherwise exit Vista class processing
[More Log Records?]
The system checks for more log records → If more records exist, continue message analysis AND if no more records exist, proceed to entry validation
[Set Cargo Arrival Found Flag - Mark equipment as arrived at location]
The message content is 'CARGO ARRIVAL':
the message contains 'EQUIPMENT' at position 12 for 9 characters AND 'ARRIVED' at position 35 for 7 characters
→ The cargo arrival found flag is set to true
[Extract 1J Entry Information - Get entry number and quantity from message]
The system extracts 1J entry information → The entry number from positions 17-32 is stored as second entry AND the quantity from positions 38-43 is added to total 1J quantity if numeric
[Store as Original Entry - Save first entry number found, Extract Entry Number to Original]
The system processes the 1J entry message → The entry number from positions 17-32 is stored as original entry number
[Set Trucker Bond Proceed Flag - Mark trucker bond as authorized]
The message content is 'US CCN TRUCKER BOND PROCEED' → The trucker bond proceed flag is set to yes
[Set FTZ Authorization Flag - Mark FTZ processing authorized, Process FTZ Authorization Message, Set FTZ Authorization Flag...]
The message content starts with 'USCS DC:BD' → The FTZ authorization flag is set to yes
[Process Canadian Manifest Linking - Create trucker bond proceed messages for Canadian cargo]
The system processes Canadian manifest linking → For each Canadian cargo manifest associated with the waybill, a trucker bond proceed message is created with the US CCN key
[Process Cargo Arrival Event, Found 1J Entry Message?]
The message text starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' at position 12 and 'ARRIVED' at position 35 → The cargo arrival found flag is set to true
[Process 1J Entry Message]
The message is processed for 1J entry information → The entry number from positions 17-32 is stored as second entry number and the quantity from positions 38-43 is added to the total 1J quantity if numeric
[Process 1J Entry Message]
The message is processed for 1J entry information → The entry number from positions 17-32 is stored as the original entry number
[Process Trucker Bond Proceed]
The message text starts with 'US CCN TRUCKER BOND PROCEED' → The trucker bond proceed flag is set to yes
[Process FTZ Authorization, Continue Processing]
The message text starts with 'USCS DC:BD' → The FTZ authorization flag is set to yes
[Continue to Next Message]
More log messages are available for analysis → The system continues to the next log message in the sequence
[Retrieve Customs Log Root Record]
The system attempts to retrieve the customs log root record → The GCSLGRT record should be accessed and the found status should be set based on retrieval success
[More Log Records?]
A dependent record retrieval is attempted → If no more records are found, end processing, otherwise continue to examine the message content
[Is 'CARGO ARRIVAL' Message?]
The system examines the message text in positions 1 through 13 → If the message equals 'CARGO ARRIVAL', set cargo arrival found flag to true
[Is 'EQUIPMENT ARRIVED' Message?]
The system examines positions 12-20 for 'EQUIPMENT' and positions 35-41 for 'ARRIVED' → If both keywords are found in the specified positions, set cargo arrival found flag to true
[Set Cargo Arrival Found Flag]
The arrival event is confirmed → The cargo arrival found flag should be set to true
[Log Arrival Event Details]
The system logs the arrival event details → The system should display the log message, LGRT segment, LGDP segment, date, time, and input message to system error output
[Continue to Next Record]
The system processes the 1J entry message → The entry number from positions 17-32 should be stored as second entry number and the quantity from positions 38-43 should be added to the total 1J quantity if numeric
[Continue to Next Record]
The system processes the 1J entry message → The entry number from positions 17-32 should be stored as the original entry number
[Continue to Next Record]
The message text in positions 1-27 equals 'US CCN TRUCKER BOND PROCEED' → The trucker bond authorization flag should be set to yes
[Continue to Next Record]
The message text in positions 1-10 equals 'USCS DC:BD' → The FTZ authorization flag should be set to yes
[Extract entry number from position 17-32]
The system processes the message content → The entry number is extracted from character positions 17 through 32 of the message
[Extract quantity from position 38-43]
The system continues processing the message content → The quantity value is extracted from character positions 38 through 43 of the message
[Store as second entry number WS-1J-NTRY-SCND or Store as original entry number WS-1J-NTRY-ORIG]
The system determines the cargo arrival status → If cargo arrival has not been found, store as second entry number (WS-1J-NTRY-SCND), otherwise store as original entry number (WS-1J-NTRY-ORIG)
[Set CPR Identifier to '=C=P=R=']
The CPR identifier field needs to be populated → The header CPR ID field should be set to '=C=P=R=' to identify the originating system
[Set Source Application to 'CSTMS']
The source application field needs to be populated → The header source application should be set to 'CSTMS' to identify the customs system as the message originator
[Set Source Application Version to '001.001.01']
The source application version needs to be documented → The header source application version should be set to '001.001.01' to indicate the current customs system version
[Set Destination Application Message Tag to 'CSTMS_CSD_01']
The destination application message tag is being set → The header destination application message tag should be set to 'CSTMS_CSD_01' for proper message routing and identification
[Extract Equipment Initial from US Cargo Record]
Building the equipment segment for US CSD message → The equipment initial should be extracted from GCUSRT-RT081-EQUIP-INIT field
[Extract Equipment Number from US Cargo Record]
Building the equipment segment for US CSD message → The equipment number should be extracted from GCUSRT-RT081-EQUIP-NUM field
[Set Equipment Initial in CSD Equipment Segment]
Building the CSD equipment segment → The equipment initial should be moved to EQP-INIT field of the equipment segment
[Set Equipment Number in CSD Equipment Segment]
Building the CSD equipment segment → The equipment number should be moved to EQP-NUM field of the equipment segment
[Shiproot Data Available?]
The system checks for available data sources → If Shiproot data is found, use Shiproot as primary source, otherwise use Waybill Inquiry database as fallback source
[Build Waybill from Shiproot Data]
Building the waybill segment for US CSD message → Use Shiproot data as the primary source for waybill information including dates, times, and shipment indicators
[Build Waybill from Inquiry Database]
Building the waybill segment for US CSD message → Use Waybill Inquiry database as the source for waybill information
[TOFC/COFC Indicator Present?]
The TOFC/COFC indicator equals 'C' or 'T' and Bill of Lading date is not spaces, low-values, or zeroes → Use Bill of Lading date and time for waybill segment, otherwise use standard waybill date and time
[Use Bill of Lading Date/Time]
Setting waybill date and time → Extract date from positions 2-6 of Bill of Lading date and use Bill of Lading time for waybill segment
[Use Standard Waybill Date/Time]
Setting waybill date and time → Use waybill date and time from Shiproot for waybill segment
[Set TOFC/COFC Indicator]
Setting transportation mode indicator → Copy TOFC/COFC indicator from Shiproot or Inquiry data to waybill segment
[Set Origin Station Number]
Setting origin station data → Copy origin station number from Shiproot or Inquiry data to waybill segment
[Set Original Waybill Information]
Setting original waybill information → Copy original waybill road, station, and number from Shiproot or original key from Inquiry data to waybill segment
[Extract Base Unit Number]
For Canadian cargo, if equipment number position 2 is not zero, extract positions 2-6 as base unit and position 7 as check digit, otherwise extract positions 3-6 as base unit; for US cargo, apply same logic to US equipment number → Set base unit number in waybill segment after removing leading zeros and adjusting position pointer
[Set Equipment Check Digit]
Check digit was extracted during base unit processing or exists in Shiproot → Use extracted check digit if available, otherwise use equipment check digit from Shiproot data
[Set Manifest CCN Qualifier to CUB]
The CCN qualifier needs to be set → The manifest CCN qualifier should be set to CUB
[Complete Manifest Segment]
The manifest completion date processing is evaluated → No completion date or time should be set and processing should continue to completion
[Move Location ID to Entry Port Code]
Building the entry port segment → The P401 location ID should be copied to the entry port code field as a 9-digit numeric value
[Entry Port Segment Complete]
The entry port qualifier, code, and name have been successfully populated → The entry port segment should be marked as complete and ready for inclusion in the CSD message
[Exit - Entry Port Segment Empty]
The location ID validation fails → The entry port building process should exit without populating any entry port fields, leaving the segment initialized to spaces
[Extract Quantity from US Manifest Record GCSUSRT]
Building the quantity segment for CSD message → The M1103 quantity field should be moved to the quantity segment piece count
[Get Unit Code from US Manifest Detail GCSUSS07]
Building the quantity segment for CSD message → The N1010 manifest unit code should be moved to the quantity piece count qualifier
[Check if Released Quantity is Spaces or Zeroes]
Processing quantity data for CSD message → If the released quantity is spaces or zeroes, skip released quantity processing, otherwise process the released quantity value
[Set Released Piece Count in Quantity Segment]
Building the quantity segment for CSD message → The RT31 released quantity should be moved to the quantity segment released piece count field
[Extract CP Cargo Status from GCSUSRT]
Building the status segment for CSD message → The first 7 characters of the CP cargo status description are extracted for status lookup
[Map to CSD Status Code]
The lookup return flag equals '0' → The CSD status code from control table is assigned to the CPRS status code field in status segment
[Set Default Status 'OT']
The lookup return flag != '0' → The default status code 'OT' is assigned to the CPRS status code field in status segment
[Extract US Cargo Status from GCSUSRT]
Building the second status mapping for CSD message → The US cargo short description is extracted for status lookup
[Map to CSD Status Code]
The lookup return flag equals '0' → The CSD status code from control table is assigned to the USCS status code field in status segment
[Set Default Status 'OT']
The lookup return flag != '0' → The default status code 'OT' is assigned to the USCS status code field in status segment
[Set Broker Name Qualifier to 'XU']
The broker name qualifier is being set → The broker name qualifier should be set to 'XU'
[Move Broker Short Name to Broker Segment]
The broker segment is being populated → The broker short name should be moved to the broker name field in the broker segment
[Move Broker Entry Number to Broker Segment]
The broker segment is being populated → The broker entry number should be moved to the broker entry field in the broker segment
[Is Border Crossing?]
The manifest movement type indicates a border crossing (M1201 field equals border value) → Bond processing is skipped and the system exits bond segment building
[Set Bond Type IT - Immediate Transport]
The manifest movement code indicates immediate transport (M1201 field equals immediate transport value) → The bond type is set to IT (Immediate Transport)
[Set Bond Type TE - Transport Export]
The manifest movement code indicates transport export (M1201 field equals transport export value) → The bond type is set to TE (Transport Export)
[Set Bond Type IE - Immediate Export]
The manifest movement code indicates immediate export (M1201 field equals immediate export value) → The bond type is set to IE (Immediate Export)
[Set Bond Type TR - In Transit]
The manifest movement code indicates in-transit (M1201 field equals in-transit value) → The bond type is set to TR (In Transit)
[Set Bond Type MT - Multi Transit]
The manifest movement code indicates multi-transit (M1201 field equals multi-transit value) → The bond type is set to MT (Multi Transit)
[Set Bond Entry Number from Manifest]
Bond segment building continues → The bond entry number is set from the manifest M1202 entry number field
[Set Foreign Destination Port and Code]
The second location ID (M1204 field) is available and numeric AND the bond type is transport export or immediate export → The foreign destination qualifier is set to K, foreign destination code is set from the second location ID, and foreign destination port name is set from the second location name
[Set In-Bond Control Number]
Bond segment building continues → The in-bond control number is set from the manifest M1206 in-bond control number field
[Set Despacho Hold Indicator from US Cargo]
Building the Mexico manifest segment → The despacho hold indicator from the US cargo record is copied to the Mexico manifest segment
[Set Despacho Hold SCAC Code]
Building the Mexico manifest segment → The despacho hold SCAC code from the US cargo record is copied to the Mexico manifest segment
[Set Despacho Hold FSAC Code]
Building the Mexico manifest segment → The despacho hold FSAC code from the US cargo record is copied to the Mexico manifest segment
[Extract Pedimento Receive Timestamp]
Building the Mexico manifest segment → The pedimento receive timestamp is copied from the US cargo record to the Mexico manifest segment
[Set Timezone to CST if Timestamp Present]
Processing the Mexico manifest segment → The pedimento date timezone is set to 'CST'
[Loop Through N9 Data Segments]
Building the Mexico manifest segment → Loop through each N9 data segment until maximum occurrences reached or empty segment found
[Extract Pedimento Number]
Processing N9 segments for Mexico manifest → The reference number is copied to the Mexico manifest pedimento field and the pedimento qualifier code is set to true
[Extract CCN Number]
Processing N9 segments for Mexico manifest → The reference number is copied to the Mexico manifest CCN field and the CCN qualifier code is set to true
[More N9 Segments?]
Checking for continuation of N9 segment processing → Continue processing if loop counter is within maximum occurrences and current N9 data is not spaces or low-values
[Set Despacho Hold Indicator from US Cargo Record]
The system processes despacho hold information → The despacho hold indicator is copied from the US cargo record to the Mexico manifest segment
[Set Despacho Hold SCAC Code]
The system processes despacho hold SCAC information → The despacho hold SCAC code is copied from the US cargo record to the Mexico manifest segment
[Set Despacho Hold FSAC Code]
The system processes despacho hold FSAC information → The despacho hold FSAC code is copied from the US cargo record to the Mexico manifest segment
[Set Pedimento Received Timestamp]
The system processes pedimento timestamp information → The pedimento received timestamp is copied from the US cargo record to the Mexico manifest segment
[Set Timezone to CST]
The system processes the pedimento timestamp → The pedimento date timezone is set to 'CST'
[More N9 Segments to Process?]
The system processes N9 segments sequentially → Processing continues until all segments are processed or maximum occurrences reached or empty segment found
[Qualifier is FEN?]
If the reference number qualifier → If qualifier equals 'FEN' and reference number is not spaces or low-values, process as pedimento number
[Extract Pedimento Number]
The system processes the FEN reference → The reference number is copied to the Mexico manifest pedimento field
[Set Pedimento Qualifier Code]
The system sets the pedimento qualifier → The pedimento qualifier code indicator is set to true in the Mexico manifest segment
[Qualifier is KCM?]
If the reference number qualifier → If qualifier equals 'KCM' and reference number is not spaces or low-values, process as CCN number
[Extract CCN Number]
The system processes the KCM reference → The reference number is copied to the Mexico manifest CCN field
[Set CCN Qualifier Code]
The system sets the CCN qualifier → The CCN qualifier code indicator is set to true in the Mexico manifest segment
[Loop Through N9 Data Segments]
The system processes each N9 segment sequentially using a loop counter from 1 to maximum occurrences → Each N9 segment is examined until all segments are processed or an empty segment is encountered
[Qualifier = 'FEN'?]
The reference number qualifier equals 'FEN' and the reference number is not spaces or low-values → The segment is identified as containing a Pedimento number for extraction
[Extract Pedimento Number]
The Pedimento number is extracted from the N9 reference number field → The Pedimento number is stored in the Mexico manifest Pedimento field and the Pedimento qualifier code is set to true
[Qualifier = 'KCM'?]
The reference number qualifier equals 'KCM' and the reference number is not spaces or low-values → The segment is identified as containing a CCN number for extraction
[Extract CCN Number]
The CCN number is extracted from the N9 reference number field → The CCN number is stored in the Mexico manifest CCN field and the CCN qualifier code is set to true
[Use Control Table SCAC/FSAC Codes]
Both SCAC and FSAC codes are found in the port configuration table → The retrieved Vista class SCAC and FSAC codes are assigned to the border hold segment
[Move Export Control Tag to Broker Name Key]
Setting up the database lookup key → The system should move the export control tag (WS-EXP-CTL-TAG) to both the broker name long key and broker name key index fields
[Use Control Table SCAC Code]
Both the retrieved SCAC code and FSAC code are not empty → The system should use the SCAC code and FSAC code from the control table for the CBP border hold segment
[Move CSD Message to EET3211 Message Structure]
The system prepares for message transmission → The system moves the complete CSD message to the EET3211 message structure
[Set Accept Status for Message Processing]
The system prepares the message queue → The system sets the accept status to blank spaces to enable message processing
[Call CIMS to Change Message Queue Status]
The system initiates queue status change → The system calls CIMS service with CHNG function, alternate PCB, and EET3211 message structure to change the message queue status
[Call WRITMSGL to Write Message to EET3211 Transaction Queue]
The system transmits the CSD message → The system calls WRITMSGL service with alternate PCB, EET3211 message code, message content, message length, and module name to write the message to the EET3211 transaction queue
[Call CIMS to Purge Message Queue]
The system completes message transmission → The system calls CIMS service with PURG function and alternate PCB to purge the message queue
[Extract bill of lading date and time from SHIPROOT]
The system processes waybill segment building → Bill of lading date-time is extracted and stored in working storage variable WS-BL-DTTM
[Set TOFC/COFC indicator in waybill segment]
The system builds the waybill segment → The TOFC/COFC indicator from SHIPROOT is copied to the waybill segment TOFC/COFC indicator field
[Set multi-shipment indicator from SHIPROOT]
The system builds the waybill segment → The multi-shipment indicator from SHIPROOT is copied to the waybill segment multi-shipment indicator field
[Set multi-shipment indicator to 'I' for idler]
The system processes multi-shipment indicator logic → The waybill segment multi-shipment indicator is set to 'I' regardless of the original SHIPROOT multi-shipment indicator value
[Set lead equipment ID from car ID]
The system processes equipment identification → The lead equipment ID in waybill segment is set to the car ID from SHIPROOT
[Set originating station number]
The system builds the waybill segment → The originating station number from SHIPROOT is copied to the waybill segment originating station number field
[Set original waybill road, station, and number]
The system builds the waybill segment → Original waybill road, station, and number from SHIPROOT are copied to corresponding waybill segment fields
[Complete waybill segment building]
The system formats the base unit number for waybill segment → Leading zeros are replaced with spaces, remaining digits are positioned correctly, and formatted base unit number is assigned to waybill segment
[Set Lead Equipment ID from Car ID]
The multi-ship indicator is 'M' (Multi-ship):
'I' (Idler)
→ Set the lead equipment ID to the car ID from the shiproot record
[Cargo Type?]
If the cargo type from LGRT segment → The system routes to Canadian cargo processing if LGRT-TYPE-CA-CARGO is true, otherwise routes to US cargo processing if LGRT-TYPE-US-CARGO is true
[Store Base Unit Number and Check Digit in WB2 Segment]
The system finalizes the WB2 segment data → Move the processed base unit number to WB2-BASE-UNIT-NBR and move the final check digit to WB2-EQUIP-CHECK-DIGIT
[Extract waybill date and time from FWIQROOT]
The system processes waybill segment building from inquiry → The waybill date (WB-DTE) is extracted from FWIQROOT and converted to working storage format (WS-WB-DTTM)
[Convert date/time format and populate WB-DT and WB-TM]
The system converts the date and time for waybill segment population → The date portion (WS-WB-DT) is moved to WB-DT of waybill segment and time portion (WS-WB-TM) is moved to WB-TM of waybill segment
[Set TOFC/COFC indicator from inquiry root]
The system builds waybill segment from inquiry data → The TOFC-COFC-IND from FWIQROOT is moved to WB-TOFC-COFC-IND of the waybill segment
[Set shiproot key from inquiry with sequence '01']
The system builds waybill segment from inquiry → The SHI-INQ from FWIQROOT is moved to WB-SHIPROOT-KEY and positions 16-17 of WB-SHIPROOT-KEY are set to '01'
[Clear FWEX equipment waybill key]
The system processes equipment waybill key information → The WB-FWEX-EQP-WB-KEY of the waybill segment is set to zeroes
[Set origin station number from inquiry root]
The system builds waybill segment from inquiry data → The ORIG-STN-NUM from FWIQROOT is moved to WB-ORIG-STN-NUM-9 of the waybill segment
[Set original waybill key from inquiry info]
The system builds waybill segment from inquiry data → The ORIGINAL-KEY from FWIQINFO is moved to WB-ORIGINAL-WB-KEY of the waybill segment
[Cargo Type Check]
The system processes equipment number for waybill segment building → If cargo type is Canadian (LGRT-TYPE-CA-CARGO), process Canadian equipment car number, else if cargo type is US (LGRT-TYPE-US-CARGO), process US equipment car number
[Set equipment check digit from inquiry root]
The system completes waybill segment building from inquiry → The EQUIP-NO-CHECK from FWIQROOT is moved to WB2-EQUIP-CHECK-DIGIT of the waybill segment
[Set Customs Event ID from Log Dependent Key]
Creating an event segment → The customs event ID should be set to the log dependent key value
[Calculate Complement of Log Dependent Key]
Processing the event timestamp → The system should subtract the LGDP key from nines complement to get the proper key value
[Set Event Posted Date Starting at Position 3]
Setting the event posted date → The posted date should be set from the load date starting at position 3 for 6 characters
[Set Event Posted Time Positions 1-6]
Setting the event posted time → The posted time should be set from positions 1 to 6 of the load time
[Set User ID from ACF2 User Code]
Setting the event user ID → The user ID should be set from the ACF2 user code field
[Set Event Description from Log Message]
Setting the event description → The event description should be set from the log message field
[US Bond Indicator Setting - Set bond indicators for export manifests]
US bond indicator determination is performed → If transport type is train or vessel name is spaces or cargo status is RELEASE or EXPORT or PTT, then exit; if bond movement type is immediate export or transport export, then set shipment bond indicator to Yes
[US Clearance Location Determination - Determine clearance location with trucker bond and FTZ authorization]
Trucker bond processing is performed → Scan log entries; if message is CARGO ARRIVAL or EQUIPMENT ARRIVED, mark cargo arrival found; if message is USCS DC:1J NTRY and cargo arrival not found, store second entry number and add quantity; if message is USCS DC:1J NTRY and cargo arrival found, store original entry number; if message is US CCN TRUCKER BOND PROCEED, mark trucker bond authorized; if message is USCS DC:BD, mark FTZ authorized
[Mexico Manifest Building - Build Mexico manifest segment for Laredo TX operations]
Mexico manifest processing is performed → Build Mexico manifest segment with dispatch hold indicator, SCAC, FSAC, pedimento receive timestamp with CST timezone, and reference numbers for FEN (pedimento) and KCM (CCN) qualifiers
[Call Database to Get First Canadian Cargo Record]
The database search is executed → The system calls the Canadian cargo database interface to retrieve the first matching record and sets the database status
[Process US Bond Requirements]
The system processes US bond requirements → The system checks if the cargo is train-based OR has no vessel name OR has RELEASE status OR has EXPORT status OR has PTT status, and if none of these conditions are met AND the cargo has immediate export OR transport export bond type, then the bond indicator is set to Y
[Process US Vista Class Clearance]
If Vista class clearance needs → If the cargo status is not RELEASE OR PTT OR PTT-EX, then the system determines the port name based on immediate transport (using destination location) or default/empty equipment/returned goods (using origin location), looks up Vista class settings, and if clearance is required based on intermodal/carload rules, sets the clearance location SCAC and FSAC codes
[Handle Mexico Manifest Data for Laredo TX]
The system handles Mexico manifest data → If the origin location ID OR the destination location ID equals the Laredo TX station code, then retrieve the USS02 segment data, build the Mexico manifest segment, and if the origin is Laredo TX, also build the CBP border hold segment
[Retrieve GCSUSS02 Mexico Manifest Data]
The system attempts to retrieve GCSUSS02 segment with record type '02' and sequence '0001' → Mexico manifest data should be loaded if the segment exists in the database
[Set Despacho Hold Indicators]
The system processes despacho hold information from the US cargo record → The despacho hold indicator, SCAC code, and FSAC code should be populated in the Mexico manifest segment
[Set Pedimento Received Timestamp]
The pedimento received timestamp is not spaces or low-values → The timestamp should be copied to the Mexico manifest segment and timezone should be set to 'CST'
[Loop Through N9 Data Segments]
The system processes each N9 data segment sequentially until maximum occurrences reached or empty segment found → All valid reference numbers with FEN or KCM qualifiers should be extracted and processed
[Start N9 Data Loop Processing]
The N9 data loop processing begins → The loop counter WS-IDX is initialized to 1 to start from the first segment
[Extract Pedimento Number]
The FEN qualifier is processed → The reference number is moved to MXMFST-PEDIMENTO and the pedimento qualifier is set to CD
[Extract CCN Number]
The KCM qualifier is processed → The reference number is moved to MXMFST-CCN and the CCN qualifier is set to CD
[Increment Loop Counter]
Moving to the next segment → The loop counter WS-IDX is incremented by 1
[Loop through GCSUSS02 N9 data segments]
System loops through each N9 data segment occurrence from 1 to maximum allowed occurrences → System processes each non-empty N9 data segment for further validation
[Qualifier = 'FEN'?]
Reference number qualifier equals 'FEN' → System proceeds to validate the associated reference number value for Pedimento extraction
[Extract Pedimento value from reference number]
System extracts the reference number value → System moves the reference number to Pedimento field and sets Pedimento qualifier to 'CD'
[Check reference number qualifier]
Reference number qualifier equals 'KCM' → System proceeds to validate the associated reference number value for CCN extraction
[Extract Pedimento value from reference number]
System extracts the reference number value → System moves the reference number to CCN field and sets CCN qualifier to 'CD'
[Set CCN Qualifier to CD]
Moving the CCN to the Mexico manifest segment → Set the CCN qualifier field to 'CD' to indicate the CCN source type
[Determine Port Based on Bond Type]
Bond type is evaluated for port determination → If bond type is immediate transport, use destination location name; if default, empty equipment, or returned US goods, use origin location name; otherwise exit Vista class check
[TOFC/COFC Equipment]
Equipment type is evaluated from waybill segment → If equipment type is 'C' (COFC) or 'T' (TOFC), check intermodal clearance requirements, otherwise check carload clearance requirements
[Set Clearance Location Required with SCAC/FSAC]
Clearance location information is set → Set clearance location required flag to true and assign SCAC and FSAC codes from Vista class control table to shipment segment
[Process Cargo Arrival Event, Set Cargo Arrival Found Flag, Message Type?]
The message content starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' at position 12 and 'ARRIVED' at position 35 → The cargo arrival found flag is set to true
[Process 1J Entry Validation]
The message content starts with 'USCS DC:1J NTRY:' and cargo arrival has not been found → The 1J entry number is extracted from position 17-32, quantity is extracted from position 38-43, and if quantity is numeric it is added to the total 1J quantity
[Process 1J Entry Validation]
The message content starts with 'USCS DC:1J NTRY:' → The original 1J entry number is extracted from position 17-32
[Process Trucker Bond Proceed Message, US CCN TRUCKER BOND PROCEED, Trucker Bond Proceed Message?]
The message content starts with 'US CCN TRUCKER BOND PROCEED' → The trucker bond authorization flag is set to yes
[Continue to Next Record]
The current message analysis is complete → The system retrieves the next log dependent record using GNP function
[Extract Entry Number to Secondary Field]
The system processes the 1J entry message → The entry number from positions 17-32 is moved to the secondary entry number field
[Add Quantity to Running Total]
The quantity field is numeric → The quantity value is added to the running total counter
[Extract Entry Number to Original Field]
The system processes the 1J entry message → The entry number from positions 17-32 is moved to the original entry number field
[Set Trucker Bond Proceed Flag]
The message content starts with 'US CCN TRUCKER BOND PROCEED' → The trucker bond proceed flag is set to yes
[Continue to Next Message]
The message type evaluation is complete → Processing continues to the next available log message without setting any flags
[Get Next Log Dependent Record]
The system retrieves the next dependent log record → The next GCSLGDP record is accessed for message content analysis
[Message = 'CARGO ARRIVAL'?]
The message content is examined for cargo arrival indicators → Cargo arrival is identified if message starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' and 'ARRIVED' pattern
[Message = 'EQUIPMENT ARRIVED'?]
The message content is examined for equipment arrival indicators → Equipment arrival is identified if message contains 'EQUIPMENT' at position 12 and 'ARRIVED' at position 35
[Set Cargo Arrival Found Flag]
The system processes the arrival event → The cargo arrival found indicator is set to true to track successful detection
[Display Arrival Event Details]
The system processes the arrival event details → System displays message content, manifest segments, date, time, and input message details to system error output
[Continue to Next Record]
The message starts with 'USCS DC:1J NTRY:' and cargo arrival has not been found → The system extracts the 16-character entry number as second entry, extracts 6-digit quantity, converts quantity to numeric if valid, and accumulates total quantity
[Continue to Next Record]
The message starts with 'USCS DC:1J NTRY:' → The system extracts the 16-character entry number as the original entry for later comparison
[Continue to Next Record]
The message content equals 'US CCN TRUCKER BOND PROCEED' → The trucker bond authorization flag is set to yes
[Continue to Next Record, Parse Log Message Content]
The message starts with 'USCS DC:BD' → The FTZ authorization flag is set to yes
[Check if Message Contains '1J NTRY:']
The message contains the text 'USCS DC:1J NTRY:' starting at position 1 → The system initiates 1J entry processing workflow
[Cargo Arrival Found?]
The cargo arrival status flag indicates no previous arrival record exists → The system processes the entry number as a secondary entry and accumulates quantities
[Extract Entry Number to Secondary Field]
The message contains 'USCS DC:1J NTRY:' at position 1 → The system extracts characters 17-32 as the secondary entry number
[Store Entry Number as Original Entry]
The message contains 'USCS DC:1J NTRY:' at position 1 → The system extracts characters 17-32 as the original entry number
[Add Quantity to Running Total]
The quantity passes numeric validation checks → The system adds the quantity to the existing running total for comparison against manifest quantities
[Check US Bond Requirements]
The cargo is not train transport AND has vessel name AND status is not RELEASE/EXPORT/PTT AND bond type is immediate export or transport export → The shipment bond indicator is set to required
[Check US Vista Class Clearance]
The cargo is immediate transport with destination location:
default/empty equipment/returned US goods with origin location AND cargo arrival conditions are not met AND trucker bond is not authorized
→ Vista class clearance requirements are evaluated and clearance location SCAC/FSAC codes are set if required
[Retrieve Mexico Manifest Data GCSUSS02]
The system needs Mexico manifest data → GCSUSS02 segment is retrieved using US CCN key with record type '02' and sequence '0001'
[Build Mexico Manifest Segment]
The system processes Mexico manifest information → Mexico manifest segment is built with dispatch hold indicators, pedimento receive timestamp, pedimento number with qualifier 'FEN', and CCN with qualifier 'KCM'
[Entry Port is Laredo TX?]
The entry port location ID equals Laredo TX station code → CBP border hold segment processing is initiated
[Build CBP Border Hold Segment]
The cargo status is HOLD-BORDER, HOLDFDA, or PROCEED-HOLD-BORDER AND export control validation passes → CBP border hold segment is built with hold indicator, status code, and SCAC/FSAC codes from location lookup
[Process Mexico Manifest for Laredo TX]
The system processes the US manifest → Mexico manifest segment (USS02) is retrieved and Mexico manifest data is built, and CBP border hold processing is performed for P401 Laredo location
[Is manifest type Immediate Export?]
The manifest type is immediate export (M1201 field indicates immediate export) → The shipment bond indicator is set to Yes
[Is manifest type Transport Export?]
The manifest type is transport export (M1201 field indicates transport export) → The shipment bond indicator is set to Yes
[Is cargo Immediate Transport?]
The cargo bond type is Immediate Transport and the destination location name exists → The system sets the port to the destination location name for Vista Class lookup
[Is cargo Default, Empty Equipment, or Returned US Goods?]
The cargo manifest type is Default or Empty Equipment or Returned US Goods → The system sets the port to the entry location name for Vista Class processing
[Process Canadian Manifest linking]
Trucker bond authorization is confirmed → The system spawns GCT1051E messages linking US CCN to Canadian manifests with 'US CCN TRUCKER BOND PROCEED' message
[More Log Records?]
The system checks the database response → If no more records exist, proceed to final validation; if records exist, continue message analysis
[CARGO ARRIVAL or EQUIPMENT ARRIVED]
The message content starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' and 'ARRIVED' → The cargo arrival found flag is set to true
[Extract 1J Entry Number and Quantity]
The system processes the message content → The entry number is extracted from positions 17-32 and quantity from positions 38-43 of the message
[Add Quantity to Running Total]
The system processes the quantity → The quantity value is added to the cumulative 1J quantity total
[Process Canadian Manifest Linking]
The system processes Canadian manifest linking → For each Canadian cargo record matching the waybill, a trucker bond proceed message is generated and sent to the message queue
[Set FTZ Authorization Flag]
If processing conditions → If FTZ authorization flag is yes, trucker bond processing is terminated without further validation
[Process Cargo Arrival Event]
The message text starts with 'CARGO ARRIVAL':
the message contains 'EQUIPMENT' at position 12 and 'ARRIVED' at position 35
→ Set cargo arrival found flag to true
[Process Trucker Bond Proceed]
The message text equals 'US CCN TRUCKER BOND PROCEED' → Set trucker bond proceed flag to yes
[Process FTZ Authorization]
The message text starts with 'USCS DC:BD' → Set FTZ authorization flag to yes
[Continue to Next Message]
Message analysis is complete for current message → Move to next log message using GNP function call
[Get Next Log Dependent Record]
The system retrieves the next dependent log record using GNP function → The next LGDP segment is accessed and the found status is updated based on retrieval success
[More Log Records?]
The system checks if more log records are available → If no more records exist, processing ends; if records exist, message type checking continues
[Is Cargo Arrival Message?]
The system examines the message text → If the message starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' and 'ARRIVED' at specific positions, it is identified as a cargo arrival message
[Set Cargo Arrival Found Status]
The system processes the cargo arrival message → The cargo arrival found status is set to true
[Log Arrival Event Details]
The system logs the arrival event details → System date, time, message content, and related segment information are displayed to system error output
[Continue to Next Record]
The system processes the 1J entry message → If no cargo arrival was found, the entry number is stored as second entry and quantity is accumulated; if cargo arrival was found, the entry number is stored as original entry
[Continue to Next Record]
The system examines the message content → If the message starts with 'US CCN TRUCKER BOND PROCEED', the trucker bond authorization status is set to yes
[Continue to Next Record]
The system examines the message content → If the message starts with 'USCS DC:BD', the FTZ authorization status is set to yes
[Store as Second Entry Number / Store as Original Entry Number]
The system determines storage location based on cargo arrival status → If cargo arrival not found, store as second entry number; if cargo arrival found, store as original entry number
[Is manifest type Immediate Export?]
The manifest type is Immediate Export → The bond indicator should be set to YES to indicate bond processing is required
[Is manifest type Transport Export?]
The manifest type is Transport Export → The bond indicator should be set to YES to indicate bond processing is required
[Check Bond Type]
The bond type is Immediate Transport → The system should use the entry location name as the port search key
[Process Trucker Bond Authorization]
The system processes trucker bonds by scanning cargo log entries → The system should check for cargo arrival events, 1J entry numbers, trucker bond proceed messages, and FTZ authorization codes in the log data
[Process Canadian Manifest Linking]
The cargo type is US cargo with valid trucker bond authorization → The system should retrieve all Canadian cargo manifests for the same waybill and spawn GCT1051E messages with trucker bond proceed notifications
[Retrieve Customs Log Root Record]
The system attempts to retrieve the customs log root record → The GCSLGRT record is retrieved and availability status is determined
[Cargo Arrival Message?]
The message content starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' and 'ARRIVED' at specific positions → The cargo arrival found flag is set to true
[Store Second Entry Number]
The system processes the 1J entry message → The entry number is stored as second entry number and the quantity is added to the running total if numeric
[Store Original Entry Number]
The system processes the 1J entry message → The entry number is stored as the original entry number
[More Log Records?]
A log dependent record retrieval is attempted → If no more GCSLGDP records are found, analysis is complete; if records exist, message parsing continues
[Parse Log Message Content]
The message text is 'CARGO ARRIVAL' → The cargo arrival found flag is set to true
[Parse Log Message Content]
The message contains 'EQUIPMENT' at position 12-20 and 'ARRIVED' at position 35-41 → The cargo arrival found flag is set to true
[Parse Log Message Content]
The message starts with 'USCS DC:1J NTRY:' and cargo arrival has not been found → The second 1J entry number is extracted from positions 17-32, quantity is extracted from positions 38-43, and if quantity is numeric it is added to the total 1J quantity
[Parse Log Message Content]
The message starts with 'USCS DC:1J NTRY:' → The original 1J entry number is extracted from positions 17-32
[Parse Log Message Content]
The message is 'US CCN TRUCKER BOND PROCEED' → The trucker bond status flag is set to yes
[Extract Entry Number from Message Position 17-32]
The message contains entry information at positions 17-32 → The entry number is extracted and stored as either the second entry number if cargo arrival not found or as the original entry number if cargo arrival already found
[Store as Second Entry Number / Store as Original Entry Number]
The cargo arrival status is evaluated → If cargo arrival has not been found, store as second entry number, otherwise if cargo arrival has been found, store as original entry number
[Scan Customs Log Messages]
Processing customs log messages using get-next-position function → Continue scanning through all available log messages until no more messages are found
[Found 1J Entry Message?]
The message content starts with 'USCS DC:1J NTRY:' in the first 16 characters → Identify this as a 1J entry message and proceed to extract entry details
[Extract Entry Number from Message]
Cargo arrival has not been found and the message contains 1J entry data → Extract characters 17-32 from the message as the second entry number, otherwise extract as the original entry number if cargo arrival was already found
[Extract Quantity from Message]
The message contains quantity information in positions 38-43 → Extract the 6-character quantity value from the message for numeric validation
[Accumulate Entry Quantity]
The quantity passes numeric validation → Add the quantity value to the accumulated 1J quantity total
[Retrieve Customs Log Root Record]
The system attempts to retrieve the customs log root record → The GCSLGRT record is accessed using the current segment key
[Set Cargo Arrival Found Flag]
The message content is 'CARGO ARRIVAL' or contains 'EQUIPMENT' and 'ARRIVED' → The cargo arrival found flag is set to true
[Extract 1J Entry Number - Second Occurrence]
The system processes the message → The entry number from positions 17-32 is extracted and stored as the second entry number, and the quantity from positions 38-43 is accumulated
[Store 1J Entry Number - Original Occurrence]
The system processes the message → The entry number from positions 17-32 is extracted and stored as the original entry number
[Continue to Next Record]
The message content is 'US CCN TRUCKER BOND PROCEED' → The trucker bond authorization flag is set to yes
[Store as Original Entry Number]
Cargo arrival status indicates arrival has been found → The entry number is stored as the original entry number
[Store as Second Entry Number]
Cargo arrival status indicates arrival has not been found → The entry number is stored as the second entry number
[Process Customs Log Messages]
The system processes each customs log message in sequence → Each message is evaluated for cargo arrival events, 1J entry numbers, trucker bond authorizations, and FTZ authorizations
[Cargo Arrival Found?]
The system checks if cargo arrival has been found in previous messages → If cargo arrival was not found, the entry number is stored as second entry number, otherwise it is stored as original entry number
[Store as Second Entry Number]
The entry number is extracted from message positions 17 to 32 → The extracted entry number is stored as the second entry number for comparison
[Extract Quantity from Message]
The quantity field is numeric → The quantity value is added to the running total quantity counter
[Store as Original Entry Number]
The entry number is extracted from message positions 17 to 32 → The extracted entry number is stored as the original entry number for comparison
[Compare Entry Numbers and Quantities]
The system performs final validation of entry numbers and quantities → Authorization is granted if original entry number is different from second entry number and accumulated quantity is greater than or equal to the manifest quantity
[Set Clearance Location Required Flag]
The system updates clearance location settings → The clearance location required flag is set to true in the shipment segment
[Assign SCAC and FSAC to Clearance Location]
The system configures clearance location details → The SCAC and FSAC codes are assigned to the clearance location SCAC and FSAC fields in the shipment segment
[Extract Entry Number to Secondary]
The system processes the 1J entry message → The entry number from positions 17-32 is stored as secondary entry number and the quantity from positions 38-43 is added to the total if numeric
[FTZ Authorization Found?]
FTZ authorization flag is set to yes → Processing terminates without further trucker bond actions
[Process Canadian Manifest Links]
The system processes Canadian manifest links → All Canadian cargo manifests matching the waybill key are identified for trucker bond message creation
[Create Trucker Bond Log Messages]
The system creates trucker bond log messages → A log message is created with action code 'ZZZ', Canadian cargo flag set, and message text containing 'US CCN TRUCKER BOND PROCEED:' followed by the US CCN key
[Spawn GCT1051E Transaction]
The system spawns the GCT1051E transaction → The message is submitted to the alternate PCB queue for processing with proper message formatting and length calculation
[Read Next Log Message from GCSLGDP]
The next message needs to be retrieved → The system calls the database to get the next GCSLGDP log message and updates the message availability status
[More Messages Available?]
The database status is evaluated → If status indicates not found, message processing is complete, otherwise continue with message analysis
[Parse Message Content]
The message content is analyzed → The message text is examined to identify the message type and extract relevant business data
[Message Type?]
The message text is evaluated against known patterns → The message is classified as cargo arrival, equipment arrival, entry processing, trucker bond, FTZ authorization, or other type based on specific text content
[Process CARGO ARRIVAL Message]
The message is processed → The cargo arrival event is recorded and the cargo arrival found flag is set to true
[Process EQUIPMENT ARRIVED Message]
The message is processed → The equipment arrival event is recorded and the equipment arrival found flag is set to true
[Process USCS DC:1J NTRY Message]
The message is processed → Entry number and quantity information is extracted from specific positions in the message text
[Extract Entry Number and Quantity]
Entry data extraction occurs → Entry number is extracted from positions 17-32 and quantity is extracted from positions 38-43 of the message text
[Accumulate Entry Quantities]
Quantity accumulation occurs → The extracted quantity is added to the running total quantity counter
[Process US CCN TRUCKER BOND PROCEED Message]
The message is processed → The trucker bond proceed event is recorded and the trucker bond proceed flag is set to true
[Set Trucker Bond Proceed Flag]
The trucker bond processing is completed → The trucker bond proceed indicator is set to true to track this authorization event
[Process USCS DC:BD Message]
The message is processed → The FTZ authorization event is recorded and the FTZ authorization flag is set to true
[Set FTZ Authorization Flag]
The FTZ authorization processing is completed → The FTZ authorization indicator is set to true to track this authorization event
[Process Other Message Types]
The message is processed → The message is acknowledged but no specific processing action is taken
[Continue to Next Message]
Message processing continues → The system moves to read and process the next log message in the database
[Complete Message Analysis]
Message analysis completion occurs → All message analysis flags and counters are finalized and ready for business decision processing
[Cargo Arrival Event - CARGO ARRIVAL or EQUIPMENT ARRIVED]
The message content starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' at position 12 and 'ARRIVED' at position 35 → Set cargo arrival found flag to true and continue processing
[Entry Processing Event - USCS DC:1J NTRY]
The message content starts with 'USCS DC:1J NTRY:' and cargo arrival has not been found → Extract entry number from positions 17-32 as second entry number and extract quantity from positions 38-43, adding to total quantity if numeric
[Entry Processing Event - USCS DC:1J NTRY]
The message content starts with 'USCS DC:1J NTRY:' → Extract entry number from positions 17-32 as original entry number
[Bond Processing Event - US CCN TRUCKER BOND PROCEED]
The message content equals 'US CCN TRUCKER BOND PROCEED' → Set trucker bond proceed flag to true
[Authorization Event - USCS DC:BD]
The message content starts with 'USCS DC:BD' → Set FTZ authorization flag to true
[Other Message Types]
The message content does not match cargo arrival, entry processing, bond processing, or authorization patterns → Continue to next message without setting any specific flags
[Start Message Parsing]
The system begins parsing log messages → Set cargo arrival not found, trucker bond to no, FTZ authorization to no, clear entry numbers, and set quantity to zero
[Get Next Log Message]
The system needs to continue parsing additional messages → Retrieve the next log dependent message using get next position function
[Extract Entry Number from Position 17-32]
The system processes the message to extract entry information → The entry number is extracted from positions 17-32 of the message and stored for processing
[Extract Quantity from Position 38-43]
The system continues processing the message to extract quantity information → The quantity value is extracted from positions 38-43 of the message for numeric validation
[Add Quantity to Running Total]
The system processes the valid quantity → The quantity is added to the running total (WS-1J-QTY) for cumulative entry quantity tracking
[Store Entry Number for Processing]
The system determines the cargo arrival status → The entry number is stored in WS-1J-NTRY-SCND if no cargo arrival found, or in WS-1J-NTRY-ORIG if cargo arrival was found
[Extract Entry Number from Message Position 17-32]
The system processes the message for entry information → The entry number is extracted from character positions 17 through 32 of the message
[Extract Quantity from Message Position 38-43]
The quantity at positions 38-43 is numeric → The quantity value is added to the running total of all 1J entry quantities
[Store as Second Entry Number]
The system extracts the entry number from the message → The entry number is stored as the second entry number
[Store as Original Entry Number]
The system extracts the entry number from the message → The entry number is stored as the original entry number
[Scan Customs Log Messages]
Processing trucker bonds validation → The system retrieves LGRT record and performs get-next-position on LGDP records to scan through all related log messages
[Accumulate Total Entry Quantities]
The extracted quantity is numeric → The quantity is added to the running total of all entry quantities
[Get Manifest Quantity from GCSUSRT]
Performing quantity validation → The system uses the manifest quantity from the GCSUSRT record field M1103-QUANTITY-PIC9 as the baseline for comparison
[Continue Processing]
The message text equals 'US CCN TRUCKER BOND PROCEED' → The trucker bond authorization flag is set to yes
[CARGO ARRIVAL or EQUIPMENT ARRIVED]
The message content starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' at position 12 and 'ARRIVED' at position 35 → The cargo arrival found indicator is set to true
[USCS DC:1J NTRY]
The message content starts with 'USCS DC:1J NTRY:' and cargo arrival has not been found → The 1J entry number from positions 17-32 is stored as second entry number and the quantity from positions 38-43 is added to the total quantity if numeric
[Store as original 1J entry number]
The system processes the 1J entry message → The 1J entry number from positions 17-32 is stored as the original entry number
[US CCN TRUCKER BOND PROCEED]
The message content starts with 'US CCN TRUCKER BOND PROCEED' → The trucker bond proceed indicator is set to yes
[USCS DC:BD]
The message content starts with 'USCS DC:BD' → The FTZ authorization indicator is set to yes
[Store as Original Entry Number]
Cargo arrival has been found in previous log messages → The entry number is stored as the original entry number for comparison purposes
[Store as Second Entry Number]
The system encounters a 1J entry without prior cargo arrival detection → The entry number is stored as the second entry number for later comparison
[Scan Customs Log Messages]
A log message contains 'US CCN TRUCKER BOND PROCEED' text → The system sets trucker bond authorization to yes for subsequent processing decisions
[Scan Customs Log Messages]
A log message contains 'USCS DC:BD' indicating FTZ authorization → The system sets FTZ authorization to yes and may bypass certain clearance location requirements
[Get Next Log Dependent Record]
The system processes log dependent records → Each log dependent record is retrieved sequentially for message analysis
[Set Cargo Arrival Found Flag]
The message starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' and 'ARRIVED' → Set cargo arrival found flag to true
[Extract Entry Number from 1J Message]
Cargo arrival has not been found and the message contains entry information → Extract the second entry number and add the quantity to running total
[Extract Entry Number from 1J Message]
The system processes the 1J entry message → Extract and store the original entry number from the message
[Set Trucker Bond Proceed Flag]
The message equals 'US CCN TRUCKER BOND PROCEED' → Set trucker bond proceed flag to yes
[Set FTZ Authorization Flag]
The message starts with 'USCS DC:BD' → Set FTZ authorization flag to yes
[FTZ Authorization Found?]
FTZ authorization flag is set to yes → Exit processing as no further validation is required
[Process Canadian Manifest for US Cargo]
The system processes Canadian manifests by waybill → Spawn GCT1051E messages with trucker bond proceed information for each Canadian cargo manifest
[Set Security and Transaction Details]
The system sets up transaction security details → The system assigns sending transaction as 'GCT1511E', sets ACF2 user ID from CCCOM, and establishes current date and time
[Set Cargo Type to Canadian]
The system sets the cargo type designation → The system sets the cargo type indicator to Canadian cargo in the GCX105 message
[Build Trucker Bond Proceed Message]
The system builds the trucker bond message text → The system concatenates 'US CCN TRUCKER BOND PROCEED: ' with the US CCN key into the GCX105 message field
[Spawn GCT1051E Transaction]
The system spawns the GCT1051E transaction → The system calls the 9000-SPAWN-GCT1051E procedure to process the transaction message
[Set Security and Transaction Details]
Security and transaction details need to be set → Sending transaction is set to GCT1511E and ACF2 user ID is populated from system context
[Build Date and Time from System]
Date and time information is required for the message → System date is formatted with century and machine date, and system time is captured for message timestamp
[Set Action Code to ZZZ]
Action code needs to be specified for the transaction → Action code is set to ZZZ to indicate trucker bond proceed processing
[Set Canadian CCN Key]
Cargo identification is required in the trucker bond message → Canadian CCN key from the manifest is assigned to the train or US CCN field in the message
[Build Trucker Bond Proceed Message]
Trucker bond proceed message needs to be built → Message text is constructed with 'US CCN TRUCKER BOND PROCEED: ' prefix followed by the US CCN key
[Spawn GCT1051E Transaction]
Cross-border transaction needs to be processed → GCT1051E transaction is spawned with the prepared message data
[Set Action Code to ZZZ]
The system sets the transaction action code → The action code is set to 'ZZZ' to identify this as a trucker bond proceed notification
[Set Canadian Cargo CCN Key]
The system sets the cargo identification in the message → The Canadian cargo CCN key is assigned to the train or US CCN field and the cargo type is set to Canadian cargo
[Build Trucker Bond Proceed Message]
The system builds the trucker bond proceed message → The message text is formatted as 'US CCN TRUCKER BOND PROCEED: ' followed by the US CCN key
[Spawn GCT1051E Transaction]
The system needs to send the trucker bond notification → The GCT1051E transaction is spawned with the constructed message data
[Set Security and Transaction Details]
The system sets up transaction context → The system sets sending transaction to 'GCT1511E', assigns current user ID, and records current date and time
[Set Canadian CCN Key from Record]
The system builds the linking message → The system assigns the Canadian CCN key from GCSCCRT record to the train or US CCN field in the message
[Set Cargo Type to Canadian]
The system sets cargo type classification → The system sets cargo type indicator to Canadian cargo in the message structure
[Build Trucker Bond Proceed Message with US CCN]
The system builds the message content → The system creates message text 'US CCN TRUCKER BOND PROCEED: ' concatenated with the US CCN key from GCSUSRT record
[Spawn GCT1051E Transaction]
The system needs to execute the linking transaction → The system calls the GCT1051E transaction processing module to complete the cargo linking operation
[Set Security Byte to High-Value]
The system configures security settings → The security byte is set to high-value for message protection
[Set Sending Transaction to GCT1511E]
The system sets the sending transaction identifier → The sending transaction is set to 'GCT1511E' to identify the transaction type
[Set ACF2 User ID from CCCOM]
The system assigns user authentication information → The ACF2 user ID from the common communication area is assigned to the message for audit purposes
[Set Current Date from Machine Century and Date]
The system assigns the transaction date → The current date is constructed from machine century and date components
[Set Current Time from Machine Time]
The system assigns the transaction time → The current time is obtained from the machine time for transaction timestamp
[Set Action Code to ZZZ]
The system sets the action code → The action code is set to 'ZZZ' to identify the trucker bond proceed action
[Build Trucker Bond Proceed Message]
The system builds the trucker bond proceed message → The message is constructed with 'US CCN TRUCKER BOND PROCEED: ' followed by the US CCN key
[Call 9000-SPAWN-GCT1051E Routine]
The system calls the GCT1051E spawning routine → The 9000-SPAWN-GCT1051E routine is invoked to handle message transmission
[Move Input to GCT1051E Message]
The system transfers content to GCT1051E message → The input content is moved to the GCT1051E message structure for queue processing
[Change IMS Message Queue Status]
The system changes the IMS message queue status → The queue status is changed to allow message writing operations
[Write Message to GCT1051E Queue]
The system writes the message to the GCT1051E queue → The message is successfully written to the GCT1051E queue with proper message code, content, length, and module name
[Purge IMS Message Queue]
The system purges the IMS message queue → The queue is purged to clean up resources and prepare for subsequent operations
[Keep retrieved broker name data]
Lookup operation returns successful status → Retrieved broker name segment data is preserved for further processing
[Clear broker name segment data]
Lookup operation returns unsuccessful status → Broker name segment is initialized to clear any existing data
[Is TOFC/COFC Indicator 'C' or 'T'?]
The TOFC/COFC indicator is 'C' (Container) or 'T' (Trailer) → The system should proceed to validate the bill of lading date for potential use in waybill segment
[Use Bill of Lading Date and Time for Waybill Segment]
The TOFC/COFC indicator is 'C' or 'T' and bill of lading date is valid → The system should move characters 2-6 of bill of lading date to waybill date and move bill of lading time to waybill time
[Set TOFC/COFC Indicator in Waybill Segment]
Processing waybill segment data → The system should move the TOFC/COFC indicator from shiproot to the waybill segment
[Continue with Current Multi-Shipment Indicator]
The idler indicator field is empty or contains only spaces → The original multi-shipment indicator from SHIPROOT should be maintained unchanged in the waybill segment
[Get Multi-Shipment Indicator from SHIPROOT]
The system processes lead equipment identification → The multi-shipment indicator is retrieved from the SHIPROOT segment
[Set Lead Equipment ID from SHIPROOT Car ID]
Lead equipment processing is required → The car ID from SHIPROOT is assigned as the lead equipment ID in the waybill segment
[Set Lead Equipment ID from SHIPROOT Car ID]
Processing waybill segment multi-shipment indicator → The multi-shipment indicator is set to 'I' regardless of the original SHIPROOT value
[Extract original waybill road number from SHIPROOT]
Processing waybill segment from SHIPROOT data → Original waybill road number is moved to WB-ORIGINAL-WB-RD field
[Extract original waybill station number from SHIPROOT]
Processing waybill segment from SHIPROOT data → Original waybill station number is moved to WB-ORIGINAL-WB-STN field
[Extract original waybill number from SHIPROOT]
Processing waybill segment from SHIPROOT data → Original waybill number is moved to WB-ORIGINAL-WB-NUM field
[Cargo Type?]
The system needs to process equipment numbers → The system should identify if the cargo type is Canadian cargo or US cargo based on LGRT segment type
[Move Base Unit Number to Output Segment]
The system builds the waybill segment → Move the base unit number from the starting position to WB2-BASE-UNIT-NBR in the output segment
[Use Extracted Check Digit or Use SHIPROOT Check Digit]
The system builds the waybill segment → If check digit was extracted from equipment number, use that value; otherwise use EQUIP-NO-CHECK from SHIPROOT for WB2-EQUIP-CHECK-DIGIT
[Use Bond Destination Location]
The location for Vista class lookup is determined → The bond destination location name is used as the port identifier for Vista class table lookup
[Use Entry Port Location]
The location for Vista class lookup is determined → The entry port location name is used as the port identifier for Vista class table lookup
[Check Bond Type]
The bond type is Immediate Transport → Use the destination location name as the port for Vista class lookup
[FTZ Authorization Found?]
FTZ authorization is found in the cargo log messages → Exit Vista class processing without setting clearance location requirements
[Set Clearance Location Required]
Clearance is determined to be required → Set clearance location as required in the shipment segment
[Retrieve Customs Log Root Record]
The system attempts to retrieve the customs log root record → The GCSLGRT record is accessed using the LGRT key
[Get Next Log Dependent Record]
The system scans for log dependent records → Each GCSLGDP dependent record is retrieved sequentially for message analysis
[CARGO ARRIVAL or EQUIPMENT ARRIVED]
The message content starts with 'CARGO ARRIVAL' or contains 'EQUIPMENT' and 'ARRIVED' → Set the cargo arrival found flag to true
[USCS DC:1J NTRY -No Prior Arrival-]
The message starts with 'USCS DC:1J NTRY:' → Extract the entry number to secondary entry field and add the quantity to the total quantity counter
[USCS DC:1J NTRY -After Arrival-]
The message starts with 'USCS DC:1J NTRY:' → Extract the entry number to the original entry field
[US CCN TRUCKER BOND PROCEED]
The message content is 'US CCN TRUCKER BOND PROCEED' → Set the trucker bond proceed flag to yes
[USCS DC:BD]
The message content starts with 'USCS DC:BD' → Set the FTZ authorization flag to yes
[Cargo Arrival Found AND Entry Numbers Different AND Quantity Sufficient?]
If the collected information → If cargo arrival is found AND original entry number is different from secondary entry number AND total 1J quantity is greater than or equal to the manifest quantity, then proceed with Canadian manifest linking
[Process Canadian Manifest Linking]
The system processes Canadian manifest linking → For each Canadian cargo manifest associated with the waybill, spawn a GCT1051E message with trucker bond proceed notification including the US CCN key
[Continue with Vista Class Processing]
If processing options → Exit trucker bond processing immediately and continue with Vista class processing
[Set Security and Transaction Details]
The system sets authentication and timing details → The ACF2 user ID is copied from the current session, machine date is formatted and stored, and machine time is captured for the transaction
[Set Action Code to ZZZ]
The system sets transaction parameters → The action code is set to 'ZZZ', the Canadian cargo flag is set to true, and the train/US CCN is populated with the Canadian CCN key
[Build Trucker Bond Proceed Message]
The system builds the trucker bond proceed message content → The message is constructed by concatenating 'US CCN TRUCKER BOND PROCEED: ' with the US CCN key from the cargo record
[Spawn GCT1051E Transaction]
The system dispatches the transaction for processing → The GCT1051E transaction is spawned with the message content and sent to the processing queue for further handling
[Set Security Byte to High-Value]
Security settings are configured → The security byte should be set to high-value to ensure secure transmission
[Set Sending Transaction to GCT1511E]
Transaction identification is required → The sending transaction should be set to 'GCT1511E'
[Copy ACF2 User ID from CCCOM]
User authentication data is available in CCCOM → The ACF2 user ID should be copied from CCCOM to the message structure
[Format System Date from Machine Century and Date]
System date formatting is performed → The date should be constructed by concatenating machine century and machine date from CCCOM
[Copy Machine Time]
Time data is being set → The machine time should be copied from CCCOM to the message time field
[Set Action Code to ZZZ]
Action code specification is required → The action code should be set to 'ZZZ'
[Copy Canadian CCN Key to Train/US CCN Field]
CCN identification is required → The Canadian CCN key should be copied to the train or US CCN field
[Set Cargo Type to Canadian]
Cargo type identification is needed → The cargo type indicator should be set to Canadian
[Construct Message Text with US CCN Key]
Message text construction is performed → The message should contain 'US CCN TRUCKER BOND PROCEED: ' followed by the US CCN key
[Call Spawn GCT1051E Transaction]
Message submission is required → The GCT1051E spawn transaction should be called to process the message
[Set TOFC/COFC Indicator in Waybill Segment]
Processing waybill segment creation → The system should copy the TOFC/COFC indicator from shiproot to waybill segment
[Check Idler Indicator from SHIPROOT]
The system processes the shiproot data for waybill segment building → If the idler indicator is not empty or spaces, set the multi-shipment indicator to 'I' for idler car, otherwise continue with normal multi-shipment processing
[Set Multi-Shipment Indicator to 'I' for Idler]
The idler indicator contains a value → The multi-shipment indicator is set to 'I' in the waybill segment
[Set Lead Equipment ID in Waybill Segment]
The lead equipment ID needs to be recorded in the waybill → The car ID from SHIPROOT is moved to the lead equipment ID field in the waybill segment
[Extract Original Waybill Road Number from SHIPROOT]
Processing waybill segment from SHIPROOT data source → Original waybill road number is extracted and assigned to WB-ORIGINAL-WB-RD field
[Extract Original Waybill Station Number from SHIPROOT]
Processing waybill segment from SHIPROOT data source → Original waybill station number is extracted and assigned to WB-ORIGINAL-WB-STN field
[Extract Original Waybill Number from SHIPROOT]
Processing waybill segment from SHIPROOT data source → Original waybill number is extracted and assigned to WB-ORIGINAL-WB-NUM field
[Move Base Unit Number to Output Segment]
Output segment is populated → Base unit number from the first non-space position to the end is moved to WB2-BASE-UNIT-NBR
[Immediate Transport Bond]
Bond type is immediate transport → Location ID1 name is used if available (not spaces), otherwise processing exits
[Default, Empty Equipment, or Returned US Goods]
Cargo type is evaluated → Entry port location name is used if cargo type is default, empty equipment, or returned US goods, otherwise processing exits
[TOFC/COFC Equipment]
Equipment type is evaluated from waybill segment → Intermodal clearance rules apply if equipment type is 'C' or 'T', otherwise carload clearance rules apply

Structural Validations

[Message Read Successfully?]
The return code is evaluated → If return code is zero, proceed with database processing, otherwise call error handler
[14:Equipment Validation - Validate equipment initial and number presence before sending CSD message]
Equipment validation is performed → For Canadian cargo, GCCC equipment car initial and number must not be spaces; for US cargo, GCUSRT equipment initial and number must not be spaces
[Validate Cargo Type - US or Canadian]
The system checks the cargo type in the LGRT segment → Processing continues if the cargo type is either US cargo or Canadian cargo, otherwise the process exits
[Cargo Type Validation Failed]
The system cannot complete cargo type validation → Cargo type validation fails and processing terminates without building customs messages
[Extract Canadian Equipment Initial from GCSCCRT]
The system checks equipment initial and equipment number fields → Both equipment initial and equipment number must not be spaces to proceed with CSD message processing
[Extract US Equipment Initial from GCSUSRT]
The system checks RT081 equipment initial and equipment number fields → Both RT081 equipment initial and equipment number must not be spaces to proceed with CSD message processing
[Is Manifest From Transaction Code Numeric?]
Building the entry port segment → The manifest from transaction code must be numeric to proceed with entry port processing
[Is Manifest To Transit Code Numeric?]
Building the bond segment for Canadian CSD message → The manifest destination transit code should be validated as numeric before setting bond destination details
[Use M1203 Location Name]
The system checks M1203 location ID1 name field → If M1203 location ID1 name is empty or spaces, exit Vista class processing, otherwise use M1203 location name for SD control table lookup and continue with trucker bond processing
[Validate Entry Matching - Compare original vs second entry numbers and quantities]
The system validates entry matching → If cargo arrival was found AND second entry number is not spaces AND original entry number is not equal to second entry number AND 1J quantity is greater than or equal to manifest quantity, validation passes OR if trucker bond proceed flag is yes, validation passes
[Check if message starts with 'USCS DC:1J NTRY:']
The system checks the message format → The message must start with 'USCS DC:1J NTRY:' to be processed as a 1J entry message
[Validate quantity is numeric]
The system validates the extracted quantity → The quantity must be in numeric format to be processed for accumulation
[Is Location ID Numeric?]
Building the entry port segment for CSD message → The location ID must be numeric to proceed with entry port data population, otherwise the entry port segment remains empty
[Replace Any Spaces in Quantity with Zeroes]
Processing the quantity data for CSD message → All spaces in the quantity piece count should be replaced with zeroes
[Valid Bond Type Set?]
No valid bond type has been set (bond type field remains empty) → Bond processing is skipped and the system exits bond segment building
[Mexico Manifest Data Available?]
Checking for required USS02 segment data → If USS02 segment is not found, exit the Mexico manifest building process
[Mexico Manifest Data Available?]
The system checks for USS02 segment availability → Processing continues only if USS02 segment data is found, otherwise despacho processing completes
[More N9 Segments to Process?]
The loop counter is within the maximum occurrence limit and the current N9 segment data is not spaces or low-values → Processing continues to the next N9 segment, otherwise the loop terminates
[Clear Export Control Segment]
The database return status indicates record not found (CC-STATUS-CODE is not spaces) → The system should initialize and clear the export control broker name segment
[Display CSD Message Details to System Error Log]
The system initiates CSD message transmission → The system displays all message segment details including equipment segment, waybill segment, manifest segment, shipment segment, Mexico manifest segment, and CBP border hold segment to the system error log with timestamp and transaction identifier
[Extract Pedimento Number]
A reference number qualifier equals 'FEN' and the reference number is not spaces or low-values → The reference number should be extracted as the pedimento number and the pedimento qualifier code should be set
[Extract CCN Number]
A reference number qualifier equals 'KCM' and the reference number is not spaces or low-values → The reference number should be extracted as the CCN number and the CCN qualifier code should be set
[More N9 Segments to Process?]
The loop counter is checked against maximum occurrences and segment availability → Processing continues if WS-IDX is less than or equal to GCSUSS99-S02-MAX-OCURS-BYSEQ and segments exist, otherwise loop terminates
[N9 Data Empty or Low-Values?]
The segment content is evaluated for emptiness → If GCSUSS02-N9-DATA for current index equals SPACES or LOW-VALUES, skip to next segment, otherwise continue processing
[N9 data segment empty?]
N9 data segment is empty or contains only spaces or low-values → System terminates the extraction process and exits the loop
[Reference number not empty?]
Reference number value is not empty and not spaces and not low-values → System extracts the reference number as valid Pedimento data
[Check N9 Reference Qualifier = 'KCM']
Processing each N9 record where the reference qualifier equals 'KCM' and the reference number is not empty or low-values → Extract the reference number as CCN value, move it to the Mexico manifest segment CCN field, and set the CCN qualifier to CD
[Continue to Next N9 Record]
Processing each N9 record where the reference qualifier equals 'FEN' and the reference number is not empty or low-values → Extract the reference number as Pedimento value, move it to the Mexico manifest segment Pedimento field, and set the Pedimento qualifier to CD
[Extract Quantity from Message Position 38-43]
The message contains quantity data at positions 38-43 → The system extracts the 6-character quantity field for numeric validation
[Is Quantity Numeric?]
The extracted quantity field is evaluated for numeric content → The system accepts only purely numeric values for quantity accumulation
[Compare Original vs Secondary Entry Numbers]
If the entry numbers for validation → The system requires the original entry number to be different from the secondary entry number
[Validate Entry Quantity is Numeric]
The system validates the quantity format → If the quantity is numeric, it is added to the running total; if not numeric, it is ignored
[Cargo Arrival Found AND Entry Quantities Match?]
The system validates the collected information → If cargo arrival is found AND second entry number differs from original AND accumulated 1J quantity is greater than or equal to manifest quantity, proceed to Canadian manifest processing
[Process 1J Entry Validation]
The message text starts with 'USCS DC:1J NTRY:' AND cargo arrival has not been found → Extract entry number from positions 17-32 as second entry number AND extract quantity from positions 38-43 AND if quantity is numeric then add it to total 1J quantity accumulator
[Process 1J Entry Validation]
The message text starts with 'USCS DC:1J NTRY:' → Extract entry number from positions 17-32 as original entry number
[Validate Quantity Against Manifest]
The accumulated 1J quantity is greater than or equal to the manifest quantity from GCSUSRT → Allow trucker bond processing to proceed for Canadian manifests
[Extract Entry Number from Position 17-32]
The system processes the message for 1J entry extraction → The entry number is extracted from positions 17-32 of the message
[Extract Quantity from Position 38-43]
The system extracts quantity from positions 38-43 → The quantity is validated as numeric format and only processed if valid
[Continue to Next Message]
The system compares entry numbers and quantities → Processing continues if original entry differs from second entry and accumulated quantity is greater than or equal to manifest quantity
[Extract Quantity from Message Position 38-43]
The quantity field at positions 38-43 is extracted → If the quantity is numeric, it is added to the total 1J quantity accumulator, otherwise processing continues without adding to the total
[Validate Entry Quantities Against Manifest]
The total 1J quantity is compared to the manifest quantity from the cargo record → If the 1J quantity is greater than or equal to the manifest quantity, the quantity validation passes, otherwise it fails
[Original Entry ≠ Second Entry?]
Entry number consistency is validated → If the original entry number is not equal to the second entry number, the entry validation succeeds, otherwise it fails
[Is Quantity Numeric?]
Validating the extracted quantity for numeric content → Accept the quantity for accumulation only if it contains valid numeric characters, otherwise skip the quantity
[Compare with Manifest Quantity]
Comparing the total accumulated 1J quantity with the manifest quantity from GCSUSRT → Proceed with entry number validation if accumulated quantity is greater than or equal to manifest quantity
[Extract Entry Number from Position 17-32]
The message is processed for entry number extraction → The entry number is extracted from positions 17-32 of the message and stored appropriately based on cargo arrival status
[Extract Quantity from Position 38-43]
The quantity is extracted from positions 38-43 of the message → If the extracted quantity is numeric, it is added to the accumulated total quantity
[Message Type: USCS DC:1J NTRY?]
The message content starts with 'USCS DC:1J NTRY:' → The message is identified as containing entry number information and processed for entry number extraction
[Set Cargo Arrival Found Flag]
The cargo arrival processing is completed → The cargo arrival found indicator is set to true to track this event occurrence
[Set Equipment Arrival Found Flag]
The equipment arrival processing is completed → The equipment arrival found indicator is set to true to track this event occurrence
[Check Message Format]
The system checks the message format and the message starts with 'USCS DC:1J NTRY:' at position 1-16 → The message is accepted for further processing to extract entry number and quantity
[Validate Quantity is Numeric]
The system validates the extracted quantity value → The quantity is accepted for processing only if it contains valid numeric characters
[Message Type: '1J NTRY'?]
The message begins with 'USCS DC:1J NTRY:' → The message is identified as a 1J entry message and entry information extraction proceeds
[Quantity is Numeric?]
The system checks the quantity format → Only numeric quantity values are added to the running total, non-numeric values are ignored
[Extract Entry Quantity from Message]
Processing the log message → The system extracts the entry number from positions 17-32 and stores it as second entry number, and extracts quantity from positions 38-43 for accumulation
[Extract Entry Quantity from Message]
Processing the log message → The system extracts the entry number from positions 17-32 and stores it as the original entry number
[More log dependent records?]
The system checks for record availability → If no more records exist, processing ends; if records exist, message content examination continues
[Extract Entry Number from Message]
The message format is 'USCS DC:1J NTRY:' followed by entry data → The system extracts the 16-character entry number starting at position 17 of the message
[Extract Quantity from Message]
The system processes the 6-character quantity field → If the quantity is numeric, it is added to the running total quantity counter for validation purposes
[Compare Entry Numbers]
The system performs entry number comparison → If the original entry number is different from the second entry number, the system proceeds with quantity validation
[Found 1J Entry Message?]
A log message contains 'CARGO ARRIVAL' or equipment arrival information with 'EQUIPMENT' and 'ARRIVED' → The system sets cargo arrival found status to true and continues processing for quantity validation
[Canadian Manifest Found?]
A Canadian cargo record is found in the database → The system proceeds to initialize the GCX105 input message for trucker bond processing
[Prepare Date Field - Replace Spaces with Zeroes]
The system prepares the date field for message processing → All space characters in the date field are replaced with zeroes
[Prepare Time Field - Replace Spaces with 1]
The system prepares the time field for message processing → All space characters in the time field are replaced with '1'
[Is Bill of Lading Date Valid?]
The bill of lading date is populated, low-values, or zeroes → The system should use the bill of lading date and time for the waybill segment
[Use Standard Waybill Date and Time from SHIPROOT]
The TOFC/COFC indicator is not 'C' or 'T', or the bill of lading date is invalid → The system should extract waybill date from shiproot, convert it to date/time format, and assign to waybill segment
[Check US Cargo Status]
The cargo status is RELEASE or PTT or PTT-EX → Vista class processing should be bypassed and exit immediately
[Check US Manifest Location]
The manifest location name is checked based on bond type → If immediate transport bond and destination location name is missing, or if other bond types and origin location name is missing, clearance determination ends
[Check US Port Location Name]
Port location name is determined based on bond type → For immediate transport use destination location name, for other types use origin location name, if location name is empty then no clearance required

Module: GCX151A 1 Consolidated Epic Story

Epic: GCX151A Complete EDI Specification Extracted from Legacy

Contains 149 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX151A EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize SHIPROOT Search Parameters]
The system initializes the SHIPROOT search parameters → The SHIPROOT and FWWWBIO data structures are cleared and the segment type is set to 'SHIPROOT'
[Initialize Search Parameters]
The search is initiated → The search parameters are initialized with SHIPROOT segment type, equipment ID as search key, greater than operator, and secondary index flag set to Y
[Initialize Search Parameters]
The search process is initiated → The shiproot segment type is set, waybill not found flag is established, and equipment ID variables are prepared for database search
[Initialize Database Segments]
The system begins the initial database search process → All database interface segments (SHIPROOT and FWWWBIO) are cleared and reset to initial state
[Initialize Search Parameters]
The system prepares to search for shipment records → The system initializes the shipment database interface, sets the segment type to SHIPROOT, and clears any previous search results
[Initialize SHIPROOT and FWWWBIO segments]
The system begins the search process → Both SHIPROOT and FWWWBIO data structures are cleared of any previous values
[Initialize FWSWXEQ Search Parameters]
The system initializes FWSWXEQ search parameters → The search segment type is set to 'FWSWXEQ', function code is set to GU (Get Unique), operator is set to '> ', secondary index indicator is set to 'Y', equipment index key is cleared, and accept status is set to 'GEGB'
[Initialize SHIPROOT and FWWWBIO segments]
The system prepares to search for shipment records by equipment ID → The SHIPROOT and FWWWBIO database segments are initialized to empty values
[Initialize Database Segments]
The system prepares for database access → Database segments SHIPROOT and FWWWBIO are cleared and initialized to empty state
[Initialize FWIQROOT Search Parameters]
The system prepares to search the waybill inquiry database (FWIQROOT) → The system clears the inquiry input/output area and sets the segment type to 'FWIQROOT'
[Initialize FWIQIO Parameters]
The system prepares to search the FWIQROOT database → The FWIQIO parameters are cleared and the segment type is set to 'FWIQROOT'
[Initialize Header Segment to Spaces]
The header building process begins → The header segment should be initialized to spaces to ensure clean data structure
[Initialize FWSWXEQ Segment]
The system begins equipment exchange data retrieval → The FWSWXEQ segment should be initialized to spaces
[Initialize Waybill Segments]
The waybill segment building process starts → Both primary and secondary waybill segments are initialized to spaces
[Initialize Manifest Segment]
The manifest segment building process begins → The manifest segment structure is cleared and initialized to spaces
[Initialize Entry Port Segment to Spaces]
The entry port segment needs to be created → The entry port segment should be initialized with blank/empty values
[Initialize Quantity Segment]
The quantity segment building process begins → The quantity segment should be cleared and initialized to spaces
[Initialize Event Segment]
The event segment building process begins → The event segment should be initialized to spaces
[Initialize Bond Segment with Spaces]
The bond segment construction process is initiated → The bond segment should be initialized with spaces to clear any previous data
[Initialize Shipment Segment to Spaces]
The shipment segment building process is initiated → The shipment segment should be cleared of any previous data by setting all fields to spaces
[Initialize Mexico Manifest Segment]
The build Mexico manifest segment process begins → The Mexico manifest segment is initialized to spaces
[Initialize Message Queue for Transmission]
The system prepares to transmit the message → The system calls CIMS with CHNG function using ALT-PCB and EET3211 parameters to initialize the message queue

Core Acceptance Criteria

[Retrieve Lead Car Information]
Lead car information is needed → Retrieve shiproot using lead waybill key and extract lead car ID for the waybill segment
[Build CSD Message Header]
Header segment is built → Set CPR ID to '=C=P=R=', length to '045', version to '02', source application to 'CSTMS', and destination message tag to 'CSTMS_CSD_01'
[Build Equipment Segment]
Equipment segment is built → Move equipment initial to equipment initial field and equipment number to equipment number field in the segment
[Build Waybill Segment from Shiproot]
Waybill segment is built → Use bill of lading date for TOFC/COFC shipments if available, otherwise use waybill date; set multi-ship indicator to 'I' if idler indicator exists; for multi-ship or idler, set lead equipment ID; calculate shiproot and equipment waybill keys based on multi-ship rules
[Build Waybill Segment from Inquiry]
Waybill segment is built from inquiry → Use waybill date from inquiry root, set TOFC/COFC indicator, create shiproot key with '01' suffix, set original waybill key from inquiry info, and format base unit number based on equipment number format
[Build Manifest Segment]
Manifest segment is built → Set CCN qualifier to CUB; if DSP service successful, use US CCN from service, otherwise generate dummy CCN using system date and time
[Build Entry Port Segment]
Entry port segment is built → Initialize entry port segment with spaces
[Build Quantity Segment]
Quantity segment is built → Set piece count to 1 and piece count qualifier to 'UNT'
[Build Event Segment]
Event segment is built → Generate unique customs event ID using nines complement of current date-time, create event timestamp, set posted date and time from machine date-time, adjust century based on year greater than 70, correct seconds if equals 60, set user ID from ACF2, and use provided event description or default dummy description
[Build Status Segment]
Status segment is built → Initialize status segment with spaces
[Build Broker Segment]
Broker segment is built → Set broker name qualifier to XU and broker name to 'NOT REQ'
[Build Bond Segment]
Bond segment is built → Initialize bond segment with spaces
[Build Shipment Segment]
Shipment segment is built → Initialize shipment segment with spaces
[Build Mexico Manifest Segment]
Mexican manifest segment is built and DSP service is successful → If Mexican CCN is not empty, set CCN with CD qualifier; if Pedimento number is not empty, set Pedimento with CD qualifier; if Pedimento received timestamp is not empty, set timestamp with CST timezone; set DSP hold indicator, SCAC code, and FSAC code from service data
[Send CSD Message to Customs]
Customs message is sent → Log message details, call CIMS to send message, call WRITMSGL to write message log, and call CIMS to purge message queue
[Shipment Source?]
Waybill segment building is initiated → If shiproot is found, build waybill segment from shiproot data, otherwise build waybill segment from inquiry data
[Log Initialization Details]
The initialization logging is triggered → A log entry must be created displaying the system date, system time, and initialization message for module GCX151AR
[Display Equipment Parameters]
The parameter display process is executed → The system must display the equipment initialization code, equipment number, and waybill number in a formatted log message
[Set Search Parameters]
The system configures search parameters → The segment type is set to 'SHIPROOT' for database query targeting
[Set segment type to 'SHIPROOT']
The system sets up search parameters → The segment type is set to 'SHIPROOT' to target the correct database table
[Search FWSWXEQ Segment by Equipment ID]
The system executes the FWSWXEQ database call → Retrieve equipment cross-reference segment data and determine if any records exist for the specified equipment
[Get First FWSWXEQ Record by Equipment ID]
The system executes the first database retrieval → The FWCWRIO program is called with CCCOM, FWWWRIO, and FWSWXEQ-SEGMENT parameters
[Execute Database Call]
The system executes a Get Unique (GU) database call with predefined accept status codes → The system returns the requested record if found or sets appropriate not found status
[Clear FWSWXEQ Segment Data]
Starting to process the next FWSWXEQ record → The FWSWXEQ segment data should be cleared to spaces
[Call FWCWRIO with GN Function]
Calling FWCWRIO with Get Next function code → The next FWSWXEQ record should be retrieved from the database
[Retrieve Equipment Record from FWSWXEQ]
The system calls FWCWRIO to retrieve equipment exchange data from FWSWXEQ segment → The equipment exchange record is retrieved and made available for validation
[Update Waybill Segment with Lead Car ID]
The system updates the customs message waybill segment → The lead equipment identifier is assigned to the waybill segment's lead equipment field
[Retrieve Additional Waybill Information from FWIQINFO]
The system searches for additional information in FWIQINFO segment with key 'A1' → The system attempts to retrieve supplementary waybill details
[Search Inquiry Database with Extracted Keys]
Inquiry database search is executed → FWIQROOT database is searched using extracted keys with segment type FWIQROOT
[Get Additional Inquiry Information]
Additional information retrieval is requested → FWIQINFO segment is accessed with segment type FWIQINFO and key A1
[Use Default Values for Missing Data]
Default value assignment is performed → Original road, original station, and original waybill fields are set to zeroes
[Extract from SHIPROOT Record]
Building waybill segment from shiproot record → The originating station number from shiproot record is moved to the waybill segment station number field
[Extract from FWIQROOT Record]
Building waybill segment from inquiry database record → The originating station number from inquiry root record is moved to the waybill segment station number field
[Extract from FWCIROOT Record]
Performing fallback inquiry search for waybill information → The originating CSC number from car inquiry root record is moved to the inquiry segment station number field
[Convert to 9-Digit Format]
Building the customs waybill segment → The station number is converted and stored in 9-digit numeric format in the waybill segment
[Set search parameters for car lookup]
The system configures search parameters for database lookup → The segment type is set to 'SHIPROOT', equipment ID is assigned to car ID field, operator is set to '> ', and secondary index flag is set to 'Y'
[Set Search Parameters]
The system configures search parameters → Segment type is set to 'SHIPROOT', secondary index flag is enabled with 'Y', and search operator is set to greater than '> '
[Execute Database Get Unique Call]
The system executes the database call → A Get Unique function is performed against the SHIPROOT segment using FWCWBIO interface with acceptable status codes of spaces and 'GE'
[Prepare Database Call Parameters]
The system prepares the database call parameters → The segment type is set to 'SHIPROOT', the equipment ID is assigned to the car ID field, the operator is set to '>', and the secondary index flag is set to 'Y'
[Execute Database Call]
The database call is executed → The system calls FWCWBIO with the communication control block, database I/O area, and shiproot segment
[Search for Additional Info in FWIQINFO]
The system needs additional waybill information → The system sets segment type to 'FWIQINFO', sets key to 'A1', and calls FWIQIO to retrieve additional information
[Use Found Additional Information]
The FWIQINFO record is successfully retrieved → The system continues processing without modifying the original waybill data
[Search for FWIQINFO Record]
The system searches for FWIQINFO record with segment type 'FWIQINFO' and key2 'A1' → The system attempts to retrieve FWIQINFO record for additional original key data
[Search for Additional Info in FWIQINFO]
The system searches for additional information using segment type 'FWIQINFO' and key 'A1' → Additional waybill information is retrieved if available
[Set Segment Type to FWIQROOT]
The system sets up the database search parameters → The segment type is set to 'FWIQROOT' to identify the target record type
[Set Segment Type to FWIQINFO]
The system prepares to retrieve additional waybill information → The segment type is changed to 'FWIQINFO' to target additional information records
[Set Search Parameters for FWIQINFO]
The system needs to search for FWIQINFO record with segment type 'FWIQINFO' and key2 value 'A1' → The system should set the segment type to 'FWIQINFO' and key2 to 'A1' for the database search
[Execute Database Search]
The system executes the database search call → The system should call FWIQIO using the configured search parameters to retrieve the FWIQINFO record
[Set CPR ID to '=C=P=R=']
The CPR identification needs to be set → The header CPR ID field should be set to '=C=P=R='
[Set Message Length to '045']
The message length specification is required → The header length field should be set to '045'
[Set Version to '02']
The message version needs to be specified → The header version field should be set to '02'
[Set Source Application to 'CSTMS']
The source application field is being populated → The header source application field should be set to 'CSTMS'
[Set Source App Version to '001.001.01']
The source application version needs to be specified → The header source application version field should be set to '001.001.01'
[Set Destination App Message Tag to 'CSTMS_CSD_01']
The destination application message tag is being set → The header destination application message tag field should be set to 'CSTMS_CSD_01'
[Set Destination App Version to '01']
The destination application version needs to be specified → The header destination application version field should be set to '01'
[Set Data Sensitivity Level to '2']
The data sensitivity level is being assigned → The header data sensitivity field should be set to '2'
[Clear Equipment Segment Structure]
The equipment segment structure needs to be initialized → The equipment segment structure is cleared to spaces
[Set Equipment Initial in Segment]
The equipment initial needs to be set in the customs message segment → The equipment initial from working storage is moved to the equipment segment initial field
[Set Equipment Number in Segment]
The equipment number needs to be set in the customs message segment → The equipment number from working storage is moved to the equipment segment number field
[Is TOFC/COFC Shipment with Valid Bill of Lading Date?]
The shipment is TOFC or COFC type AND the bill of lading date is not spaces, low-values, or zeroes → Use the bill of lading date and time for the waybill segment
[Set Traffic Type Indicator]
Building the waybill segment → Copy the TOFC/COFC indicator from shiproot to the waybill segment
[Set Multi-Shipment Indicator]
Building the waybill segment → Copy the multi-shipment indicator from shiproot to the waybill segment
[Set Original Station Number]
Building the waybill segment → Copy the original station number from shiproot to the waybill segment
[Set Original Waybill Information]
Building the waybill segment → Copy original waybill road, station, and number from shiproot to waybill segment
[Format Base Unit Number]
Processing the base unit number for waybill segment → Remove leading zeros and format the remaining digits for the waybill segment
[Call FWCWRIO to Access Equipment Cross-Reference]
System calls FWCWRIO to access equipment cross-reference database → Equipment cross-reference record is retrieved from the database
[Clear FWSWXEQ Segment Data]
The system prepares to access equipment exchange data → The FWSWXEQ segment data structure is cleared to ensure clean data processing
[Call FWCWRIO with Equipment Parameters]
The system needs to retrieve equipment exchange data from the database → The FWCWRIO database interface is called with the equipment parameters and segment data
[Extract Waybill Date and Time from Inquiry Root]
Building waybill segment from inquiry data → Waybill date-time is extracted from inquiry root WB-DTE field
[Set Date and Time in Waybill Segment]
Populating waybill segment fields → Date component is moved to waybill segment date field and time component is moved to waybill segment time field
[Copy TOFC/COFC Indicator from Inquiry]
Building waybill segment from inquiry data → TOFC/COFC indicator is copied from inquiry root to waybill segment
[Set Shipment Root Key from Inquiry]
Building waybill segment from inquiry data → Shipment root key is set from inquiry root SHI-INQ field
[Set Equipment Waybill Key to Zero]
Setting equipment waybill key field → Equipment waybill key is set to zeroes
[Copy Origin Station Number]
Building waybill segment from inquiry data → Origin station number is copied from inquiry root to waybill segment
[Set Original Waybill Key from Inquiry Info]
Building waybill segment from inquiry data → Original waybill key is set from inquiry info ORIGINAL-KEY field
[Equipment Number Starts with Zero?]
Equipment number second position equals zero → Equipment number extraction starts from position 3, otherwise extraction starts from position 2
[Extract Equipment Number Starting from Position 3]
Extracting equipment number for waybill segment → 6 characters starting from position 3 of equipment number are moved to base unit number field
[Extract Equipment Number Starting from Position 2]
Extracting equipment number for waybill segment → 6 characters starting from position 2 of equipment number are moved to base unit number field
[Set Equipment Check Digit from Inquiry]
Finalizing equipment information in waybill segment → Equipment check digit is copied from inquiry root to waybill segment
[Set CCN Qualifier to 'CUB']
The CCN qualifier needs to be set → The CCN qualifier is set to 'CUB' as the standard customs identifier
[Use US Customs Control Number from DSP]
Building the manifest segment CCN field → The US customs control number from DSP is used as the manifest CCN
[Generate Dummy CCN from System Date/Time]
Building the manifest segment CCN field → A dummy CCN is generated using system date and time and used as the manifest CCN
[Set Piece Count to 1]
The piece count needs to be assigned → The piece count should be set to 1 to represent a single equipment unit
[Set Unit Qualifier to 'UNT']
The unit qualifier needs to be specified → The piece count qualifier should be set to 'UNT' to indicate unit-based counting
[Build Status Segment - Construct shipment status information]
The status segment construction process is initiated → The status segment should be initialized with spaces to create an empty status segment
[Clear Broker Segment Data]
The broker segment needs to be initialized → All broker segment fields are cleared to spaces
[Set Broker Name Qualifier to XU]
The broker name qualifier needs to be set → The broker name qualifier is set to XU
[Set Broker Name to 'NOT REQ']
No specific customs broker is assigned to the shipment → The broker name is set to 'NOT REQ'
[Set Mexico CCN Number]
Building the Mexico manifest segment → The Mexico CCN is set in the manifest segment
[Set CCN Qualifier to CD]
The Mexico CCN is populated → The CCN qualifier is set to CD
[Set Pedimento Number]
Building the Mexico manifest segment → The pedimento number is set in the manifest segment
[Set Pedimento Qualifier to CD]
The pedimento number is populated → The pedimento qualifier is set to CD
[Set Pedimento Received Timestamp]
Building the Mexico manifest segment → The pedimento received timestamp is set in the manifest segment
[Set Timezone to CST]
The pedimento received timestamp is populated → The pedimento date timezone is set to CST
[Set DSP Hold Indicator]
Building the Mexico manifest segment → The DSP hold indicator is set from the DSP data
[Set DSP Hold SCAC Code]
Building the Mexico manifest segment → The DSP hold SCAC code is set from the DSP data
[Set DSP Hold FSAC Code]
Building the Mexico manifest segment → The DSP hold FSAC code is set from the DSP data
[Set Mexico CCN Number in Manifest]
Building the Mexico manifest segment → Set the Mexico CCN number in the manifest segment AND set the CCN qualifier to CD
[Continue to Next Field]
Building the Mexico manifest segment → Set the Pedimento number in the manifest segment AND set the Pedimento qualifier to CD
[Continue to Next Field]
Building the Mexico manifest segment → Set the Pedimento received timestamp in the manifest segment AND set the date timezone to CST
[DSP Hold Information Available?]
Building the Mexico manifest segment → Set the DSP hold indicator from customs data AND set the DSP hold SCAC code from customs data AND set the DSP hold FSAC code from customs data
[Set Pedimento Number in Mexico Manifest]
The pedimento number field is not empty or low-values → The pedimento number is copied to the Mexican manifest segment and the pedimento qualifier is set to 'CD'
[Set Pedimento Qualifier to 'CD']
The pedimento number assignment is completed → The pedimento qualifier is set to 'CD' to indicate the type of pedimento document
[Leave Pedimento Number Empty]
Processing the Mexican manifest segment → The pedimento number and qualifier fields remain empty in the Mexican manifest segment
[DSP Query Successful?]
The system processes the query results → US customs control number, Mexico customs control number, pedimento number, pedimento received timestamp, DSP hold indicator, SCAC code, and FSAC code should be extracted from the response
[Set Search Parameters]
The system initializes the database search parameters → The segment type is set to SHIPROOT, operator is set to greater than or equal, function code is set to get unique, and accept status is set to get exact
[Call Database Interface FWCWBIO]
The system calls the database interface FWCWBIO → The database interface is invoked with the communication control block, waybill I/O area, and shiproot segment to retrieve the shipment record
[Set Database Parameters]
Setting up parameters for shiproot database access → Database segment type is set to SHIPROOT, equipment ID is assigned as search key, operator is set to greater than, secondary index flag is enabled, and function code is set to Get Unique
[Call FWCWBIO Database Interface]
Executing the database interface call → FWCWBIO program is called with communication control block, database I/O area, and shiproot segment
[Access Multi-Shipment Equipment Record]
The system needs to find lead waybill information for multi-shipment equipment → The system should access the FWSWXEQ segment using equipment ID as search criteria with multi-shipment waybill type indicator
[Clear FWSWXEQ Segment Data]
The lead waybill extraction process begins → The equipment cross-reference segment data structure is initialized to spaces
[Call FWCWRIO to Read Equipment Cross-Reference]
System calls FWCWRIO database function with equipment parameters → Equipment cross-reference data is retrieved from database
[Log CSD Message Details to System]
The system prepares to send the customs message → The system logs equipment segment, waybill segment, manifest segment, quantity segment, event segment, broker segment, and Mexico manifest segment details to system error output with timestamp
[Move Complete CSD Message to EET3211 Message Queue]
The system prepares for customs transmission → The system moves the complete customs message to EET3211-MSG field
[Write Message to Customs Interface Queue]
The system executes message transmission → The system calls WRITMSGL with ALT-PCB, message code, message content, message length, and module name parameters to write the message to customs interface queue
[Purge Message Queue After Transmission]
The message transmission is complete → The system calls CIMS with PURG function using ALT-PCB to purge the message queue
[Create Email Subject Waybill Not Found Alert]
The system configures the email subject line → The email subject is set to the predefined waybill error subject message
[Build Email Content Line 1: Subject Line 2: Equipment ID Line 3: Waybill Number]
The system builds the email message body → Line 1 contains the email subject, Line 2 contains the formatted equipment ID error message, and Line 3 contains the formatted waybill number error message
[Call Email Service EMCSEND3]
The system invokes the email sending service → The EMCSEND3 service is called with sender, destination, recipient, subject, and message content parameters

Structural Validations

[Send Error Email Notification]
Error notification is required → Log error message with equipment and waybill details, prepare email with error subject and equipment information, send email using EMCSEND3 service, and handle email sending errors
[Equipment ID Matches?]
The system compares the record's equipment ID with the search equipment ID → Confirm equipment ID match to proceed with waybill validation, or mark as equipment not found if IDs do not match
[Additional Info Available?]
Additional information availability is checked → If status code is spaces then additional information is available, otherwise additional information is not available
[Set Default Road Number]
The system attempts to retrieve original waybill details → The original road, station, and waybill number fields are set to zeroes as default values
[Set Default Values for Missing Info]
The FWIQINFO record retrieval fails → The system sets original road, original station, and original waybill fields to zeroes
[Set Error Message 'SEND TO FILE OF OM01247 FAILED']
The system processes the email send failure → The error message is set to 'SEND TO FILE OF OM01247 FAILED'
[Terminate Program with Error]
The system handles the email failure condition → The program is terminated abnormally with the error condition

Module: GCX152 1 Consolidated Epic Story

Epic: GCX152 Complete EDI Specification Extracted from Legacy

Contains 90 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX152 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Cargo Retrieval Parameters]
The system begins cargo retrieval process → The cargo retrieval parameters are cleared and set to retrieve all segments with no underscore movement and no index usage
[Initialize Cargo Segment Deletion]
The system begins the cargo segment deletion process → A flag is set to indicate more cargo segments need to be processed and the deletion loop is initialized
[Initialize EDI 309 Message Structure]
The system begins EDI message preparation → The EDI 309 message structure is initialized to spaces
[Initialize EDI Parameters]
The system prepares EDI transmission parameters → The action code is set to 'P' for processing, the lead US CCN key is assigned from the input message, and the transmission prefix is set from the program configuration

Core Acceptance Criteria

[Send EDI 309 Message]
The system determines which EDI processor to use → If port is valid and cargo is export, US-Canada-US, or multi-transit, call GCCS309E, otherwise call GCCS309
[Call READQ to retrieve GCX152 message]
The system calls READQ to retrieve the GCX152 input message → The GCX152 input message is retrieved from the queue with the specified message length
[Attempt to Retrieve Shipment Root Record]
The system performs a database lookup for the shipment root record using the lead key → The system executes a get unique operation against the shipment root database segment
[Set Segment Type to SHIPROOT]
The system prepares database query parameters → The segment type is set to 'SHIPROOT' to identify the main shipment record type
[Move Waybill Key from Input Message]
The system prepares to search for a specific shipment record → The waybill key from the input message is used as the search identifier for the shipment root record
[Execute Database Call to Retrieve Shipment]
The system executes the database retrieval operation → A database call is made to retrieve the shipment root record using the specified waybill key
[Retrieve SHIPMINI Record]
The system attempts to retrieve SHIPMINI record with segment type 'SHIPMIN', segment ID 'I', and segment number '1' → The SHIPMINI record is retrieved and made available for car processing
[Insert Manifest Records]
The system inserts manifest records → All cargo manifest segments are inserted into the database and action is logged appropriately based on manifest update mode
[Send EDI 309 Message]
The system sends EDI 309 message → EDI 309 message is prepared with lead US CCN key and transmission prefix, and appropriate EDI processor is called based on port validation and cargo type
[Retrieve Lead Manifest Data]
Lead manifest data retrieval is requested → The system retrieves all cargo segments from the lead manifest
[Update CCN Keys Across Segments]
CCN key update is performed → All non-empty manifest segments are updated with the new CCN key
[Send EDI 309 Message]
EDI message transmission is initiated → EDI 309 message is sent using appropriate processor based on port validation and cargo type
[Create Follower Manifest CCN]
The cargo segments are not empty (not spaces or low-values) → The system updates the CCN key in all non-empty cargo segments including GCSUSS01, GCSUSS02, GCSUSS04, GCSUSS05, GCSUSS08 array, GCSUSS03 array, GCSUSS06 array, GCSUSS07 array, GCSUSS10, GCSUSS11, GCSUSS12 array, GCSUSS13, and GCSUSS14
[Insert All Cargo Segments to Database]
All manifest data is ready for database insertion → The system calls the cargo insertion service to insert all cargo segments as a complete manifest record set
[Log Manifest Creation Action]
Completing the manifest creation or update process → If processing a manifest update, the system logs with action code 'ZZZ' and message 'MANIFEST UPDATED AUTOMATICALLY', otherwise it logs with cargo creation action code
[Set Function to Get All Cargo Segments]
The system initializes the cargo retrieval function → The function is set to retrieve all cargo segments with appropriate configuration flags
[Use Lead Manifest CCN Key]
The system prepares to retrieve cargo data → The lead manifest CCN key is assigned to the cargo retrieval key field
[Retrieve All Cargo Segments from US Cargo Database]
The system executes the cargo retrieval operation → All cargo segments for the specified manifest are retrieved from the US cargo database
[Update CCN in Cargo Segments S01]
A new follower manifest CCN is generated → The CCN key is updated in all non-empty cargo segment records
[Update GCSUSS01 Segment CCN Key]
The CCN key update process is executed → The GCSUSS01 segment CCN key is updated with the new manifest CCN key
[Update GCSUSS02 Segment CCN Key]
The CCN key update process is executed → The GCSUSS02 segment CCN key is updated with the new manifest CCN key
[Update GCSUSS04 Segment CCN Key]
The CCN key update process is executed → The GCSUSS04 segment CCN key is updated with the new manifest CCN key
[Update GCSUSS05 Segment CCN Key]
The CCN key update process is executed → The GCSUSS05 segment CCN key is updated with the new manifest CCN key
[Process All GCSUSS08 Segment Records]
The CCN key update process is executed → All GCSUSS08 records are processed sequentially from index 1 until maximum sequence is reached or empty record is found
[Update Each GCSUSS08 CCN Key]
Processing the individual GCSUSS08 record → The GCSUSS08 segment CCN key is updated with the new manifest CCN key
[Process All GCSUSS03 Segment Records]
The CCN key update process is executed → All GCSUSS03 records are processed sequentially from index 1 until maximum sequence is reached or empty record is found
[Update Each GCSUSS03 CCN Key]
Processing the individual GCSUSS03 record → The GCSUSS03 segment CCN key is updated with the new manifest CCN key
[Process All GCSUSS06 Segment Records]
The CCN key update process is executed → All GCSUSS06 records are processed sequentially from index 1 until maximum sequence is reached or empty record is found
[Update Each GCSUSS06 CCN Key]
Processing the individual GCSUSS06 record → The GCSUSS06 segment CCN key is updated with the new manifest CCN key
[Process All GCSUSS07 Segment Records]
The CCN key update process is executed → All GCSUSS07 records are processed sequentially from index 1 until maximum sequence is reached or empty record is found
[Update Each GCSUSS07 CCN Key]
Processing the individual GCSUSS07 record → The GCSUSS07 segment CCN key is updated with the new manifest CCN key
[Update GCSUSS10 Segment CCN Key]
The CCN key update process is executed → The GCSUSS10 segment CCN key is updated with the new manifest CCN key
[Update GCSUSS11 Segment CCN Key]
The CCN key update process is executed → The GCSUSS11 segment CCN key is updated with the new manifest CCN key
[Process All GCSUSS12 Segment Records]
The CCN key update process is executed → All GCSUSS12 records are processed sequentially from index 1 until maximum sequence is reached or empty record is found
[Update Each GCSUSS12 CCN Key]
Processing the individual GCSUSS12 record → The GCSUSS12 segment CCN key is updated with the new manifest CCN key
[Update GCSUSS13 Segment CCN Key]
The CCN key update process is executed → The GCSUSS13 segment CCN key is updated with the new manifest CCN key
[Update GCSUSS14 Segment CCN Key]
The CCN key update process is executed → The GCSUSS14 segment CCN key is updated with the new manifest CCN key
[Set Lead CCN Key for Manifest Lookup]
The system prepares to retrieve cargo data → The lead US CCN key is assigned to the cargo manifest US CCN key field
[Retrieve All Cargo Segments from Lead Manifest]
The system executes cargo retrieval operation → All cargo segments from the lead manifest are retrieved using the cargo interface
[Mark Manifest Status as Lead Type]
The system processes manifest status updates → The manifest is marked as lead type and if RT43 status is 'to create', it is changed to 'created'
[Search SE Table for Port Code]
The system performs table lookup with table ID 'SE' and the port location code as sequence ID → Execute table segment retrieval using GCCTBIO function with specified search parameters
[Construct Car ID from Car Initial and Car Number]
The system processes the car for manifest creation → The system concatenates the car initial and car number to form a complete car identification string
[Check if Manifest Update Required]
The system checks the manifest update flag in the input message → The system identifies whether this is an update operation for existing manifest records
[Retrieve Next Cargo Segment]
The system attempts to retrieve the next cargo segment record using the manifest key → The system performs a database lookup to find cargo segments linked to the specified manifest
[Delete Cargo Segment Record]
The system initiates deletion of the cargo segment record → The cargo segment record is retrieved using its specific key and then deleted from the database
[More Segments?]
If the continuation flag for cargo segment processing → If more segments need to be processed, the system continues the retrieval loop, otherwise it completes the deletion process
[Set More Records Flag to True]
The deletion process begins → The system sets the more records flag to true to enable iterative processing
[More Records to Process?]
The system checks if more records need to be processed → The system continues the loop if more records flag is true, otherwise terminates the deletion process
[Search for Next Cargo Segment with Manifest CCN]
The system searches for cargo segments associated with the manifest → The system performs a database search using the manifest CCN as the search criteria
[Get Cargo Segment Record]
The system needs to delete the cargo segment record → The system performs a get hold operation to retrieve the cargo segment record for deletion
[Delete Cargo Segment Record]
The system executes the deletion operation → The system performs a database delete operation to permanently remove the cargo segment record
[Set No More Records Flag]
The system determines that no more relevant records exist for deletion → The system sets the no more records flag to true to terminate the deletion loop
[Configure All Segments for Insert]
The system prepares segment configuration for insertion → All segments flag is set to true for comprehensive manifest record creation
[Log Manifest Update Action]
The system needs to record the update action → The action is logged with code 'ZZZ' and message 'MANIFEST UPDATED AUTOMATICALLY'
[Set Processing Action Code to 'P']
The system sets the action code → The action code is set to 'P' for processing
[Set Lead Manifest CCN Key]
The system sets the manifest identifier → The lead US CCN key from the input message is assigned to the EDI message
[Set Program Transmission Prefix]
The system sets the transmission prefix → The program transmission prefix from the input message is assigned to the EDI message
[Check Port Validation and Manifest Type]
If port validity AND manifest type is export:
US-Canada-US
multi-transit
→ The enhanced EDI 309 processor (GCCS309E) is selected, otherwise the standard processor (GCCS309) is used
[Call Export EDI 309 Program GCCS309E]
The system processes the EDI 309 transmission → The enhanced EDI 309 program GCCS309E is called with the prepared message structure
[Call Standard EDI 309 Program GCCS309]
The system processes the EDI 309 transmission → The standard EDI 309 program GCCS309 is called with the prepared message structure
[Evaluate port validation status and manifest type to select appropriate EDI transmission program]
If the port is valid AND the manifest is either export type:
US-Canada-US transit type
multi-transit type
→ If any of these conditions are true, select enhanced EDI program GCCS309E, otherwise select standard EDI program GCCS309
[Port Valid AND Export Manifest?]
The port is valid AND the manifest type is export → Select the enhanced EDI transmission program GCCS309E
[Port Valid AND US-Canada-US Transit?]
The port is valid AND the manifest type is US-Canada-US transit → Select the enhanced EDI transmission program GCCS309E
[Port Valid AND Multi-Transit?]
The port is valid AND the manifest type is multi-transit → Select the enhanced EDI transmission program GCCS309E
[Select GCCS309E Program Enhanced EDI Transmission]
The enhanced EDI program GCCS309E is selected → Execute the GCCS309E program with the manifest data
[Execute Selected EDI Program]
The standard EDI program GCCS309 is selected → Execute the GCCS309 program with the manifest data
[Check Port Validation and Manifest Type]
If port validity and manifest type conditions → If the port is valid AND the manifest is export type OR US-Canada-US type OR multi-transit type, then GCCS309E program is selected, otherwise GCCS309 program is selected
[Call GCCS309E Program Export/Transit Processing]
The system executes EDI transmission → The GCCS309E program is called with the EDI parameters to handle enhanced transmission processing
[Call GCCS309 Program Standard Processing]
The system executes EDI transmission → The GCCS309 program is called with the EDI parameters to handle standard transmission processing
[Set Log Message Text]
An audit log entry is being created → A descriptive message should be set that identifies whether it was an equipment update, manifest creation, or manifest update action
[Write Log Message to System]
The log entry needs to be persisted → The log entry should be written to the audit logging system using the appropriate logging service
[Purge Message Queue]
The logging process is completing → The message queue should be purged to remove the processed log message
[Check Input Message Type]
The system checks if GCX152-MANIFEST-EQUIP-UPDATE flag is set → The system routes to equipment update processing if the flag is true, otherwise continues with normal manifest processing
[Set CCN Key from Lead Manifest]
The system prepares to log the equipment update action → The lead US CCN key from the input message is moved to the cargo record US CCN key field
[Set Message: 'EQUIPMENT UPDATE, MANIFEST NOT UPDATED']
The system prepares the log message for the equipment update → The message is set to 'EQUIPMENT UPDATE, MANIFEST NOT UPDATED' to clearly indicate the scope of the update
[Log Equipment Update Action]
The system needs to record the equipment update activity → The log action procedure is performed to write the equipment update record to the audit trail

Structural Validations

[Message retrieved successfully?]
The message retrieval return code equals zero → The system continues processing with the retrieved message
[Set error message: 'INVALID RETURN FROM READQ']
The message retrieval return code != zero → The system sets the error message to 'INVALID RETURN FROM READQ'
[Call error handler CERR]
The system needs to handle the message retrieval error → The system calls the CERR error handler with the error information
[Port Location Available?]
The system checks the port location field in the cargo manifest → If port location identifier is not blank, it is extracted for validation, otherwise it is marked as blank
[Port Location Code Present?]
The system checks the port location field (GCUSRT-P401-LOCATION-ID) → If the port location code is not spaces, proceed with table lookup; otherwise set invalid port flag and display error message
[Cargo Segment Found?]
The system checks the operation status → If the status indicates success, the system proceeds to validate segment ownership, otherwise it completes the deletion process
[Segment Belongs to Manifest?]
The system compares the segment's US CCN key with the manifest's US CCN key → If the keys match, the segment belongs to the manifest and should be deleted, otherwise the deletion process is complete
[Cargo Segment Found?]
If the search results → The system determines if a cargo segment record was found based on the database status code being spaces
[CCN Matches Target Manifest?]
The system compares the cargo segment's CCN with the target manifest CCN → The system confirms the match if the cargo segment CCN equals the target manifest CCN
[Select GCCS309 Program Standard EDI Transmission]
The manifest does not meet criteria for enhanced processing (invalid port:
not export/US-Canada-US/multi-transit type)
→ Select the standard EDI transmission program GCCS309

Module: GCX153 1 Consolidated Epic Story

Epic: GCX153 Complete EDI Specification Extracted from Legacy

Contains 59 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX153 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize MQ Message Structure]
The system begins MQ message preparation → The MQ message structure is initialized to clear any previous data
[Initialize MQ Message Structure]
The message preparation process begins → The MQ message structure is initialized to clear any previous data
[Initialize Message ID and Correlation ID]
Message identification parameters are being configured → The system initializes both message ID and correlation ID to none values for new message generation

Core Acceptance Criteria

[4:MQ Connection]
The system attempts to connect to the MQ manager → If connection fails, log 'CONN FAILED' error and terminate processing
[5:Message Preparation]
The system prepares message for transmission → Extract 90 characters from position 2-91 of input data and set as message text
[6:Queue Configuration]
The system configures queue parameters → Set queue name to 'IH.IF.CUSTOMS.STATUS', message type to datagram, format to string, and buffer length to 90 characters with syncpoint and default context options
[7:Message Publishing]
The system attempts to publish the message → If message publishing fails, log 'PUT1 FAILED' error and terminate processing
[8:MQ Disconnection]
The system attempts to disconnect from MQ manager → If disconnection fails, log 'DISC FAILED' error and terminate processing
[9:Log Entry Preparation]
The system prepares transaction log entry → Create log entry with CCN, record type, current date/time, CCN status, action code 'ZZZ', sending transaction 'GCCIH', and user ID
[10:Status Logging]
The system performs status logging → Write log message to system with all transaction details including CCN status and processing timestamp
[11:Transaction Logging]
The system completes transaction logging → Finalize log message writing with proper message codes and lengths
[Execute READQ Call]
The system executes the READQ operation to retrieve the message → The message content is loaded into the input buffer with specified length for further processing
[Security Validation Passed - Continue]
The security byte is not high-values AND CCN is not spaces or low-values AND CCN Status is not spaces or low-values → Security validation passes and main processing continues
[Move Message Data to Screen Buffer]
The system processes the input message for mainline operations → The input message data is moved to the screen buffer SCR
[Move Input Data to Message Text]
The system prepares the message for MQ transmission → Characters 2 through 91 from the input data are moved to the MQ message text field
[Extract Input Data from Position 2 to 91]
The system processes the input data for message preparation → Exactly 90 characters are extracted from positions 2 to 91 of the input message
[Move Input Data to Message Text Field]
The data needs to be placed into the message queue structure → The extracted data is moved to the MQ message text field
[Set Output Options for Queue Access]
Queue access options are being configured → The system sets output options to enable message sending capabilities
[Configure Message Options with Syncpoint and Default Context]
Message processing options are being set up → The system combines syncpoint control with default context settings for message operations
[Set Target Queue Name to 'IH.IF.CUSTOMS.STATUS']
The target queue is being configured → The system sets the queue name to 'IH.IF.CUSTOMS.STATUS' for customs status processing
[Clear Reply Queue Settings]
Reply queue settings are being established → The system clears both reply queue name and reply queue manager to indicate no response expected
[Set Message Type to Datagram]
Message type is being configured → The system sets the message type to datagram for one-way communication without expecting a response
[Set Message Format to String]
Message format is being configured → The system sets the message format to string type for text-based content transmission
[Set Buffer Length to 90 bytes]
Buffer length is being set for message transmission → The system sets the buffer length to exactly 90 bytes for message content
[Set Queue Output Options]
The system prepares queue configuration → The queue output options are set to MQOO-OUTPUT to enable message publishing
[Configure Message Options for Syncpoint and Default Context]
The system configures message publishing options → The options are set to combine MQPMO-SYNCPOINT and MQPMO-DEFAULT-CONTEXT for transactional delivery with standard message context
[Set Target Queue Name to 'IH.IF.CUSTOMS.STATUS']
The system configures the target queue → The queue name is set to 'IH.IF.CUSTOMS.STATUS' for customs status message processing
[Clear Queue Manager Name]
The system sets up queue manager routing → The queue manager name is set to spaces to use the default queue manager
[Clear Reply Queue Information]
The system configures reply queue settings → Both reply queue name and reply queue manager are set to spaces to indicate no reply is expected
[Set Message ID to None]
The system configures message identification → The message ID is set to MQMI-NONE to let the queue manager assign a unique identifier
[Set Correlation ID to None]
The system configures message correlation → The correlation ID is set to MQCI-NONE to indicate no correlation with other messages
[Set Message Type to Datagram]
The system configures message type → The message type is set to MQMT-DATAGRAM for one-way communication
[Set Message Format to String]
The system configures message format → The message format is set to MQFMT-STRING to handle string data
[Execute MQPUT1 to Send Message]
The system executes the message publishing operation → MQPUT1 is called with connection handle, object descriptor, message descriptor, put options, buffer length, and message content
[Message Sent Successfully?]
The system checks the completion code → If completion code equals MQCC-OK then message publishing is successful, otherwise it has failed
[Copy CCN from Input Message]
Creating a log entry → The CCN from the input message is copied to the log entry train or US CCN field
[Copy Record Type from Input Message]
Creating a log entry → The record type from the input message is copied to the log entry record type code field
[Copy Status from Input Message]
Creating a log entry → The CCN status from the input message is copied to the log status field
[Build Status Log Message]
Building the log message → The log message is constructed using the captured status information
[Prepare Final Log Message Structure]
Preparing for log transmission → The complete log input structure is moved to the final message format
[Copy CCN from Input Message]
Creating a log entry → The CCN is copied to the train or US CCN field in the log structure
[Copy Record Type from Input Message]
Creating a log entry → The record type is copied to the record type code field in the log structure
[Copy Status from Input Message]
Creating a log entry → The CCN status is copied to the log status field
[Build Expressway Notification Message]
A descriptive message is needed → The log message is set to indicate Expressway notification of the status
[Complete Log Message Structure]
The log structure is complete → The log input structure is copied to the message format for processing
[Call WRITMSGL to Write Log Message]
The system needs to persist the log message → The system must call WRITMSGL with CCCOM, ALT-PCB, message code, message content, message length, and module name parameters
[Transaction Logging Complete]
The logging process needs to be completed → The system must call CIMS with PURG command using CCCOM and ALT-PCB parameters to purge the transaction

Structural Validations

[1:Message Reading]
The system attempts to read the message → If the message reading fails, the system must terminate processing and exit with error
[2:Security Validation Passed?]
The system validates the input data → If security byte is not properly set OR CCN is empty OR CCN status is empty, then terminate processing immediately
[Return to Main Process]
The system checks the return code from the message reading operation → If the return code is not zero, the system terminates processing with an error, otherwise it continues to the next step
[Security Byte = High-Values?]
The security byte equals high-values → The security validation fails and processing terminates
[CCN = Spaces or Low-Values?]
The CCN field equals spaces or low-values → The security validation fails and processing terminates
[CCN Status = Spaces or Low-Values?]
The CCN Status field equals spaces or low-values → The security validation fails and processing terminates
[Format Error Message]
The system processes the connection failure → The reason code is formatted for display, error message text is initialized and populated using GCCMQERR, MQ error text is set, program error text is set to 'CONN FAILED', and the complete error message is prepared
[Call Error Handler]
The system needs to report the connection failure → The error handler CERR is called with the formatted error information
[Set Buffer Length to 90 bytes]
The system configures message buffer size → The buffer length is set to 90 bytes to match the message content size
[Handle Publishing Error]
The completion code is not MQCC-OK → The system generates error message 'PUT1 FAILED', retrieves detailed error information, and terminates processing
[Handle Disconnection Error]
The system processes the disconnection error → The system moves the reason code to display format, initializes output message text, calls error handling to get error description, sets MQ error text, sets program error text to 'DISC FAILED', and sets the complete error message
[Exit with Error]
The system needs to terminate due to disconnection failure → The system calls error handler with communication control block and exits the program

Module: GCX160 1 Consolidated Epic Story

Epic: GCX160 Complete EDI Specification Extracted from Legacy

Contains 23 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX160 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[7:Map Bond Type Code]
The system processes the bond type code → The system searches the bond type lookup table and maps the internal bond type code to the corresponding EDI format value, or sets to spaces if no match found
[9:Extract Vehicle Information]
The system begins vehicle information extraction → The system initializes VIN sequence counter and sets up to process VIN data from multiple segments
[10:Load VIN Data]
The system processes each VIN segment → The system loads up to 7 VINs per segment, up to a maximum of 36 total VINs, skipping any VIN entries that are spaces or low-values, and continues until all segments are processed or VIN capacity is reached
[Execute Database Query for First US Manifest Record]
Executing the database query to get the first manifest record → The system should call the database interface with GU operation using GCUS-PCB6 and GCSUSRT segments with SSAQ-A6RT search criteria
[Map Bond Type Code Using Lookup Table]
Formatting the Honda output record → The internal bond type code is searched in the lookup table and if found, the corresponding EDI value is used, otherwise spaces are set
[Map to EDI 309 Format Code]
The system searches the lookup table for a matching internal bond type code → The corresponding EDI 309 format code is assigned to the output bond type field
[Map Bond Type Code - Convert internal bond type code to EDI 309 format using lookup table]
The system processes the bond type code conversion → The system searches the lookup table for a matching internal bond type code and assigns the corresponding EDI 309 value, or assigns blank if no match is found
[Get Corresponding EDI 309 Value]
The system processes the matched table entry → The system retrieves the corresponding EDI 309 value from the same table entry position
[Set Bond Type to EDI 309 Format]
The system assigns the bond type value to the output record → The output bond type field is populated with the EDI 309 format value
[Extract VIN Number]
Extracting the VIN number → The VIN value from the current segment index is retrieved for storage
[Move to Next VIN in Record]
Moving to the next VIN in the same record → The segment index is incremented by 1 to access the next VIN position
[Extract VIN Number]
The VIN extraction process is executed → The VIN value is moved from the segment array to the Honda output record at the current sequence position
[Store VIN in Honda Output Record]
The VIN needs to be stored in the output record → The VIN is moved to the Honda output VIN array at the current Honda sequence position
[Move to Next VIN in Type 6 Record]
More VINs may exist in the same segment → The segment index counter is incremented to access the next VIN position
[Increment VIN Sequence Counter]
The system needs to check for additional VIN segments → The VIN sequence counter is incremented to access the next Type 6 record
[Access Type 6 Record for Current VIN Position]
The system attempts to access the Type 6 record segment for the current VIN position → The system retrieves the vehicle record segment containing VIN data
[More Vehicle IDs in Record?]
The current vehicle ID position has been processed → If the position counter is 7 or less, continue processing, otherwise complete the current record
[Move to Next Vehicle ID Position]
The system needs to continue processing within the current record → The system increments the vehicle ID position counter to process the next vehicle ID in the segment

Structural Validations

[Report Date Calculation Error]
The date calculation service indicates failure → An error message 'ISCDTCAL ERROR' is reported through the error handling system
[Report Date Conversion Error]
The date conversion service returns an error code other than '0' → An error message 'ISCDATECV ERROR' is reported through the error handling system
[More VINs in Record AND Total VINs < 36?]
Checking if more VINs can be processed → Continue processing if segment index is 7 or less AND Honda sequence is 36 or less AND current VIN is not spaces or low-values
[More VINs in Record AND Honda Sequence ≤ 36?]
If whether to continue processing VINs from the current segment → Continue if the segment index is 7 or less AND the Honda sequence counter is 36 or less AND the current VIN is not spaces or low-values
[Vehicle ID Not Empty?]
The system examines the vehicle ID content → If the vehicle ID is not spaces and not low-values, extract the VIN, otherwise skip to next position

Module: GCX162 1 Consolidated Epic Story

Epic: GCX162 Complete EDI Specification Extracted from Legacy

Contains 12 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX162 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[11:Generate Delete Keys]
The system creates deletion tracking information → Write a delete key record containing segment name 'GCSUSS15', the record's primary key, and the count of errors found
[Date Validation Successful?]
System checks the validation result → If validation is successful, continue processing; if not successful, set error message and terminate program
[Generate Delete Key Record]
The system generates a deletion key record → A record is written to DLETKEYS-FILE containing segment name 'GCSUSS15', the primary key from the processed record, and the count of errors found
[Set Segment Name to 'GCSUSS15']
The system is creating a delete key for an error record → The segment name field is set to 'GCSUSS15' to identify the error record segment type
[Write Delete Key Record to File]
The system has completed generating the delete key information → The delete key record is written to the delete keys file for later processing

Structural Validations

[4:Validate Input Date]
The system validates the date format and validity → If the date is invalid, display error message 'INVALID DATE ENTERED ON DATECARD' and terminate program
[Use Date from Control Card]
Date validation is performed using ISCDATCV function → If date validation succeeds, the date is accepted; if validation fails, an invalid date error message is set and program abends
[Validate date from control card using date conversion routine]
The system validates the date using date conversion routine → If the date is valid, processing continues; if invalid, system displays error message 'INVALID DATE ENTERED ON DATECARD' and terminates
[Set Error Message: 'INVALID DATE ENTERED ON DATECARD']
System processes the validation failure → Error message 'INVALID DATE ENTERED ON DATECARD' is set in the common communication area
[Terminate Program with Error]
System needs to handle the invalid date condition → Program termination routine is performed to end processing
[Copy Error Record Primary Key]
The system is generating delete keys for the error record → The primary key from the error record is copied to the delete key record for unique identification
[Set Error Count from Processing]
The system is finalizing the delete key generation → The number of errors processed from the current record is stored in the delete key record

Module: GCX163 1 Consolidated Epic Story

Epic: GCX163 Complete EDI Specification Extracted from Legacy

Contains 21 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX163 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Add Lines to Email Content]
The system prepares email content for distribution → Each summary line is added to the email message content and the email line counter is incremented
[Trigger System Abend]
The system needs to handle the email failure condition → The system calls the error handling routine to terminate processing and notify operations of the failure

Structural Validations

[8:Lookup Error Code Descriptions]
The system looks up the error code in the MS message table → If found, the English text description is retrieved, otherwise an error message indicating table entry not found is generated
[19:Send Report via Merlin Email System]
Email transmission completes with return status 0 → Processing continues normally, but if return status is 2 then invalid Merlin ID error is reported, otherwise invalid return from Merlin send error is reported and program terminates
[Error Description Found?]
The lookup operation completes → If the error description is found, use the retrieved message; otherwise, set an appropriate 'not found' message
[Use Retrieved Error Message]
The system needs to set the error message for reporting → The retrieved error description from the MS table should be used as the error message
[Set 'Error Code Not Found' Message]
The system needs to set an error message for reporting → A message should be constructed indicating 'MS TABLE ENTRY NOT FOUND FOR ERROR CODE' followed by the specific error code
[Format Error Type Report Line]
The system needs to prepare the error type information for reporting → A report line should be formatted containing the error count and error message information
[Write Error Type Line to Report]
The system needs to output the error type summary → The error type line should be written to the error report file and added to the email message buffer
[Lookup Error Description in MS Table]
The system needs to provide a meaningful error description for reporting → The error code must be used to lookup the corresponding error description in the MS message table
[Error Description Found?]
The error code is not found in the message table → The system must set the error message to 'MS TABLE ENTRY NOT FOUND FOR ERROR CODE' followed by the specific error code
[Use Retrieved Error Message]
The error code is found in the message table → The system must use the retrieved English text description as the error message for the report
[Retrieve English Error Message Text]
System needs to display error description → The English text from MS table record is moved to the report error message field
[Set Default Message: 'MS TABLE ENTRY NOT FOUND FOR ERROR CODE']
System needs to display error description → A default message 'MS TABLE ENTRY NOT FOUND FOR ERROR CODE' concatenated with the error number is set as the error message
[Use Retrieved Error Description]
The system needs to set the error message for the report → The English text from the MS table entry is moved to the report error message field
[Set Default Message: 'MS TABLE ENTRY NOT FOUND FOR ERROR CODE']
The system needs to set an error message for the report → A default message 'MS TABLE ENTRY NOT FOUND FOR ERROR CODE' concatenated with the error number is created
[Format Error Type Report Line]
The system needs to create a report line for this error type → The error count is moved to the report total field to format the complete error type line
[Write User Error Report Sub-Header]
The system begins generating the user error report → The user error report sub-header is written to both the report file and stored for email transmission
[Email Sent Successfully]
The email service returns a status code of 0 → The system continues normal processing indicating successful email transmission
[Set Error: Invalid Merlin ID]
The email service returns a status code of 2 indicating invalid recipient identification → The system sets an error message 'INVALID MERLIN ID ON INPUT CARD' for business user notification
[Set Error: Invalid Return from Merlin]
The email service returns any status code other than 0 or 2 → The system sets an error message 'INVALID RETURN FROM MERLIN SEND' for business user notification

Module: GCX164 1 Consolidated Epic Story

Epic: GCX164 Complete EDI Specification Extracted from Legacy

Contains 2 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX164 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[6:Check Line Count Limit]
The system checks segmentation conditions → If line count exceeds maximum Merlin lines AND the current manifest record contains only spaces, prepare to insert additional headers
[7:Insert Additional Email Headers]
Additional email headers need to be inserted → Six email header lines are written to the output file and line counter is reset to 6

Structural Validations

None explicitly identified in logic extraction.

Module: GCX165 1 Consolidated Epic Story

Epic: GCX165 Complete EDI Specification Extracted from Legacy

Contains 32 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX165 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[4:Write US Root Segment]
The US root segment writing process is executed → The cargo root data is moved to the output record and written to the output file
[5:Write Type 3 Records]
The Type 3 record writing process is executed → The segment type is set to GCSUSS03 and the specialized Type 3 cargo processing routine is performed
[6:Write Type 6 Records]
The Type 6 record writing process is executed → The segment type is set to GCSUSS06 and the specialized Type 6 cargo processing routine is performed
[7:Write Type 8 Records]
The Type 8 record writing process is executed → The segment type is set to GCSUSS08 and the specialized Type 8 cargo processing routine is performed
[8:Write Type 13 Records]
The Type 13 record writing process is executed → The segment type is set to GCSUSS13 and the specialized Type 13 cargo processing routine is performed
[Prepare Cargo Search Parameters]
The system prepares to search for cargo data → The cargo search structure is cleared and the segment type is set to root segment (GCSUSRT)
[Write US Root Segment to Output]
The system processes the root segment output → The US root segment data is written to the output file
[Write Type 3 Manifest Records to Output]
The system processes Type 3 manifest records → The cargo search structure is prepared for Type 3 segment (GCSUSS03) and Type 3 manifest processing is performed
[Write Type 6 Manifest Records to Output]
The system processes Type 6 manifest records → The cargo search structure is prepared for Type 6 segment (GCSUSS06) and Type 6 manifest processing is performed
[Write Type 8 Manifest Records to Output]
The system processes Type 8 manifest records → The cargo search structure is prepared for Type 8 segment (GCSUSS08) and Type 8 manifest processing is performed
[Write Type 13 Manifest Records to Output]
The system processes Type 13 manifest records → The cargo search structure is prepared for Type 13 segment (GCSUSS13) and Type 13 manifest processing is performed
[Search Database for Cargo Record]
The system executes the database search → The database search is performed using the CCN key to retrieve the cargo root segment
[Clear Output Record Buffer]
The write US root segment process begins → The output record buffer is cleared of all existing data
[Extract US Root Segment Data from Cargo Database]
US root segment data needs to be extracted → The system retrieves root segment data from HRDB-P1GCUS-GCSUSRT-AREA
[Move Root Segment Data to Output Buffer]
The data needs to be prepared for output → The root segment data is moved from HRDB-P1GCUS-GCSUSRT-AREA to the output record buffer
[Write US Root Segment to Output File]
The system writes the root segment to output → The US root segment record is written to the output file
[Set Type 3 Segment Flag GCSUSS03]
The system needs to identify the segment type for processing → The GCSUSS03 segment flag is set to true for Type 3 manifest records
[Process US Cargo Type 3 Records X7023-PRCS-USCARGO-GCSUSS03]
Type 3 manifest records need to be processed → The X7023-PRCS-USCARGO-GCSUSS03 processing routine is executed to handle Type 3 records
[Set Type 3 Segment Flag GCSUSS03]
Type 3 cargo record processing is configured → The segment flag should be set to GCSUSS03 for the first occurrence
[Process US Cargo Type 3 Records X7023-PRCS-USCARGO-GCSUSS03]
Type 3 cargo record processing is executed → The X7023-PRCS-USCARGO-GCSUSS03 processing routine should be invoked
[Set Type 6 Segment Indicator]
The system needs to identify the segment type for processing → The GCWUSIO2-SEG-GCSUSS06 indicator is set to TRUE for the first occurrence
[Process US Cargo Type 6 Records]
Type 6 manifest records need to be processed → The X7026-PRCS-USCARGO-GCSUSS06 processing routine is executed
[Set Segment Type to GCSUSS06]
The segment type needs to be specified for Type 6 records → The system sets the segment indicator to GCSUSS06 for the first occurrence
[Process US Cargo Type 6 Records]
Type 6 record processing is executed → The system invokes the specialized Type 6 processing routine X7026-PRCS-USCARGO-GCSUSS06
[Set Type 8 Segment Flag GCSUSS08]
The system needs to identify the segment type for processing → The GCSUSS08 segment flag is set to true for the first occurrence
[Process US Cargo Type 8 Records X7028-PRCS-USCARGO-GCSUSS08]
Type 8 manifest records need to be processed → The specialized US cargo Type 8 processing routine X7028-PRCS-USCARGO-GCSUSS08 is executed
[Set Segment Type to GCSUSS08]
The segment type needs to be specified for Type 8 cargo records → The system must set the segment type to GCSUSS08 for the first occurrence
[Process US Cargo Type 8 Records X7028-PRCS-USCARGO-GCSUSS08]
Type 8 cargo records need to be processed → The system must execute the X7028-PRCS-USCARGO-GCSUSS08 processing routine
[Set Type 13 Segment Flag]
The segment type needs to be specified for Type 13 records → The GCSUSS13 segment flag is set to true in the first occurrence
[Process US Cargo Type 13 Records]
Type 13 manifest records need to be processed → The X7033-PRCS-USCARGO-GCSUSS13 processing routine is executed
[Set Type 13 Segment Flag]
The system prepares to access Type 13 cargo data → The GCSUSS13 segment flag is set to true in the first occurrence
[Process US Cargo Type 13 Records]
The system is ready to process Type 13 cargo data → The X7033-PRCS-USCARGO-GCSUSS13 processing routine is executed

Structural Validations

None explicitly identified in logic extraction.

Module: GCX166 1 Consolidated Epic Story

Epic: GCX166 Complete EDI Specification Extracted from Legacy

Contains 64 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX166 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Queue Open Successful?]
The queue open completion code indicates failure → The system terminates processing with queue open failure message
[Initialize Correlation ID]
The correlation ID needs to be set → The correlation ID should be initialized to MQCI-NONE
[Initialize Message ID]
The message ID needs to be initialized → The message ID should be set to MQMI-NONE to allow automatic generation
[Initialize Connection Variables]
MQ connection process begins → Connection handle is set to zero and queue name is cleared to spaces
[Call MQ Open Function]
The queue needs to be opened for message transmission → The MQ open function should be called with connection handle, object descriptor, options, and result parameters
[Open MQ Queue for Output]
Opening queue for message transmission → The queue should be opened with the specified name and output options
[Queue Open Successful?]
Checking the completion status → If the operation failed, the process should be terminated, otherwise continue with message formatting

Core Acceptance Criteria

[8: Batch Limit Reached?]
Read count reaches:
exceeds 24,998 records
end of file is reached
→ Current batch processing is triggered and batch is prepared for transmission
[5: Create MQ Message Header]
Message is prepared for transmission → Message length equals 45 bytes plus read count multiplied by 80 bytes per record
[7: Connect to Message Queue]
Message queue connection is required → MQCONNC is called with queue manager name to establish connection
[8: Send Data to Mercator Server]
Data transmission is initiated → MQPUT is called to send message with calculated length and formatted data to specified queue
[10: Close MQ Resources]
Message transmission is complete → MQCLOSE is called to close queue object and MQDISCC is called to disconnect from queue manager
[Send Current Batch to MQ]
The system initiates batch transmission → The system connects to the message queue manager AND opens the target queue AND calculates message length as 45 plus record count times 80 AND sends the batch message to the queue AND closes the queue connection
[More Records Available?]
If continuation conditions → The system determines if more records are available by checking if not at end of file AND record count is greater than 24,998
[Prepare Message Format]
The system prepares message transmission parameters → Message format is set to string format and put message options are configured
[Calculate Message Length 45 + Record Count × 80]
The system prepares to send the batch message → Message length is calculated as 45 bytes header plus read count multiplied by 80 bytes per record
[Send Message to Queue]
The system sends the Honda batch message to the queue → The complete batch of Honda records is transmitted as a single message
[Close Output Queue]
The system closes the output queue → Queue handle is released and queue resources are freed
[Set Message Function Type]
The message header creation process begins → The message function type should be set to PUT operation
[Configure Queue Object Type]
The queue object configuration is being set → The object type should be configured as a standard queue (MQOT-Q)
[Set Target Queue Name]
The MQ message header is being prepared → The target queue name should be set to the configured queue name value
[Set Output Options]
The message queue options are being configured → The options should be set to MQOO-OUTPUT for output operations
[Calculate Message Length
45 bytes header + Records × 80 bytes, Calculate Message Length 45 + Record Count × 80]
The message length needs to be calculated for MQ transmission → The message length should be computed as 45 bytes plus the record count multiplied by 80 bytes per record
[Set Message Format to String]
The message format needs to be specified for Honda data transmission → The message format should be set to MQFMT-STRING
[Set Put Message Options]
The put message options need to be configured → The put message options should be set to MQPMO-NONE for standard processing
[Calculate Total Message Length]
The system prepares to send Honda data via MQ → The message length is calculated as 45 bytes for header plus read count multiplied by 80 bytes per record
[Set Message Format to String]
The system prepares message properties for Honda data transmission → The message format is set to string format
[Set Message Format to String]
The system prepares message options for Honda data transmission → The put message options are set to none
[Create Single MQ Message Package]
The system sends Honda data via MQ → The complete MQ output structure containing header and Honda records is transmitted as one message
[Connect to Queue Manager Using Configuration Name]
System attempts to connect to message queue manager → Connection is established using the configured queue manager name and connection handle is returned
[Calculate Message Length - 45 bytes header + Records × 80 bytes]
The system prepares to send the batch message → The system calculates message length as 45 bytes plus read count multiplied by 80 bytes per record
[Set Message Format to String]
The system prepares message properties for Honda data → The system sets the message format to string format
[Set Message Options]
The system prepares message transmission options → The system sets message options to none for standard transmission
[Put Message to Queue]
The system executes the message transmission → The system puts the Honda data message to the MQ queue using calculated length and output structure
[Transmission Successful?]
The system checks the transmission result → The system proceeds to close queue if transmission succeeded, otherwise handles transmission failure
[Close MQ Queue]
The system completes the transmission process → The system closes the MQ queue with appropriate options
[Set Queue Function to PUT]
The queue function needs to be configured for message transmission → The MQ function should be set to PUT operation mode
[Set Queue Options for Output]
Queue access options are being configured → The queue options should be set to output mode (MQOO-OUTPUT)
[Clear Message Correlation ID]
Message correlation settings need to be initialized → The correlation ID should be set to none (MQCI-NONE)
[Clear Message ID]
Message identification settings need to be initialized → The message ID should be set to none (MQMI-NONE)
[Set Message Format to String]
Message format needs to be specified for data transmission → The message format should be set to string format (MQFMT-STRING)
[Set Put Message Options]
Put message options need to be configured → The put message options should be set to none (MQPMO-NONE) for default behavior
[Set Message Function to PUT]
The put message process is initiated → The MQ function should be set to PUT operation
[Configure Queue Object Type]
The queue object is being set up → The object type should be set to queue type
[Set Queue Name from Parameters]
Setting up message queue for output → The queue name from parameters should be assigned to the queue object
[Set Output Options]
Configuring queue options → The options should be set to output mode
[Calculate Message Length 45 + Record Count × 80]
Preparing to send message to queue → Message length should be calculated as 45 plus the read count multiplied by 80
[Clear Message Correlation ID]
Setting up message properties → The correlation ID should be set to none
[Clear Message ID]
Setting up message properties → The message ID should be set to none
[Set Message Format to String]
Configuring message properties → The message format should be set to string format
[Set Put Message Options]
Setting up message transmission parameters → Put message options should be set to none
[Put Message to Queue]
Transmitting the message → The message should be sent to the queue using the calculated length and prepared data
[Message Put Successful?]
Checking the transmission status → If the transmission failed, the process should be terminated, otherwise proceed to close the queue
[Close MQ Queue]
Completing the message transmission process → The queue should be closed properly
[Close MQ Queue]
The system initiates the queue closure process → The MQ queue should be closed using MQCO-NONE option and the closure operation should complete successfully
[Queue Close Successful?]
The MQ queue close operation fails with completion code equal to MQCC-FAILED → The system should display an error message with the completion code and reason code, then terminate the program execution
[Disconnection Successful?]
The MQ manager disconnection operation fails with completion code equal to MQCC-FAILED → The system should display an error message with the completion code and reason code, then terminate the program execution

Structural Validations

[3: Convert Data Format]
Record is processed for message preparation → All LOW-VALUES are converted to SPACES and all HIGH-VALUES are converted to SPACES
[Connection Successful?]
The connection completion code indicates failure → The system terminates processing with connection failure message
[Message Sent Successfully?]
The message put completion code indicates failure → The system terminates processing with message send failure notification
[Queue Closed Successfully?]
The queue close completion code indicates failure → The system terminates processing with queue close failure message
[Disconnection Successful?]
The disconnection completion code indicates failure → The system terminates processing with disconnection failure message
[Connection Successful?]
Connection completion code is evaluated → If connection failed, system terminates processing with connection failure message

Module: GCX170 1 Consolidated Epic Story

Epic: GCX170 Complete EDI Specification Extracted from Legacy

Contains 36 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX170 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Status Indicators]
Database access is initiated for log root record retrieval → Accept status is set to 'GEGB', status code is cleared, and log root segment is initialized

Core Acceptance Criteria

[9:Write History Record]
The system processes the record for archival → The system increments the deletion counter, writes the log root segment to history file, and writes the log root key to keys file
[11:Process Dependent Records]
The system finds dependent log records associated with the root record → The system writes each dependent record segment to the history file until no more dependent records exist
[Perform Checkpoint]
An IMS shutdown request is received → The system displays a shutdown message and terminates the program abnormally
[Set Current System Date for Age Calculations]
Date comparison baseline needs to be established → Concatenate CC-MACHINE-CENTURY and CC-MACHINE-DATE-X from CCCOM into TIMEDIFF-DATE1 and set TIMEDIFF-TIME1 to zeroes
[Use Checkpoint Number from File]
The checkpoint number is numeric AND the checkpoint number is greater than or equal to 1 → The system uses the checkpoint number from the file and displays the checkpoint setting message
[Table Access Successful?]
The table access operation completes → If the operation is successful, the retrieved data must be moved to GCSTBRT-AD, otherwise an error message must be constructed and the program must be terminated
[Call Database to Get Next Log Root Record]
System requests the next log root record using hierarchical navigation → Database service is called with get-next-hierarchical command to retrieve the next log root segment
[Log Record Available?]
No more log records are available to read (LGRT-READ-IS-DONE condition is true) → The system sets the purge time reach flag to true to indicate immediate processing
[Copy Log Root Data to History Record]
Log root data needs to be archived → The log root segment data is copied to the history record log root field
[Copy Dependent Record to History]
Processing each dependent record → The dependent log segment is copied to the history record and written to the history file
[Dependent Record Found?]
The system attempts to read the first dependent log segment → If no dependent records are found, write only the root record to history file and complete processing
[Move Dependent Segment Data to History Record]
The dependent record needs to be prepared for archival → Move the dependent segment data to the history record structure
[Read First Dependent Log Segment]
The system begins processing dependent records → The system should read the first dependent log segment associated with the root record
[Dependent Record Found?]
No dependent log segments are found for the root record → The system should write only the root record to the history file and complete processing
[Write Root Record to History File]
The system determines there are no dependent segments → The system should write the root record to the history file
[Move Dependent Segment to History Record]
The system processes the dependent record for archival → The system should move the dependent segment data to the history record structure
[Write Dependent Record to History File]
The system writes the dependent record → The system should write the dependent record to the history file
[Read Next Dependent Log Segment]
The system continues processing dependent records → The system should read the next dependent log segment in sequence
[More Dependent Records?]
The system checks for additional dependent records → The system should determine if more dependent records exist or if processing is complete
[Display Shutdown Message]
The system processes the shutdown request → The system displays shutdown message and sets error message for abnormal termination
[Terminate Processing]
The system needs to terminate processing → The system calls abnormal termination procedure
[Display Shutdown Message]
The shutdown condition is confirmed → A shutdown notification message is displayed to the console
[Terminate Program]
All shutdown preparation steps are complete → The program is terminated through the abnormal termination procedure
[Execute Database Reposition Command]
The system needs to reposition to a specific log root record → A database Get Unique command is executed using the log root segment and qualified search argument

Structural Validations

[3:Read Checkpoint Configuration]
The system reads the checkpoint file and the file is empty:
the checkpoint number is not numeric
the checkpoint number is less than 1
→ The system uses the default checkpoint value and displays an invalid checkpoint message
[Use Default Checkpoint Value]
The file read operation reaches end of file (no records found) → Assign CST-CHKP-DEFAULT to IN-CHKP-NUM and display 'INVALID CHECKPOINT - DEFAULT TO' message with the default value
[Checkpoint Value Valid?]
The checkpoint value IN-CHKP-NUM is not numeric:
IN-CHKP-NUM is less than 1
→ Assign CST-CHKP-DEFAULT to IN-CHKP-NUM and display 'INVALID CHECKPOINT - DEFAULT TO' message with the default value
[File Read Successfully?]
The file read operation reaches end of file (empty or missing file) → The system sets the checkpoint number to the default value and displays an invalid checkpoint message
[Is Checkpoint Number Numeric and >= 1?]
The checkpoint number is not numeric:
the checkpoint number is less than 1
→ The system applies the default checkpoint value and displays an invalid checkpoint message
[Display Error Message]
The table access operation is unsuccessful → The system must display an error message indicating the table was not found along with the return code, and then terminate the program abnormally
[File Contains Data?]
The file contains no data or cannot be read → The system uses the default checkpoint value and displays a message indicating the default value is being used
[Is Checkpoint Value Valid?]
The checkpoint value is not numeric:
the checkpoint value is less than 1
→ The system uses the default checkpoint value and displays a message indicating the default value is being used
[Display Error Message]
The table I/O operation returns an unsuccessful status → An error message must be constructed containing 'CCN SEQUENCE NUMBER TABLE CW NOT FOUND RC=' concatenated with the return flag value and stored in the error message field
[Terminate Program with Error]
The system cannot proceed without valid purge configuration → The program must be terminated by performing the abend routine (9000-ABEND)
[Set Error Message]
The system prepares for termination → The shutdown message is assigned to the error message field for proper error handling

Module: GCX172 1 Consolidated Epic Story

Epic: GCX172 Complete EDI Specification Extracted from Legacy

Contains 15 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX172 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Log Root Segment Structure]
Database access is about to be performed → The system initializes both the status code and the log root segment structure to empty/default values
[Initialize Database Call Parameters]
The database call preparation process is initiated → The system sets accept status to 'GEGB', clears status code, and initializes the log dependent segment structure

Core Acceptance Criteria

[10:Identify Manual Cargo Changes]
The system examines the change message → The change is counted only if the first 22 characters of the message equal 'CARGO MANUALLY CHANGED'
[Abort Program Processing]
The system cannot proceed without control parameters → The system calls the error handling routine to abort program processing
[Call Database to Get Next Root Record]
The system needs to retrieve the next log root record → The system calls the database management system with GN operation, database control block, log root segment structure, and search criteria
[Retrieve Next Dependent Record]
The system executes the database retrieval operation → The system calls CIMS program with GNP operation to get next log dependent record from GCSLGDP segment
[Process Change Record]
The system processes the valid change record → The system searches for the user ID in the control file user list and increments the appropriate counters if found
[Record Identified as Manual Cargo Change]
The record meets the date range criteria and contains the manual change message → The system proceeds to match the user ID against the authorized user list for counting purposes
[Record Not a Manual Cargo Change]
The message field does not equal 'CARGO MANUALLY CHANGED' in the first 22 characters → The system skips the record and continues to the next log dependent record without counting or processing
[Count Total Manual Changes - Increment overall total change counter]
The system processes this validated manual change record → The total change counter is incremented by 1 to reflect the additional manual change in the overall count

Structural Validations

[3:Validate Control File]
The system attempts to read the first record from the control file → If the control file is empty, the system must terminate processing with an error message 'CONTROL FILE IS EMPTY'
[Control File Has Data?]
The control file read operation is completed → If no data is found, the system must terminate with an error message 'CONTROL FILE IS EMPTY' and abort processing
[Control File Has Data?]
The control file is opened and read → If the control file is empty, the system should terminate with 'CONTROL FILE IS EMPTY' error message
[Set Error Message: 'CONTROL FILE IS EMPTY']
The system needs to communicate the error condition → The system sets the error message to 'CONTROL FILE IS EMPTY' for user notification
[Check Message Field]
The system checks the first 22 characters of the message field → The record is identified as a manual cargo change if the message equals 'CARGO MANUALLY CHANGED', otherwise it is not considered a manual cargo change

Module: GCX173 1 Consolidated Epic Story

Epic: GCX173 Complete EDI Specification Extracted from Legacy

Contains 49 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX173 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Database Call Parameters]
The database call is initiated → The system sets accept status to 'GEGB' and initializes status code and log root segment to ensure clean parameter state

Core Acceptance Criteria

[9:Process US Manual Changes]
The load date is between control FROM date and TO date (inclusive) AND the message starts with 'CARGO MANUALLY CHANGED' → The record is processed for US manual change tracking
[10:Process CA Manual Changes]
The load date is between control FROM date and TO date (inclusive) AND the message starts with 'CARGO MANUALLY CHANGED' → The record is processed for CA manual change tracking
[Abort - US Array Full]
The system validates US array capacity → Processing is aborted with error message 'US USER ARRAY IS FULL, INCREASE IT'
[Abort - CA Array Full]
The system validates CA array capacity → Processing is aborted with error message 'CA USER ARRAY IS FULL, INCREASE IT'
[Map to 'Add/Correct Broker Name']
The reason code equals '18' → The system maps it to 'Add/Correct Broker Name' description and sets the reason text for report output
[Is Reason Code = '18'?]
If the reason code value → If the reason code equals '18', process as broker name change; otherwise continue with other reason code evaluation
[Map Reason Code 20 - Other Customer Necessitated Amendment]
The reason code equals '20' → The system maps it to 'Other Customer Necessitated Amendment', increments the US change counter for code 20, sets the reason text description, and continues processing the change record
[Map Reason Code 20 - Other Customer Necessitated Amendment]
The reason code equals '00' → The system maps it to 'Other Customer Necessitated Amendment', increments the CA change counter for code 00, sets the reason text description, and continues processing the change record
[Reason Code = '90'?]
The reason code equals '90' → The change should be categorized as 'Add/Correct Broker Name' type
[Is Reason Code = '95'?]
The reason code equals '95' → The system should increment the CA change counter for code 95, set the reason text to 'Customer Requested Piece Count/Quantity Adjustment', update the user-specific change count for code 95, and update the total CA change count
[Call Database System to Get Next Root Record]
The system executes the database retrieval call → The system calls 'CIMS' program with GN function to get next log root record from GCLG-PCB using LGRT-SEGMENT and SSAU-LGRT parameters
[Process US Change Type]
The system processes the change type AND extracts the reason code from the log message → The system performs change type processing to categorize and count the change
[Set US User Index to 1]
The system begins searching for the user in the US user array → The search index should be set to position 1 to start from the first user in the array
[Extract Reason Code from Log Message]
The system processes the log message → The reason code is extracted from the message and stored for validation
[Is Reason Code = '18'?]
The reason code equals '18' → Set reason text to 'Add/Correct Broker Name' and increment the US change count for code 18
[Is Reason Code = '19'?]
The reason code equals '19' → Set reason text to 'Customer Requested Piece Count/Quantity Adjustment' and increment the US change count for code 19
[Is Reason Code = '20'?]
The reason code equals '20' → Set reason text to 'Other Customer Necessitated Amendment' and increment the US change count for code 20
[Extract CA Reason Code from Message]
System processes the change message → System extracts the CA reason code from the log message for further processing
[Extract Reason Code from Log Message, Extract Reason Code from CA Log Message]
The system processes the log message → The reason code is extracted from the message and stored for further processing
[Extract Reason Code from Log Message]
The system processes the log message for US cargo changes → The reason code is extracted from the message and stored for validation
[Extract Reason Code from Log Message]
The system processes the log message for CA cargo changes → The reason code is extracted from the message and stored for validation
[Search for Valid Reason Code in User's Change Types]
The system searches through the user's authorized change types → The system identifies if the reason code matches any of the user's valid change types (18, 19, 20)
[Search for Valid Reason Code in User's Change Types]
The system searches through the user's authorized change types → The system identifies if the reason code matches any of the user's valid change types (90, 95, 00)
[Search for Valid CA Change Type]
The system searches the user's authorized CA change types → Process the change only if the reason code matches one of the user's authorized CA change types, otherwise skip processing
[Extract Reason Code from Log Message]
The system analyzes the log message content → The reason code is extracted from the CA log message and stored for further processing
[US Reason Code = '18'?]
The US reason code equals '18' → Increment the US change count for code 18 and set description to 'Add/Correct Broker Name'
[US Reason Code = '19'?]
The US reason code equals '19' → Increment the US change count for code 19 and set description to 'Customer Requested Piece Count/Quantity Adjustment'
[US Reason Code = '20'?]
The US reason code equals '20' → Increment the US change count for code 20 and set description to 'Other Customer Necessitated Amendment'
[CA Reason Code = '90'?]
The CA reason code equals '90' → Increment the counter for code 90 changes and set the reason text to 'Add/Correct Broker Name'
[CA Reason Code = '95'?]
The CA reason code equals '95' → Increment the counter for code 95 changes and set the reason text to 'Customer Requested Piece Count/Quantity Adjustment'
[CA Reason Code = '00'?]
The CA reason code equals '00' → Increment the counter for code 00 changes and set the reason text to 'Other Customer Necessitated Amendment'
[Extract CA Reason Code from Log Message]
Processing the log message for reason code extraction → Move the log message to CA log reason field and extract the reason code for further processing

Structural Validations

[2:Read Control Date File]
The control date file is accessed → The system must terminate with error message 'CONTROL DATE FILE IS EMPTY' if the file contains no records
[3:Load User Array]
The control user file is accessed → The system must terminate with error message 'CONTROL USER FILE IS EMPTY' if the file contains no records
[3:Load User Array]
More than 20 US users are encountered during loading → The system must terminate with error message 'US USER ARRAY IS FULL, INCREASE IT'
[3:Load User Array]
More than 20 CA users are encountered during loading → The system must terminate with error message 'CA USER ARRAY IS FULL, INCREASE IT'
[Read Control Date File]
The control date file is read → If the file is empty, display error message 'CONTROL DATE FILE IS EMPTY' and terminate processing
[Read First User File Record]
The control user file is read → If the file is empty, display error message 'CONTROL USER FILE IS EMPTY' and terminate processing
[Control Date File Empty?]
The control date file is opened and read → If the file is empty, display error message 'CONTROL DATE FILE IS EMPTY' and terminate processing
[Error: US Array Full]
The system detects array overflow condition → An error message 'US USER ARRAY IS FULL, INCREASE IT' is generated and processing terminates
[Error: CA Array Full]
The system detects array overflow condition → An error message 'CA USER ARRAY IS FULL, INCREASE IT' is generated and processing terminates
[Error: CA User Array Full]
The system detects array capacity overflow → The system sets error message 'CA USER ARRAY IS FULL, INCREASE IT' and performs abnormal termination
[Message = 'CARGO MANUALLY CHANGED'?]
The system processes the record AND the first 22 characters of the message equal 'CARGO MANUALLY CHANGED' → The system proceeds to validate the user who made the change
[Check if Message is 'CARGO MANUALLY CHANGED']
The system processes the log entry for user validation → Only records with message starting with 'CARGO MANUALLY CHANGED' should proceed to user search validation
[Within Date Range AND Message = 'CARGO MANUALLY CHANGED'?]
System validates the record → Record is processed only if load date is between control FROM date and control TO date AND message starts with 'CARGO MANUALLY CHANGED'
[Valid CA Reason Code 90, 95, or 00?]
System validates the reason code → Change is processed only if reason code is '90', '95', or '00', otherwise change is skipped

Module: GCX180 1 Consolidated Epic Story

Epic: GCX180 Complete EDI Specification Extracted from Legacy

Contains 266 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX180 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Call MQ OPEN Function]
The system executes the queue open operation → The MQOPEN function is called with connection handle, object descriptor, options, and response parameters
[Handle MQ Open Error]
Error handling is required → The system sets the error message to MQ open error text and performs MQ error handling routine
[Initialize M10 Data Structure]
The system prepares to parse M10 data → The M10 manifest identification data structure is initialized to spaces
[Initialize M11 BOL Details Structure]
The BOL details parsing process starts → The M11 manifest BOL details structure is initialized to spaces
[Initialize SHIPROOT and FWWWBIO structures]
The system prepares to search for shipment records → SHIPROOT and FWWWBIO structures are initialized and search parameters are configured with segment type 'SHIPROOT', equipment ID, greater than operator, and bypass flag set to 'Y'
[Initialize Lead Car Search Parameters]
The system initializes lead car search parameters → All car types except 98 and 99 are included, all statuses are searched, incomplete EDI records are included, temporary and corrector waybills are included, returned lead waybills are included, and latest waybill date is used
[Initialize CSD Message Parameters]
The system begins CSD message preparation → All CSD message parameters are cleared and equipment information is set from parsed manifest data
[Initialize M10 Data Structure]
The system prepares to extract M10 data → The M10 manifest identification data structure is initialized to spaces
[Initialize M11 Data Structure]
M11 data structure initialization is performed → WS-M11-MANIFEST-BOL-DETAILS is set to SPACES
[Initialize Length and Position Counters]
Segment parsing operation begins → The system sets length counter, position start counter, and segment ID length counter to zero
[Initialize Position and Length Variables]
Message structure validation begins → Segment length, position start, and segment ID length variables are set to zero
[Initialize Check Digit Processing]
The system prepares for equipment identification formatting → The program name is set to 'GCX180R' and message name is set to '{KCSM->iEDI309->L-CP Customs}' and check digit field is cleared
[Initialize Lead Car Search Parameters]
The system initializes lead car search parameters → All car types except 98 and 99 are included, all statuses are searched, incomplete EDI records are included, temporary and corrector waybills are included, returned lead waybills are processed, and latest waybill date is used
[Initialize Search Parameters]
The search parameters need to be initialized → Set all search criteria flags to include all car types except 98-99, include all status types, include EDI incomplete cars, include temporary waybills, include corrector waybills, return lead waybill, and use latest waybill date
[Initialize Freight Inquiry Parameters]
Preparing to query the freight inquiry database → The segment type should be set to 'FWIQROOT', road number from car inquiry root, station number from car inquiry root, and waybill number from car inquiry root should be assigned to query parameters

Core Acceptance Criteria

[Transaction Started?]
The system checks the transaction start status → If the transaction is already started, skip all processing and terminate, otherwise continue with MQ message processing
[Message Valid?]
All validation checks are complete → If MQ completion code is OK and backout count is zero, set message as good for processing, otherwise handle as error or EOF
[Parse M10 Manifest ID Information]
The M10 segment is located and parsed → Extract SCAC code, transport type, country code, vessel information, voyage number, reference numbers, quantity, manifest type, and application type into corresponding data fields
[Parse M11 Manifest BOL Details]
The M11 segment is located and parsed → Extract BOL/waybill numbers, location ID, quantity, weight, volume, BOL type, place of receipt, multiple SCAC codes, and shipper export requirements into corresponding data fields
[Parse VID Conveyance Information]
The VID segment is located and parsed → Extract equipment description code, equipment initial, equipment number, seal numbers, dimensions, equipment type, load/empty status, service type, and location ID into corresponding data fields
[Find US Cargo Manifest]
The system formats equipment ID and searches GCSUSRT database → If matching manifest record is found with correct equipment ID and waybill number, set US CCN found flag, otherwise set US CCN not found flag
[Store KCSM Manifest Reference]
The system attempts to store KCSM manifest reference → If A2RT N9 segment exists, append new KCSM reference, otherwise insert new N9 segment with KCSM manifest qualifier and BOL waybill number
[Insert New N9 Segment]
A new N9 segment needs to be created → Set index to 1, initialize N9 information with KCSM manifest qualifier and BOL waybill number, then insert new A2RT N9 segment
[Log Manifest Processing]
Audit logging is performed → Create log entry with current date/time, input message action code, US CCN key, cargo type flag, SCAC code, CCN number, and received KCSM EDI309 message identifier
[Send CSD Message]
Additional waybill processing is required → Call GCX151AR program with equipment initial, equipment number, road number, station number, waybill number, sequence number, and event description
[Set Queue Type to Input Queue]
The system prepares to open the message queue → The queue object type is set to MQOT-Q to designate it as a standard queue
[Set Queue Name to MQTMC-QNAME]
The system needs to identify which queue to access → The queue name is set to MQTMC-QNAME to target the correct EDI message queue
[Set Access Options for Input]
The system needs to define access permissions → The access options are set to MQOO-INPUT-AS-Q-DEF to enable input operations with queue-defined settings
[Queue Ready for Reading]
The completion code indicates success → The queue is ready for reading messages and processing can continue
[Set Message Not Available]
The message queue completion code is OK AND the reason code indicates no message available → The system sets the message status to not available to allow continued processing
[Set EOF Flag]
The error condition does not match any of the specific handled error types → The system sets the end-of-file flag and initiates error handling
[Set Segment ID to M10]
The M10 parsing process begins → The segment ID is set to M10 identifier
[Parse MQ Message for M10 Segment]
The system parses the MQ message for M10 segment → The system determines the position and length of M10 segment in the message
[Extract M10 Data Elements]
The system processes the M10 segment content → All M10 data elements are extracted using data element delimiter and stored in respective fields including identifier, SCAC, transport type code, country code, vessel code, vessel name, flight/voyage number, reference numbers, quantity, manifest type code, vessel code qualifier, condition response code, transaction set purpose code, and application type
[Set M11 Segment Identifier]
The M11 segment parsing begins → The segment identifier is set to M11 format for message parsing
[Parse MQ Message to Get M11 Segment]
The system parses the message for M11 segment → The M11 segment is located and extracted from the message
[Extract M11 Data Elements Using Delimiter]
The system processes the segment data → The segment content is parsed using data element delimiters to extract all M11 fields including identifier, BOL numbers, location ID, quantity, unit codes, weight, volume, BOL type, place of receipt, SCAC codes, and export declaration fields
[Set VID Segment Identifier]
VID segment processing begins → The segment identifier is set to VID for message parsing
[Clear Conveyance Information Area]
The system prepares to extract conveyance information → The conveyance information storage area is cleared to spaces
[Parse EDI Message to Find VID Segment]
The system performs VID segment parsing → The message is searched for VID segment and parsing position and length are determined
[Extract Equipment Description Code]
The system processes VID segment data elements → The equipment description code is extracted from VID-01 position using data element delimiter
[Extract Equipment Initial]
The system processes VID segment data elements → The equipment initial is extracted from VID-02 position using data element delimiter
[Extract Equipment Number]
The system processes VID segment data elements → The equipment number is extracted from VID-03 position using data element delimiter
[Extract Primary Seal Number]
The system processes VID segment data elements → The primary seal number is extracted from VID-04 position using data element delimiter
[Extract Secondary Seal Number]
The system processes VID segment data elements → The secondary seal number is extracted from VID-05 position using data element delimiter
[Extract Equipment Length]
The system processes VID segment data elements → The equipment length is extracted from VID-06 position using data element delimiter
[Extract Equipment Height]
The system processes VID segment data elements → The equipment height is extracted from VID-07 position using data element delimiter
[Extract Equipment Width]
The system processes VID segment data elements → The equipment width is extracted from VID-08 position using data element delimiter
[Extract Equipment Type]
The system processes VID segment data elements → The equipment type is extracted from VID-09 position using data element delimiter
[Extract Load/Empty Status Code]
The system processes VID segment data elements → The load/empty status code is extracted from VID-10 position using data element delimiter
[Extract Type of Service Code]
The system processes VID segment data elements → The type of service code is extracted from VID-11 position using data element delimiter
[Extract Location ID]
The system processes VID segment data elements → The location ID is extracted from VID-12 position using data element delimiter
[Search Lead Car Information]
The system searches for lead car information → System uses FWCARGET service to find lead car with latest waybill date, excluding status 98-99, including all statuses, incomplete EDI, temporary waybill, corrector waybill, and returned lead waybill
[Search Multi-Shipment Equipment Records]
The system searches multi-shipment equipment records → System queries FWSWRWR and FWSWREQ segments to find equipment record where equipment ID matches and either waybill reference number or equipment waybill number matches the message waybill number
[Get Equipment ID from EDI Message]
The system needs to identify equipment for waybill matching → Equipment initial is extracted from VID-02-EQUIP-INIT and equipment number is extracted from VID-03-EQUIP-NUM
[Search Shipment Records by Equipment ID]
The system searches for shipment records → The system queries SHIPROOT database using the equipment ID as the search key
[EDI Waybill = Current Waybill?]
The system performs waybill matching validation → If EDI waybill number equals current waybill number from shipment record and origin road number is not 000, then waybill match is found
[EDI Waybill = Original Waybill?]
The system performs alternative waybill matching validation → If EDI waybill number equals original waybill number from shipment record and origin road number is 990, then waybill match is found
[Set Waybill Match Found]
A successful waybill match is identified → The system sets WS-WB-FOUND flag to TRUE to indicate waybill match found
[Search Multi-Shipment Records]
The system searches multi-shipment records → Root key from SHIPROOT is used to search FWSWRWR segment and then iterate through FWSWREQ segments
[Multi-Shipment Record Found?]
FWSWRWR segment is queried using the root key → Multi-shipment found flag is set based on whether records are found or not found
[Extract Waybill Information]
Waybill information extraction is performed → Road numbers, station numbers, and waybill numbers are extracted from both WR and EQP segments of the equipment record
[N9 Segment Exists?]
The system checks for existing N9 segment data in the manifest → If N9 segment data exists (status code is SPACES), append to existing segments, otherwise insert new N9 segment
[Search for Available N9 Slot]
The system iterates through N9 data entries from index 1 to maximum N9 limit → Stop searching when an empty slot is found (SPACES or LOW-VALUES) or when an existing KCSM manifest qualifier is found
[Replace N9 Segment in Manifest]
The system performs replace operation on the N9 segment → The existing N9 segment in the manifest is updated with the new KCSM reference data
[Insert N9 Segment in Manifest]
The system performs insert operation for new N9 segment → A new N9 segment with KCSM manifest reference is inserted into the manifest at index position 1
[Increment Index Counter]
The system needs to continue searching for available space → The system increments the index counter by 1 to examine the next N9 segment position
[N9 Space Available - Proceed]
The validation process determines space is available → The system proceeds with storing or updating KCSM manifest data in the identified N9 segment position
[Retrieve Existing N9 Segment Data]
System attempts to retrieve N9 segment data for the manifest → System retrieves the N9 segment and determines processing path based on segment existence
[N9 Segment Found?]
System evaluates the status code from the retrieval operation → If status code is SPACES then append to existing segment, otherwise insert new segment
[Search for Available N9 Slot]
System iterates through N9 array from index 1 to maximum N9 entries → System stops when it finds empty slot (SPACES or LOW-VALUES) or existing KCSM manifest qualifier entry
[Get Current N9 Segment for Update]
System needs to update existing N9 segment → System retrieves N9 segment using hold-update function for modification
[Replace Existing N9 Segment]
System performs replace operation for existing segment → System replaces the N9 segment in the database with the updated data
[Insert New N9 Segment]
System performs insert operation for new segment → System inserts new N9 segment with KCSM manifest data into the database using US CCN key
[Search for Available N9 Slot]
The system searches through N9 segments from position 1 to maximum allowed positions → The system identifies either an empty N9 slot (containing spaces or low-values) or an existing N9 slot with KCSM manifest qualifier
[Get Current N9 Segment for Update]
The system needs to update the N9 segment with new KCSM reference information → The system retrieves the current N9 segment data using the manifest's US CCN key for hold and update operations
[Add KCSM Manifest Qualifier]
The system needs to mark the N9 segment as containing KCSM manifest data → The system sets the N9 reference number qualifier field to the KCSM manifest qualifier value
[Add KCSM Reference Number]
The system needs to store the actual KCSM reference number → The system sets the N9 reference number field to the BOL waybill number from the M11 segment
[Replace N9 Segment with Updated Data]
The system needs to save the updated N9 segment data to the manifest record → The system replaces the existing N9 segment in the manifest record with the updated segment containing KCSM reference data
[Set N9 Segment Index to 1]
The insert new N9 segment process is initiated → The N9 segment index is set to 1 to indicate the first position
[Set Reference Number Qualifier to KCSM Manifest Type]
The reference number qualifier needs to be set → The qualifier is set to the KCSM manifest type identifier
[Set Reference Number to BOL/Waybill Number from M11 Segment]
The reference number needs to be assigned → The reference number is set to the BOL waybill number from M11-01-BOL-WB-NUM
[Insert N9 Segment into US Cargo Manifest]
The segment is ready for database insertion → The N9 segment is inserted into the A2RT segment of the US cargo manifest database
[Set Action Code to Input Message]
The log entry is being prepared → The action code is set to input message type (WS-LOG-USE-INPUT-MSG) in GCX105-ACTION-CODE
[Extract SCAC Code from M10 Segment]
The log message is being constructed → The SCAC code from M10-01-SCAC is moved to WS-LOG-MSG-SCAC
[Extract CCN from M11 BOL Details]
The log message is being constructed → The BOL/waybill number from M11-01-BOL-WB-NUM is moved to WS-LOG-MSG-CCN
[Build Log Message for KCSM EDI309 Receipt]
The log message needs to be formatted → The log message is set to the standard KCSM EDI309 receipt format (WS-LOG-MSG-RECV-KCSM-EDI309) and stored in GCX105-MESSAGE
[Add CPKC CCN to Message]
The system continues building email content → The system formats the US CCN key as CPKC CCN error information and adds it as the second item line in the email message
[Add Equipment ID to Message]
The system continues building email content → The system formats the original equipment ID as error information and adds it as the third item line in the email message
[Add KCSM CCN Details to Message]
The system continues building email content → The system formats the M10 SCAC code and M11 BOL waybill number as KCSM CCN error information and adds it as the fourth item line in the email message
[Add Waybill Number to Message]
The system completes building email content → The system formats the M10 reference number as waybill number error information and adds it as the fifth item line in the email message
[System Abend - Email Failed]
The system processes the failed email response → The system sets error message to 'SEND TO FILE OF OM01247 FAILED' and performs system abend
[Set Waybill Number from Reference Number]
DSP record retrieval parameters are being configured → The manifest reference number is assigned to the DSP waybill number field for record matching
[Set Waybill Number from M10 Reference]
The system processes waybill information for DSP record → The waybill number field in DSP record is set to the M10-07-REF-NUM value
[Set KCSM CCN from M11 BOL Number]
The system processes KCSM CCN information for DSP record → The KCSM CCN field in DSP record is set to M11-01-BOL-WB-NUM value
[Set Equipment Information]
CSD message parameters are being populated → Equipment initial is set from VID-02-EQUIP-INIT and equipment number is set from VID-03-EQUIP-NUM
[Multi-Shipment Found?]
CSD message waybill data needs to be populated → If multi-shipment is found, use FWEQ multi-shipment data, otherwise use standard SHIPROOT data
[Use Multi-Shipment Waybill Data]
CSD message waybill parameters are being set → Road number is set from FWEQ-EQP-ORIG-ROAD, station number from FWEQ-EQP-ORIG-STN, waybill number from FWEQ-EQP-WB-NUM, and sequence number from FWEQ-EQP-SEQ
[Use Standard Shipment Root Data]
CSD message waybill parameters are being set → Road number is set from ORIG-RD-NUM of SHIPROOT, station number from ORIG-CSC-STN-NUM of SHIPROOT, waybill number from WB-NUM of SHIPROOT, and sequence number from WB-ADDN-CAR-SEQ-NUM of SHIPROOT
[Set KCSM SCAC Code]
CSD message manifest information is being populated → SCAC code is set from M10-01-SCAC and CCN number is set from M11-01-BOL-WB-NUM
[Set Event Description]
CSD message event description is being set → Event description is set to the standard KCSM EDI309 receipt message format
[Call GCX151AR Program]
CSD message is ready to be sent → GCX151AR program is called with the populated parameter structure to transmit the message to CSD system
[Call MQCLOSE API]
The system initiates closure of the message queue connection → The system calls the MQCLOSE API to properly close the queue connection
[Message Queue Closed Successfully]
If the successful closure → The system continues normal processing flow without error handling
[Call MQDISC to Disconnect from WebSphere MQ]
The manifest message processing is complete and disconnection is requested → The system calls MQDISC to properly disconnect from the WebSphere MQ queue
[Map Reason Code to Text Message]
Error message mapping is required → The external error mapping service is called to convert the reason code to descriptive text message
[Set Message as Valid for Processing]
All message validation checks pass → Set message good flag to true to proceed with EDI message processing
[Mark Message as Good for Processing]
The message backout count equals zero → Set the message status to good for processing
[Format Equipment ID]
The system needs to search for manifest records → Equipment initial and equipment number are combined and formatted into a standardized equipment ID
[Search Lead Car Information]
Searching for lead car information → Use car get function to find latest waybill information excluding status 98-99, including all statuses, incomplete EDI, temporary waybills, and corrector waybills
[Search Lead Car Information]
The system searches for lead car information using equipment ID → The system retrieves lead car records including all status types, EDI incomplete records, temporary waybills, corrector waybills, and latest waybill dates
[Lead Car Found?]
If the lead car search results → The system confirms lead car is found if no error occurred, record was found, haulage right carrier exists, and EDI completion release is 'Y'
[Multi-Shipment Found?]
If the multi-shipment search results → The system confirms multi-shipment is found if equipment ID matches and either the waybill reference number or equipment waybill number matches the message waybill number
[Parse M10 Manifest ID Segment]
The system processes the M10 segment for manifest ID information → The system should extract and store SCAC code, transport type code, country code, vessel code, vessel name, flight/voyage number, reference numbers, quantity, manifest type code, vessel code qualifier, condition response code, transaction set purpose code, and application type from the delimited M10 segment data
[Parse M11 Manifest BOL Segment]
The system processes the M11 segment for manifest BOL details → The system should extract and store BOL/waybill number, location ID, quantity, manifest unit code, weight, weight unit code, volume, volume unit qualifier, BOL type code, place of receipt, multiple BOL/waybill numbers, multiple SCAC codes, shipper export declaration requirement, and export exception code from the delimited M11 segment data
[Parse VID Conveyance Segment]
The system processes the VID segment for conveyance ID information → The system should extract and store equipment description code, equipment initial, equipment number, seal numbers, equipment length, height, width, equipment type, load/empty status code, type of service code, and location ID from the delimited VID segment data
[Extract M10 Data Elements]
The system parses the segment data → The system should use the data element delimiter to separate individual fields and handle overflow conditions by continuing processing
[Set Segment ID to M10]
M10 segment processing begins → The segment ID is set to M10 identifier
[Parse MQ Message for M10 Segment]
The system parses the message for M10 segment → The system locates the M10 segment within the message and determines its position and length
[Extract M10 Data Elements Using Delimiter]
The system extracts M10 data elements → The message content is parsed using data element delimiters to separate individual M10 fields including identifier, SCAC, transport type, country code, vessel code, vessel name, flight/voyage number, reference numbers, quantity, manifest type code, vessel code qualifier, condition response code, TS purpose code, and application type
[Store M10-01 SCAC Code]
The system processes the first M10 data element → The SCAC code is stored in M10-01-SCAC field
[Store M10-02 Transport Type Code]
The system processes the second M10 data element → The transport type code is stored in M10-02-TRANSP-TYP-CDE field
[Store M10-03 Country Code]
The system processes the third M10 data element → The country code is stored in M10-03-COUNTRY-CDE field
[Store M10-04 Vessel Code]
The system processes the fourth M10 data element → The vessel code is stored in M10-04-VESSEL-CDE field
[Store M10-05 Vessel Name]
The system processes the fifth M10 data element → The vessel name is stored in M10-05-VESSEL-NAME field
[Store M10-06 Flight/Voyage Number]
The system processes the sixth M10 data element → The flight/voyage number is stored in M10-06-FLIGHT-VOYAGE-NUM field
[Store M10-07 Reference Number]
The system processes the seventh M10 data element → The reference number is stored in M10-07-REF-NUM field
[Store M10-08 Quantity]
The system processes the eighth M10 data element → The quantity is stored in M10-08-QUANTITY field
[Store M10-09 Manifest Type Code]
The system processes the ninth M10 data element → The manifest type code is stored in M10-09-MANIFEST-TYP-CDE field
[Store M10-10 Vessel Code Qualifier]
The system processes the tenth M10 data element → The vessel code qualifier is stored in M10-10-VESSEL-CODE-QUAL field
[Store M10-11 Condition Response Code]
The system processes the eleventh M10 data element → The condition response code is stored in M10-11-COND-RESP-CDE field
[Store M10-12 Reference Number]
The system processes the twelfth M10 data element → The secondary reference number is stored in M10-12-REF-NUM field
[Store M10-13 TS Purpose Code]
The system processes the thirteenth M10 data element → The TS purpose code is stored in M10-13-TS-PURPOSE-CDE field
[Store M10-14 Application Type]
The system processes the fourteenth M10 data element → The application type is stored in M10-14-APPLICATION-TYPE field
[Set Segment ID to M10]
The system begins M10 segment parsing → The segment identifier is set to M10 and the M10 data structure is initialized to spaces
[Calculate Segment ID Length]
The system needs to locate the segment in the EDI message → The system counts characters in the segment identifier before the first space to determine its length
[Search for M10 Segment in Message]
The system searches for the segment in the message → The system counts characters before the segment identifier to determine its start position
[Calculate Segment Length]
The system needs to extract the complete segment data → The system identifies the segment delimiter, adjusts the start position, and counts characters until the next delimiter to determine segment length
[Parse M10 Fields Using Delimiters]
The system parses the segment data using data element delimiters → The system extracts and stores M10 identifier, SCAC code, transport type code, country code, vessel code, vessel name, flight/voyage number, reference numbers, quantity, manifest type code, vessel code qualifier, condition response code, additional reference number, TS purpose code, and application type into their respective fields
[Set M10 Segment Identifier]
The M10 segment processing is initiated → The system sets the segment identifier to M10 and initializes the manifest ID information data structure to spaces
[Parse EDI Message for M10 Segment]
The system parses the message to locate the M10 segment → The system determines the segment position and length within the message
[Extract M10 Fields Using Delimiters]
The system processes the segment content using UNSTRING operation with data element delimiters → The system extracts 14 distinct fields including identifier, SCAC code, transport type, country code, vessel information, reference numbers, quantity, manifest type, vessel code qualifier, condition response code, additional reference number, transaction set purpose code, and application type into their respective data fields
[Set Segment ID to M10]
The system begins M10 segment extraction → The segment identifier is set to M10 and the M10 data structure is initialized to spaces
[Parse Message to Get M10 Segment]
The system parses the message to locate the M10 segment → The segment start position and length are determined for M10 data extraction
[Extract Fields Using Data Element Delimiter]
The system processes the M10 segment using UNSTRING with data element delimiter → Individual fields are extracted and stored in their respective M10 data elements: M10-IDENTIFIER, M10-01-SCAC through M10-14-APPLICATION-TYPE, with overflow handling to continue processing
[Set Segment ID to M11]
M11 segment processing is initiated → The segment identifier is set to M11 and the data structure is initialized to spaces
[Parse MQ Message for M11 Segment]
The system parses the message for M11 segment → The segment start position and length are determined for data extraction
[Extract M11 Data Elements]
The system extracts M11 data elements using UNSTRING with data element delimiter → All 19 M11 data fields are populated including identifier, BOL numbers, location data, quantities, weights, volumes, SCAC codes, and export information
[Set Segment ID to M11]
M11 segment processing is initiated → The segment identifier is set to M11 and the manifest BOL details structure is cleared
[Extract M11 Data Using UNSTRING]
The system processes the M11 segment data → All M11 data elements are extracted including BOL/waybill number, location ID, quantity, weight, volume, BOL type, SCAC codes, and export declaration requirements using data element delimiters
[Search for M11 Segment in MQ Message]
The system searches for the M11 segment in the message → The system identifies the starting position of the M11 segment or determines it is not present
[Calculate M11 Segment Length]
The system calculates segment boundaries → The segment length is determined by counting characters until the next segment delimiter
[Skip M11 Processing - Segment Not Found]
The M11 segment is not found in the message → M11 processing is skipped and the system continues with remaining processing
[Set Segment ID to M11]
M11 segment processing is initiated → The segment ID is set to WS-SEGMENT-ID-M11
[Parse MQ Message to Get M11 Segment]
MQ message parsing is performed for M11 segment → XA000-PARSE-MQ-MSG-GET-SEGMENT is executed to extract the segment
[Extract M11 Fields Using UNSTRING]
M11 field extraction is performed using UNSTRING with data element delimiter → All 19 M11 fields are extracted including identifier, BOL numbers, location ID, quantity, weight, volume, BOL type, SCAC codes, and export requirements
[Set Segment ID to M11]
M11 segment processing begins → The segment ID is set to M11 identifier and M11 data structure is initialized to spaces
[Parse MQ Message for M11 Segment]
The system parses the message to locate M11 segment → The system determines segment start position and length for M11 data extraction
[Extract M11 Fields Using UNSTRING]
The system performs UNSTRING operation on M11 segment data → All 19 M11 fields are extracted including BOL/WB numbers, location ID, quantity, manifest unit code, weight and weight unit, volume and volume unit qualifier, BOL type code, place of receipt, multiple SCAC codes, shipper export declaration requirement, and export exception code
[Set Segment ID to VID]
The VID segment processing is initiated → The system sets the segment identifier to VID and initializes the conveyance information structure to spaces
[Parse MQ Message to Get VID Segment]
The system parses the message to locate the VID segment → The system determines the segment length and starting position, and sets the length to zero if the segment is not found
[Extract VID Segment Data Using Delimiters]
The system processes the VID segment data using UNSTRING with data element delimiters → The system extracts equipment description code, equipment initial, equipment number, seal numbers, dimensions, equipment type, load/empty status, service type, and location ID into their respective data fields, continuing processing even if overflow occurs
[Set VID Segment ID as Target]
The system begins parsing for VID segment data → The system sets WS-SEGMENT-ID-VID as the target segment identifier to locate
[Calculate Segment ID Length]
The system needs to determine the exact length of the segment identifier → The system counts all characters in the segment identifier before the first space character and stores the count
[Search for VID Segment in Message]
The system searches for the segment within the message content → The system counts characters in the message before finding the target segment identifier and records the position
[Set Start Position After Segment ID]
The system needs to access the segment content data → The system increments the position counter by one to move past the segment identifier to the content area
[Find Segment Delimiter Character]
The system needs to determine the segment boundary → The system reads the first character at the current position and stores it as the segment delimiter
[Calculate Segment Content Length]
The system needs to determine how much content belongs to the current segment → The system counts characters from the current position until it encounters the segment delimiter again and stores the count as segment length
[Extract VID Segment Boundaries]
Segment boundary detection is complete → The system has established both the starting position and length of the segment content for extraction
[Count Characters Before Space in Segment ID]
Calculating segment ID length → Count all characters in the segment ID before the first space character and store the count
[Search for Segment ID in MQ Message]
Searching for the segment in the message → Count characters in the message before finding the segment identifier and store as starting position
[Extract Segment Delimiter Character]
Extracting segment delimiter → Take the character at the starting position as the segment delimiter
[Move to Next Position After Delimiter]
Preparing to read segment content → Increment the starting position by 1 to skip past the delimiter character
[Count Characters Before Next Delimiter]
Calculating segment content length → Count characters from current position until the next occurrence of the delimiter character
[Return Segment Position and Length]
Completing segment extraction process → Return the starting position and calculated length of the segment content
[Extract Equipment Initial from VID Segment]
The system processes the equipment identification data → The equipment initial (VID-02-EQUIP-INIT) is extracted and stored in the working storage equipment initial field
[Extract Equipment Number from VID Segment]
The system processes the equipment identification data → The equipment number (VID-03-EQUIP-NUM) is extracted and stored in the working storage equipment number field
[Set Waybill Number from M10 Segment]
The system processes the waybill reference data → The waybill number (M10-07-REF-NUM) is extracted and stored in the working storage waybill number field
[Save Original Equipment Values]
The system prepares for potential check digit processing → The original equipment initial is saved to WS-ORIG-EQUIP-INIT and original equipment number is saved to WS-ORIG-EQUIP-NUM
[Check Container Equipment Type]
The fourth character of the equipment initial equals the container indicator → The equipment is classified as container type and container-specific processing is enabled
[Search Lead Car Information]
The system searches for lead car information using the equipment ID → The system should retrieve lead car data excluding status 98-99, including all statuses, incomplete EDI, temporary waybills, corrector waybills, and latest waybill date
[Multi-Shipment Records Found?]
If the multi-shipment search results → The system should confirm multi-shipment records are found if equipment ID matches and either waybill record or equipment waybill number matches the message waybill number
[Waybill Matches?]
The waybill index in the cargo record matches the waybill number from the message (GCUSRT-RT073-WB-INDEX = WS-WAYBILL-NUMBER) → The US CCN is marked as found for manifest processing
[Set Equipment ID as Search Key]
Setting up the shipment root search criteria → The system assigns the equipment ID to the search key field and sets search operator to greater than for range searching
[Validate Car ID Match]
Checking for duplicate processing → If the car's feedback key matches the previously processed feedback key, set not found status and complete search, otherwise update the feedback key and continue
[Extract Lead Car Waybill Details]
Extracting waybill details → Copy origin road number, origin station number, and waybill number from SHIPROOT, and determine original waybill details based on whether original waybill number is zero or has a value
[Multi-Shipment Found?]
Validating equipment and waybill match → If equipment ID matches AND (waybill record waybill number equals message waybill number OR equipment waybill number equals message waybill number), then multi-shipment is found

Structural Validations

[Message Available?]
The MQ get operation is performed → If no message is available (MQRC-NO-MSG-AVAILABLE), set message not available flag and exit processing loop
[Validate Message Length]
The message backout count is checked → If backout count is not zero, set message skip flag to avoid reprocessing failed messages
[Check Backout Count]
The message data length is validated → If message length is less than minimum required length, set error message for too short and abort processing
[Append N9 Segment Data]
The system searches for available N9 slot or existing KCSM qualifier → If no space is available (index exceeds maximum), send error email for no space available, otherwise initialize new N9 information with KCSM qualifier and BOL waybill number
[Set MQ Error Status]
The system prepares for error handling → The program error text should be set to MQ connection error message (WS-MQ-ERROR-CONNECT)
[Log Error Details]
The completion code indicates failure → The system logs timestamp, program name, queue name, completion code, and reason code to system error output
[Set Message Skip]
The message completion code is OK AND the message backout count is not zero → The system marks the message to be skipped from processing
[Set Message Too Short Error]
The message data length is less than the minimum required length → The system sets an error indicating the message is too short and initiates error handling
[Set Message Good]
The message completion code is OK AND the backout count is zero AND the message length meets minimum requirements → The system marks the message as good for processing
[Set MQ Error]
The message queue completion code indicates failure AND the reason code shows no message available → The system sets MQ error status and initiates error handling procedures
[M10 Segment Found?]
The segment length is evaluated → If segment length is greater than zero, M10 segment is considered found, otherwise parsing is skipped
[M11 Segment Found?]
The segment parsing is complete → If the segment length is greater than zero, processing continues, otherwise parsing is complete
[VID Segment Found?]
The parsing length is evaluated → If length is greater than zero, VID segment is found and processing continues, otherwise VID processing is completed without extraction
[Validate Waybill Match]
The system compares the message waybill number with the database waybill number → If waybill numbers match exactly, the manifest is considered found; otherwise continue searching for additional records
[Waybill Number Matches?]
The waybill number in the cargo record (GCUSRT-RT073-WB-INDEX) equals the waybill number from the message (WS-WAYBILL-NUMBER) → The system sets US CCN found status to true indicating a manifest match
[Check Waybill Match]
The system compares the waybill number from RT073 index (GCUSRT-RT073-WB-INDEX) with the message waybill number (WS-WAYBILL-NUMBER) → If waybill numbers match, the system should set the US CCN found flag, otherwise continue processing next record
[Display Invalid Check Digit Error]
Error handling is required for invalid check digit → An invalid check digit error message is displayed and invalid flag is set
[Display Invalid Container Error]
Container validation fails → An invalid container error message is displayed and invalid flag is set
[Waybill Matches?]
The system compares message waybill number against current waybill number and original waybill number in the record → The system extracts waybill information if match found or continues to next record if no match
[Lead Car Waybill Matches?]
The system compares message waybill number against lead car current and original waybill numbers → The system extracts waybill information if match found or searches multi-shipment records if no match
[Check EDI Completion Status]
The system checks EDI completion status → If EDI completion 418 release is 'Y', mark search as complete, otherwise continue to next iteration
[Validate Equipment ID Match]
The system validates equipment ID match → If car ID from SHIPROOT equals the search equipment ID, continue waybill validation, otherwise mark as not found
[Validate Waybill Number Match]
The system validates waybill number match → If waybill number from SHIPROOT equals message waybill number OR original waybill number from SHIPROOT equals message waybill number, proceed to extract waybill information, otherwise search multi-shipment records
[Multi-Shipment Found?]
The system validates multi-shipment equipment match → If equipment ID equals FWEQ equipment ID AND (FWEQ waybill number equals message waybill number OR FWEQ equipment waybill number equals message waybill number), mark multi-shipment as found, otherwise continue search
[Check Digit Available?]
The system checks if check digit is present in the input message → If check digit is not spaces in the input, it is considered available, otherwise check digit computation is required
[Display Invalid Check Digit Error]
The check digit validation returns invalid status or computation fails → The system displays error message with check digit status, equipment initial, equipment number, and container details, and marks the check digit as invalid for programs other than GCX903R or GCX905R
[Space Available in N9 Array?]
The search index exceeds the maximum N9 array limit → No space is available and system should trigger error handling for insufficient space
[Send Error - No Space Available]
The system attempts to add a new KCSM manifest reference → Set error reason to A2RT no space available and send error notification email for KCSM manifest processing
[Check Current N9 Segment Position]
The system checks each N9 segment position for availability → The system identifies if the current position is empty (spaces or low-values) or contains existing KCSM qualifier data
[N9 Segment Empty or Low-Values?]
The N9 segment data at current index contains spaces or low-values → The system identifies this position as available for storing new KCSM manifest data
[KCSM Qualifier Already Exists?]
The reference number qualifier at current index equals the KCSM manifest qualifier → The system identifies this position as suitable for updating existing KCSM data
[Index Exceeds Maximum N9 Segments?]
The current index counter exceeds the maximum number of N9 segments allowed → The system determines that no space is available for storing new KCSM manifest data
[Error: No N9 Space Available]
No empty slots or existing KCSM qualifiers are found within the maximum segment limit → The system generates a no space available error for manifest processing
[Send Email Notification for N9 Error]
The system encounters the no space available error condition → The system sends an email notification with A2RT no space available error reason to the operations team
[Check N9 Entry]
The N9 segment data is either empty (spaces or low-values) or contains the KCSM manifest qualifier → The system identifies this slot as available for KCSM manifest data storage
[Send Error - No Space Available]
The search index exceeds the maximum allowed N9 segments → The system triggers an error notification process indicating no space is available for the manifest reference
[Add Error Reason to Message]
The system builds the email message content → The system adds the error reason description as the first item line in the email message
[Close Successful?]
If the completion code from the close operation → The system determines success if completion code equals MQCC-OK, otherwise identifies closure failure
[Log Close Error Details]
The system processes the closure failure → The system converts MQ variables to display format and logs error details including timestamp, program name, queue name, completion code, and reason code
[Set MQ Error Message]
The system prepares for error handling → The system moves the MQ open error message to the program error text field
[Terminate Program with Error]
The system handles the closure failure → The system performs MQ error processing which terminates the program with an abend
[Log Disconnect Error Message]
Error logging is triggered → Display system date, time, program name, queue name, completion code, and reason code to system error output
[Format Error Message with Details]
Error message formatting is required → A detailed error message is constructed including transaction set information, mapped error text, and formatted as ERROR-MESSAGE2
[Set Error Message in System]
System error handling is invoked → The error message is moved to the system communication area error message field and program termination is initiated
[Validate Message Length - Ensure EDI message meets minimum length requirements]
The system checks the message data length against the minimum required length → If message length is less than minimum required, generate error message for too short content and terminate processing with abend
[MQ Operation Successful?]
MQ get operation returns with completion code not equal to OK → Set appropriate message status flag based on the specific MQ reason code - either no message available, skip message, or EOF condition
[Set Message as Valid for Processing]
Message backout count != zero → Set message skip flag to true to bypass processing of this message
[Message Queue Operation Successful?]
The MQ completion code != MQCC-OK and the reason code is MQRC-NO-MSG-AVAILABLE → Set the message status to not available and continue to next message
[Message Queue Operation Successful?]
The MQ completion code is MQCC-FAILED and the reason code is MQRC-NO-MSG-AVAILABLE → Set error message and Execute MQ error handling
[Backout Count = 0?]
The message backout count != zero → Set the message status to skip and continue to next message without processing
[Check Message Backout Count]
The message data length is less than the minimum required MQ length → Set error message indicating message is too short and Execute system abend
[Continue to Next Message]
The operation results in any condition other than the specifically handled success or known error cases → Set end-of-file status to true and Execute MQ error handling
[Equipment Found in Shipment?]
Validating waybill information → Waybill is considered found if message waybill number matches shipment waybill number or original waybill number, and road number is not 000 for current waybill or road number is 990 for original waybill
[Waybill Matches?]
The system compares the waybill numbers → The system confirms a match if the message waybill number equals either the current waybill number (when road number is not 000) or the original waybill number (when road number is 990)
[Equipment and Waybill Match?]
The system validates the lead car data → The system confirms a match if the car ID equals the equipment ID and either the waybill number or original waybill number matches the message waybill number
[Waybill Matches Equipment?]
The system compares the cargo record's waybill index against the message waybill number → The record is valid if waybill numbers match, otherwise continue searching for matching records
[Extract M10 Data Elements]
The system attempts to extract data elements from the segment → The system should only proceed with data extraction if the segment length is greater than zero
[M10 Segment Found?]
The system checks if M10 segment data is present → If segment length is greater than zero, proceed with data extraction, otherwise skip M10 processing
[M10 Segment Found?]
The segment start position is greater than zero → The system proceeds to extract segment data, otherwise skips segment processing
[M10 Segment Found?]
The segment parsing is completed → The system continues with field extraction if segment length is greater than zero, otherwise skips M10 processing
[M10 Segment Found?]
The segment length is evaluated → If length is greater than zero, M10 segment is considered found and processing continues, otherwise M10 processing is skipped
[M11 Segment Found?]
The segment length is evaluated → Processing continues if length is greater than zero, otherwise M11 processing is skipped
[Segment Length > 0?]
The system checks the segment length → If segment length is greater than zero, data extraction proceeds, otherwise M11 processing is skipped
[M11 Segment Found?]
M11 segment length validation is performed → Processing continues only if WS-LENGTH is greater than ZEROES
[M11 Segment Found?]
The segment length is evaluated → Processing continues only if segment length is greater than zero, otherwise M11 processing is skipped
[VID Segment Found?]
The segment parsing is complete → The system proceeds with data extraction only if the segment length is greater than zero, otherwise it exits the VID processing
[VID Segment Found?]
The search operation returns a position value → If the position is greater than zero, the segment exists and processing continues, otherwise the segment is not found
[Return Zero Length - Segment Not Found]
The segment identifier is not found in the message content → The system sets the segment length to zero to indicate the segment is not present
[Segment Found?]
Checking if segment was found → If starting position is greater than zero, segment exists, otherwise segment is not found
[Return Zero Length - Segment Not Found]
Segment is not found in the EDI message → Return zero as the segment length to indicate segment not found
[Display Invalid Check Digit Error]
The check digit calculation service returns an invalid result → An error message is displayed with check digit status, equipment initial, and equipment number details
[Display Container Not Allowed Error]
The system validates equipment number format for check digit calculation → An error message is displayed indicating the container is invalid for check digit calculation with equipment details
[Waybill Number Matches?]
The system compares the message waybill number with shipment waybill data → The system should confirm a match if the waybill number equals the shipment waybill number and origin road number is not 000, or if waybill number equals original waybill number and origin road number is 990
[Check EDI Completion Status]
EDI completion status is checked → If EDI completion release is 'Y', accept the record, otherwise continue searching for next record
[Validate Lead Car Against Equipment]
Lead car is validated against requested equipment → If car ID matches equipment ID, proceed with waybill validation, otherwise search multi-shipment records
[Check Waybill Match]
The waybill number is compared between manifest record and message data → US CCN found flag is set if waybill index matches the waybill number from the message, otherwise car found flag is set for continued search
[Check EDI Completion Status]
Checking EDI completion status → If EDI completion 418 release flag is 'Y', mark search as complete, otherwise continue processing
[Validate Waybill Match]
Validating waybill information → If waybill number from SHIPROOT equals the message waybill number OR original waybill number from SHIPROOT equals the message waybill number, then waybill matches
[Check Waybill Number Match]
System compares waybill numbers between the equipment record and message data → Waybill match status is determined and system extracts multi-shipment data if match is found or continues search if no match

Module: GCX185 1 Consolidated Epic Story

Epic: GCX185 Complete EDI Specification Extracted from Legacy

Contains 292 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX185 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Handle Queue Open Error]
The completion code is not MQCC-OK → Set error text to queue open error message and Execute MQ error handling routine
[Initialize Search Parameters]
The search parameters are being configured → All car types except 98-99 should be included, all status types should be searched, incomplete EDI records should be included, temporary waybills should be included, corrector waybills should be included, returned lead waybills should be processed, and latest waybill date should be used
[Initialize Search Parameters]
The search parameters are being initialized → All car types except 98 and 99 should be included, all status types should be included, EDI incomplete records should be included, temporary waybill records should be included, corrector waybill records should be included, lead waybill should be returned, and latest waybill date preference should be set
[Initialize Equipment Search]
The system prepares to search for equipment records → Equipment search parameters are initialized and search indicator is set to active
[Initialize Search Parameters]
The search parameters are being configured → All car types except 98 and 99 should be included, all status types should be searched, incomplete EDI records should be included, temporary and corrector waybills should be included, and the search should return the latest waybill date
[Initialize New GCSA2RT Segment]
The system creates a new segment → The system initializes a new GCSA2RT segment type 07 structure and sets the US CCN updated flag to true
[Initialize Log Entry Structure]
The log status message process begins → The system initializes the GCX105-INPUT structure and clears any previous status information
[Initialize FEN and KCM Search Flags]
The system begins to search for existing N9 records → FEN and KCM search flags are set to NOT FOUND and update flag is set to NOT UPDATE
[Initialize Search Flags]
The N9 segment search process begins → FEN found flag is set to false, KCM found flag is set to false, and update flag is set to false
[Initialize Email Parameters]
The system needs to send a notification email → Initialize the email text structure to prepare for notification content
[Initialize SHIPROOT and Parameters]
The system initializes the equipment search process → All search parameters are set to include all equipment types except 98-99, all status types, incomplete EDI records, temporary waybills, corrector waybills, returned lead waybills, and latest waybill dates
[Initialize Equipment Search]
The system initializes equipment search → Search parameters are set and equipment request indicator is initialized for FWSWREQ segment search
[Initialize New GCSA2RT Segment]
The system processes remaining export references → The system initializes a new GCSA2RT segment AND sets the US CCN key AND sets record type to 07 AND sets the sequence number AND moves the Despacho reference to SED field AND inserts the new segment
[Initialize SHIPROOT and FWWWBIO]
The search parameters need to be initialized → Clear SHIPROOT and FWWWBIO data structures, set segment type to SHIPROOT, and enable box flag for search operations

Core Acceptance Criteria

[Retrieve MQ Message]
The system connects to the message queue and attempts to retrieve messages → Messages are successfully retrieved or appropriate error handling is triggered based on queue status
[Update Export Reference Numbers]
The system compares existing export reference numbers with message reference numbers → Existing records are updated if references differ, and new records are inserted for additional references up to maximum sequence limit
[Update US Cargo Record Status]
The system processes the hold indicator value from the message → Hold status is set to YES if indicator is 'Y', set to NO if indicator is 'N', and SCAC/FSAC codes are updated accordingly
[EDI 309 Required?]
If cargo status is deleted, delete pending, released, arrival, or export → EDI 309 transmission is skipped if cargo has excluded status, otherwise EDI 309 send flag is set to true
[Send EDI 309 Message]
If manifest preliminary status and T-value conditions → Action is set to preliminary if manifest is preliminary, or if T-value exists but EDI not sent electronically, otherwise action is set to update
[Update Pedimento and Manifest Numbers]
The system processes permit number (PDMNTO-NUM) or Mexican manifest number (MX-MANIFEST-NBR) → Existing N9 segments are updated if values differ, or new N9 segments are appended if space is available, with appropriate qualifier codes
[Store DSP Hold Information]
The system attempts to retrieve existing GCCDSPIO record by equipment ID and waybill number → Record is updated if it exists, or new record is inserted with all message fields including hold status, SCAC codes, and reference information
[Handle Missing Manifest]
The system completes manifest search without finding matching records → Error message is logged, email notification is sent to default recipients with equipment and waybill details, and alternative processing is triggered
[Clear MQ Message Area]
The initialization process begins → The MQ message area is cleared of any previous content
[Clear Working Storage Variables]
The system prepares for message processing → All working storage variables are cleared and reset to initial state
[Clear MQ API Fields]
The initialization process executes → All MQ API fields are cleared and prepared for message queue operations
[Clear DSP Message Layout]
The initialization sequence executes → The DSP message layout area is cleared and ready for new message data
[Call MQ Connect Function]
The system attempts to connect to the message queue → The MQCONNC function must be called with MQ manager name, connection handle, completion code, and reason code parameters
[Set Queue Object Type]
The queue configuration process is initiated → The queue object type is set to standard queue type (MQOT-Q) to enable message operations
[Set Queue Name to GC.DSP.MSG.RECEIVE]
Queue identification is required → The queue name is set to the predefined Despacho message queue (MQTMC-QNAME)
[Set Input Options for Queue Access]
Access permissions need to be configured → The queue options are set to input-as-queue-defined (MQOO-INPUT-AS-Q-DEF) to allow message retrieval
[Set Message Not Available]
The MQ completion code is not OK and the reason code indicates no message available → Set the message status to not available
[Skip Backed Out Message]
The MQ completion code is OK and the message backout count is not zero → Set the message status to skip and continue to the next message
[Accept Valid Message]
The MQ completion code is OK, the backout count is zero, and the message length meets minimum requirements → Set the message status to good and proceed with business processing
[Set EOF - No More Messages]
The MQ completion code is failed with no message available reason or any other error condition occurs → Set end of file status and stop message retrieval processing
[Validation Successful]
The system validates the message content and both equipment ID and waybill fields contain valid non-empty values → The system should proceed with normal message processing
[Extract Equipment ID from MQ Message]
The system processes the message data extraction → The equipment ID from the message is moved to working storage equipment ID field
[Extract Waybill Key from MQ Message]
The system processes the message data extraction → The waybill key from the message is moved to working storage waybill key field
[Extract Waybill Date from MQ Message]
The system processes the message data extraction → The waybill date from the message is moved to working storage waybill date field
[Extract Origin Station from MQ Message]
The system processes the message data extraction → The origin station code from the message is moved to working storage origin station field
[Extract Destination Station from MQ Message]
The system processes the message data extraction → The destination station code from the message is moved to working storage destination station field
[Extract Shipper CHOP Code from MQ Message]
The system processes the message data extraction → The shipper CHOP code from the message is moved to working storage shipper CHOP field
[Extract Consignee CHOP Code from MQ Message]
The system processes the message data extraction → The consignee CHOP code from the message is moved to working storage consignee CHOP field
[Check Digit Present in Message?]
Check digit is present in the message and not spaces → Use the check digit from the message instead of computing it
[Compute Check Digit Using Algorithm]
Check digit computation is required → Call check digit calculation service GCCKDGT with equipment initial and number
[Set Cargo Hold Status to YES]
The DSP hold status in the message equals 'Y' → The cargo hold status is set to YES
[Set Cargo Hold Status to NO]
The DSP hold status in the message equals 'N' → The cargo hold status is set to NO
[Update SCAC and FSAC Codes]
The hold status processing is completed → The SCAC code is updated from the message SCAC code AND the FSAC code is updated from the message FSAC code
[EDI 309 Transmission Required?]
The cargo status is NOT deleted AND NOT delete pending AND NOT released AND NOT arrival AND NOT export → The EDI 309 send flag is set to TRUE
[Continue Without EDI 309]
The cargo status is deleted:
delete pending
released
arrival
export
→ The EDI 309 transmission is skipped and processing continues without setting the EDI 309 flag
[EDI Released?]
The EDI release status is evaluated → If the EDI completion 418 release flag is 'Y', the equipment should be considered EDI released, otherwise it should continue with previous status waybill date processing
[Check EDI Completion Status]
The EDI completion status is evaluated → If EDI release is marked as 'Y' (complete), the equipment is found successfully; otherwise check for previous status
[Check for Previous Status]
The current search key is compared with previous search attempts → If the search key matches a previous attempt, mark as not found; otherwise set previous status flag and continue searching
[Continue Search with Next Record]
The search needs to continue → Set the previous status waybill date flag and execute the search again for the next available record
[Check Cargo Status]
The system checks if the cargo status is CP Cargo Deleted, CP Cargo Delete Pending, US Cargo Released, US Cargo Arrival, or US Cargo Export → EDI 309 transmission is not required if any of these completion statuses are present, otherwise EDI 309 transmission is required
[Set EDI 309 Not Required]
Any of the cargo completion statuses (deleted, delete pending, released, arrival, export) are detected → The system continues processing without setting the EDI 309 transmission flag
[Set EDI 309 Required]
None of the cargo completion statuses (deleted, delete pending, released, arrival, export) are present → The system sets the flag to send EDI 309 transmission
[Get Root Key from SHIPROOT]
The system needs to search for multi-shipment records → The root key from SHIPROOT is extracted and assigned to the multi-ship search qualifier
[Search FWSWRWR Segment]
The system searches for FWSWRWR segment using the root key → The FWSWRWR segment is retrieved if it exists for the given root key
[FWSWRWR Found?]
The system checks the search results → If FWSWRWR segment is found, proceed to equipment search, otherwise mark multi-ship as not found
[Search FWSWREQ Segments]
The system searches FWSWREQ segments → Equipment records are retrieved from FWSWREQ segments for matching analysis
[Get Next FWSWREQ Segment]
The system continues the search process → The next FWSWREQ segment is retrieved for evaluation
[More Segments?]
The system checks for additional segments to process → If more segments exist, continue searching, otherwise conclude that no multi-ship records were found
[Execute database query to locate root waybill records using SHIPROOT key]
The system searches the FWSWRWR segment using the SHIPROOT key → The system sets the multi-ship status to found if root waybill records exist, otherwise sets status to not found
[Root Waybill Record Found?]
The query returns with a status code indicating success or failure → If the status code indicates success (spaces), set multi-ship status to found, otherwise set multi-ship status to not found
[Search Multi-Ship Records]
The system searches FWSWRWR and FWSWREQ segments for multi-ship records using root key → The system retrieves multi-ship equipment records that match the equipment ID and waybill number
[DSP Waybill = Current Waybill AND Origin Road ≠ 000?]
The system compares DSP waybill with current waybill number and checks origin road number → The system confirms match if DSP waybill equals current waybill AND origin road is not equal to 000
[DSP Waybill = Original Waybill AND Origin Road = 990?]
The system compares DSP waybill with original waybill number and checks origin road number → The system confirms match if DSP waybill equals original waybill AND origin road equals 990
[Set search parameters with Equipment ID]
Setting up the database search parameters → The equipment ID is assigned to the search key field and search operator is set to greater than
[Waybill matches message waybill?]
The message waybill number equals the record waybill number and origin road number is not 000:
the message waybill number equals the original waybill number and origin road number is 990
→ The waybill is considered a valid match
[Additional waybill matches?]
The message waybill number equals the additional record waybill number and origin road number is not 000:
the message waybill number equals the additional record original waybill number and origin road number is 990
→ The additional record waybill is considered a valid match
[Compare Lead Car Waybill with DSP Message Waybill]
The system compares the lead car waybill number with DSP message waybill number:
the lead car original waybill number with DSP message waybill number
→ The system determines if there is a waybill number match between lead car and DSP message
[Waybill Numbers Match?]
If the comparison result → The system determines if waybill numbers match or do not match
[Extract Original Waybill Numbers]
The system processes the original waybill information from the lead car record → If original waybill number is zero, the system uses current waybill road, station, and number; otherwise it uses the original waybill road, station, and number
[Search Multi-Ship Equipment Records]
The system searches for multi-ship equipment records using the root key from SHIPROOT → The system retrieves multi-ship equipment records if they exist
[Equipment Waybill Matches?]
If the validation result → The system determines if equipment waybill matches or does not match with DSP message
[Set Multi-Ship Waybill Information]
The system assigns multi-ship waybill information to working storage → The system sets waybill road number, station number, waybill number, and original waybill information from multi-ship equipment records
[Execute SHIPROOT Car Search]
FWCARGET is called with the equipment ID and search criteria → The system should continue searching until a car is found with valid haulage right carrier and EDI completion status, or until search fails
[EDI Complete Release Status?]
The EDI completion 418 release status is checked → If EDI completion release is 'Y', the car is considered found and search ends
[Same Feedback Key as Previous?]
The FWBX feedback key is compared with previously processed key → If the feedback key matches the previous one, mark as not found and end search to prevent infinite loop
[Get Root Key from SHIPROOT]
Multi-ship search is initiated for equipment tracking → Root key is extracted from SHIPROOT and assigned to SSAQ-WRRT-ROOT-KEY for subsequent multi-ship record searches
[Search FWSWREQ Segments]
System begins searching through FWSWREQ segments → WREQ indicator is set to space and search process continues until equipment match is found or all records are processed
[Extract Waybill Information]
System extracts waybill information from the matched record → FWEQ-WR-ORIG-ROAD is moved to WS-WB-ROAD-NUM, FWEQ-WR-ORIG-STN to WS-WB-STN-NUM, FWEQ-WR-WB-NUM to WS-WB-NUM, FWEQ-EQP-ORIG-ROAD to WS-ORIG-WB-ROAD-NUM, FWEQ-EQP-ORIG-STN to WS-ORIG-WB-STN-NUM, and FWEQ-EQP-WB-NUM to WS-ORIG-WB-NUM
[Set Multi-Ship Found Flag]
System confirms successful match in multi-ship records → WS-MULTSHIP-FOUND flag is set to TRUE and WREQ search process is marked as done
[More FWSWREQ Records?]
System evaluates if more FWSWREQ records exist for processing → If CC-STATUS-CODE is spaces, continue to next FWSWREQ record; otherwise mark WREQ search as done
[Get First GCSA2RT Segment Type 07]
The system needs to process export reference numbers → The system retrieves the first GCSA2RT segment with record type '07' and sequence starting from '0000' for the given US CCN
[Segment Found?]
If the query result → If return status is OK, processing continues with segment comparison, otherwise system proceeds to check for new references to add
[References Match?]
If the comparison result → If the SED matches the Despacho reference, no update is needed and processing continues to next segment, otherwise the SED must be updated with the new reference
[Update SED with DSP Reference]
The system processes the update → The system sets the US CCN updated flag to true, moves the Despacho reference to the SED field, and replaces the segment in the database
[Get Next GCSA2RT Segment]
The system needs to check for additional segments → The system retrieves the next GCSA2RT segment for the same US CCN key using sequential access
[More DSP References to Process?]
The system checks for remaining Despacho references → If the current sequence number is less than or equal to the maximum allowed sequences and there are non-blank Despacho references remaining, new segments must be created
[Set Segment Key and Sequence]
The system sets the segment identification → The system assigns the US CCN key, sets record type to '07', and assigns the current sequence number as the segment key
[Insert DSP Reference as New SED]
The system assigns the reference value → The system moves the current Despacho reference number to the SED field of the new segment
[Insert New Segment]
The system performs the database insert → The system inserts the new GCSA2RT segment into the database
[All DSP References Processed?]
The system checks processing completion → If the current sequence number exceeds the maximum allowed sequences or all non-blank Despacho references have been processed, the update process ends, otherwise processing continues with the next reference
[Compare DSP Reference with Existing SED - Validate and match export reference numbers between DSP message and existing GCSA2RT segments]
The system processes each DSP reference against existing SED values in sequence → If DSP reference matches existing SED value, continue to next segment; if different, update SED with DSP reference value
[Update SED with DSP Reference]
The system detects the mismatch between DSP reference and existing SED → Update the SED field with the DSP reference value and replace the GCSA2RT segment
[Create New GCSA2RT Segment]
All existing segments have been processed and additional DSP references remain → Create new GCSA2RT segment type 07 with US CCN key, sequential number, and SED value from DSP reference
[Update SED with DSP Reference]
The system modifies any GCSA2RT segment type 07 data → Set the US CCN updated flag to true to indicate changes were made
[DSP Hold Status from Message]
The hold status value is 'Y' → Set the cargo hold status to YES in the US cargo record
[DSP Hold Status from Message]
The hold status value is 'N' → Set the cargo hold status to NO in the US cargo record
[Keep Current Hold Status]
The hold status value is neither 'Y' nor 'N' → Keep the current hold status unchanged in the US cargo record
[Update SCAC Code from DSP Message]
Processing cargo record updates → Update the SCAC code in the US cargo record with the value from the Despacho message
[Update FSAC Code from DSP Message]
Processing cargo record updates → Update the FSAC code in the US cargo record with the converted value from the Despacho message
[Set Cargo Status to SENT]
Processing cargo status updates → Set the cargo status to SENT in the US cargo record
[Set Cargo Status to ACK-R]
The cargo was previously acknowledged → Set the cargo acknowledgment status to ACK-R in the US cargo record
[Extract DSP Hold Status from Message]
The status information is being extracted for logging → The system moves CSTMS-DSP-MQ-HOLD to WS-DESPACHO-STATUS-LOG for processing
[Format Status Message Text]
The log message is being formatted → The system moves WS-DESPACHO-STATUS-LOG-MSG to GCX105-MESSAGE to create the formatted audit message
[Send Message to Log Queue]
The message is being sent to the queue → The system calls WRITMSGL to send the formatted message with code, content, length and module name to the log queue
[Both Numbers Empty?]
Both the pedimento number and Mexican manifest number are spaces or low-values → The system should skip all N9 segment processing and continue with normal flow
[Search for Existing N9 Segment]
The system searches for existing N9 segment records with record type '02' → The system should retrieve the N9 segment if found or prepare for new segment creation if not found
[Process Existing N9 Records]
The system needs to update pedimento or manifest numbers → The system should process the existing N9 data structure to locate and update FEN and KCM qualifiers
[Create New N9 Segment]
Pedimento or manifest numbers need to be stored → The system should initialize a new N9 segment structure with record type '02' and prepare it for data insertion
[Check Pedimento Number Match]
The system compares the existing pedimento number with the incoming pedimento number → If the numbers match, no update is needed; if they differ, the system should proceed with updating the FEN record
[Update FEN Record]
The system needs to update the pedimento number → The system should replace the existing pedimento number in the FEN record and mark the segment for database update
[Add New FEN Record]
The system creates a new FEN record → The system should set the qualifier to FEN, store the pedimento number, and mark the segment for database update
[Update KCM Record]
The system needs to update the manifest number → The system should replace the existing manifest number in the KCM record and mark the segment for database update
[Add New KCM Record]
The system creates a new KCM record → The system should set the qualifier to KCM, store the manifest number, and mark the segment for database update
[Save N9 Segment Updates]
All N9 processing is complete and updates are marked for saving → The system should commit all N9 segment changes to the GCSA2RT database
[Log Pedimento Status Message]
The FEN processing is complete → The system should log a status message indicating the pedimento number processing result
[Log Manifest Status Message]
The KCM processing is complete → The system should log a status message indicating the manifest number processing result
[Search Through Existing N9 Segments]
The system searches through N9 data segments up to maximum allowed → If FEN qualifier is found, save the index position and set FEN found flag, and if KCM qualifier is found, save the index position and set KCM found flag
[Replace FEN N9 Record]
The incoming pedimento number differs from the existing FEN reference number → Replace the existing FEN reference number with the incoming pedimento number, log the FEN status message, and set the update flag
[Replace KCM N9 Record]
The incoming Mexican manifest number differs from the existing KCM reference number → Replace the existing KCM reference number with the incoming Mexican manifest number, log the KCM status message, and set the update flag
[Search Through Existing N9 Segments]
An empty N9 segment slot is available within the maximum limit → Create new FEN reference entry in the available slot, log the FEN status message, and set the update flag
[Search Through Existing N9 Segments]
An empty N9 segment slot is available within the maximum limit → Create new KCM reference entry in the available slot, log the KCM status message, and set the update flag
[Search Through Existing N9 Segments]
All N9 segment slots are occupied and maximum limit is reached → Send email notification about N9 space unavailability error
[Update GCSA2RT Segment]
The update flag indicates that changes were made to N9 segments → Update the GCSA2RT segment with the modified N9 data
[More N9 Records Available?]
The system checks if more N9 records are available for processing → Continue processing if index is within maximum N9 limit, otherwise end the search process
[Pedimento Number Available?]
Pedimento number is not spaces and not low-values → Set FEN index to 1, initialize new N9 info for FEN qualifier with pedimento number, and log FEN status message
[Mexican Manifest Number Available?]
Mexican manifest number is not spaces and not low-values → Determine appropriate KCM index, initialize new N9 info for KCM qualifier with manifest number, and log KCM status message
[Insert New GCSA2RT Segment]
All required N9 segment data is populated → Insert the new GCSA2RT segment record into the database
[Is Manifest Preliminary?]
If the manifest preliminary status → If manifest is preliminary, set EDI 309 action to preliminary, otherwise continue to evaluate T-value status
[Is Manifest T-Value?]
If the manifest T-value status → If manifest has T-value, check electronic transmission status, otherwise set action to update
[EDI Already Sent Electronically?]
The system checks if EDI was previously sent electronically → If EDI was sent electronically, set action to update, otherwise set action to preliminary
[Set Action to Preliminary]
The system determines EDI 309 action type → Set the EDI 309 action type to preliminary
[Set Action to Update]
The system determines EDI 309 action type → Set the EDI 309 action type to update
[Set Transmission Method to GCX111]
The system prepares for EDI 309 transmission → Set the transmission method to GCX111
[Set US CCN Key for Transmission]
The system prepares EDI 309 transmission parameters → Set the US CCN key as the identifier for the EDI 309 transmission
[Call EDI 309 Service]
The system initiates EDI 309 transmission → Call the GCCS309E service with the configured parameters
[Get Existing DSP Hold Record]
System searches for existing DSP hold record using equipment ID and waybill number → System determines if record exists for update or if new record creation is required
[Set Equipment ID and Waybill Number]
System sets up new record data → Equipment ID, waybill road, station, number, sequence, date, origin station, destination station, shipper chop, and consignee chop are populated from customs message
[Store DSP Hold Status]
System updates hold information → DSP hold indicator from customs message is stored in the record
[Store SCAC and FSAC Codes]
System updates carrier information → SCAC code and FSAC code from customs message are stored in the record
[Store Check Digit Information]
System updates equipment validation information → Check digit from customs message is stored in the record
[Store Hold Reason Code]
System updates hold reason information → Hold reason code, pedimento flag, and Mexican manifest flag from customs message are stored in the record
[Store Export Reference Numbers]
System processes export reference information → All export reference IDs and reference numbers are stored in corresponding record fields
[Move Waybill Details to Record]
The system populates waybill information from the message → Waybill road, station, number, sequence, date, origin station, destination station, shipper CHOP, and consignee CHOP are assigned to their respective record fields
[Move Message Data to Record]
The system populates additional message data → Mexican manifest number and permit number from the message are assigned to their respective record fields
[Add Waybill Number to Email]
The email content is being populated with shipment details → The waybill number should be formatted and added to the email content for shipment identification
[Clean Up Email Resources]
Post-transmission cleanup is required → The system should clear the accept status and purge any temporary email resources
[Add Equipment ID to Email]
Adding equipment information to the email content → Include the data mismatch error message and original equipment ID in the email body
[Add DSP Message Data]
Adding DSP message context to the email → Include explanatory text about the data mismatch in the email body
[Add Mexican Manifest Number from DSP]
Adding Mexican manifest information from the DSP message → Include the Mexican manifest number from the DSP message in the email content
[Add Pedimento Number from DSP]
Adding pedimento information from the DSP message → Include the pedimento number from the DSP message in the email content
[Add Existing Customs Data]
Adding context for existing customs data → Include explanatory text about the existing customs database information in the email
[Add Pedimento Number from Customs]
Adding pedimento information from customs database → Include the pedimento number from the customs database record in the email content
[Clean Up Resources]
Cleaning up after email transmission → Clear system status and purge any temporary resources used for the email process
[Search for Lead Car]
System performs lead car search using FWCARGET with specific parameters for all car types except 98-99, all statuses, including incomplete EDI, temporary waybill, corrector waybill, returned lead waybill, and latest waybill date → System retrieves lead car information if available
[Lead Car Found?]
System checks if CARGET operation resulted in error:
not found
haulage right carrier is spaces
EDI completion release is 'Y'
→ Lead car is not found if any of these conditions are true, otherwise lead car is found
[Process FWSWREQ Segments]
System iterates through FWSWREQ segments using GNP operation until status code is not spaces:
equipment match is found
→ System processes each FWSWREQ segment to find equipment match
[Set Search Criteria for All Car Types]
The system sets car type inclusion criteria → All car types except status 98 and 99 are included, with incomplete EDI, temporary waybills, corrector waybills, and returned lead waybills all included in the search scope
[Search Multi-Ship Equipment Records]
The system searches for multi-ship arrangements → The root key from the lead car record is used to search FWSWRWR segments for multi-ship transportation records
[Set Search Criteria: - All car types except 98-99 - All status types - Include incomplete EDI - Include temporary waybills - Include corrector waybills - Return lead waybill - Use latest waybill date]
Setting up the search parameters → The system should configure to search all car types except 98-99, include all status types, include incomplete EDI records, include temporary waybills, include corrector waybills, return lead waybill information, and use the latest waybill date
[EDI Complete Release = 'Y'?]
The EDI complete 418 release flag equals 'Y' → The system should accept this lead car record as the final result and complete the search
[Same as Previous Search?]
The FWBX key feedback matches the previous search iteration → The system should set the search status to not found and terminate the search to prevent infinite loops
[Set Previous Status Waybill Date]
Preparing for the next search iteration → The system should set the search criteria to previous status waybill date and update the feedback key for the next iteration
[Include Incomplete EDI Records]
EDI completion status filtering is configured → Records with incomplete EDI processing are included in the search
[EDI Complete Release = Y?]
The EDI complete release status is checked → If EDI complete release equals 'Y', the equipment is accepted as the lead car
[Search for Lead Car in SHIPROOT]
System searches for lead car using equipment ID with all status types, EDI incomplete, temporary waybill, corrector waybill, and latest waybill date options → System retrieves lead car information if found and validates haulage right carrier and EDI completion status
[Check EDI 418 Release Status]
The system checks the EDI completion 418 release status → If EDI completion 418 release equals 'Y', mark as EDI complete; otherwise check previous status
[Check Previous Status]
The system compares current status with previous feedback key → If current feedback key matches previous feedback key, mark as not found; otherwise set previous status flag and continue
[Search FWSWRWR Segment]
The system searches for multi-ship records in FWSWRWR segment → The system retrieves the multi-ship root record if it exists
[FWSWRWR Record Found?]
The system checks if a multi-ship root record was found → If found, proceed to equipment search; if not found, mark multi-ship search as complete with no match
[Search FWSWREQ Segment for Equipment]
The system searches FWSWREQ segment → Equipment records are retrieved for validation against the target equipment ID
[Close Message Queue Handle]
The system initiates queue closure process → The message queue handle is closed and queue resources are released
[Disconnect from MQ Manager]
The system initiates disconnection from MQ Manager → The connection to MQ Manager is terminated
[Set DSP Hold Status as Event Description]
System prepares event description for notification → Despacho status log message is moved to GCX151AR-EVENT-DESC parameter
[Retrieve Existing DSP Hold Record]
The system needs to validate data consistency against existing records → The system retrieves the existing DSP hold record from GCCDSPIO table using the equipment ID and waybill number as key
[Data Matches?]
If the comparison results → If Mexican manifest numbers match AND pedimento numbers match, data is consistent; otherwise a data mismatch exists requiring notification
[Update Existing Record with New Data]
The system processes the DSP message → The system updates the existing record with Mexican manifest number and pedimento number from the DSP message if they are not spaces or low-values
[Create New DSP Hold Record]
The system processes the DSP message → The system creates a new DSP hold record with all DSP message data including equipment ID, waybill information, Mexican manifest number, pedimento number, hold status, and reference data
[Send Data Mismatch Email Notification]
The system identifies inconsistent data → The system sends an email notification about the data mismatch to the default recipient
[Include Equipment ID in Notification]
The system constructs the notification content → The system includes the original equipment ID in the notification message
[Include DSP Message Data in Notification]
The system constructs the notification content → The system includes the DSP message Mexican manifest number and pedimento number in the notification
[Include Existing Customs Data in Notification]
The system constructs the notification content → The system includes the existing record's Mexican manifest number and pedimento number in the notification
[Retrieve First GCSA2RT Segment Type 07]
The system needs to process export reference updates → The system retrieves the first GCSA2RT segment with record type 07 and sequence starting from all zeros using greater than operator
[Compare DSP Reference with Existing SED]
The system processes export reference updates → The system compares the existing SED value with the corresponding Despacho reference number at the current sequence position
[Update SED with DSP Reference Number]
The system processes export reference updates → The system updates the SED field with the new Despacho reference number AND sets the US CCN updated flag to true AND replaces the segment in the database
[Move to Next Existing Segment]
The system continues export reference processing → The system retrieves the next GCSA2RT segment using get-next operation AND increments the processing counter
[More Segments to Check?]
If continuation conditions → The system continues processing if sequence counter is within maximum limit AND database return status is OK AND segment is not end-of-file AND US CCN key matches AND segment record type is 07
[More DSP References to Insert?]
If remaining reference insertion needs → The system continues insertion if sequence counter is within maximum limit AND database return status is OK AND the Despacho reference number is not spaces
[Space Available for New Entry?]
The current index exceeds the maximum N9 segment limit → The system triggers an error notification process for insufficient storage space
[Send Email Notification]
The system needs to notify stakeholders of the storage limitation → An email notification is sent with equipment details, waybill information, pedimento number, and Mexican manifest number to designated recipients
[Add Pedimento Number to Message]
The system processes the pedimento number for N9 segment storage → The pedimento number is assigned to an available N9 segment with FEN qualifier and appropriate logging is performed
[Add Mexican Manifest Number to Message]
The system processes the Mexican manifest number for N9 segment storage → The Mexican manifest number is assigned to an available N9 segment with KCM qualifier and appropriate logging is performed
[Check Digit Present in Message?]
The check digit field in the message is evaluated → If check digit is present in message and not spaces, use the provided check digit, otherwise compute check digit using algorithm
[Set Check Digit Not Allowed Flag]
Check digit calculation is attempted → Set check digit not allowed flag and display container type error message
[Search for Lead Car in SHIPROOT]
System searches for lead car using equipment ID with specific criteria including all car types except 98-99, all status types, incomplete EDI inclusion, temporary waybill inclusion, corrector waybill inclusion, returned lead waybill, and latest waybill date → If lead car search returns results without error and car is not marked as not found, then lead car information is available for validation
[Search Multi-Ship Equipment Records]
System searches multi-ship equipment records using root key and iterates through equipment records → If equipment ID matches and either waybill record waybill number or equipment waybill number equals message waybill number, then multi-ship record is found
[Current Waybill Matches DSP Message?]
Comparing waybill numbers for validation → Check if the waybill number from the Despacho message matches the waybill number in the SHIPROOT record
[Original Waybill Matches DSP Message?]
Checking the original waybill number for a match → Compare the waybill number from the Despacho message with the original waybill number extracted from the SHIPROOT record
[Mark Waybill as Found]
A successful waybill match is confirmed → Set the waybill found flag to true to indicate successful validation
[Set Segment Type to 'SHIPROOT']
The system configures the query parameters → The segment type is set to 'SHIPROOT' to target the correct database segment
[Set Segment Type to 'SHIPROOT']
The system sets the segment type parameter → The segment type is set to 'SHIPROOT' to target the correct database table
[Execute FWCWBIO Database Call]
The system executes the FWCWBIO database call → The database query is performed against the SHIPROOT segment with the specified equipment ID
[Get Root Key from SHIPROOT]
The system needs to search for multi-ship equipment records → The root key from the SHIPROOT record is extracted and used for FWSWRWR segment search
[Search FWSWRWR Segment]
The system searches for multi-ship equipment in FWSWRWR segment → The multi-ship found flag is set based on whether FWSWRWR record exists
[Get Next FWSWREQ Segment]
The system processes each FWSWREQ segment → Each FWSWREQ record is evaluated for equipment ID and waybill number matches
[Query FWSWRWR Database]
The system queries the FWSWRWR segment using the SHIPROOT key → The system determines if the equipment is part of a multi-ship configuration and sets the appropriate status flag
[Set Multi-Ship Found Flag]
The database status code indicates successful record retrieval (status code equals spaces) → The system sets the multi-ship found flag to indicate equipment is part of multi-ship configuration
[Set Multi-Ship Not Found Flag]
The database status code indicates unsuccessful record retrieval (status code not is empty) → The system maintains the multi-ship not found flag to indicate equipment is not part of multi-ship configuration
[Get Next FWSWREQ Record]
The system attempts to get the next FWSWREQ record → The system should retrieve the next available equipment record or indicate no more records are available
[Execute CIMS GNP Call to Retrieve Next Equipment Record]
The system executes a call to retrieve the next equipment record from FWSWREQ segments → The system retrieves the next available equipment record and updates the processing status accordingly
[Record Retrieved Successfully?]
The system checks the retrieval status → If no record is available, the system sets the process complete flag, otherwise it continues with equipment validation
[Format Equipment ID Using Standard Rules]
The system processes the equipment ID for formatting → The equipment ID should be formatted using standard railroad equipment formatting rules and stored for further processing
[Check Digit Available in Message?]
The system checks if a check digit is available in the message → If check digit is not spaces, the system should add the check digit to create an alternative equipment ID for searching
[Add Check Digit to Equipment ID]
The system creates an equipment ID by adding the message check digit to the container number → The system should search for cargo records using this check digit enhanced equipment ID
[Compute Check Digit Using Algorithm]
The system attempts to compute a check digit using the container initial and number → The system should use the standard railroad check digit algorithm to calculate the appropriate check digit for the container
[Mark as Active Cargo for Processing]
All cargo status validations pass successfully → The system marks the cargo as active and proceeds with despacho message processing
[Mark as Inactive Cargo - Skip Processing]
The cargo status evaluation determines the cargo should not be processed → The system marks the cargo as inactive and skips despacho message processing for this cargo
[Search for Lead Car in SHIPROOT]
Searching for lead car using car retrieval function with all status types, incomplete EDI, temporary waybill, corrector waybill, and latest waybill date parameters → Retrieve lead car information if found and not in error state, otherwise mark as waybill not found
[Search Equipment in Multi-Ship]
Searching FWSWREQ records for equipment ID and comparing waybill numbers → Mark multi-ship as found if equipment ID matches and either waybill record waybill number or equipment waybill number equals message waybill number, otherwise mark as not found

Structural Validations

[Message Retrieved Successfully?]
If the message completion code and backout count → Message is marked as good if completion code is OK and backout count is zero, otherwise marked as skip, not available, or error
[Equipment ID and Waybill Present?]
The system checks if Equipment ID or Waybill fields are spaces → Processing continues if both fields contain data, otherwise the system abends with invalid message error
[Clear Error Message Area]
The initialization process runs → The error message area is cleared of any previous error content
[Set Error Message for Connection Failure]
The system processes the connection failure → The system must set WS-MQ-ERROR-CONNECT to WS-PGM-ERROR-TEXT and Execute Z900-MQ-ERROR error handling
[Abort - Message Too Short]
The MQ completion code is OK and the message data length is less than the minimum required length → Set error message indicating the message is too short and abort processing
[Equipment ID Present?]
The system validates the message content and the equipment ID field is empty or contains only spaces → The system should set an invalid message error and terminate processing
[Waybill Present?]
The system validates the message content and the waybill field is empty or contains only spaces → The system should set an invalid message error and terminate processing
[Set Invalid Message Error]
Either the equipment ID or waybill field is missing or empty → The system should set the invalid Despacho message error code in the error message field
[Terminate Program with Error]
The invalid message error has been set → The system should terminate the program with an abend condition
[Log Invalid Check Digit Error]
Check digit is invalid or computation fails → Log error message with equipment details and continue processing
[Waybill Matches?]
The system compares message waybill number with SHIPROOT waybill number or original waybill number → The system confirms match if waybill numbers are equal and road number conditions are met
[Waybill Matches?]
The system compares the waybill number from the record with the message waybill number → If GCUSRT-RT073-WB-INDEX equals WS-WAYBILL-NUMBER then waybill numbers match and US cargo is found
[Equipment ID Matches?]
The equipment ID is compared with the search criteria → If the car ID from the search result equals the input equipment ID, the equipment should be considered matched, otherwise alternative equipment sources should be searched
[CP Cargo Deleted Status?]
If the RT10 CP cargo deleted status indicator → If the cargo is marked as deleted, EDI 309 processing is bypassed
[CP Cargo Delete Pending Status?]
If the RT10 CP cargo delete pending status indicator → If the cargo is marked as delete pending, EDI 309 processing is bypassed
[US Cargo Released Status?]
If the RT11 US cargo released status indicator → If the cargo is marked as released, EDI 309 processing is bypassed
[US Cargo Arrival Status?]
If the RT11 US cargo arrival status indicator → If the cargo is marked as arrived, EDI 309 processing is bypassed
[US Cargo Export Status?]
If the RT11 US cargo export status indicator → If the cargo is marked as exported, EDI 309 processing is bypassed
[Equipment ID Match?]
The system compares FWEQ-EQP-ID with the target equipment ID → If equipment IDs match, proceed to waybill validation, otherwise continue to next segment
[Waybill Number Match?]
The system compares FWEQ-WR-WB-NUM or FWEQ-EQP-WB-NUM with the target waybill number → If either waybill number matches the target, proceed to extract multi-ship details, otherwise continue to next segment
[Waybill Matches?]
The system compares the message waybill number against SHIPROOT waybill number and original waybill number → The system sets waybill found status if waybill matches current waybill (when origin road is not 000) or matches original waybill (when origin road is 990)
[Lead Car Found?]
The system checks if lead car record exists and haulage right carrier is not empty and EDI completion status is 'Y' → The system sets lead car found status if record meets all criteria, otherwise continues with alternative search
[Lead Car Waybill Matches?]
The system compares message waybill number against lead car's current waybill number and original waybill number → The system sets waybill found status if waybill matches either current or original waybill number in the lead car record
[Validate Equipment Waybill Against DSP]
The system compares equipment ID with DSP equipment ID AND (equipment waybill number with DSP waybill number:
equipment original waybill number with DSP waybill number)
→ The system determines if equipment waybill information matches with DSP message
[Search FWSWRWR Segment]
System searches for FWSWRWR segment using the root key → Multi-ship found flag is set based on successful retrieval of FWSWRWR segment
[Equipment ID Matches?]
System compares FWEQ-EQP-ID with the target equipment ID → If equipment IDs match, proceed to waybill validation; otherwise continue to next FWSWREQ record
[Waybill Number Matches?]
System compares FWEQ-WR-WB-NUM or FWEQ-EQP-WB-NUM with target waybill number → If either waybill number matches the target waybill number, proceed to extract waybill information; otherwise continue to next record
[Compare DSP Reference with Existing SED]
The system processes the segment → The system compares the existing SED value (GCUS-SED) with the corresponding Despacho reference number (CSTMS-DSP-MQ-REF)
[More Segments for Same CCN?]
The system validates the segment → If return status is OK and the segment US CCN key matches the original CCN and record type is '07', processing continues, otherwise segment processing ends
[Process Next DSP Reference]
A DSP reference is encountered during new segment processing → Only process the reference if it is not spaces, otherwise skip to next reference
[Search for FEN Qualifier]
The system iterates through N9 data entries looking for FEN qualifier → The system should identify if FEN qualifier already exists and record its position for potential updates
[Find Available N9 Space]
The system searches for an empty slot in the N9 data array → If an empty slot is found, the system should use it for the new FEN record; if no space is available, an error condition should be triggered
[Search for KCM Qualifier]
The system iterates through N9 data entries looking for KCM qualifier → The system should identify if KCM qualifier already exists and record its position for potential updates
[Search Through Existing N9 Segments]
The reference number is spaces or low-values → Skip processing for that specific reference type and continue with other processing
[Store Pedimento and Manifest Numbers]
Mexican manifest number is not spaces or low-values → Mexican manifest number from customs message is stored in the record
[Prepare Error Message Text]
An error notification email is being prepared → The standard missing manifest error message should be set as the first line of the email content
[Waybill Matches?]
System compares message waybill number with SHIPROOT waybill number:
original waybill number AND origin road number conditions are met
→ Waybill matches if (waybill equals SHIPROOT waybill AND origin road not equal 000) OR (waybill equals original waybill AND origin road equals 990)
[Waybill Numbers Match?]
System compares message waybill number with SHIPROOT waybill number:
original waybill number
→ Waybill numbers match if message waybill equals either SHIPROOT waybill number OR original waybill number
[Follower Car Equipment Match?]
System checks if equipment ID equals FWSWREQ equipment ID AND (message waybill number equals FWSWREQ waybill number:
message waybill number equals FWSWREQ equipment waybill number)
→ Follower car equipment matches if equipment ID matches AND either waybill condition is true
[Check Haulage Right Carrier]
The system validates the carrier information → If haulage right carrier is spaces or empty, the search continues for the next record, otherwise proceed with EDI validation
[Check EDI Completion Status]
The system checks EDI completion status → If EDI completion 418 release flag is 'Y', the lead car is considered valid, otherwise continue searching for previous status waybill date
[Validate Car ID Match]
The system validates equipment identification match → If the car ID in the lead car record equals the search equipment ID, proceed with waybill validation, otherwise search for multi-ship equipment records
[Check Waybill Match in SHIPROOT]
System compares message waybill number with SHIPROOT waybill number:
original waybill number
→ System sets waybill found status if waybill number matches current waybill (when origin road is not 000) OR matches original waybill (when origin road is 990)
[Handle MQ Close Error]
The queue close operation fails with an error condition → The system handles the MQ close error and initiates error processing
[MQ Resources Cleaned Up]
All MQ operations complete successfully → MQ resources are confirmed as cleaned up and process completes
[Compare Mexican Manifest Numbers]
The system performs data consistency validation → If the DSP message Mexican manifest number is not spaces or low-values, the system compares it with the existing record's Mexican manifest number
[Compare Pedimento Numbers]
The system performs data consistency validation → If the DSP message pedimento number is not spaces or low-values, the system compares it with the existing record's pedimento number
[Check Available N9 Segment Space]
The system attempts to find an available N9 segment slot → The system identifies if space is available by checking for empty or low-value N9 data entries up to the maximum allowed segments
[Set Check Digit Invalid Flag]
The calculation fails or produces an invalid result → Set check digit invalid flag and display error message with calculation details
[Display Invalid Check Digit Error]
Processing programs other than GCX903R or GCX905R → Display error message with timestamp, program name, status code, equipment initial and equipment number
[Mark Check Digit as Invalid]
The system encounters the invalid check digit and the program is not GCX903R or GCX905R → The system should mark the check digit as invalid and log an error message with system date, time, program name, and equipment details
[Log Invalid Check Digit Error]
Check digit validation fails → A detailed error message is logged with timestamp, program name, message name, status code, equipment initial, and equipment number
[Waybill Number Matches?]
System compares message waybill number with SHIPROOT waybill data → If waybill number equals SHIPROOT waybill number and origin road number is not 000, OR if waybill number equals original waybill number and origin road number is 990, then waybill is considered matched
[Equipment ID Matches Lead Car?]
System compares message equipment ID with lead car ID → If equipment ID equals the car ID from SHIPROOT lead car record, then equipment ID matches lead car
[Waybill Matches Lead Car?]
System compares message waybill number with lead car waybill information → If waybill number equals SHIPROOT waybill number OR waybill number equals SHIPROOT original waybill number, then waybill matches lead car
[Equipment ID Matches?]
The equipment ID in FWEQ-EQP-ID is compared with the working storage equipment ID → The system continues to waybill validation if equipment IDs match, otherwise continues to next record
[Equipment ID Matches Current Equipment?]
The system compares the retrieved equipment ID with the current equipment ID being processed → If the equipment IDs do not match, the system sets the process complete flag, otherwise it proceeds to waybill validation
[Waybill Number Matches DSP Message?]
The system compares the waybill number from the retrieved record with the waybill number from the Despacho message → If the waybill numbers match, the system marks multi-ship equipment as found, otherwise it sets the process complete flag
[Is DSP Waybill = Current Waybill AND Origin Road ≠ 000?]
The DSP waybill number equals the SHIPROOT current waybill number AND the origin road number != 000 → Set waybill match found flag to true
[Is DSP Waybill = Original Waybill AND Origin Road = 990?]
The DSP waybill number equals the SHIPROOT original waybill number AND the origin road number equals 990 → Set waybill match found flag to true
[Is DSP Waybill = Lead Car Current Waybill?]
The DSP waybill number equals the lead car's current waybill number → Set lead car waybill match found flag to true
[Is DSP Waybill = Lead Car Original Waybill?]
The DSP waybill number equals the lead car's original waybill number → Set lead car waybill match found flag to true
[Check Digit Present in Message?]
The system examines the check digit field in the message → If check digit is not spaces, proceed with check digit validation, otherwise continue without check digit processing
[Log Invalid Check Digit Error]
The system encounters invalid check digit conditions → Error details including program name, message name, status code, equipment initial and number are logged to system error output
[Check Waybill Match]
The system compares the record's waybill number with the message waybill number → If the waybill numbers match exactly, the cargo record is marked as found; otherwise continue searching
[Waybill Matches?]
The system compares the record's waybill index with the message waybill number → If the waybill index equals the message waybill number, US cargo found flag is set; otherwise car found flag is set for continued search
[Waybill Number Matches?]
The system compares the message waybill number with the cargo record waybill → If waybill numbers match exactly, then set US cargo manifest found flag; If waybill numbers do not match, then set equipment found flag only
[Waybill Matches Message Waybill?]
The system compares the cargo record waybill number with the message waybill number → If the waybill numbers match, the cargo is marked as active for processing, otherwise continue to next cargo record
[Waybill Matches?]
Comparing message waybill number with SHIPROOT waybill number or original waybill number → Mark waybill as found if waybill number equals WB-NUM and origin road number is not 000, or if waybill number equals original waybill number and origin road number is 990
[Waybill Numbers Match?]
Comparing message waybill number with lead car waybill numbers → Mark waybill as found and extract waybill information if waybill number equals WB-NUM or original waybill number from SHIPROOT, otherwise mark waybill as not found

Module: GCX186 1 Consolidated Epic Story

Epic: GCX186 Complete EDI Specification Extracted from Legacy

Contains 3 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX186 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Copy Pedimento Number]
The system processes the customs documentation fields → The Pedimento Number from the dispatch system is copied to the archive record
[Copy Pedimento Type]
The system processes the customs documentation fields → The Pedimento Type from the dispatch system is copied to the archive record
[Copy Pedimento Action Code]
The system processes the customs documentation fields → The Pedimento Action Code from the dispatch system is copied to the archive record

Structural Validations

None explicitly identified in logic extraction.

Module: GCX199 1 Consolidated Epic Story

Epic: GCX199 Complete EDI Specification Extracted from Legacy

Contains 18 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX199 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize System Variables]
The initialization process begins → All input files (INPUT-MONTH-FILE, CHKP-FILE) are opened for reading, all output files (OUT-TRN-RPT, OUT-COM-RPT) are opened for writing, all counters are set to zero, all text fields are set to spaces, and all data segments are initialized

Core Acceptance Criteria

[Clear Working Storage Variables - Train Data Fields - Equipment Fields - Report Counters]
The initialization process begins → All train data segments, equipment segments, and working storage areas are initialized to clean state
[Use Default Checkpoint Number 500]
The system attempts to read checkpoint configuration → The checkpoint number is set to 500 and invalid checkpoint flag is set to 'Y' and a message 'INVALID CHECKPOINT - DEFAULT TO 500' is displayed
[Display Checkpoint Information to Console]
The initialization process completes checkpoint setup → A message displaying 'GCX199 CHECKPOINTING AT' followed by the checkpoint number is shown on the console
[Display Invalid Checkpoint Message]
The checkpoint file cannot be read or contains non-numeric data → The system displays message 'INVALID CHECKPOINT - DEFAULT TO 500' to the console
[Display Final Checkpoint Number]
Either valid file data or default value has been assigned → The system displays 'GCX199 CHECKPOINTING AT [number]' message to the console
[Access GCSUTRT Train Database]
A database access operation is performed → The system accesses the GCSUTRT train database segment
[Display Shutdown Message]
The system processes the shutdown request → A shutdown message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX199' is displayed to the console
[Call IMS Database to Get Next Equipment Record]
The system executes database call to get next equipment record → The system calls CIMS with GNP function to retrieve equipment dependent segment data
[Extract CCN SCAC Code from Array Element]
The system processes commodity control number data → The CCN SCAC code is extracted from the MBL01-M1309-US-CCN-SCAC field at the current array position and stored in the working storage CCN SCAC field
[Set Database Query Parameters]
The system prepares to query the GCA2 database → The system sets segment type to '07', sequence to '0001', and uses the constructed CCN key as the search criteria
[Query GCA2 Database with CCN Key]
The system executes the database query against GCA2 → The system performs a Get Unique operation using the CCN key to locate the specific commodity record
[Populate Equipment Type]
Equipment type needs to be populated in output record → Equipment type code is moved from equipment data array to output equipment type field
[Populate Equipment Initials]
Equipment initials need to be populated in output record → Equipment initials are moved from equipment data array to output equipment initials field
[Populate Equipment Number]
Equipment number needs to be populated in output record → Equipment number is moved from equipment data array to output equipment number field
[Populate Load/Empty Status]
Load/empty status needs to be determined for car control lookup → Load/empty indicator is moved from equipment data array to car control key field
[Set Database Query Parameters]
Preparing database query parameters → System sets segment type to '07', sequence to '0001', and uses the constructed CCN key as search criteria

Structural Validations

[Checkpoint Value Valid?]
The checkpoint value is evaluated for validity → If the checkpoint value is numeric, it is used as the checkpoint number, otherwise the default value 500 is used and an invalid checkpoint message is displayed

Module: GCX501 1 Consolidated Epic Story

Epic: GCX501 Complete EDI Specification Extracted from Legacy

Contains 8 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX501 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Execute GHN Database Call to Retrieve Train Record]
The GHN (Get Hold Next) function is called with train root segment parameters → The system should retrieve the next train cargo record from the database
[System Shutdown Requested?]
The system status code indicates shutdown request (XD) → The system displays shutdown message and terminates the program
[Display Shutdown Message]
The shutdown condition is confirmed → The system displays 'XD IMS REQUESTED SHUTDOWN' message
[Terminate Program]
The shutdown sequence is complete → The program terminates and returns control to the calling system
[Display Shutdown Message]
The system needs to inform about the shutdown → A shutdown message is displayed to notify users
[Display Shutdown Message 'XD IMS REQUESTED SHUTDOWN']
The shutdown condition is confirmed → The system should display the message 'XD IMS REQUESTED SHUTDOWN' to inform operators
[Terminate Program]
The shutdown processing is complete → The program should terminate and return control to the calling system
[Call Database Function to Reposition]
The system calls the database function to reposition → The database function GHU is called with the train root segment to locate the specific record

Structural Validations

None explicitly identified in logic extraction.

Module: GCX502 1 Consolidated Epic Story

Epic: GCX502 Complete EDI Specification Extracted from Legacy

Contains 6 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX502 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[11:Shutdown Detection - IMS shutdown requested?]
The checkpoint response indicates a shutdown request → The system displays shutdown message and terminates processing immediately
[Check Correction Count]
The correction count (REPL-COUNT) exceeds 20,000 → Display stopping message with current correction count, set end of file flag to 'Y', and exit main processing to prevent further corrections
[System Shutdown Requested]
The shutdown condition is detected → The system should display shutdown message and terminate the program
[Check Status Code = 'XD'?]
The system returns a shutdown status code 'XD' → Display shutdown notification message and terminate the program immediately
[Display Shutdown Message]
The shutdown condition is confirmed → Display the message 'XD IMS REQUESTED SHUTDOWN' to inform operators
[Terminate Program]
The shutdown notification is complete → Terminate the cargo processing program immediately

Structural Validations

None explicitly identified in logic extraction.

Module: GCX503 1 Consolidated Epic Story

Epic: GCX503 Complete EDI Specification Extracted from Legacy

Contains 1 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX503 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Display Total Count to Console]
The system reaches the end of processing → A summary message containing the text 'TABLE ENTRIES' followed by the total count of processed records is displayed to the console

Structural Validations

None explicitly identified in logic extraction.

Module: GCX504 1 Consolidated Epic Story

Epic: GCX504 Complete EDI Specification Extracted from Legacy

Contains 17 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX504 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[IMS Shutdown Request?]
The checkpoint operation returns status code 'XD' → An IMS shutdown request has been received and requires immediate processing termination
[12:Shutdown Handling]
Processing the shutdown request → Shutdown message is displayed, error is logged through CERR routine, checkpoint file is closed, and program terminates gracefully
[Display Default Message]
The system sets the checkpoint number to the default value of 500 → Display message 'INVALID CHECKPOINT - DEFAULT TO 500' to the console
[Display Final Checkpoint Number]
Checkpoint processing is complete → Display message 'GCX504 CHECKPOINTING AT' followed by the checkpoint number to the console
[Display Final Checkpoint Number]
Checkpoint processing is complete → Display message 'GCX504 CHECKPOINTING AT [checkpoint number]' to the console
[Display Shutdown Message]
The system begins shutdown procedures → A shutdown notification message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX504' must be displayed to the console for operator awareness
[Close Files and Exit Program]
The system completes shutdown notification procedures → The checkpoint file must be closed and program execution must terminate immediately to comply with shutdown request
[Display Shutdown Message on Console]
The system processes the shutdown request → Display message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX504' on the operations console
[Close CHKP-FILE Only]
An IMS shutdown request is received (status code 'XD') → Only the checkpoint file must be closed before immediate program termination

Structural Validations

[2:Checkpoint File Processing]
The checkpoint file is empty:
the checkpoint value is not numeric
→ The checkpoint number is set to default value 500 and an invalid checkpoint message is displayed
[Checkpoint File Available?]
The checkpoint file is empty or cannot be read → The system sets checkpoint number to 500, marks checkpoint as invalid, and displays default checkpoint message
[Checkpoint Number Valid?]
The checkpoint value from file is evaluated → If the checkpoint value is numeric, use it as checkpoint number, otherwise set checkpoint number to 500 and display default checkpoint message
[Log Error Message]
The system continues shutdown procedures → The shutdown message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX504' must be logged as an error message through the error handling routine
[Log Error Message to System]
The system processes error logging → Log error message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX504' to the system error handler

Module: GCX508 1 Consolidated Epic Story

Epic: GCX508 Complete EDI Specification Extracted from Legacy

Contains 27 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX508 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Train Root Segment]
The system initializes the train root segment → The train root segment is cleared and assigned key '1234567890123456789012345' with status 'II'
[4:Initialize Train Equipment Departure Segment]
The system initializes the equipment departure segment → The equipment departure segment is cleared, assigned key '00000', and status is set to 'GEII'

Core Acceptance Criteria

[2:Create Train Root Record]
The system calls CIMS to insert the train root record → The train root record is inserted into GCSB4RT segment using ISRT operation
[3:Validate Train Root Creation]
The system processes the successful creation → The system displays 'II STATUS' message and terminates processing
[5:Create Train Equipment Departure Record]
The system calls CIMS to insert the equipment departure record → The equipment departure record is inserted into GCSB4DP segment using ISRT operation with additional segment references
[6:Validate Equipment Departure Creation]
The system processes the error condition → The system displays 'DP ISRT DID NOT WORK' error message
[Set Accept Status to 'II']
The system begins train root segment initialization → The accept status should be set to 'II' to indicate initial insert mode
[Clear Train Root Segment Data Structure]
The system initializes the train root segment → The train root segment data structure should be cleared to spaces
[Set Train Root Key to '1234567890123456789012345']
The system sets up the train root key → The train root key should be set to the standard value '1234567890123456789012345'
[Set Train Root Key Value]
The system initializes the train root record → The train root key is set to '1234567890123456789012345'
[Execute Database Insert Operation]
The system executes the database insert operation → The CIMS database interface is called with insert operation for the train root segment
[Train Root Record Created in Database]
The insert operation completes → Train root record is established in the database with the assigned key
[Display Success Message]
The system needs to notify about the successful creation → The system displays 'II STATUS' message to indicate successful train root creation
[Complete Program Execution]
No further processing is required for successful train root creation → The system terminates the program execution and returns control to calling program
[Continue to Next Process]
The creation was not successful or requires additional processing → The system continues execution to process train equipment departure segment
[Clear Train Equipment Departure Segment Data Structure]
The system needs to initialize the departure segment for new data → All fields in the train equipment departure segment data structure are cleared to spaces
[Set Equipment Departure Key to '00000']
The system sets up the departure segment key → The equipment departure key is set to '00000'
[Set Accept Status to 'GEII']
The system configures the operation status → The accept status is set to 'GEII' indicating Get Equipment Initial Insert
[Clear Train Equipment Departure Segment Data]
The system needs to create a new train equipment departure record → All fields in the train equipment departure segment are cleared to spaces
[Set Equipment Departure Key to '00000']
The system sets the departure key → The equipment departure key is set to '00000'
[Set Database Operation Status to 'GEII']
The system prepares the database operation → The database operation status is set to 'GEII'
[Execute Database Insert Operation]
The system executes the database insert operation using CIMS interface → A new train equipment departure record is inserted into the database

Structural Validations

[Check Train Root Creation Status]
The system checks the status code from the creation operation → The system reads the status code to determine if creation was successful or failed
[Train Equipment Departure Record Created]
The system checks the operation result status → If the status code is not blank, display error message indicating the departure insert did not work
[Check Equipment Departure Creation Status]
The system checks the status code returned from the equipment departure creation operation → If the status code is not blank (spaces), the system identifies this as a creation failure and displays an error message indicating the equipment departure insertion did not work
[Equipment Departure Creation Successful]
The system checks the status code and finds it is blank (spaces) → The equipment departure segment creation is considered successful and processing continues normally without error messages
[Display Error Message]
The status code indicates a creation failure (not blank/spaces) → The system displays the message 'DP ISRT DID NOT WORK' to notify of the equipment departure insertion failure

Module: GCX511 1 Consolidated Epic Story

Epic: GCX511 Complete EDI Specification Extracted from Legacy

Contains 19 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX511 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Record Update Required?]
Any modifications were made to the cargo report segment → The system replaces the record in the database and increments the replacement count
[14:Replacement Count Tracking]
The system performs record replacement → The system increments the replacement count by 1
[19:Shutdown Detection]
The checkpoint operation returns status code 'XD' → The system displays shutdown message and terminates processing
[Execute GHN Database Call]
The database call is executed with GHN function, cargo report segment, and selection criteria → The system should attempt to retrieve the next available cargo report
[Set Record for Update]
Index fields have been cleared for deletion processing → The replacement segment flag is set to 'Y' to indicate record needs updating
[Mark Record for Update]
The system completes the status correction → The system should set the replacement segment flag to Y to indicate the record needs to be updated in the database
[Set Record for Update]
The record modifications are complete → Set the replacement segment flag to 'Y' to indicate the record needs database update
[Mark Record for Replacement]
All deletion field updates are complete → Set the replacement segment flag to 'Y' to indicate the record needs database update
[Mark Record for Update]
The system completes the release status correction processing → The system sets the replacement segment flag to Y to indicate the record needs to be updated in the database
[Clear Station Information]
The lookup function returns a non-zero return flag indicating no match found → The station segment information is cleared to spaces
[Load Station Information from Table]
The lookup function returns a zero return flag indicating successful match → The table segment data is moved to the station MC segment for further processing
[Mark Record for Update]
The record is processed for destination station updates → The record should be marked for replacement by setting the replacement segment flag to Y
[Mark Record for Update]
The system determines the record qualifies for transit updates → The replacement segment flag should be set to 'Y' to indicate the record needs to be updated
[Mark Record for Update]
The system completes the destination station update process → The record should be marked for replacement in the database by setting the replacement segment flag to 'Y'
[Check if Record Update Required]
The system checks if any modifications were made to the record during processing → The system identifies whether the record needs to be updated in the database based on the replacement segment flag
[Increment Replacement Counter]
The replacement segment flag is set to 'Y' → The replacement counter should be incremented by 1
[Update Record in Database]
The replacement segment flag equals 'Y' → The system should update the record in the database using the replacement function
[Display Shutdown Message]
The shutdown status is confirmed → The system should display a shutdown message and terminate the program
[Check IMS Response Status]
The IMS system responds with status code 'XD' indicating a shutdown request → The system should display a shutdown message and terminate processing immediately

Structural Validations

None explicitly identified in logic extraction.

Module: GCX601 1 Consolidated Epic Story

Epic: GCX601 Complete EDI Specification Extracted from Legacy

Contains 69 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX601 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Security Byte to Low Values]
The security byte field needs to be initialized → The security byte field is set to low values
[Initialize Accept Status]
The accept status field needs initialization → The accept status field is set to spaces
[Initialize Security Parameters]
The system begins message preparation → The security byte field is set to low values
[Initialize Accept Status]
The system sets up message parameters → The accept status field is initialized to spaces

Core Acceptance Criteria

[2:Control Parameters Reading]
Control parameters are read → Control layout is populated with transmission type and record number limits
[Control Type = 309?]
Control transmission type is evaluated → If control transmission type equals 309, apply 309/358 input filtering rules, otherwise apply 311/blank input filtering rules
[5:Transmission Type Filtering - Type 309 or 358?]
Input transmission type is evaluated → If input transmission type is 309 or 358, Execute special GCT121 processing, otherwise write record directly to output
[5:Transmission Type Filtering - Type 311 or Blank?]
Input transmission type is evaluated → If input transmission type is 311 or blank, Execute special GCT121 processing, otherwise write record directly to output
[6:Type 309 Record Processing, 7:Non-309 Record Processing]
Record qualifies for special processing → Invoke GCT121 transaction processing workflow
[9:Transaction Message Preparation]
Transaction message is being prepared → Security bytes are initialized, transmission number is set, message structure is populated, and communication parameters are calculated
[10:External Transaction Invocation]
External transaction is invoked → GCT121 transaction is called through CSIEXCI interface with prepared message data
[Read Control Parameters from CONTROL-FILE]
Control parameters are loaded during initialization → The system reads control data including record limits and transmission type settings into control layout
[Extract Transmission Type Filter]
Processing parameters are being established → Transmission type filter (CL-TRANSMISSION-TYPE) is available for record routing decisions
[Control Type = 309?]
The system needs to determine which transmission type filtering rules to apply → The system checks if the control transmission type equals '309' to select appropriate input filtering criteria
[Input Transmission Type = 309 or 358?]
An input record is being evaluated for processing type → The system checks if input transmission type is '309' or '358' to determine if special processing is required
[Input Transmission Type = 311 or Blank?]
An input record is being evaluated for processing type → The system checks if input transmission type is '311' or blank to determine if special processing is required
[Process Record via External Transaction]
The record qualifies for enhanced processing based on control and input transmission type combinations → The system invokes external transaction processing through GCT121 module
[Write Record Directly to Output]
The record does not qualify for enhanced processing → The system writes the input record directly to the output file without modification
[Control Type = 309? - Determine processing path based on control file transmission type]
The system reads the control file transmission type → The system classifies the transmission type as either '309' type or non-'309' type to determine subsequent record processing rules
[Set Processing Path for Type 309 Records]
System evaluates processing path requirements → System sets up filtering logic to process input records with transmission types '309' or '358' through enhanced processing pathway
[Set Processing Path for Non-309 Records]
System evaluates processing path requirements → System sets up filtering logic to process input records with transmission type '311' or blank values through enhanced processing pathway
[Allow Record Processing - Proceed with Transmission Type Filtering]
The system needs to determine the processing path for the current record → Proceed to evaluate transmission type filtering rules to determine if enhanced processing or standard output processing should be applied
[Control Type = '309'?]
The control file transmission type equals '309' → The system should apply 309-specific filtering rules to determine if input transmission types 309 or 358 qualify for external processing
[Input Transmission Type = '309' or '358'?]
The input record transmission type is '309':
the input record transmission type is '358'
→ The record qualifies for external processing through the spawn routine
[Input Transmission Type = '311' or Blank?]
The input record transmission type is '311':
the input record transmission type is blank (spaces)
→ The record qualifies for external processing through the spawn routine
[Record Qualifies for External Processing]
The record qualifies for external processing based on transmission type rules → The system should Execute the external processing routine C100-SPAWN-GCT121
[Record Does Not Qualify - Direct Output]
The record does not qualify for external processing based on transmission type rules → The system should write the input record directly to the output file without additional processing
[Input Record Transmission Type = 309 or 358?]
The input record transmission type is either 309 or 358 → The record qualifies for special GCT121 transaction processing
[Prepare Transaction Message with Transmission Number]
Preparing the transaction message → The transmission number from the input record is moved to the transaction message structure
[Configure EXCI Communication Parameters]
Setting up EXCI communication parameters → Transaction name is set to GCT1211E, communication length is calculated, message data is moved to communication area, and call data length is computed
[Input Record Transmission Type = 309 or 358? - Validate transmission type eligibility for Type 309 processing]
Input record transmission type is evaluated for eligibility → Record qualifies for special processing if transmission type equals 309 OR 358, otherwise record receives direct output processing
[Input Record Transmission Type = 311 or Blank?]
Input record transmission type is 311 or blank (spaces) → Record qualifies for external processing through GCT121 spawn
[Qualify Record for External Processing]
Record meets qualification criteria → Invoke external processing routine GCT121 spawn
[Prepare Transaction Message with Transmission Number]
External processing routine is invoked → Set up transaction message with transmission number and security parameters for external system call
[Route Record to Direct Output]
Record does not qualify for external processing → Write input record directly to output file without additional processing
[Record Not Eligible - Direct Output]
The input record transmission type is neither '311' nor blank/spaces → The record is written directly to the output file without external processing
[Record Count Limit Exceeded?]
If whether the control file limit is greater than the current processed record count → If the limit is exceeded, records are written directly to output; if within limit, records proceed to transmission type evaluation
[Control Type = 309?]
The control transmission type equals '309' → The system evaluates input transmission types against criteria 309 or 358 for special processing eligibility
[Control Type = 309?]
The control transmission type does not equal '309' → The system evaluates input transmission types against criteria 311 or blank for special processing eligibility
[Write Input Record Directly to Output File]
The record does not qualify for special processing → The input record is written directly to the output file without modification
[Set Transmission Number from Input Record]
Preparing transaction message data → The transmission number from input record is moved to the transaction message transmission number field
[Move Input Data to Transaction Message]
Building the transaction message → The input data is moved to the transaction message field
[Calculate Communication Area Length]
Calculating the communication area length → The communication area length equals the message length plus 4
[Move Message Data to Communication Area]
Setting up the communication area → The message data is moved to the communication data field using the calculated message length
[Calculate Total Call Data Length]
Calculating the total call data length → The call data length equals the length of communication area header plus the message length
[Prepare GCT121 Transaction Message]
Security parameters need to be set up → The security byte field is set to low values
[Extract Transmission Number from Input Record]
Preparing data for external transaction processing → The transmission number from the input record is moved to the GCX121 transmission number field
[Set Message Data and Length Parameters]
Setting up the external transaction message → The GCX121 input is moved to the message structure and communication length is calculated as message length plus 4
[Prepare GCT121 Transaction Message]
Transaction status needs to be initialized → The accept status field is set to spaces
[Set Message Data and Length Parameters]
Transaction name needs to be specified → The transaction name is set to GCT1211E
[Set Message Data and Length Parameters]
Calculating total data length for external call → The call data length equals the length of communication area header plus the message length
[Set Message Data and Length Parameters]
Preparing communication data area → The message data is copied to the communication data field using the specified message length
[Call EXCI Interface to Invoke GCT121]
Initializing return code parameters → The return code message pointer is set to null
[External GCT121 Transaction Processes Message]
External transaction processing is required → The CSIEXCI program is called with program name, return code, data length, application ID, communication area, and control parameters
[Set Transmission Number from Input Record]
The system prepares the transaction message → The transmission number from the input record is copied to the GCX121 transmission number field
[Prepare Base Message Structure]
The system prepares the transaction message → The GCX121 input structure is moved to the GCT1211E message area
[Set Transaction Name to GCT121]
The transaction message is being prepared → The transaction name is set to GCT1211E
[Calculate Communication Area Length]
The system calculates communication parameters → The communication area length equals the message length plus 4
[Copy Message Data to Communication Area]
The system prepares the communication area → The message data is copied to the external communication data area using the message length
[Calculate Total Call Data Length]
The system calculates the total data length for the external call → The call data length equals the sum of the communication area header length and the message length
[Start Message Preparation]
The system begins preparing the transaction message → The processed record counter is incremented by 1
[Set EXCI Return Code Pointer to NULL]
The EXCI interface initialization begins → The EXCI return code message pointer is set to NULL to ensure clean state

Structural Validations

[4:Record Count Validation - Within Limit?]
A record is being evaluated for processing → If control number of records is greater than processed counter, apply transmission type filtering rules, otherwise write record directly to output
[Input Transmission Type = 309 or 358? - Validate input record transmission type for 309 control processing]
Input record transmission type is evaluated → If input transmission type is 309 OR 358, then validation passes and special processing is triggered, otherwise validation fails and standard processing occurs
[Input Transmission Type = 311 or Blank? - Validate input record transmission type for non-309 control processing]
The input record transmission type is evaluated → If the input transmission type equals 311 OR is blank/spaces, the record qualifies for external processing via C100-SPAWN-GCT121, otherwise the record is written directly to output
[Input Record Transmission Type = 311 or Blank? - Validate transmission type eligibility for Non-309 processing]
The input record transmission type is '311':
the input record transmission type is blank/spaces
→ The record is eligible for external processing through C100-SPAWN-GCT121
[Transmission Type = 309 or 358?]
The input transmission type equals '309':
'358'
→ The record qualifies for special processing; otherwise it is written directly to output
[Transmission Type = 311 or Blank?]
The input transmission type equals '311':
is blank/spaces
→ The record qualifies for special processing; otherwise it is written directly to output

Module: GCX701 1 Consolidated Epic Story

Epic: GCX701 Complete EDI Specification Extracted from Legacy

Contains 8 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX701 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Status Code = 'XD'?]
The CC-STATUS-CODE equals 'XD' → The system recognizes this as an IMS shutdown request and initiates immediate termination of processing
[IMS Shutdown Request]
The system processes the shutdown request → Close all open files (CHKP-FILE, LAST-KEY-FILE, STORE-02-REC-FILE, ERROR-02-FILE) and execute GOBACK to terminate the program immediately
[Close All Files and Exit]
The shutdown request is processed → Close all open files (checkpoint file, last key file, store file, and error file) and terminate the program with shutdown message
[Handle IMS Shutdown Request]
The system receives the shutdown signal → The error message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX701' is set
[Handle Shutdown Request]
The system needs to handle the shutdown gracefully → The error message is set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX701'
[Set Shutdown Message]
The system processes the shutdown request → The error message is set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX701'
[Set Shutdown Message]
The system needs to document the shutdown reason → The system should set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX701'
[Close Checkpoint File]
The system needs to close all open files during emergency shutdown → The checkpoint file should be closed as part of the graceful shutdown sequence

Structural Validations

None explicitly identified in logic extraction.

Module: GCX702 1 Consolidated Epic Story

Epic: GCX702 Complete EDI Specification Extracted from Legacy

Contains 7 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX702 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Backup Data Structure]
The system prepares to create a backup copy → The backup data structure is initialized to clear any previous values

Core Acceptance Criteria

[Log Shutdown Message]
The system processes the shutdown request → The system logs message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX702'
[Set Shutdown Message]
The shutdown condition is confirmed → The system sets error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX702'
[Replace GCSA2RT Segment with Formatted GCSUSS07 Data]
The system executes a database replace operation → The GCSA2RT segment in the database is updated with the formatted GCSUSS07 data
[Copy Original 07 Segment Data to Backup Area]
The system needs to preserve the original data → The complete GCSUSS07 segment data is copied to the backup data area
[Write Backup Data to BACKUP-DATA-07-FILE]
The system completes processing of the segment → The backup data is written to the BACKUP-DATA-07-FILE for permanent storage
[IMS Shutdown Request Received]
The system status code indicates 'XD' (shutdown request) → All files must be closed immediately, key record must be initialized, and the program must return control to the system

Structural Validations

None explicitly identified in logic extraction.

Module: GCX703 1 Consolidated Epic Story

Epic: GCX703 Complete EDI Specification Extracted from Legacy

Contains 6 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX703 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[19:Handle IMS Shutdown - Shutdown Request?]
A shutdown request status code 'XD' is received → Close all open files and terminate the program immediately
[Retrieve Next Record from GCSA2RT Segment]
The system needs to access the specific record segment → The system should use SSAU-A2RT segment parameters to retrieve the record data
[Log Shutdown Message]
The system processes the shutdown request → The system logs the message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX703'
[IMS Status Code = 'XD'?]
The IMS status code equals 'XD' indicating a shutdown request → The system should identify this as a shutdown condition requiring immediate termination
[Set Shutdown Message]
The system needs to record the shutdown reason → The system should set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX703'
[Close Checkpoint File]
The system begins the file closure sequence → The checkpoint file should be closed first in the shutdown sequence

Structural Validations

None explicitly identified in logic extraction.

Module: GCX704 1 Consolidated Epic Story

Epic: GCX704 Complete EDI Specification Extracted from Legacy

Contains 12 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX704 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[24:Handle IMS Shutdown Request]
An IMS shutdown request is received (status code 'XD') → The system closes all files and terminates the program immediately
[Log Shutdown Message]
The system needs to record the shutdown event → The system logs the message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX704' to the error message area
[Set Shutdown Message]
The system processes the shutdown request → The error message is set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX704'
[Close All Files]
The system prepares for shutdown → All files (CHKP-FILE, CCRT-KEY-FILE, A2RT-KEY-FILE, CCRT-LAST-KEY-FILE) are closed
[Call Database Insert Function]
The system performs database insert operation → The shipper record is inserted into the GCSA2RT database segment using insert function
[Execute Database Insert Operation]
The system executes the database insert operation → The consignee record is inserted into the GCSA2RT database segment and tracking keys are written to output files
[Execute Database Insert Operation]
The system executes the database insert operation → The formatted notify party record is inserted into the GCSA2RT database segment
[Execute Database Insert Operation - Perform IMS database insert with status validation]
The database insert operation is executed → The entity record is inserted into the GCSCCS55 database segment through IMS database call
[Call database insert function]
The system processes the database insert operation → The formatted importer record is inserted into the GCSA2RT database segment
[Set Shutdown Message]
The system needs to record the reason for termination → The system should set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX704'
[Close Checkpoint File]
The system initiates file closure sequence → The checkpoint file should be closed to ensure data integrity
[IMS Shutdown Request Received]
An IMS shutdown request is received (status code 'XD') → All files (Checkpoint File, CCRT Key File, A2RT Key File, and CCRT Last Key File) must be closed immediately and the program must terminate gracefully

Structural Validations

None explicitly identified in logic extraction.

Module: GCX706 1 Consolidated Epic Story

Epic: GCX706 Complete EDI Specification Extracted from Legacy

Contains 10 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX706 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Database Segment Structure]
The system prepares to call the database → The system initializes the GCSUSS00 segment structure to clear any previous data

Core Acceptance Criteria

[9:Update Database Record]
The data found flag is set to true → Move backup data to segment structure, update the database record using external program call, write the key to output file, increment update counter, and save the key as last processed
[Set Segment Type to '07']
The system prepares the database query parameters → The system sets the segment type to '07' to identify the specific data segment type
[Call Database to Retrieve GCSUSS07 Segment]
The system needs to retrieve the corresponding database record → The system calls the CIMS database system with GHU operation to retrieve the GCSUSS07 segment
[Parse Customer Control Number from Key Positions 1-25]
The system needs to identify the customer account for database lookup → Characters 1 through 25 of the key should be extracted and used as the customer control number
[Parse Sequence Number from Key Positions 28-4]
The system needs to identify the specific record sequence for database lookup → Characters 28 through 31 of the key should be extracted and used as the sequence number
[Set Segment Type to '07']
The system sets up the query parameters → The segment type is set to '07' to specify the record type
[Parse Key: Extract Sequence Number Characters 28-31]
The system parses the key to extract sequence information → Characters 28 through 31 are extracted and assigned as the sequence number
[Parse Key: Extract Customer Control Number Characters 1-25]
The system parses the key to extract customer information → Characters 1 through 25 are extracted and assigned as the customer control number
[Execute Database Call GHU GCSA2RT]
The system executes the database retrieval operation → A database call is made using GHU operation against GCSA2RT segment

Structural Validations

None explicitly identified in logic extraction.

Module: GCX707 1 Consolidated Epic Story

Epic: GCX707 Complete EDI Specification Extracted from Legacy

Contains 19 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX707 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Data Structures]
Data structures need to be reset to initial state → The GCSCCS00 communication segment should be initialized to default values
[Initialize Status Code and Segment]
The system starts the database lookup process → The status code and segment data structure must be cleared and initialized to empty values
[Initialize Status and Segment Data]
The system initializes the lookup process → All status codes and segment data structures are cleared to spaces or initial values

Core Acceptance Criteria

[7:Retrieve Database Segment]
The external CIMS system is called with GHU operation → Retrieve the corresponding database segment for validation
[8:Update Database Record]
The external CIMS system is called with REPL operation → Update the database record with the processed data
[Retrieve Database Segment Using Record Key]
Database segment retrieval is requested with type '52' → External system is called to retrieve the corresponding database segment using the extracted key
[Extract Key Value from Retrieved Segment]
The segment contains valid key information → The key value is extracted and stored for record processing
[Retrieve Database Segment Using Store Record Key]
Database segment retrieval is requested with record type '52', sequence number from positions 28-31, and customer control number from positions 1-25 of the store record → The system calls external validation service to retrieve the corresponding database segment
[Database Segment Retrieved Successfully?]
The system checks the operation result status → If status code is empty (successful), proceed to extract key value and process data, otherwise increment error counter and end processing
[Extract Key Value from Retrieved Segment]
The segment data is available for processing → The system extracts the segment key value and stores it for use in subsequent data processing
[Call Process Data Function]
The record is ready for data processing → The system calls the process data function to Execute record updates
[Set Database Operation Parameters]
The system sets operation parameters → The accept status is set to 'GE' to indicate acceptable response codes
[Extract Record Type from Store Data]
The system prepares the database key → The record type is set to '52' for the segment lookup
[Call GCA2 Database to Retrieve Segment]
The system calls the GCA2 database for segment retrieval → A database lookup is performed using CIMS with GHU operation and the prepared segment key
[Segment Retrieved Successfully?]
The system checks the result of the database operation → If the status code is spaces, the segment retrieval is considered successful, otherwise it failed

Structural Validations

[Database Segment Found?]
The status code is evaluated → If status code is spaces, proceed to update process, otherwise increment error count and skip record
[Database Segment Retrieved Successfully?]
The retrieval operation returns a status code → If status code is spaces then proceed to extract key value, otherwise increment error counter and skip record
[Increment Error Counter]
Either database segment retrieval fails or database update fails → The error counter is incremented by 1
[Increment Error Counter]
The operation status indicates failure (non-empty status code) → The system increments the error counter by 1 and terminates processing for this record

Module: GCX708 1 Consolidated Epic Story

Epic: GCX708 Complete EDI Specification Extracted from Legacy

Contains 12 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX708 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Use Qualified SSA with Restart Key]
The database query is executed for sequential record access → The qualified segment search argument (SSA) uses the restart key to position the database cursor at the correct starting point
[IMS Shutdown Status 'XD' Received?]
The IMS system returns status code 'XD' indicating a shutdown request → The system should identify this as a shutdown condition requiring immediate graceful termination
[Set Shutdown Message]
The system needs to log the shutdown reason → The system should set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX704'
[Close All Processing Files]
The system prepares for emergency termination → The system should close all open files including checkpoint file, key files, and last key file
[Set Shutdown Message]
The system prepares for shutdown → The error message is set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX704'
[Close All Files]
The system initiates file closure → All files (CHKP-FILE, CCRT-KEY-FILE, A2RT-KEY-FILE, CCRT-LAST-KEY-FILE) are closed
[Delete GCSA2RT Records - Perform GHU (Get Hold Unique) and DLET (Delete) operations on GCSA2RT segments using formatted keys]
The delete process is initiated for GCSA2RT records → The system should attempt to get hold of the unique record and delete it if found, completing the delete process regardless of whether a record was found or not
[Call IMS with GHU Function]
The system calls IMS database with Get Hold Unique function using GCSCCS55 segment structure and A2RT search key → The record is retrieved and held exclusively for update, preventing other processes from modifying it simultaneously
[Set Accept Status to 'GE']
The database access operation is initiated → The accept status is set to 'GE' to specify the type of records that can be retrieved
[Record Retrieved and Held for Update]
The status code indicates successful retrieval (blank spaces) → The record is available for processing and is held exclusively to prevent concurrent modifications

Structural Validations

[Record Found Successfully?]
The system checks the operation result status → If status code is blank spaces, the record was found successfully; otherwise, the record was not found or an error occurred
[Record Not Found or Error]
The status code indicates failure (not blank spaces) → The system recognizes that the record was not found or an error occurred during retrieval

Module: GCX709 1 Consolidated Epic Story

Epic: GCX709 Complete EDI Specification Extracted from Legacy

Contains 3 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX709 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize GCSA2RT Segment Structure]
The system prepares the data structure for new data → The GCSCCS00 data structure should be initialized to clear any previous values

Core Acceptance Criteria

[Execute Get Next Operation on GCA2 Database]
A get next operation is executed on the GCA2 database using GCSA2RT segment → The system calls the database interface to retrieve the next sequential record
[Call Database Interface with GCSA2RT Segment]
The database interface call is made with CCCOM, GN operation, GCA2-PCB, GCSCCS00 structure, and SSAU-A2RT segment → The CIMS program is called to execute the database operation

Structural Validations

None explicitly identified in logic extraction.

Module: GCX710 1 Consolidated Epic Story

Epic: GCX710 Complete EDI Specification Extracted from Legacy

Contains 14 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX710 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[8:Parse Input Record Key]
Record key parsing is performed → CCN number, record type, and sequence number are extracted and assigned to database query structure
[Parse CCN Number from Record]
The system needs to identify the customer → Extract the CCN number from the A2RT record and move it to the query structure
[Parse Record Type from Record]
The system needs to identify the record type → Extract the record type from the A2RT record and move it to the query structure
[Parse Sequence Number from Record]
The system needs to identify the record sequence → Extract the sequence number from the A2RT record and move it to the query structure
[Extract CCN Number from Record]
The system parses the record structure → The CCN number component is extracted and stored in WS-CCN-NUMBER
[Extract Record Type from Record]
The system parses the record structure → The record type component is extracted and stored in WS-KEY-RECTYPE
[Extract Sequence Number from Record]
The system parses the record structure → The sequence number component is extracted and stored in WS-KEY-SEQ
[Call IMS Database Service with GET HOLD UNIQUE Operation]
The system attempts to retrieve the corresponding GCA2 database record → The system should call the database service using GET HOLD UNIQUE operation with the constructed search key
[Set Database Key Components - CCN Number - Record Type - Sequence Number]
The system needs to prepare for database record retrieval or deletion → The CCN number, record type, and sequence number are extracted from the workspace record and assigned to the database search key fields
[Handle IMS Shutdown Request]
The response status code equals 'XD' indicating shutdown request → The system sets shutdown message, closes all files, and terminates the program
[IMS Shutdown Response 'XD' Received]
The IMS response code equals 'XD' indicating a shutdown request → Set shutdown message, close all open files, and terminate the program immediately
[Set Shutdown Message]
The system processes the shutdown condition → The error message is set to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX710'
[Close Record-Not-Found File]
The system initiates graceful shutdown procedures → The record not found file is closed
[IMS Shutdown Request]
An IMS shutdown request is received with status code 'XD' → The record-not-found file, checkpoint file, and last key file must be closed immediately and the program must terminate

Structural Validations

None explicitly identified in logic extraction.

Module: GCX800 1 Consolidated Epic Story

Epic: GCX800 Complete EDI Specification Extracted from Legacy

Contains 6 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX800 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Call IMS Database with GHN Function]
The system executes the database retrieval operation → A GHN (Get Hold Next) database call is made to the IMS database to retrieve the GCSCCRT segment record using the specified key and query parameters
[Call IMS to Replace GCSCCRT Record]
The system performs a replace operation on the GCSCCRT segment → The GCSCCRT record is updated with the new sublocation and customer bonded information
[Close All Files and Terminate]
The system needs to terminate processing → All open files are closed and the program terminates with shutdown message
[Set Shutdown Message]
System needs to log the shutdown reason → The system should set error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCX800'
[Close All Processing Files]
System needs to perform emergency shutdown → The system should close checkpoint file, last key file, store GCCC record file, and error GCCC file
[Terminate Program]
Emergency shutdown procedures are complete → The system should terminate program execution immediately

Structural Validations

None explicitly identified in logic extraction.

Module: GCX900 1 Consolidated Epic Story

Epic: GCX900 Complete EDI Specification Extracted from Legacy

Contains 7 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX900 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Database Segments - GCSCCS55 - GCSCCRT]
Preparing database segment structures → GCSCCS55 and GCSCCRT segments are initialized to clear any residual data

Core Acceptance Criteria

[Display Shutdown Message]
The system processes the shutdown request → The message 'IMS SHUTDOWN REQUEST RECEIVED BY GCX900' is displayed to the console
[Close All Files]
The system prepares for shutdown → All open files (CHKP-FILE, DATE-FILE, AUDT-FILE) are closed

Structural Validations

[Checkpoint Number Valid?]
Validating the checkpoint number format → If the checkpoint value is numeric, use it; otherwise set checkpoint to 500 and display invalid message
[Set Default Checkpoint to 500]
The checkpoint file contains no data (AT END condition) → The checkpoint number is set to 500 and an invalid checkpoint message is displayed
[Checkpoint Value is Numeric?]
The checkpoint value is evaluated for numeric content → If numeric, use the file value; if not numeric, set checkpoint to 500 and display invalid message
[Set Default Checkpoint to 500]
The checkpoint value from the file is not numeric → The checkpoint number is set to 500 and an invalid checkpoint message is displayed

Module: GCX902 1 Consolidated Epic Story

Epic: GCX902 Complete EDI Specification Extracted from Legacy

Contains 21 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX902 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[More Records?]
The end of file status is evaluated → Processing continues if not at end of file, otherwise moves to segment count operations
[2:Data Record Extraction]
The record data needs to be processed → The input segment is saved and the input code is moved to the working area
[4:Table Segment Insertion]
Table segment insertion is performed → The record is inserted into the database table
[6:Segment Count Retrieval]
Segment count update is required → The existing segment count record is retrieved from the database
[7:Segment Count Update]
Segment count update is performed → The segment count record is updated with the saved segment information and replaced in the database
[Process Record Data]
The record is not an end-of-file condition → The input segment data is saved and the input code is prepared for table insertion processing
[Extract Segment Code from Record]
The system processes the record for data extraction → The segment code (IN-CODE) is extracted from the record
[Move Segment Code to Database Structure]
The system prepares data for database insertion → The segment code (IN-CODE) is moved to the database structure field (GCSTBDP)
[Save Input Segment Data]
The system processes the input record for database insertion → The original input segment data must be saved to a backup location before any modifications
[Move Input Code to Database Segment]
The system prepares the record for database insertion → The input code must be mapped to the corresponding database segment field structure
[Execute Database Insert Call]
Database insert operation is executed → System attempts to insert the segment data into the database table
[Display Insert Failure Message]
Insert failure is detected → System displays failure message along with the segment data that failed to insert
[Set Insert Status Code]
System prepares for database insert operation → System sets the status code to 'II' to indicate insert operation type
[Segment Count Retrieval - Retrieve existing segment count from database table]
A database retrieval operation is initiated using Get Hold Unique command → The system successfully retrieves the existing segment count record and holds it for update
[Segment Count Available for Update]
The system needs to update the segment count with the last processed input segment data → The system moves the saved input segment data to the segment count field in preparation for database replacement
[Segment Count Available for Update]
The system executes a database replace operation → The GCSTBRT table segment count record is successfully updated with the new values
[Move processed segment count to database field]
The system needs to update the database table with the processed segment count → The segment count from SAVE-IN-SEG is moved to the database field GCSTBRT-KS-SEG-COUNT
[Execute database replace operation]
The system executes the database replace operation → The GCSTBRT table record is updated with the new segment count using the REPL operation

Structural Validations

[Insertion Success?]
The insertion status is evaluated → If insertion failed, error handling is triggered, otherwise processing continues
[5:Insertion Error Handling]
The failure status is detected → An error message is displayed showing the failed record data
[Display Error Message 'ISRT FAILED' with Data Content]
The database insertion operation fails with status code 'II' → Display error message 'ISRT FAILED' along with the specific data content that failed to insert

Module: GCX903 1 Consolidated Epic Story

Epic: GCX903 Complete EDI Specification Extracted from Legacy

Contains 23 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX903 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Search Parameters]
The system prepares to search for lead car information → All search parameters are initialized including car type filters, status filters, EDI completion flags, temporary waybill inclusion, corrector waybill inclusion, returned lead waybill flag, and latest waybill date flag
[Initialize FWCARGET Parameters]
The FWCARGET search is initiated → All car types except 98 and 99 are included, all statuses are searched, incomplete EDI records are included, temporary waybills are included, corrector waybills are included, returned lead waybills are included, and latest waybill date is used
[Clear Manifest Data Structure - Initialize GCSUSRT segment]
The system prepares to retrieve current manifest data → The manifest data structure is cleared to spaces

Core Acceptance Criteria

[File Empty?]
The input file is empty (end of file reached immediately) → The system generates an empty report message instead of processing records
[12:Log Entry Advisory Message]
The system logs the transaction → Advisory message is logged with CCN key, action code 'ZZZ', entry number, broker quantity, user ID, and timestamp
[13:Log USCS DC Advisory]
The system logs the second advisory message → USCS DC advisory message is logged with CCN key, action code 'ZZZ', user ID, and timestamp
[Handle Empty File - Generate empty file report when no records are found in the input file]
The input file is empty with no records to read (WS-INP-EOF is true after first read attempt) → The system should initialize a report record, set the empty report flag, format an empty file message, and write the empty report to the output file
[Search for Lead Car in System]
System searches for lead car using equipment ID with specific status filters → System retrieves lead car information excluding status 98-99, including all other statuses, EDI incomplete, temporary waybill, corrector waybill, and returned lead waybill records
[Search Multi-Ship Records]
Multi-shipment search is performed → System searches FWSWREQ segments for equipment ID matching input AND waybill number matching either current or original waybill
[EDI Complete Release?]
The EDI completion release status is evaluated → If EDI-COMP-418-RELEASE equals 'Y', the search is marked as complete, otherwise continue with duplicate check
[Same Car as Previous Search?]
The current search feedback key is compared with previous search feedback key → If CARGET-FWBX-KEY-FEEDBACK equals WS-CARGET-FWBX-KEY-FEEDBACK, mark as CARGET-NOT-FOUND and complete search, otherwise update previous status for next iteration
[Search Complete?]
Any termination condition is met → If CARGET-ERROR, CARGET-NOT-FOUND, HAULAGE-RIGHT-CARRIER is spaces, EDI-COMP-418-RELEASE is 'Y', or duplicate feedback key is found, then set WS-DONE to TRUE and exit search loop
[Format Log Message with Entry Number and Quantity]
The system formats the audit log message → The entry number is moved to log entry field and broker quantity is moved to log quantity field to create the advisory message
[Send Log Entry to Audit System]
The system submits the log to the external audit system → The log message is moved to the external transaction message area and submitted via external call interface with calculated message length
[Set Advisory Message Content]
Creating audit log message content for USCS DC advisory → The message field is populated with formatted entry number and broker quantity information
[Prepare Message for Transmission]
Message needs to be prepared for external system transmission → The audit log input is moved to the message structure and communication area length is calculated
[Call External Transaction System]
External transaction system needs to be invoked → The CSIEXCI program is called with proper parameters to transmit the audit log message
[Transaction Successful?]
Transaction result needs to be evaluated → Success is determined when response code is zero, response2 is zero, abend code is space, and message length is zero

Structural Validations

[Check Haulage Right Carrier]
The system checks the haulage right carrier field → If haulage right carrier is spaces or empty, continue searching for next car, otherwise proceed with EDI validation
[Check EDI Completion Status]
The system checks the EDI completion status → If EDI completion release flag is 'Y', accept the car, otherwise continue searching for next car
[Validate Car Against Equipment ID]
The system compares the car ID from the lead car record with the input equipment ID → If car ID equals the equipment ID, proceed with waybill validation, otherwise mark as not found
[Log Successfully Created?]
The system checks the submission response → If response code is zero AND response2 is zero AND abend code is space AND message length is zero, then the log submission is considered successful
[Display Error Message]
The system processes the error response → Error details including response codes and abend code are displayed, and if error message pointer is not null, the error message content is also displayed

Module: GCX905 1 Consolidated Epic Story

Epic: GCX905 Complete EDI Specification Extracted from Legacy

Contains 152 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX905 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize SHIPROOT Search Parameters]
The system initializes search parameters → SHIPROOT and FWWWBIO structures are cleared, segment type is set to 'SHIPROOT', equipment ID is assigned as search key, operator is set to '> ', and box flag is set to 'Y'
[Initialize FEN N9 Information]
The system initializes FEN N9 information → The system sets FEN qualifier and moves incoming pedimento number to the designated N9 segment position
[Initialize FEN Search Flags]
The system prepares to search N9 segments → Set FEN not found flag to true and KCM not found flag to true as initial state
[Initialize Loop Counter to 1]
The N9 segment processing begins → The loop counter is set to 1 to start from the first N9 segment position
[Initialize Search Index to 1]
The system needs to establish a starting search position → The search index is set to position 1 to begin sequential scanning
[Initialize New N9 Info for KCM]
The system initializes the N9 segment information → The system sets the KCM qualifier in the reference number qualifier field and sets the Mexican manifest number in the reference number field at the designated index position
[Initialize New KCM N9 Information]
The system prepares to set new KCM information → The system calls initialization routine for new KCM N9 information using saved index position
[Initialize Log Input Parameters]
The logging process is initiated → All log input parameters are initialized to prepare for logging
[Initialize Log Message Structure]
The system needs to log the activity → The log message input structure is initialized to clear any previous data
[Initialize SHIPROOT Search Parameters]
The system initializes search parameters for equipment lookup → The SHIPROOT and FWWWBIO structures are cleared, segment type is set to 'SHIPROOT', equipment ID is assigned as search key, operator is set to '>', and box flag is enabled

Core Acceptance Criteria

[Generate Empty Report]
The empty file condition is detected → An empty report message is written to the output file
[Retrieve A2RT Manifest Record]
The A2RT manifest record retrieval is performed → The system retrieves the GCSA2RT record using the US CCN key AND searches for existing FEN (pedimento) and KCM (Mexican manifest) reference numbers AND sets found flags and saves index positions for any existing entries
[Process FEN Pedimento]
FEN pedimento processing is performed → If existing pedimento information is found AND the pedimento number matches the input, cargo skipped counter is incremented AND if existing pedimento information is found AND the pedimento number differs, the existing entry is replaced AND if no existing pedimento information is found, a new entry is appended AND cargo updated counter is incremented for replacements and additions
[Update Manifest Record]
The manifest record update is performed → The GCSA2RT record is updated with the new pedimento and Mexican manifest reference numbers in the appropriate index positions
[Update USRT Record]
USRT record update is performed → The GCSUSRT record is retrieved using the US CCN key AND the pedimento type and pedimento received timestamp fields are updated with input values
[Update Despacho Hold Table]
Despacho hold table update is performed → If existing record found, update with US CCN, Mexican manifest number, pedimento information, and user ID AND if no existing record found, create new record with equipment ID, waybill information, station routing, Mexican manifest number, pedimento details, and timestamps
[Log FEN Activity]
FEN activity logging is performed → A log entry is created with US CCN, pedimento number, transaction details, user ID, and timestamp information
[Write Processing Report]
Report detail writing is performed → A report line is written containing sequence number, equipment ID (with or without check digit based on processing), waybill number, Mexican manifest number, pedimento number, and processing status
[Display Check Digit Removal Message]
The system completes the removal process → Audit message is displayed showing equipment initial without check digit, equipment number without check digit, and the removed check digit value
[Set Status to Include All Statuses]
Status criteria is set → All car statuses are included in the search along with EDI incomplete, temporary waybill, corrector waybill, returned lead waybill, and latest waybill date options
[Check EDI Completion Status]
EDI completion status is checked → If EDI completion 418 release is 'Y' then search is marked as done, otherwise check for previous status waybill date
[Search Multi-Ship Equipment Records]
Multi-ship equipment search is performed → Root key from shiproot is used to search FWSWRWR segment and then search FWSWREQ segments for matching equipment ID and waybill number
[Search N9 Segments]
The system processes each N9 segment sequentially from index 1 to maximum occurrences → The system examines each segment until all segments are processed or empty segments are encountered
[More N9 Segments?]
The system checks the current segment index against maximum occurrences and segment content → If index is within limits and segment data is not spaces or low-values then more segments exist, otherwise no more segments to process
[FEN Qualifier Found?]
The system compares the segment qualifier against the FEN qualifier value → If the qualifier matches FEN qualifier then pedimento information is found, otherwise continue searching
[Save FEN Index Position]
The system processes the FEN segment → The system sets FEN found flag to true, saves the segment index position, and moves the reference number to report pedimento number field
[KCM Qualifier Found?]
The system compares the segment qualifier against the KCM qualifier value → If the qualifier matches KCM qualifier then Mexican manifest information is found, otherwise continue to next segment
[Save KCM Index Position]
The system processes the KCM segment → The system sets KCM found flag to true and saves the segment index position
[Set Manifest Record Found Flag]
The system completes the manifest record processing → The system sets the segment found flag to true indicating successful manifest record retrieval
[Set Manifest Record Not Found Flag]
The database operation returns a non-space status code indicating no record found → The system sets the segment not found flag to true indicating no manifest record exists
[Search N9 Segments for FEN Qualifier]
The system searches for FEN qualifier in N9 segments → The system identifies if FEN qualifier exists and records its position and current pedimento number
[Same Pedimento Number?]
Incoming pedimento number matches the existing pedimento number → The system skips the update and increments cargo skipped counter
[Replace Existing FEN Pedimento]
The system processes the pedimento update → The system replaces the existing pedimento number with the new one and increments cargo updated counter
[Append New FEN Pedimento]
The system appends new FEN pedimento information → The system adds FEN qualifier and pedimento number to the available slot and increments cargo updated counter
[Update Manifest Record]
The system updates the manifest record → The system replaces the manifest record with updated N9 segment information
[Get A2RT Manifest Record Using US CCN Key]
The system attempts to retrieve the A2RT manifest record → The system uses the US CCN key to access the A2RT segment and loads the manifest data
[Loop Through N9 Segments]
The system processes each N9 segment sequentially → Continue processing from index 1 to maximum occurrences by sequence until all segments are checked or empty segment is found
[More N9 Segments to Check?]
The current index is evaluated against the maximum occurrence limit → If index is less than or equal to maximum occurrences, continue processing, otherwise stop iteration
[Is Qualifier = FEN?]
The system examines the reference number qualifier → If the qualifier equals FEN qualifier value, process FEN information, otherwise move to next segment
[Set FEN Found Flag]
The system processes the FEN information → Set FEN found flag to true to indicate successful location of pedimento information
[Save FEN Index Position]
The system needs to track the location for future updates → Save the current segment index to FEN index variable for later reference
[Store Current Pedimento Number]
The system processes the reference number data → Move the reference number from the N9 segment to the report pedimento number field
[Move to Next N9 Segment]
The system continues the search loop → Increment the segment index by 1 to examine the next N9 segment
[Set Segment Not Found Flag]
No manifest record exists for the provided US CCN key → Set segment not found flag to true to indicate absence of manifest data
[Get Current N9 Segment Data]
The system accesses the N9 segment at the current counter position → The N9 segment data is retrieved for further processing
[Check N9 Qualifier Type]
The qualifier field is examined → The qualifier type is identified for further processing based on specific qualifier values
[Qualifier = FEN?]
The qualifier is compared against the FEN qualifier value → If qualifier equals FEN, process as pedimento information; otherwise check for other qualifier types
[Mark FEN Found]
The FEN qualifier is confirmed → The FEN found flag is set to true to indicate pedimento information is available
[Extract Current Pedimento Number]
The pedimento number needs to be extracted → The reference number field from the FEN N9 segment is copied to the report pedimento number field
[Qualifier = KCM?]
The qualifier is compared against the KCM qualifier value → If qualifier equals KCM, process as Mexican manifest information; otherwise continue to next segment
[Mark KCM Found]
The KCM qualifier is confirmed → The KCM found flag is set to true to indicate Mexican manifest information is available
[Increment Loop Counter]
The system needs to move to the next N9 segment → The loop counter is incremented by 1 to point to the next N9 segment position
[End N9 Segment Processing]
The N9 segment processing loop needs to terminate → The N9 segment processing is completed and control returns to the calling process
[FEN Qualifier Found in N9 Segments?]
The system searches through all N9 segments for an existing FEN qualifier → The system identifies whether FEN qualifier is found and saves the index position for further processing
[Same Pedimento Number?]
The system compares the current pedimento number with the new input pedimento number → If pedimento numbers are identical, the system skips the update; if different, the system proceeds with replacement
[Skip Update - Same Pedimento]
The system determines no update is required → The system increments the cargo skipped counter and sets the same pedimento number flag without modifying the cargo record
[Get Hold on A2RT Segment]
The system needs to modify the A2RT segment containing N9 data → The system retrieves the current A2RT segment with a hold for update to ensure data integrity during modification
[Set FEN Qualifier in N9]
The system updates the N9 segment with FEN information → The system sets the FEN qualifier in the reference number qualifier field and moves the input pedimento number to the reference number field at the designated index position
[Replace A2RT Segment]
The system commits the changes to the cargo database → The system replaces the existing A2RT segment with the updated version containing the new pedimento information
[Increment Updated Counter]
The update operation completes successfully → The system increments the cargo updated counter by one and sets the pedimento number update flag to track the successful modification
[Start N9 Slot Search]
The system initiates a search for available N9 segment slots → The search process begins with proper initialization
[N9 Data Empty or Low-Values?]
The N9 data at the current position contains spaces or low-values → The position is identified as available for new data entry
[Found Matching Qualifier?]
The reference qualifier in the current position matches the qualifier of the new data (FEN for pedimento or KCM for manifest) → The position is identified as a match for potential replacement
[End Search Process]
The search process reaches its conclusion → The search operation terminates with the determined outcome status
[Search N9 Segments for KCM Qualifier]
The system searches through all N9 segments for the KCM qualifier → The system identifies whether a KCM qualifier exists and records its position index for further processing
[Mexican Manifest Numbers Match?]
The system compares the existing Mexican manifest number with the new input Mexican manifest number → If the numbers are identical, no update is needed; if different, the existing number must be replaced with the new number
[Update A2RT Manifest Record]
The system performs the database update operation → The A2RT manifest record is updated with the current N9 segment data containing the KCM Mexican manifest information
[Start KCM N9 Segment Search]
The KCM N9 segment search process begins → The KCM not found flag is set to true to indicate no KCM qualifier has been located yet
[Check Reference Number Qualifier]
Each N9 segment is examined for reference number qualifier → The system checks if the qualifier equals KCM and continues until all segments are processed or KCM is found
[Mark KCM Found]
The KCM qualifier is identified in the segment → The KCM found flag is set to true and the segment index is saved for future reference
[Skip - Same Mexican Manifest]
The input Mexican manifest number is identical to the existing KCM reference number → No update action is performed and processing continues without modification
[Replace Existing KCM Segment]
The Mexican manifest numbers do not match → The existing KCM segment is replaced with the new Mexican manifest number and logging is performed
[Append New KCM Segment]
The search completes without finding a KCM qualifier → A new N9 segment is created with KCM qualifier and the input Mexican manifest number, and logging is performed
[KCM Qualifier Found in Existing N9 Segments?]
The system searches through existing N9 segments for KCM qualifier → The system identifies if KCM qualifier is found and saves the index position for further processing
[Current KCM Number Same as Input?]
The system compares the existing KCM manifest number with the input Mexican manifest number → The system determines if the numbers are identical to decide whether to skip or proceed with update
[Skip Update - No Change Needed]
The system processes the KCM update request → The system continues processing without making any changes to the KCM N9 segment
[Replace Existing KCM N9 Segment]
The system processes the KCM update request → The system initializes new KCM N9 information and proceeds to replace the existing segment
[Find Available N9 Segment Slot]
The system searches through N9 segments for an empty or available slot → The system identifies the next available index position for adding KCM information
[Get Hold on A2RT Manifest Record]
The system prepares to update KCM N9 segment information → The system performs get-hold-unique operation on the A2RT manifest record to enable updates
[Set KCM Qualifier in N9 Segment]
The system sets KCM qualifier information → The system moves KCM qualifier to the N9 reference number qualifier field at the saved index position
[Set Mexican Manifest Number in N9 Segment]
The system sets Mexican manifest number information → The system moves input Mexican manifest number to the N9 reference number field at the saved index position
[Replace A2RT N9 Segment]
The system commits the KCM N9 segment changes → The system performs replace operation on the A2RT N9 segment record
[Log KCM Manifest Update Activity]
The system completes KCM manifest update processing → The system calls logging routine to record KCM manifest update activity
[FEN Pedimento Found in N9 Segments?]
The system searches through all N9 segments for FEN qualifier → The system identifies if FEN pedimento information is found and saves the index position
[Same Pedimento Number?]
The system compares the existing pedimento number with the input pedimento number → The system determines if the pedimento numbers are identical
[Skip - No Update Needed]
The system processes the pedimento update request → The system skips the update and increments the cargo skipped counter
[Replace Existing FEN N9 Segment]
The system processes the pedimento update → The system replaces the existing pedimento information with new data and increments updated counter
[Find Available N9 Slot, Find Available N9 Slot for KCM]
The system searches for available N9 segment slots up to maximum occurrences → The system identifies the first available slot or determines no space is available
[Space Available?]
The search index exceeds maximum allowed N9 segment occurrences → The system determines there is no space available for new pedimento information
[Append New FEN N9 Segment]
The system processes the new pedimento information → The system adds FEN qualifier and pedimento number to the available N9 slot and increments updated counter
[KCM Manifest Found in N9 Segments?]
The system searches through all N9 segments for KCM qualifier → The system identifies if KCM manifest information is found and saves the index position
[Same Manifest Number?]
The system compares the existing manifest number with the input manifest number → The system determines if the Mexican manifest numbers are identical
[Replace Existing KCM N9 Segment]
The system processes the Mexican manifest update → The system replaces the existing Mexican manifest information with new data
[Space Available for KCM?]
The search index exceeds maximum allowed N9 segment occurrences → The system determines there is no space available for new Mexican manifest information
[Append New KCM N9 Segment]
The system processes the new Mexican manifest information → The system adds KCM qualifier and Mexican manifest number to the available N9 slot
[Update A2RT Manifest Record]
The system processes the manifest record update → The system replaces the A2RT manifest record with the updated N9 segment data
[F100-GHU-GCSUSRT: Get Current USRT Record]
The system needs to update the USRT record with pedimento information → The system retrieves the current USRT record from the database using the US CCN key
[Move Pedimento Type to USRT Record]
The system processes the pedimento information update → The pedimento type from the input record is moved to the USRT record pedimento type field
[Move Pedimento Received Timestamp to USRT Record]
The system processes the pedimento timestamp update → The pedimento received timestamp from the input record is moved to the USRT record pedimento received timestamp field
[F200-REPL-GCSUSRT: Update USRT Record]
The system needs to persist the changes to the database → The updated USRT record is replaced in the database
[DSPIO Record Exists?]
The system checks for existing DSPIO record using equipment ID and waybill number → If DSPIO record exists, prepare update operation; if DSPIO record does not exist, prepare insert operation
[Update Pedimento Number]
The system processes pedimento number from input → Set DSPIO pedimento number field to the input pedimento number
[Update Pedimento Type]
The system processes pedimento type from input → Set DSPIO pedimento type field to the input pedimento type
[Update Pedimento Received Timestamp]
The system processes pedimento received timestamp from input → Set DSPIO pedimento received timestamp field to the input pedimento received timestamp
[Move Mexican Manifest Number to DSPIO]
Mexican manifest and pedimento information needs to be assigned → Mexican manifest number, pedimento number, pedimento type, and pedimento received timestamp should be moved from input fields to corresponding DSPIO fields
[Move US CCN Key to Log Record]
Log record is being prepared → The US CCN key is moved to the train or US CCN field in the log record
[Set Action Code to 'ZZZ']
The action code needs to be specified → Action code is set to 'ZZZ' to indicate pedimento update activity
[Format FEN Log Message with Pedimento Number and Type]
Log message needs to be formatted → Pedimento number is moved to FEN message field and pedimento type is moved to type field, and the complete FEN message is assigned to the log message
[Add Transaction Details - Date, Time, User ID]
Transaction context needs to be added → Sending transaction code, user ID, current date and time are added to the log entry
[Prepare EXCI Transaction Call]
External transaction call needs to be prepared → Log input is moved to transaction message, transaction name is set, communication length is calculated, and call parameters are prepared
[Set Security Parameters]
Security parameters need to be established for the log transaction → The security byte is set to high-values to indicate secure processing
[Get US CCN Key from Manifest]
The US CCN key needs to be identified for logging → The US CCN key from the manifest record is moved to the log message train or US CCN field
[Set Cargo Type to US Cargo]
The cargo type needs to be specified in the log message → The cargo type flag is set to indicate US cargo
[Move Mexican Manifest Number to Log Message]
The Mexican manifest number needs to be logged → The Mexican manifest number from the input record is moved to the log message field
[Format Log Message for KCM Update]
The log message content needs to be formatted → The formatted KCM log message is moved to the final log message field
[Set Transaction Details]
Transaction details need to be established → The sending transaction code and user ID are set from the communication area
[Get Current Date and Time]
The log entry needs to be timestamped → The current machine date and time are formatted and moved to the log message date and time fields
[Prepare EXCI Transaction Call]
The EXCI transaction call needs to be prepared → The log input is moved to the transaction message, accept status is cleared, transaction name is set, and communication area lengths are calculated
[Call Transaction Log System]
The log entry needs to be submitted to the transaction log system → The CSIEXCI program is called with the prepared communication area and log message
[Generate Empty File Report Message]
The input file is empty with no cargo manifest records → Generate an empty report message and write it to the report file
[A2RT Segment Found?]
The A2RT cargo segment is found in the database → Proceed to check space availability in N9 segments for pedimento information updates
[Execute Initial SHIPROOT Search]
The system executes a GU (Get Unique) function call to FWCWBIO with SHIPROOT database → The database returns the first matching equipment record or indicates no match found

Structural Validations

[Validate Lead Car Equipment ID]
Equipment ID validation is performed → If car ID from shiproot equals the equipment ID being searched then proceed to waybill validation, otherwise search for multi-ship equipment records
[Search for Available N9 Slot]
The system searches for available N9 segment slots → The system identifies the first available slot or determines no space is available
[Report No Space Error]
The system attempts to append new FEN pedimento information → The system sets no space error flag and increments error record counter
[Manifest Record Found?]
If the query result → If the record exists, set segment found flag to true, otherwise set segment not found flag to true
[Is N9 Data Empty or Low-Values?]
If the N9 data content → If N9 data equals spaces or low-values, stop processing segments, otherwise continue with qualifier check
[Counter <= Maximum N9 Segments?]
The counter is compared against the maximum N9 segments allowed → Continue processing if counter is less than or equal to maximum, otherwise end processing
[N9 Data Empty or Low-Values?]
The N9 segment data is checked for emptiness or low-values → If data is empty or contains low-values, end N9 processing; otherwise continue with qualifier checking
[Space Available in N9 Array?]
The system searches through N9 segments array for an empty or available slot → If an available slot is found within the maximum array size, the system proceeds with appending; if no space is available, the system reports a no space error
[Report No Space Error]
The system attempts to append new FEN pedimento information → The system sets the no space error flag and increments the error records counter without modifying the cargo record
[Check Current N9 Position]
If the current position for availability → The N9 data at the current position is examined for content
[Index Exceeds Maximum?]
The current search index exceeds the maximum allowed N9 segment occurrences → The search boundary limit is detected to prevent array overflow
[Set No Space Available Error]
No empty positions are found and the search index exceeds the maximum limit → A no space available error is set and the error record counter is incremented
[Find Available N9 Segment Slot]
The system searches through N9 segments to find an empty or available slot → The system identifies the first available slot index or determines that no space is available for the new KCM entry
[Space Available?]
The available slot index exceeds the maximum allowed N9 segments → The system sets an error condition indicating no space is available and increments the error record count
[Qualifier = KCM?]
The reference number qualifier is compared to the KCM qualifier constant → If the qualifier matches KCM, mark KCM as found and save the segment index position
[Mexican Manifest Numbers Match?]
The input Mexican manifest number is compared with the existing reference number in the KCM segment → If the numbers match exactly, no update is needed; if different, the segment requires replacement
[Space Available in N9 Segments?]
The search index exceeds the maximum allowed N9 segment occurrences → The system determines there is no space available and sets error condition
[Set Error - No Space Available]
The system attempts to add KCM information to N9 segments → The system sets no space available error flag and increments error record count
[Report No Space Error]
The system attempts to add new pedimento information → The system sets no space error flag and increments the error record counter
[Report No Space Error for KCM]
The system attempts to add new Mexican manifest information → The system sets no space error flag and increments the error record counter
[EXCI Call Successful?]
Call results need to be validated → Success is determined when response code is zero AND response2 code is zero AND abend code is space AND message length is zero
[Display Error Message to System Error]
Error information needs to be communicated → Error message with response codes and abend code is displayed to system error output
[Error Message Available?]
Detailed error information needs to be checked → System determines if error message pointer is not null indicating detailed error message availability
[Display Detailed Error Information]
Detailed error information needs to be displayed → Detailed error message is displayed to system error output using the error message length
[Log Call Successful?]
The success of the log transaction needs to be determined → The system checks if EXCI response is zero, response2 is zero, abend code is space, and message length is zero to determine success
[Display Error Message]
Error information needs to be displayed → The system displays the program name, EXCI response codes, abend code, and any error message to system error output
[A2RT Segment Space Available?]
The maximum number of occurrences in the A2RT segment has been reached → Set no space available error flag and increment error counter
[Space Available in N9 Segments?]
The index exceeds the maximum allowed N9 segment occurrences → Set no space available error flag and increment the error counter
[Continue Processing]
The input pedimento number equals the existing cargo pedimento number → Set same pedimento number flag and increment the cargo skipped counter

Module: GCXA2D 1 Consolidated Epic Story

Epic: GCXA2D Complete EDI Specification Extracted from Legacy

Contains 42 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCXA2D EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[5:Execute Database Checkpoint]
The system receives a shutdown request during checkpoint (status code 'XD') → The system displays shutdown message and terminates abnormally, otherwise resets non-committed operations counter to zero
[Segment Type?]
The segment type is 'GCSCCS54' → The system processes GCSCCS54 segment deletion, when the segment type is 'GCSUSS15' then the system processes GCSUSS15 segment deletion, otherwise no processing occurs
[6:Delete GCSCCS54 Segments]
The system successfully retrieves the segment (status code is spaces) → The segment is deleted, non-committed operations counter is incremented, and GCSCCS54 deletion counter is incremented
[7:Delete GCSUSS15 Segments]
The system successfully retrieves the segment (status code is spaces) → The segment is deleted, non-committed operations counter is incremented, and GCSUSS15 deletion counter is incremented
[9:Display Deletion Summary]
GCSCCS54 segments were deleted (count greater than zero) → Display the count of GCSCCS54 segments deleted, otherwise if GCSUSS15 segments were deleted then display the count of GCSUSS15 segments deleted, otherwise display 'NO P1GCA2 SEGMENTS DELETED'
[Display Shutdown Message]
The checkpoint response indicates shutdown status → The system displays 'IMS SHUTDOWN REQUEST RECEIVED BY GCXA2D' message to the console and sets error message
[Initiate System Shutdown Process]
Shutdown message has been displayed → The system performs abnormal termination procedures
[Display Shutdown Message]
The checkpoint response status code equals 'XD' → The system displays 'IMS SHUTDOWN REQUEST RECEIVED BY GCXA2D' message to the console and sets the error message
[Initiate System Shutdown Process]
The system needs to terminate due to IMS shutdown request → The system performs abnormal termination procedure
[Set Retrieval Status to 'GEGB']
The system prepares to retrieve the segment → The system sets the accept status to 'GEGB' to enable segment retrieval
[Move Primary Key from Delete Keys File]
The system prepares to retrieve the segment → The system extracts and uses the primary key from the delete keys file record
[Retrieve GCSCCS54 Segment by Primary Key]
The system attempts to retrieve the segment → The system calls the database service to retrieve the GCSCCS54 segment using the primary key
[Segment Found Successfully?]
The system checks the retrieval result → The system proceeds with deletion only if the segment was found successfully (status code is spaces), otherwise skips the deletion process
[Clear Status for Delete Operation]
The system prepares to delete the segment → The system clears the accept status to spaces to enable the delete operation
[Delete GCSCCS54 Segment]
The system performs the deletion → The system calls the database service to delete the GCSCCS54 segment
[Increment Non-Committed Transaction Counter]
The deletion operation completes → The system increments the non-committed transaction counter by 1
[Increment GCSCCS54 Deletion Counter]
The deletion operation completes → The system increments the GCSCCS54 deletion counter by 1
[Get Primary Key from Delete Keys Record]
The system needs to identify the target segment for deletion → The primary key is extracted from the delete keys record and used as the search key
[Retrieve GCSUSS15 Segment Using Primary Key]
The system attempts to retrieve the segment from the database → The system performs a get hold unqualified operation to locate and lock the segment for potential deletion
[Delete GCSUSS15 Segment]
The segment deletion operation is executed → The system performs a delete operation to remove the segment from the database
[Increment Deletion Counter for GCSUSS15]
The deletion operation completes → The system increments the GCSUSS15 deletion counter by 1 and increments the non-committed operations counter by 1
[Skip - Segment Not Found]
The segment is not found in the database → The system skips the deletion process and continues to the next record without incrementing any counters
[Increment GCSCCS54 Counter]
The segment type is GCSCCS54 and the deletion operation completed without errors → The GCSCCS54 deletion counter is incremented by 1
[Increment GCSUSS15 Counter]
The segment type is GCSUSS15 and the deletion operation completed without errors → The GCSUSS15 deletion counter is incremented by 1
[Segment Type?]
If the segment type from the delete keys record → The appropriate counter is selected based on whether the segment is GCSCCS54 or GCSUSS15
[Display GCSCCS54 Deletion Count with Message]
The number of GCSCCS54 segments deleted is greater than zero → Display the count of GCSCCS54 segments deleted with the message 'P1GCA2 GCSCCS54 SEGMENTS DELETED'
[Display GCSUSS15 Deletion Count with Message]
The number of GCSUSS15 segments deleted is greater than zero → Display the count of GCSUSS15 segments deleted with the message 'P1GCA2 GCSUSS15 SEGMENTS DELETED'
[Display 'NO SEGMENTS DELETED' Message]
Both GCSCCS54 and GCSUSS15 deletion counts are zero → Display the message 'NO P1GCA2 SEGMENTS DELETED'
[Display GCSCCS54 Deletion Count]
The number of deleted GCSCCS54 segments is greater than zero → The system displays the count of GCSCCS54 segments deleted with descriptive message
[Display GCSUSS15 Deletion Count]
The number of deleted GCSUSS15 segments is greater than zero → The system displays the count of GCSUSS15 segments deleted with descriptive message
[Display 'No Segments Deleted']
No GCSCCS54 segments were deleted AND no GCSUSS15 segments were deleted → The system displays 'NO P1GCA2 SEGMENTS DELETED' message
[Display Shutdown Message to Console]
The shutdown condition is confirmed → Display 'IMS SHUTDOWN REQUEST RECEIVED BY GCXA2D' message to the console
[Call System Abend Process]
The system needs to terminate abnormally → Invoke the system abend process to handle abnormal termination
[Display GCSCCS54 Deletion Count]
The system begins the cleanup and termination process → The system displays the count of GCSCCS54 segments that were deleted along with the segment type identifier
[Display GCSUSS15 Deletion Count]
If which deletion results to display → The system displays the count of GCSUSS15 segments that were deleted along with the segment type identifier
[Display 'No Segments Deleted']
If deletion results for reporting → The system displays a message indicating that no P1GCA2 segments were deleted
[Display GCSCCS54 Deletion Count with Message]
The number of GCSCCS54 deletions is greater than zero → The system displays the count of GCSCCS54 segments deleted with the message 'P1GCA2 GCSCCS54 SEGMENTS DELETED'
[Display GCSUSS15 Deletion Count with Message]
The number of GCSUSS15 deletions is greater than zero → The system displays the count of GCSUSS15 segments deleted with the message 'P1GCA2 GCSUSS15 SEGMENTS DELETED'
[Display 'NO P1GCA2 SEGMENTS DELETED']
No GCSCCS54 segments were deleted AND no GCSUSS15 segments were deleted → The system displays the message 'NO P1GCA2 SEGMENTS DELETED'

Structural Validations

[Segment Found?]
The system checks the operation status → If the status code is spaces (successful), the segment exists and deletion can proceed, otherwise the segment is not found
[Deletion Successful?]
The deletion operation status is evaluated → Counters are only updated if the deletion completed successfully, otherwise no counter updates occur
[Set Error Message for Shutdown]
The shutdown message needs to be recorded → Set the error message to 'IMS SHUTDOWN REQUEST RECEIVED BY GCXA2D'

Module: GCXP1A9 1 Consolidated Epic Story

Epic: GCXP1A9 Complete EDI Specification Extracted from Legacy

Contains 72 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCXP1A9 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Counters]
The initialization process begins → All transaction type counters (309, 311, 353, 358, REP, OTHER) are set to zero AND all dependent segment counters (0-dependents, 1-dependent, 2-or-more-dependents) are set to zero
[Initialize Dependent Segment Counter to 0]
The system begins counting dependent segments for the transmission segment → The dependent segment counter is initialized to 0
[Initialize Temporary Counter to 0]
The system begins counting dependent segments → The temporary counter is initialized to 0

Core Acceptance Criteria

[4:Classify Transaction Types]
The transaction set code is '309' → Increment the NUMBER-309 counter by 1
[4:Classify Transaction Types]
The transaction set code is '311' → Increment the NUMBER-311 counter by 1
[4:Classify Transaction Types]
The transaction set code is '353' → Increment the NUMBER-353 counter by 1
[4:Classify Transaction Types]
The transaction set code is '358' → Increment the NUMBER-358 counter by 1
[4:Classify Transaction Types]
The transaction set code is 'REP' → Increment the NUMBER-REP counter by 1
[4:Classify Transaction Types]
The transaction set code does not match any known category → Increment the NUMBER-OTHER counter by 1 AND display the unknown transaction set code
[6:Count Dependent Segments]
Dependent segments are retrieved for the transmission segment → Initialize temporary counter to 0 AND increment counter for each successfully retrieved dependent segment
[7:Classify Dependent Segment Counts]
The dependent segment count equals 0 → Increment the NUMBER-WITH-0 counter by 1
[7:Classify Dependent Segment Counts]
The dependent segment count equals 1 → Increment the NUMBER-WITH-1 counter by 1
[7:Classify Dependent Segment Counts]
The dependent segment count is greater than 1 → Increment the NUMBER-WITH-2-OR-MORE counter by 1
[9:Calculate Total Counts]
Summary totals are being calculated → Calculate NUMBER-TOT1 as the sum of NUMBER-309 + NUMBER-311 + NUMBER-353 + NUMBER-358 + NUMBER-REP + NUMBER-OTHER
[9:Calculate Total Counts]
Summary totals are being calculated → Calculate NUMBER-TOT2 as the sum of NUMBER-WITH-0 + NUMBER-WITH-1 + NUMBER-WITH-2-OR-MORE
[Set Transaction Type 309 Counter to Zero]
The initialization process begins → The transaction type 309 counter is set to zero
[Set Dependent Segments Count 0 Counter to Zero]
The initialization process begins → The counter for transactions with zero dependent segments is set to zero
[Set Dependent Segments Count 1 Counter to Zero]
The initialization process begins → The counter for transactions with one dependent segment is set to zero
[Set Dependent Segments Count 2-or-More Counter to Zero]
The initialization process begins → The counter for transactions with two or more dependent segments is set to zero
[Call CIMS Interface to Connect to GCA9 Database]
The system calls CIMS interface with GN operation for GCA9 database and transmission segment → The system attempts to establish connection to retrieve transmission segments
[Make Initial Database Call to Get First Transmission Segment]
The initial database call is made to retrieve the first transmission segment → The system should attempt to retrieve the first available transmission segment using the appropriate database interface
[Get Next Transmission Segment from Database]
The system needs to retrieve the next transmission segment → The system should make a database call to get the next available transmission segment and continue processing until no more segments are available
[More Transmission Segments Available?]
A database call returns a status indicating no more segments are available → The system should recognize this as the end of processing and terminate the retrieval loop
[Classify as Type 309]
The transaction set code equals '309' → The system increments the counter for Type 309 transactions by 1
[Classify as Type 311]
The transaction set code equals '311' → The system increments the counter for Type 311 transactions by 1
[Classify as Type 353]
The transaction set code equals '353' → The system increments the counter for Type 353 transactions by 1
[Classify as Type 358]
The transaction set code equals '358' → The system increments the counter for Type 358 transactions by 1
[Classify as Type REP]
The transaction set code equals 'REP' → The system increments the counter for Type REP transactions by 1
[Classify as Type OTHER]
The transaction set code does not match any predefined type → The system increments the counter for Type OTHER transactions by 1 and displays the unknown transaction set code
[Classify as Type OTHER]
The transaction set code does not match any known type → The system increments the counter for OTHER transactions by 1 and displays the unknown transaction set code
[Transaction Set = '309'?]
The transaction set code equals '309' → The NUMBER-309 counter is incremented by 1
[Transaction Set = '311'?]
The transaction set code equals '311' → The NUMBER-311 counter is incremented by 1
[Transaction Set = '353'?]
The transaction set code equals '353' → The NUMBER-353 counter is incremented by 1
[Transaction Set = '358'?]
The transaction set code equals '358' → The NUMBER-358 counter is incremented by 1
[Transaction Set = 'REP'?]
The transaction set code equals 'REP' → The NUMBER-REP counter is incremented by 1
[Increment NUMBER-OTHER Counter]
The transaction set code does not match any predefined transaction types → The NUMBER-OTHER counter is incremented by 1 and the unknown transaction set code is displayed
[Transaction Set = '309'?]
The transaction set code equals '309' → The system increments the 309 transaction counter by 1
[Transaction Set = '311'?]
The transaction set code equals '311' → The system increments the 311 transaction counter by 1
[Transaction Set = '353'?]
The transaction set code equals '353' → The system increments the 353 transaction counter by 1
[Transaction Set = '358'?]
The transaction set code equals '358' → The system increments the 358 transaction counter by 1
[Transaction Set = 'REP'?]
The transaction set code equals 'REP' → The system increments the REP transaction counter by 1
[Increment OTHER Counter]
The transaction set code does not match any predefined transaction types → The system increments the OTHER transaction counter by 1 and displays the unknown transaction set code
[Retrieve Next Dependent Segment for Current Transmission]
The system requests the next dependent segment for the current transmission → The system calls the database interface to retrieve the next dependent segment record
[Dependent Segment Found?]
The database operation completes → If the status code is blank spaces, a dependent segment was found, otherwise no dependent segment was found
[Increment Dependent Segment Counter by 1]
The system confirms the dependent segment exists → The dependent segment counter is incremented by 1
[Return Total Count of Dependent Segments]
No more dependent segments are available → The system returns the total count of dependent segments found
[Retrieve Next Dependent Segment]
The system needs to count dependent segments → The next dependent segment is retrieved from the database
[Dependent Segment Found?]
The system checks the retrieval status → If status code is blank (successful), continue processing; otherwise, stop counting
[Increment Temporary Counter by 1]
The system processes the found segment → The temporary counter is incremented by 1
[Return Total Count of Dependent Segments]
The dependent segment counting process completes → Control returns to the calling process with the total count in the temporary counter
[Increment Counter for Segments with 0 Dependents]
The dependent segment count equals zero → The counter for transmission segments with zero dependents should be incremented by one
[Increment Counter for Segments with 1 Dependent]
The dependent segment count equals exactly one → The counter for transmission segments with one dependent should be incremented by one
[Increment Counter for Segments with 2 or More Dependents]
The dependent segment count is greater than one → The counter for transmission segments with two or more dependents should be incremented by one
[Display Transaction Type 309 Count]
The system generates the summary report → The system displays the count of transactions with transaction set equal to '309'
[Display Transaction Type 311 Count]
The system generates the summary report → The system displays the count of transactions with transaction set equal to '311'
[Display Transaction Type 353 Count]
The system generates the summary report → The system displays the count of transactions with transaction set equal to '353'
[Display Transaction Type 358 Count]
The system generates the summary report → The system displays the count of transactions with transaction set equal to '358'
[Display Transaction Type REP Count]
The system generates the summary report → The system displays the count of transactions with transaction set equal to 'REP'
[Display Transaction Type OTHER Count]
The system generates the summary report → The system displays the count of transactions that do not match any of the specific transaction types (309, 311, 353, 358, REP)
[Display Transaction Type OTHER Count]
The system generates the summary report → The system computes the total as the sum of NUMBER-309 plus NUMBER-311 plus NUMBER-353 plus NUMBER-358 plus NUMBER-REP plus NUMBER-OTHER and displays the result
[Display Segments with 0 Dependents Count]
The system generates the summary report → The system displays the count of transmission segments that have exactly zero dependent segments
[Display Segments with 1 Dependent Count]
The system generates the summary report → The system displays the count of transmission segments that have exactly one dependent segment
[Display Segments with 2+ Dependents Count]
The system generates the summary report → The system displays the count of transmission segments that have two or more dependent segments
[Display Segments with 2+ Dependents Count]
The system generates the summary report → The system computes the total as the sum of NUMBER-WITH-0 plus NUMBER-WITH-1 plus NUMBER-WITH-2-OR-MORE and displays the result
[Add All Transaction Type Counts 309 + 311 + 353 + 358 + REP + OTHER]
The system performs total calculation for transaction types → The system computes NUMBER-TOT1 as the sum of all six transaction type counters (NUMBER-309 + NUMBER-311 + NUMBER-353 + NUMBER-358 + NUMBER-REP + NUMBER-OTHER)
[Add All Dependent Segment Counts 0-Segments + 1-Segment + 2-or-More-Segments]
The system performs total calculation for dependent segment categories → The system computes NUMBER-TOT2 as the sum of all three dependent segment category counters (NUMBER-WITH-0 + NUMBER-WITH-1 + NUMBER-WITH-2-OR-MORE)

Structural Validations

[Transmission Segment Retrieved Successfully?]
The system checks the retrieval status → If the status code is blank (successful), continue processing; otherwise, terminate the retrieval process

Module: GCXP1A92 1 Consolidated Epic Story

Epic: GCXP1A92 Complete EDI Specification Extracted from Legacy

Contains 91 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCXP1A92 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Counters]
The program begins execution → All counters for transaction types (309, 311, 353, 358, REP, OTHER), dependency counts (0, 1, 2+), and deletion count are set to zero
[Initialize Dependent Counter to Zero]
The dependent counting process begins → The dependent counter is set to zero
[Initialize Dependent Counter to Zero]
The dependent counting process begins → The dependent counter is set to zero to start fresh counting

Core Acceptance Criteria

[2:Retrieve First Transaction Record]
The system calls the database interface to get the first transmission segment → The first transmission record is retrieved and made available for processing
[More Records Available?]
The system checks the status after attempting to retrieve a record → Processing continues if records are available, otherwise processing moves to summary reporting
[4:Classify Transaction by Type]
The system examines the transaction set field → The record is classified as type 309, 311, 353, 358, REP, or OTHER and the corresponding counter is incremented by 1
[5:Count Dependent Records]
The system retrieves all dependent segments for the transmission record → The total count of valid dependent segments is determined and stored
[6:Classify by Dependent Count]
If the dependent count → The record is classified as having 0, 1, or 2+ dependents and the appropriate counter is incremented
[Zero Dependencies?]
The dependent count equals zero → The record is marked for deletion processing
[One Dependency?]
The dependent count equals one → The record is marked for deletion processing
[Two or More Dependencies?]
The dependent count is two or more → The record requires additional evaluation based on transaction type before deletion
[7:Delete Records with Zero Dependencies, 8:Delete Records with One Dependency, 9:Delete Leftover 311 Transactions]
The deletion process is initiated → The transmission record is deleted from the system and the deletion counter is incremented
[Transaction Type 311?]
The system checks the transaction set value → Records with transaction set '311' are marked for deletion, others are preserved
[10:Update Record for Next Processing]
The system requests the next transmission record → The next available transmission record is retrieved or end-of-data status is returned
[11:Display Processing Statistics]
The system generates processing statistics → Counts for each transaction type (309, 311, 353, 358, REP, OTHER) and dependency classification (0, 1, 2+) are displayed
[Set Transaction Type 309 Counter to Zero]
The initialization process begins → The transaction type 309 counter is set to zero
[Set Database Access Parameters]
Database access is initiated → The system sets the database accept status to 'GE' to indicate get first operation
[Execute Database Call to Get First Record]
The system executes the database call with GN operation → The system calls CIMS using CCCOM, GN, GCA9-PCB, and A9RT-TRANSMISSION-SEGMENT parameters
[Start Processing Loop]
The processing loop is initiated → The acceptance status is set to 'GE' to enable record retrieval
[Get Current Transaction Record]
A request is made to retrieve the current transmission segment record → The system calls the database interface to fetch the transmission segment record
[Process Current Record]
The record processing is initiated → The system performs the transaction segment processing routine
[Move to Next Record]
The system needs to advance to the next record → The acceptance status is set to 'GEGB' and the database interface is called to move to the next transmission segment
[More Records Available?]
If the availability of more records → If status code equals blank spaces, more records are available; if status code equals 'GB', no more records exist
[End Processing Loop]
The status code indicates 'GB' (no more records) → The processing loop terminates and control returns to the main program flow
[Transaction Set = '309'?]
The transaction set code equals '309' → Increment the 309 transaction counter by 1
[Transaction Set = '311'?]
The transaction set code equals '311' → Increment the 311 transaction counter by 1
[Transaction Set = '353'?]
The transaction set code equals '353' → Increment the 353 transaction counter by 1
[Transaction Set = '358'?]
The transaction set code equals '358' → Increment the 358 transaction counter by 1
[Transaction Set = 'REP'?]
The transaction set code equals 'REP' → Increment the REP transaction counter by 1
[Increment OTHER Counter]
The transaction set code does not match any predefined transaction types → Increment the OTHER transaction counter by 1 and display the unknown transaction set code
[Transaction Set = '309'?]
The transaction set code equals '309' → The 309 transaction counter is incremented by 1
[Transaction Set = '311'?]
The transaction set code equals '311' → The 311 transaction counter is incremented by 1
[Transaction Set = '353'?]
The transaction set code equals '353' → The 353 transaction counter is incremented by 1
[Transaction Set = '358'?]
The transaction set code equals '358' → The 358 transaction counter is incremented by 1
[Transaction Set = 'REP'?]
The transaction set code equals 'REP' → The REP transaction counter is incremented by 1
[Increment OTHER Counter]
The transaction set code does not match any predefined transaction types → The OTHER transaction counter is incremented by 1
[Retrieve Next Dependent Segment Record]
The system needs to retrieve the next dependent segment record → The system calls the database to get the next dependent segment record using the appropriate parameters
[Dependent Record Found?]
The retrieval operation completes → If the status code is blank (successful), a dependent record was found, otherwise no more dependent records exist
[Increment Dependent Counter by 1]
The record is confirmed as valid → The dependent counter is incremented by 1
[Return Total Count of Dependent Records]
No more dependent records are found → The system returns the total count of dependent records found
[Retrieve Next Dependent Segment Record]
The system processes dependent segments using CIMS with GNP function → The next dependent segment record is retrieved from the database
[Dependent Record Found?]
The system checks the status code from the retrieval operation → If status code is blank spaces, a dependent record was found; otherwise no more dependent records exist
[Increment Dependent Counter by 1]
The status code indicates successful retrieval (blank spaces) → The dependent counter is incremented by 1
[Complete Count for Current Transmission Segment]
No more dependent records are found (status code is not blank spaces) → The dependent counting process is complete and the final count is ready for use
[Count = 0?]
The dependent record count equals zero → The transmission should be incremented in the zero dependencies counter and marked for zero dependencies processing
[Count = 1?]
The dependent record count equals one → The transmission should be incremented in the one dependency counter and marked for one dependency processing
[Increment Two-or-More Dependencies Counter]
The dependent record count is two or more → The transmission should be incremented in the two-or-more dependencies counter and marked for multiple dependencies processing
[Increment Zero Dependencies Counter]
The zero dependencies classification is applied → The zero dependencies counter should be incremented by one
[Increment One Dependency Counter]
The single dependency classification is applied → The one dependency counter should be incremented by one
[Increment Two-or-More Dependencies Counter]
The multiple dependencies classification is applied → The two-or-more dependencies counter should be incremented by one
[Count = 1?]
The dependent record count equals one → The transmission should be incremented in the one dependency counter and marked for single dependency processing
[Increment Zero Dependencies Counter]
The zero dependencies classification is confirmed → The zero dependencies counter should be incremented by one
[Increment One Dependency Counter]
The single dependency classification is confirmed → The one dependency counter should be incremented by one
[Increment Two-or-More Dependencies Counter]
The multiple dependencies classification is confirmed → The two-or-more dependencies counter should be incremented by one
[Check Dependent Count]
The number of dependent records equals zero → The system should identify this record for deletion processing
[Increment Zero Dependencies Counter]
The record is identified for deletion → The zero dependencies counter should be incremented by one
[Lock Transmission Segment Record]
The deletion process is initiated → The system should lock the transmission segment record using hold/update operation
[Delete Transmission Segment Record]
The delete operation is executed → The transmission segment record should be permanently removed from the system
[Increment Deletion Counter]
The deletion operation completes → The deletion counter should be incremented by one
[Record has exactly 1 dependent]
The transmission segment has exactly one dependent record associated with it → The system increments the counter for records with one dependency, marks the record for deletion, executes the database delete operation, increments the deletion counter, and confirms the record is successfully removed
[Increment counter for records with 1 dependency]
The dependent count validation is complete → The system increments the counter for records with one dependency by one
[Mark record for deletion]
The dependency count has been verified and the counter updated → The system marks the transmission segment for deletion by calling the delete procedure
[Execute database delete operation]
The delete procedure is invoked → The system executes a hold/update operation followed by a delete operation to remove the transmission segment from the database
[Increment deletion counter]
The delete procedure is called → The system increments the deletion counter by one to track the total number of deleted records
[Transaction Set = '311'?]
The transaction set of the transmission segment equals '311' → The transmission segment is marked for deletion and the delete operation is performed
[Execute Delete Operation]
The deletion process is initiated → The system performs a hold/update operation followed by a delete operation on the transmission segment
[Increment Delete Counter]
The delete operation finishes successfully → The deletion counter is incremented by 1
[Set Status Code for Next Record Retrieval]
The record retrieval process is initiated → The system sets the status code to ' GEGB' to indicate next record request
[Call Database to Get Next Transmission Segment]
The system executes the database call to get the next transmission segment → The system invokes CIMS with GN operation to retrieve the next A9RT transmission segment record
[Record Retrieved Successfully?]
The system checks the status code returned from the database operation → If status code equals ' ' (space), record retrieval was successful, otherwise retrieval failed or end of records reached
[Log Current Status Code]
The status code != space (indicating failure or end of records) → The system displays the current status code value for tracking purposes
[Record Ready for Next Iteration]
The status code indicates successful retrieval (status code = ' ') → The record is available for processing and the system can proceed with business logic operations
[End of Records Reached]
The status code indicates no more records are available or an error occurred → The system recognizes the end of processing condition and prepares to exit the record processing loop
[Display Transaction Type 309 Count]
The system displays processing statistics → The count of transaction type 309 records is displayed with label 'NUMBER-309 = '
[Display Transaction Type 311 Count]
The system displays processing statistics → The count of transaction type 311 records is displayed with label 'NUMBER-311 = '
[Display Transaction Type 353 Count]
The system displays processing statistics → The count of transaction type 353 records is displayed with label 'NUMBER-353 = '
[Display Transaction Type 358 Count]
The system displays processing statistics → The count of transaction type 358 records is displayed with label 'NUMBER-358 = '
[Display Transaction Type REP Count]
The system displays processing statistics → The count of transaction type REP records is displayed with label 'NUMBER-REP = '
[Display Other Transaction Types Count]
The system displays processing statistics → The count of other transaction type records is displayed with label 'NUMBER-OTH = '
[Display Processing Statistics]
The system displays processing statistics → The total count is calculated as the sum of all transaction type counts and displayed with label 'TOTAL1 = '
[Display Zero Dependencies Count]
The system displays processing statistics → The count of transactions with zero dependencies is displayed with label 'NUMBER-0 = '
[Display One Dependency Count]
The system displays processing statistics → The count of transactions with one dependency is displayed with label 'NUMBER-1 = '
[Display Two or More Dependencies Count]
The system displays processing statistics → The count of transactions with two or more dependencies is displayed with label 'NUMBER-2-OR= '
[Display Total Deleted Records Count]
The system displays processing statistics → The count of deleted records is displayed with label 'DELETED = '
[Calculate Total by Transaction Type TOTAL1 = 309 + 311 + 353 + 358 + REP + OTHER]
The system needs to calculate the total number of transactions processed → The system computes TOTAL1 by adding NUMBER-309 + NUMBER-311 + NUMBER-353 + NUMBER-358 + NUMBER-REP + NUMBER-OTHER

Structural Validations

[Database Call Successful?]
The database call returns a status code → If the status code is not blank spaces, the system handles the database error by calling CERR
[Handle Database Error]
The status code indicates an error condition → The system calls CERR using CCCOM to handle the database error

Module: GCXUSSR 1 Consolidated Epic Story

Epic: GCXUSSR Complete EDI Specification Extracted from Legacy

Contains 117 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCXUSSR EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize ISCOM Communication Structure]
The system begins initialization process → The ISCOM communication structure is initialized to enable message processing
[Initialize Working Storage Areas]
The system starts Canadian manifest processing → All cargo report segments, working arrays, user IDs, email fields, and index counters are cleared to spaces or zeroes
[Initialize US Data Structures]
The system begins processing the US manifest → All US manifest data structures including root record, segment records S01-S15, and working arrays are cleared to spaces, and all index counters are reset to zero
[Initialize Log Data Structures]
The system begins log processing → All log data structures including save key, request ID, log record segments, email fields, user IDs, page numbers, and subject lines are cleared to spaces or zeros
[Initialize Valid Merlin IDs Array]
The Merlin transmission process begins → The valid user ID storage is cleared and the counter is reset to zero
[Initialize Merlin Communication]
The system prepares for Merlin communication → All Merlin communication parameters are cleared and system components are initialized through CCISCOM call
[Initialize Log Processing Variables]
The system begins log report formatting → All log processing variables are cleared to spaces, request ID is saved, log record data is moved to appropriate segments, and email variables are initialized
[Initialize Merlin Communication Parameters]
Communication parameters need to be prepared → Keywords, copy usercode, item sequences, and message counters are cleared to ensure clean transmission setup

Core Acceptance Criteria

[53:Process Log Data Request]
The system processes the log request → The system formats log details with converted timestamps, user codes, and activity messages, and continues processing until end of file or request ID changes
[54:Format Log Details]
The system formats the log details → The system converts timestamps using nines complement arithmetic, extracts year, month, day, hour, and minute components, includes user code and activity message, and formats load date and time information
[61:Send Reports to Merlin]
The system sends the report via Merlin → The system validates Merlin user IDs, writes report content to log file, and if valid user IDs exist then calls EMCSEND3 to send the report and logs successful transmission, else logs that all provided IDs were invalid
[Clear Main Cargo Report Segment]
The system begins Canadian manifest processing → The main cargo report segment structure is cleared to spaces
[Move Input Data to Working Storage]
The system begins Canadian manifest processing → The input data record is moved to the Canadian cargo report segment working storage
[Move Input Data to Canadian Cargo Segment]
The system processes the input data → The input data record is moved to the Canadian cargo report segment structure
[Set Equipment ID in CCN List]
The manifest collection process starts → The equipment ID for index is copied to both the CCN list car ID field and the email subject car ID field, and the country is set to 'CANADIAN'
[Store First Manifest CCN and Creation Date]
Processing the first manifest record → The CCN key is stored in the first position of the CCN list array and the CCN creation date is stored in the corresponding date array position
[Read Next Input Record]
Reading the next record in the collection process → If end of file is reached, set the end-of-file indicator to 'Y', otherwise move the data record to the Canadian cargo report segment
[Set Equipment ID in CCN List]
Building the CCN list for the equipment → The equipment ID is copied to both CCN list car ID field and email subject car ID field
[Store First CCN Key and Creation Date]
Processing the first CCN for the equipment → The CCN key is stored in the CCN list array at current counter position and the CCN creation date is stored in the corresponding date array
[Read Next Input Record]
Reading from input data file → If end of file is reached, set end-of-file flag to 'Y', otherwise move the data record to cargo report segment
[Store CCN Key in Array]
Storing CCN information in the array → The CCN key from the cargo report segment is moved to the CCN list array at the current counter position
[Store CCN Creation Date in Array]
Storing CCN date information in the array → The CCN creation date from the cargo report segment is moved to the CCN date array at the current counter position
[Set CCN Key to Report Header]
The system builds the report header → The CCN key from the cargo report segment should be assigned to both the MERLIN CCN field and the working storage CCN field
[Add CCN to Header]
The system builds the report header → The CCN key should be assigned to the cargo CCN field
[Extract Train ID Information]
The system extracts train information → The Canadian customs north train ID should be moved to the print train ID field
[Send Report via Merlin]
The system sends the report → Validate MERLIN user IDs, send report to valid users through MERLIN system, log successful distribution with user list, and log error message if all user IDs are invalid
[Send Reports to Merlin]
The system sends the report via MERLIN → Validate MERLIN user IDs, send report to valid users, log successful transmissions with user list, and log error message if all user IDs are invalid
[Read Next Record]
System reads next input record → Record data is moved to US manifest segment if not at end of file, otherwise end of file flag is set
[Parse CCN Key into Components]
The system needs to display CCN components separately → The SCAC code is moved to PT-US-CCN-SCAC and the first 12 characters of CCN number are moved to PT-US-CCN-NUM
[Move SCAC Code to Display Field]
The system formats the CCN display line → The SCAC code from HOLD-CCN-SCAC is moved to PT-US-CCN-SCAC display field
[Move CCN Number to Display Field]
The system formats the CCN display line → The first 12 characters of CCN number from HOLD-CCN-NUM are moved to PT-US-CCN-NUM display field
[Set Bond Type: Immediate Transportation]
The bond type code equals 'IT' or '61' → The bond type is classified as Immediate Transportation
[Set Bond Type: Immediate Exportation]
The bond type code equals 'IE' or '63' → The bond type is classified as Immediate Exportation
[Bond Type Code = 'IT' or '61'?]
The bond type code equals 'IT' or '61' → The system sets the bond type description to 'Immediate Transportation'
[Bond Type Code = 'IE' or '63'?]
The bond type code equals 'IE' or '63' → The system sets the bond type description to 'Immediate Exportation'
[Get User Activity Information]
Extracting activity information → The ACF2 user code is moved to done-by field, the log message is moved to activity field, and load date/time components are extracted to processed date/time fields
[Format Extended Message Line]
Formatting the extended message line → All date/time and user fields are cleared to spaces, the extended message content from positions 51-60 is moved to the activity field, and the formatted line is added to the email text with incremented line counters
[Format Log Details]
Reading the next log record → The input file is read, and if not at end-of-file, the data record is moved to log record structure with root and dependent segments properly assigned, otherwise the end-of-file flag is set to 'Y'
[Clear Log Data Structures]
The system begins log report processing → All log data structures (SAVE-LGRT-KEY, WS-SAVE-REQ-ID, WS-HIST-LOG-RCD, LGRT-SEGMENT, LGDP-SEGMENT) are cleared to spaces
[Set Log Key Information]
The system processes log key data → The request ID is saved to WS-SAVE-REQ-ID, input data is moved to log record structure, log segments are populated, and user MERLIN IDs are captured
[Extract User ID from Log Entry]
The system processes the log entry → The ACF2 user code is extracted to DATA-DONE-BY field and the activity message is extracted to DATA-ACTIVITY field
[Handle Extended Log Messages]
Characters 51-60 of the message field are not empty spaces → The system creates an additional log line with the extended message content from positions 51-60, clearing all timestamp and user fields for the extended line
[Extract Activity Message]
The system formats log details → The message is moved to DATA-ACTIVITY field for display
[Extended Message Available?]
If positions 51-60 of LGDP-MESSAGE → If positions 51-60 are not spaces, the extended message processing is triggered
[Format Extended Message Line]
The system processes the extended message → All timestamp and user fields are cleared to spaces, the extended message content is moved to DATA-ACTIVITY, and DATA-LINE-1 is prepared for display
[Add Extended Message to Report]
The system processes the extended message for display → The extended message is added to EMI-TEXT-LINE at the current MERLIN-LINE-CNT position and both MERLIN-LINE-CNT and LINE-COUNT are incremented by 1
[Read Next Log Record]
The system continues log processing → Next record is read from INPUT-DATA-FILE, and if not at end of file, the record is moved to log segments for processing, otherwise end-of-file flag is set
[Get User ID who Performed Activity]
The system processes the log entry → The ACF2 usercode is moved to DATA-DONE-BY and the message is moved to DATA-ACTIVITY
[Extract Extended Message Text]
The system processes the log entry → The extended message text from positions 51-60 is extracted and processed as a continuation line
[Format Extended Message Line]
The system formats the extended message line → All primary fields (DATA-EX-YR, DATA-EX-MTH, DATA-EX-DAY, DATA-EX-HR, DATA-EX-MIN, DATA-DONE-BY, DATA-PD-MTH, DATA-PD-DAY, DATA-PD-HR, DATA-PD-MIN) are cleared to spaces, the extended message is moved to DATA-ACTIVITY, and the formatted line is added to the report
[Send Current Report via Merlin]
The report needs to be sent to users → The system should call the Merlin transmission process to deliver the report to the specified recipients
[Set Subject Line for Failed Request]
Preparing the notification for transmission → The request key value is moved to the email subject key field and the failed request subject template is applied to the email subject line
[Log Successful Delivery]
Valid user MERLIN IDs were found and used for transmission → A success message 'REPORT SENT TO THE FOLLOWING USERS:' is logged followed by the list of valid user IDs and an end-of-report marker
[Set Subject for Failed Request]
The system prepares the report for transmission → The system sets the email subject to the failed request subject template, assigns the extracted key value to the subject key field, and sets the recipient user IDs from the request MERLIN IDs
[63: Log Merlin Transactions]
The system prepares to send the report via Merlin → All report lines are written to the log file before transmission
[64: Handle Merlin Response Status]
The Merlin service returns a response status → If the status is not '0' (success), the system logs the error and calls the error handler
[Log Success Message with User List]
The transmission completes without errors → The system logs a success message including the list of users who received the report
[Log All Invalid IDs Message]
No valid user IDs are found in the provided list → The system logs a message indicating all provided IDs were invalid and no report is sent
[Clear Transmission Parameters]
The system starts the transmission setup process → All transmission parameters including recipient codes, keywords, copy fields, and message sequence numbers are cleared
[User ID Position <= 3?]
Processing user ID positions → The system processes positions 1 through 3 and stops when all three positions have been evaluated
[Valid Recipients Exist?]
The system checks for valid recipients → If valid recipients exist, the message is prepared for transmission, otherwise an invalid IDs message is logged
[Log Invalid IDs Message]
The system completes user ID processing with zero valid recipients → A message stating 'ALL IDS PROVIDED WERE INVALID' is written to the log
[Prepare Communication Parameters]
The system prepares for message sending → External communication programs CCISCOM and EMCSEND3 are called to establish communication parameters and send the message
[Transmission Successful?]
The system checks the return status flag → If status flag equals '0' then transmission is successful, otherwise transmission failed
[Log Merlin Transactions - Success]
The system logs the transmission results → Success message, recipient user list, and end-of-report marker are written to the log file
[Log Invalid IDs Message]
The system attempts to send a report → An 'ALL IDS PROVIDED WERE INVALID' message and end-of-report marker are written to the log file
[Valid Users Found?]
The system checks if any valid user IDs exist → If valid users exist, send report via Merlin system, otherwise log invalid ID message
[Send Report via Merlin System]
The system initiates report transmission → The report is sent via EMCSEND3 program to all valid users with proper subject and formatting
[Log Successful Delivery Message]
The system completes the transmission → A confirmation message 'REPORT SENT TO THE FOLLOWING USERS: ' is written to the log file
[Log Invalid IDs Message]
The system attempts to send the report → An error message 'ALL IDS PROVIDED WERE INVALID ' is written to the log file
[Write End of Report Marker]
The system completes the error logging process → An end-of-report marker is written to the log file
[Call Merlin Communication System]
The system calls the Merlin communication interface → The communication system is initialized and ready for message transmission
[Log Successful Delivery]
The transmission status is confirmed as successful → A success message is written to the log file indicating report delivery
[Send Current Report Page to Merlin]
The system needs to transmit the current report page → The system calls the Merlin service to send the current report content
[Set CCN Key to Report Header]
The system formats the report header → The CCN key from the cargo report segment should be assigned to both the MERLIN CCN field and the working storage CCN field
[Move Port Code to Display Field]
The system formats the manifest report and accesses the US port of exit code field → The US port of exit code from the Canadian manifest data is moved to the display field for the MERLIN report
[Format Complete Date/Time Display]
The system formats the complete log entry for display → The user code is moved to DATA-DONE-BY and the activity message is moved to DATA-ACTIVITY for display formatting
[Print Default Entity Line 2 with standard message]
The system continues default entity output generation → The second default entity line is printed with a standard default message
[Set Bond Type = 'IMMEDIATE TRANSPORTATION']
The bond type code is 'IT' or '61' → The system sets the bond type description to 'IMMEDIATE TRANSPORTATION' for report display
[Set Bond Type = 'IMMEDIATE EXPORTATION']
The bond type code is 'IE' or '63' → The system sets the bond type description to 'IMMEDIATE EXPORTATION' for report display
[Clear Log Data Structures]
The system begins log processing → All log data structures including save key, request ID, history log record, log root segment, and log dependent segment are cleared to spaces
[Parse Log Record Data]
Log processing begins → The input data record is moved to history log record working storage for processing
[Set Up Log Root Segment]
Log data structuring occurs → The history log root data is moved to log root segment and history log dependent data is moved to log dependent segment
[Extract Log Key Information]
Report header is being prepared → The log root key is moved to title CCN, email CCN, and saved log root key fields
[Get Activity Message/Description]
The system formats the log entry details → The message is moved to DATA-ACTIVITY field for display
[Extended Message Available?]
The system checks for extended message content → If positions 51-60 of LGDP-MESSAGE are not spaces, extended message processing is required
[Format Extended Message Line]
The system formats the extended message → All timestamp and user fields are cleared to spaces, the extended message content is moved to DATA-ACTIVITY, and DATA-LINE-1 is prepared for display
[Add Extended Message to Report]
The system adds the extended message to the report → The line is added to EMI-TEXT-LINE at current MERLIN-LINE-CNT position and both MERLIN-LINE-CNT and LINE-COUNT are incremented by 1
[Convert Log Timestamp]
Processing the log detail record → The timestamp should be converted from complement format to readable year, month, day, hour, and minute format, and the primary log message should be moved to the activity field for display
[Format Primary Log Entry Line]
Formatting the log entry for display → The log entry should be formatted with execution timestamp, done-by user, activity message, and processing timestamp, then added to the report
[Extended Message Present?]
Checking for extended message content → If positions 51-60 of the log message are not spaces, then an extended message is present and should be processed separately
[Format Extended Message Line]
Processing the extended message portion → All timestamp fields should be cleared, the user ID field should be cleared, the extended message should be moved to the activity field, all date/time fields should be cleared, and the extended message line should be formatted and added to the report
[Format Log Entry Data]
Processing the log entry for display → Convert complement timestamp to year/month/day/hour/minute format, extract user code and message, format load date and time, and prepare complete log entry line
[Check Extended Message]
Checking for extended message content → Evaluate if characters 51-60 of the message contain non-space data
[Add Extended Message Line]
Extended message content is not spaces → Clear standard fields, move extended content to activity field, format as additional log line, add to report at current line position, and increment both line counters by 1
[Read Next Log Record]
Reading the next log record → If end of file is reached, set end-of-file indicator to 'Y', otherwise move the data record to log record structure and parse into root and dependent segments
[Check Extended Message]
Checking if page limit is exceeded → Evaluate if MERLIN line count is greater than 480 lines
[63:Log Merlin Transactions - Write Report Lines to Log File]
The system prepares to send the report via Merlin → Each report line is written to the log file sequentially from line 1 to the total line count
[64:Handle Merlin Response Status]
The response status != '0' (success) → The error status is logged to the system error handler for further processing
[Log Success Message with User List]
The transmission completes without errors → A success message is logged followed by the list of users who received the report and an end-of-report marker
[Valid Merlin IDs Found?]
The system checks if any valid user IDs exist → If valid IDs exist, proceed with report transmission; otherwise, log an error message about invalid IDs
[Valid Users Found?]
The system checks if any valid user codes exist → If valid user codes exist, proceed with Merlin distribution, otherwise log invalid users message
[Log Success Message with User List]
The system confirms successful distribution → The system writes success message 'REPORT SENT TO THE FOLLOWING USERS:' followed by the list of recipient user codes to the log
[Log Invalid Users Message]
The system attempts to distribute a report → The system writes 'ALL IDS PROVIDED WERE INVALID' message to the log file

Structural Validations

[Extended Message Exists?]
Checking for extended message content → An extended message exists if positions 51 through 60 of the log message are not spaces
[Log Invalid User IDs]
All provided MERLIN user IDs are invalid → An error message 'ALL IDS PROVIDED WERE INVALID' is logged followed by an end-of-report marker
[62: Validate Merlin IDs]
The system processes each user ID in the list → Only non-empty user IDs are added to the valid user list for report transmission
[User ID Not Empty?]
The system checks if the user ID at the current position is not empty → If the user ID is not empty, it is added to the valid recipients list, otherwise it is skipped
[Validate Merlin IDs]
The system processes each user ID in the list → Only non-empty user IDs are added to the valid recipients list for report transmission
[Handle Merlin Response Status - Error]
The system processes the transmission failure → If status flag is not '0' then error handling is invoked, otherwise invalid IDs message and end-of-report marker are logged
[Return Status = '0'?]
The return status flag equals '0' → The transmission is considered successful
[Error Occurred]
The return status flag != '0' → The transmission is considered failed and requires error handling
[Log Error Message]
An error status is detected → The error status information is logged for troubleshooting purposes
[Call Error Handler]
Error handling is required → The system error handler is called to process the error condition
[Continue Processing]
All provided user IDs are determined to be invalid → A message indicating all IDs are invalid is written to the log
[120:Validate User Merlin IDs]
The system processes each Merlin ID in the list → Only non-empty Merlin IDs are added to the validated user list for report transmission
[Log Error Message - All IDs Invalid]
The system attempts to send a report → An error message indicating all provided IDs are invalid is logged followed by an end-of-report marker

Module: SPOOL2 1 Consolidated Epic Story

Epic: SPOOL2 Complete EDI Specification Extracted from Legacy

Contains 5 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all SPOOL2 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[Initial Data Available?]
The system checks for initial data content in the communication area → The system determines whether initial data is available for immediate writing

Structural Validations

[15:Handle Invalid Spool Type]
Invalid spool type is detected → System displays error message indicating invalid spool type and returns control
[Invalid Spool Type Detected]
The system processes the spool type validation → An error message 'ERRATO TIPO SPOOL SPOOL SPOOL SPOOL' is prepared and displayed to the user with screen clearing
[Prepare Error Message]
The error handling process begins → The message 'ERRATO TIPO SPOOL SPOOL SPOOL SPOOL' is moved to the message field
[Display Error Message to User]
The system needs to communicate the error to the user → The error message is sent to the user with a length of 42 characters and the screen is erased

Module: GCCUSIO3 1 Consolidated Epic Story

Epic: GCCUSIO3 Complete EDI Specification Extracted from Legacy

Contains 81 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCCUSIO3 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Loop Counter J = 1]
The system initializes the loop processing → The loop counter J is set to 1 to begin with the first AES export segment
[Initialize Loop Counter J = 1]
The system begins the loop to process multiple customs data segments → The loop counter is set to 1 to start processing from the first segment

Core Acceptance Criteria

[1:Retrieve US Cargo Record]
The system attempts to retrieve the US Cargo record with all segments → The cargo record and all associated segments are successfully retrieved and made available for processing
[2:Update Root Segment Key]
The system processes the root segment key update → The root segment US-CCN key is updated to the new value
[3:Update Cargo Details Segment Key]
The system checks each cargo details segment for existing data → If GCSUSS01 segment is not empty, its US-CCN key is updated to new value, and if GCSUSS02 segment is not empty, its US-CCN key is updated to new value
[4:Update Multiple Container Segments Keys]
The system iterates through all container segment occurrences up to maximum sequence → For each container segment occurrence that is not empty, the US-CCN key is updated to the new value
[5:Update Shipper Segment Key]
The system checks the shipper segment for existing data → If GCSUSS04 segment is not empty, its US-CCN key is updated to the new value
[6:Update Consignee Segment Key]
The system checks the consignee segment for existing data → If GCSUSS05 segment is not empty, its US-CCN key is updated to the new value
[7:Update Multiple Commodity Segments Keys]
The system iterates through all commodity segment occurrences up to maximum sequence → For each commodity segment occurrence that is not empty, the US-CCN key is updated to the new value
[8:Update Multiple AES Export Segments Keys]
The system iterates through all AES export segment occurrences up to maximum sequence → For each AES export segment occurrence that is not empty, the US-CCN key is updated to the new value
[9:Update Multiple Customs Data Segments Keys]
The system iterates through all customs data segment occurrences up to maximum sequence → For each customs data segment occurrence that is not empty, the US-CCN key is updated to the new value
[10:Update Hazmat Segment Key]
The system checks the hazmat segment for existing data → If GCSUSS09 segment is not empty, its US-CCN key is updated to the new value
[11:Update Reference Numbers]
The system processes reference number updates → The M1012 reference number field is set to the new US-CCN key value
[13:Update Bill of Lading Number]
The system checks if GCSUSS01 segment contains data → If GCSUSS01 is not empty, the M1304 BOL/WB number is set to the US-CCN ID number
[14:Insert Renumbered Record]
The system attempts to insert the renumbered cargo record → The complete cargo record with all associated segments is inserted using the new US-CCN key
[16:Log Renumbering From Activity]
The system creates the 'from' audit log entry → A log entry is created with the old US-CCN key as the key, new US-CCN key as the message, and renumbering-from as the log code
[17:Log Renumbering To Activity]
The system creates the 'to' audit log entry → A log entry is created with the new US-CCN key as the key, old US-CCN key as the message, and renumbering-to as the log code
[Set Retrieval Parameters]
Setting up retrieval parameters → The system should clear all status fields, enable underscore handling, set function to Get Unique, disable index usage, and enable all segment retrieval
[Set Old US-CCN Key as Search Key]
Preparing to retrieve the cargo record → The system should set the old US-CCN key as the search key in the cargo root segment
[Call US Cargo Retrieval Service]
Executing the cargo retrieval operation → The system should call the GCCUSIO2 service with all required cargo segments and arrays
[Load All Segment Data into Memory]
Processing the retrieved data → The system should move the first occurrence of each segment array (GCSUSS03, GCSUSS06, GCSUSS07, GCSUSS08, GCSUSS09, GCSUSS12) to their corresponding working storage segments
[Check if GCSUSS01 Segment Exists]
The system checks if the GCSUSS01 root segment exists and contains data (is not empty) → The system should update the US-CCN key field in the GCSUSS01 segment with the new US-CCN value
[Skip GCSUSS01 Update - Segment Empty]
The system checks if the GCSUSS01 root segment exists and finds it is empty → The system should skip updating the GCSUSS01 segment and proceed to the next processing step
[Replace Old US-CCN Key with New US-CCN Key in GCSUSS01 Segment]
The system performs the key replacement operation → The US-CCN key field in the GCSUSS01 segment should be updated from the old value to the new US-CCN key value
[Replace Old US-CCN Key with New US-CCN Key in GCSUSS02 Segment]
The system processes the cargo renumbering operation → The old US-CCN key in GCSUSS02 segment is replaced with the new US-CCN key
[Start Container Segments Key Update Loop]
The system starts the container segments key update loop → The loop counter J is initialized to 1 to begin processing from the first container segment
[Load Container Segment J Data]
The system needs to process the container segment data → The container segment data is moved from WS-GCSUSS03-DATA(J) to GCSUSS03 working area
[Replace Old US-CCN Key with New US-CCN Key]
The system performs the key replacement operation → The GCSUSS03-KEY-US-CCN field is updated with the value from IO3-NEW-US-CCN-KEY
[Save Updated Container Segment J Data]
The system needs to persist the updated data → The updated GCSUSS03 data is moved back to WS-GCSUSS03-DATA(J) in the working storage array
[Increment Loop Counter J]
The system needs to move to the next container segment → The loop counter J is incremented by 1 to point to the next container segment position
[Container Segments Key Update Complete]
The loop counter J exceeds GCSUSS99-S03-MAX-SEQ → The container segments key update process is marked as complete and control returns to the calling process
[Check if Shipper Segment Exists]
The system checks if shipper segment GCSUSS04 exists and is not empty → If the shipper segment exists and is not empty, replace the old US-CCN key with the new US-CCN key in GCSUSS04-KEY-US-CCN field, otherwise skip the update
[Check if Consignee Segment GCSUSS05 Exists]
The cargo renumbering process is executed with a new US-CCN key → The consignee segment key should be checked for existence and updated with the new US-CCN key if the segment is not empty
[Replace Old US-CCN Key with New US-CCN Key in GCSUSS05-KEY-US-CCN]
The segment key update is performed during cargo renumbering → The GCSUSS05-KEY-US-CCN field should be updated with the new US-CCN key value
[Update Multiple Commodity Segments Keys - Loop through and replace old US-CCN key with new US-CCN key in all commodity segments (GCSUSS06)]
The system processes each commodity segment from 1 to the maximum sequence number and encounters a commodity segment that has a valid key (not empty) → The system loads the commodity segment data, replaces the old US-CCN key with the new US-CCN key, and saves the updated commodity segment data back to the array
[J > Maximum AES Export Segments?]
The counter J is compared against the maximum number of AES export segments (GCSUSS99-S07-MAX-SEQ) → If J exceeds the maximum, processing is complete; otherwise continue with current segment
[Load AES Export Segment J Data]
The system needs to update the segment's US-CCN key → The segment data is moved from the working array (WS-GCSUSS07-DATA) to the processing structure (GCSUSS07)
[Replace Old US-CCN Key with New US-CCN Key]
The system performs the renumbering operation → The old US-CCN key in the segment (GCSUSS07-KEY-US-CCN) is replaced with the new US-CCN key (IO3-NEW-US-CCN-KEY)
[Save Updated AES Export Segment J Data]
The system completes the key update for the current segment → The updated segment data is moved back from the processing structure (GCSUSS07) to the working array (WS-GCSUSS07-DATA) at position J
[Increment Counter J]
The system needs to continue to the next segment → The loop counter J is incremented by 1 to move to the next AES export segment
[AES Export Segments Update Complete]
The loop counter exceeds the maximum number of AES export segments → The AES export segments update process is marked as complete and control returns to the calling process
[Update Multiple Customs Data Segments Keys - Loop through and replace old US-CCN key with new US-CCN key in all customs data segments (GCSUSS08)]
The system processes each customs data segment in sequence up to the maximum allowed segments → Each non-empty customs data segment has its US-CCN key replaced with the new US-CCN key and is saved back to the array
[Load Customs Data Segment J from Array]
The system needs to update the segment's US-CCN key → The segment data is loaded from the array into the working segment structure
[Replace Old US-CCN Key with New US-CCN Key in Segment]
The cargo renumbering process requires key update → The old US-CCN key in the segment is replaced with the new US-CCN key
[Save Updated Segment Back to Array]
The key update is complete for the current segment → The updated segment is saved back to its original position in the working array
[Increment Counter J]
The system needs to move to the next segment in the array → The loop counter J is incremented by 1 to point to the next segment position
[Replace Old US-CCN Key with New US-CCN Key in GCSUSS09-KEY-US-CCN]
The system checks if the hazmat segment GCSUSS09 has a non-empty key → The system replaces the old US-CCN key with the new US-CCN key in the hazmat segment GCSUSS09-KEY-US-CCN field
[Set New US-CCN Key in Root Segment]
The system processes the cargo renumbering request → The root segment US-CCN key field is updated with the new US-CCN key value
[Copy US-CCN Key to Reference Number Field]
The system updates reference fields for cargo renumbering → The M1012 reference number field is populated with the same US-CCN key value
[Update SCAC and Date Fields - Update SCAC code and date fields based on cargo type]
The system processes cargo field updates → The US-CCN ID number should be copied to the M1304 BOL/WB number field
[Does Cargo Details Segment Exist?]
If the cargo details segment (GCSUSS01) for data presence → The system proceeds to extract cargo ID if segment exists, or skips the bill of lading update if segment is empty
[Set Cargo ID Number as Bill of Lading/Waybill Number]
The system processes the bill of lading number update → The cargo ID number portion of the new US-CCN key is extracted and set as the bill of lading/waybill number (GCUS-M1304-BOL-WB-NUM)
[Prepare Insert Operation Parameters]
The system needs to prepare for inserting the updated cargo record → The system clears the accept status, initializes the IO parameters, and sets the function to insert mode with all segments enabled
[Set All Segments for Insert]
The system configures which segments to include in the insert → The system sets all segments flag to true, sets function to insert, and disables index usage
[Call Database Insert Function]
The system executes the database insert function → The system calls the GCCUSIO2 program with insert function and all cargo segment data including arrays
[Record Successfully Inserted with New US-CCN Key]
The system processes the successful insert result → The system moves array data to working segments, saves the new cargo root record, sets old US-CCN key, and initiates deletion of the original cargo record
[Set Delete Function Parameters]
The system prepares the delete operation parameters → The function is set to delete mode, the target is set to root segment only, and index usage is disabled
[Set New US-CCN Key as Log Message]
The system prepares to log the renumbering from activity → The new US-CCN key must be set as the log message content
[Prepare Log Entry Details]
The system prepares the complete log entry details → All log entry fields must be populated including action code from log code, message content, cargo identifier (using provided key or default), high-value security byte, US cargo type indicator, sending transaction code, user ID, current date and time
[Send Log Entry to Message Queue]
The system sends the log entry to the message queue → The log entry must be formatted as GCT1051E message and sent to the message queue system using CIMS interface
[Write Log Message to System]
The system writes the log message to permanent storage → The log message must be written using WRITMSGL interface with message code, content, length and module name
[Purge Message Queue]
The system completes the logging process → The message queue must be purged using CIMS interface to clean up temporary storage
[Set Log Message Content]
The log message content is being set → The working storage log message should be moved to the log message field
[US-CCN Key Available?]
The system checks for an available US-CCN key → If working storage US-CCN key is not spaces, use the provided key; otherwise use the current root segment US-CCN key
[Prepare Final Log Message Structure]
The final log message structure needs to be prepared → The complete log input structure should be moved to the final log message field
[Set Old US-CCN Key as Log Message]
The log message content is being prepared → The old US-CCN key should be set as the log message content
[Set Message with Old US-CCN Key]
The message field is being populated → The message field should contain the old US-CCN key value
[Create Log Message Structure]
The message structure is being created → The log input should be moved to the message structure and accept status should be cleared
[Send Log Entry to Message Queue]
The log entry needs to be sent to the queue → The CIMS program should be called with CHNG function and alternate PCB to send the message
[Write Log Message to Queue]
The message needs to be written to storage → The WRITMSGL program should be called with message code, message content, length, and module name
[Purge Message Queue]
The logging process needs to be completed → The CIMS program should be called with PURG function and alternate PCB to purge the queue
[Set Message from Log Message Parameter]
Setting up the log entry details → The message field is populated with the provided log message value
[US-CCN Key Parameter Empty?]
The US-CCN key parameter is checked for content → If the parameter is empty (spaces), use the current cargo root segment US-CCN key, otherwise use the provided parameter value

Structural Validations

[Insert Successful?]
The system checks the insertion operation status → If no errors occurred, processing continues with deletion of original record; otherwise an error message is set and the process is terminated
[Does GCSUSS02 Cargo Details Segment Exist?]
The system checks if the GCSUSS02 segment contains data → The system determines whether the segment exists and is not empty
[J > Maximum Container Segments?]
The system checks if J is greater than GCSUSS99-S03-MAX-SEQ → If J exceeds the maximum count, the loop terminates, otherwise processing continues to the next container segment
[Container Segment J Has Valid Key?]
If the condition NOT 88-GCSUSS03-EMPTY-KEY(J) → If the container segment has a valid non-empty key, proceed with key update processing, otherwise skip to the next segment
[AES Export Segment J Has Valid Key?]
The system checks if the segment key is not empty using the empty key indicator (88-GCSUSS07-EMPTY-KEY) → If the segment has a valid key, proceed with updating; otherwise skip to next segment
[J <= Maximum Customs Data Segments?]
The system checks if there are more segments to process → Processing continues if J is less than or equal to the maximum number of customs data segments, otherwise the loop terminates
[Current Customs Data Segment J Has Valid Key?]
The system checks if the segment contains valid key data → The segment is processed for key update if it has a valid non-empty key, otherwise it is skipped
[Insert Failed - Return Error]
The system detects insert operation failure → The system sets error message indicating renumbering failure and performs abend procedure

Module: GCX005 1 Consolidated Epic Story

Epic: GCX005 Complete EDI Specification Extracted from Legacy

Contains 608 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX005 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Waybill Segments]
The system begins waybill processing → All waybill segment structures (FWSWRWR-SEGMENT, FWSWREQ-SEGMENT, SHIPRADD) are cleared to spaces
[Initialize Equipment Search]
The system begins equipment matching process → The system should initialize temporary sequence to 2 and set equipment match indicator to false
[Initialize Seal Number Collection]
The system begins seal number collection → The system should initialize seal sequence counter, clear seal data area, and set seal counter to 1
[Initialize Status Flags to Spaces]
The system processes the manifest creation → The system initializes the 309 sent flag and 309 lock flag to spaces to indicate no prior processing
[Initialize Broker Segments]
No broker configuration is available → The broker segments are initialized to empty values and processing exits
[Initialize Empty Broker Configuration]
Broker configuration initialization is required → Initialize both broker segment and B1 segment to empty values and exit broker processing
[Initialize Empty B1 Configuration]
B1 configuration initialization is required → Initialize B1 segment to empty values
[Initialize EDIBOL CCN Array]
The EDIBOL CCN retrieval process begins → The EDIBOL CCN array is cleared and the counter is set to zero
[Initialize RF Segment Processing]
The system begins RF segment processing → The EDIBOL CCN counter is set to zero and EBSBCCX indicator is cleared
[Initialize EDIBOL CCN Arrays]
EDIBOL CCN retrieval process begins → EDIBOL CCN arrays are initialized to empty state and CCN counter is set to zero
[Initialize RF Segment Search]
System begins RF segment search process → Sequence counter is set to 1, EBSBCCX not found indicator is set to true, and RF segment type is set for search
[Initialize CY Segment Search]
System begins CY segment search process → CY segment type is set to 'CR', CY sequence counter is set to 0, and EBSBCCY not found indicator is initialized
[Initialize CY Search Variables]
The search initialization is performed → The segment type is set to 'CR', sequence counter is reset to 0, and search indicators are cleared
[Initialize CY Segment Variables]
The system begins CY segment retrieval process → All CY segment variables are cleared and initialized to spaces
[Initialize Match Status to No Match]
The system begins comparing GCCC CCNs with EDIBOL CCNs → The match status is set to 'No Match' as the initial state
[Initialize Match Status to No Match]
The system begins comparing GCCC CCNs with EDIBOL CCNs → The match status should be set to no match as the initial state
[Initialize RF Segment Processing]
The system prepares to process RF segments → The sequence counter is set to 1 and RF segment processing indicators are initialized
[Initialize Processing Variables]
The system prepares for transaction processing → Message pattern should be set to zeroes, sequence cargo should be set to zeroes, notification flag should be set to spaces, and skip record flag should be set to off
[Initialize Waybill Segments]
The system initializes waybill segments → All waybill segment structures (FWSWRWR-SEGMENT, FWSWREQ-SEGMENT, SHIPRADD) are cleared to spaces
[Initialize Empty Broker Configuration]
Both broker lookup attempts return unsuccessful results → The system initializes empty GCSTBRT-BK-SEGMENT and GCSTBRT-B1-SEGMENT and skips notification processing
[Initialize Spawn Message]
The system begins preparing the spawn message → All spawn message fields are cleared to spaces to ensure clean initialization
[Initialize New Status Flags]
The corrector flag is not set → The system initializes sent 309 flag and lock 309 flag to spaces (not sent/not locked)
[Initialize GCCC CCN Array]
CCN array management process begins → GCCC CCN array is initialized to empty state and EDIBOL CCN array is initialized to empty state and all array counters are set to zero
[Initialize GCCC CCN Array]
The system begins array initialization → GCCC CCN array is cleared and EDIBOL CCN array is cleared and array counters are set to zero
[Initialize EDIBOL CCN Array]
The EDIBOL CCN extraction process begins → The EDIBOL CCN array is cleared and the counter is set to zero
[Initialize RF Segment Processing]
The system prepares to process RF segments → The EDIBOL count is set to zero and EBSBCCX indicators are cleared for RF segment iteration
[Initialize CY Segment Search]
The system prepares to search for CCN references within the RF segment → The CY segment indicators are cleared and sequence counter is reset for CY segment iteration
[Initialize S55 Arrays and Variables]
The system begins S55 array creation process → Initialize GCWCCIO2, GCSCCS55, and WS-GCSCCS55-ARRAY to spaces

Core Acceptance Criteria

[1:Transaction Type Routing]
The transaction type is evaluated → The system should route to BUNCH-BILLING for spawning multiple cars, RESPAWN-BUNCH-BILLING for individual car processing, UPDATE-FOLLOWERS for follower updates, VALIDATE-BUNCH-UPDATE for validation, UPDATE-BUNCH-BILL for updates, DELETE-BUNCH-MANIFEST for bunch deletions, VALIDATE-MULTI-UPDATE for multi-validation, or DELETE-MULTI-CAR-MANIFEST for other deletions
[7:Seal Number Processing]
EDI data contains seal number information in EBSBCCX segments → The system should retrieve seal numbers from M7 segments, populate up to 20 seal numbers in the record, and mark as processed if seal numbers are found
[10:Delete Validation]
The cargo has a train ID assigned:
the cargo is released (except for EXPORT
S.A.R. releases)
→ The system should block the deletion and generate appropriate error messages: 'CCN NOT DELETED, IT HAS BEEN REPORTED ON A TRAIN' for train assignments or 'DELETE NOT AUTHORIZED, THIS CCN HAS BEEN RELEASED' for released cargo
[23:Cargo Report Creation]
All required data is available → The system should set transmission flag based on cargo control number presence, assign manifest type (single/follower/master), convert metric weights if needed, ensure minimum weight of 1, set bunch bill indicator, and clear batch print fields for follower manifests
[8:Manifest Search and Update]
The manifest is on a train:
locked by user
cargo has arrived (for 6105E CCNs)
broker entry exists with different broker name
→ The system should block the update and generate appropriate error messages: 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN', 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST', 'WB UPDATE NOT APPLIED CARGO IS ARRIVED', or 'BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT'
[28:EDIBOL CCN Retrieval]
CCNs need to be extracted from EDI segments → The system should retrieve shiproot and shipmine data, access EBSBCBC and EBSBCCR segments, find RF segments with CY subsegments containing XC reference qualifiers, and extract CCN numbers to build EDIBOL CCN array
[29:Unmatched CCN Processing]
All multi-bills are valid for update AND not multi-car manifest → The system should delete all existing customs CCNs using bunch manifest deletion and spawn GCX011 updates for all EDIBOL CCNs, otherwise block changes for multi-car manifests with appropriate error message
[31:Matched CCN Update Spawning]
Update spawning is required for valid CCNs → The system should spawn GCX011 update processes for each valid customs CCN that is eligible for update, skipping CCNs marked as invalid for update
[Route to Bunch Billing Processing Type: B]
The transaction type is GCX005-BUNCH-BILLING → The system routes to bunch billing processing to create individual CCNs for each equipment in the shipment
[Route to Respawn Bunch Billing Type: R]
The transaction type is GCX005-RESPAWN-BUNCH-BILLING → The system routes to respawn bunch billing processing to handle individual car manifest creation
[Route to Delete Multi-Car Manifest Type: D]
The transaction type does not match any specific type (OTHER case in evaluation) → The system routes to delete multi-car manifest processing as the default action
[Route to Update Followers Processing]
The transaction type is GCX005-UPDATE-FOLLOWERS → The system routes to update followers processing and sets end-of-followers flag to 'N' to begin processing
[Route to Validate Update Bunch Bill Type: V]
The transaction type is GCX005-VALIDATE-BUNCH-UPDATE → The system routes to validate bunch bill processing to check update eligibility
[Route to Update Bunch Bill Type: U]
The transaction type is GCX005-UPDATE-BUNCH-BILL → The system routes to update bunch bill processing to modify existing bunch bill records
[Route to Delete Multi-Car Manifest Type: D]
The transaction type is GCX005-DELETE-BUNCH-MANIFEST → The system routes to delete bunch multi-manifest processing to remove bunch manifest records
[Route to Validate Multi Bill Update Type: M]
The transaction type is GCX005-VALIDATE-MULTI-UPDATE → The system routes to validate multi-update processing to check multi-bill update eligibility
[Set Equipment Sequence to 1]
The system prepares to retrieve equipment data → The equipment sequence number (FWEQ-SEQ) is set to 1 for the initial data retrieval
[Get Master Cargo Report]
Individual car processing begins → The master cargo report is retrieved and stored for reference during CCN creation
[Clone A2 Records from Master]
A2 record cloning process executes → All A2 records are copied from master CCN to new CCN with updated CCN key, and seal numbers are built from EDI data for record type '56' if available
[Extract Master CCN Prefix - First 4 characters from Master CCN]
The system creates a new CCN → The first 4 characters of the master CCN key are extracted and used as the CCN type and car identifier prefix
[Preserve Original Flags]
The system prepares to update the existing manifest → The system moves GCCC-SENT-309-FLAG to WS-SAVE-SENT-309-FLAG and GCCC-LOCK-309-FLAG to WS-SAVE-LOCK-309-FLAG and GCCC-MULTI-CAR-MFST to WS-SAVE-MULTI-CAR-MFST and GCCC-CAR-SEQ-NUM to WS-SAVE-CAR-SEQ-NUM and GCCC-MASTER-MFST-CCN to WS-SAVE-MASTER-MFST-CCN
[Preserve Existing Flags - Sent 309 Flag - Lock 309 Flag - Multi-Car Manifest - Car Sequence Number - Master Manifest CCN]
The system prepares to update the cargo record → The sent 309 flag, lock 309 flag, multi-car manifest indicator, car sequence number, and master manifest CCN are preserved from the existing record
[Save Current Manifest Flags]
The system identifies this as a corrector scenario with duplicate CCN found → The system saves the current SENT-309-FLAG, LOCK-309-FLAG, MULTI-CAR-MFST indicator, CAR-SEQ-NUM, and MASTER-MFST-CCN values for later restoration
[Restore SENT-309-FLAG]
The system processes the manifest creation → The system restores the saved SENT-309-FLAG and LOCK-309-FLAG values from the preserved state
[Set Default Flag Values]
The system processes the manifest creation → The system sets SENT-309-FLAG and LOCK-309-FLAG to spaces (empty values)
[Retrieve Master Manifest Data]
The system processes an update bunch bill request → The system retrieves the master manifest record and stores it for subsequent processing operations
[Retrieve Target Manifest for Update]
The system processes an update bunch bill request → The system retrieves the target manifest record for hold and update operations
[Preserve Critical Status Flags]
The system processes the manifest update → The system preserves the sent 309 flag, lock 309 flag, multi-car manifest flag, car sequence number, and master manifest CCN from the existing record
[Preserve Critical Status Flags]
The system processes the manifest creation → The system sets sent 309 flag and lock 309 flag to spaces to initialize them as not sent and not locked
[Set Transmission Flags]
The cargo control number is empty and short cargo control number is not empty → The system uses the short cargo control number and sets transmission flag to yes, otherwise sets transmission flag to no
[Set Transmission Flags]
The in-transit status is 'R' for refused → The system sets the transmission flag to no to prevent customs transmission
[Check Train Status]
The manifest has a CDN CUS North train ID that is not empty → The system blocks the update, logs 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN' message, and marks the record to be skipped
[Verify Lock Conditions]
The manifest is locked due to user changes (309 locked condition) → The system blocks the update, logs 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST' message, and marks the record to be skipped
[Generate Audit Logs]
The system processes audit logging → The system creates audit logs for cargo creation, automatic transmission, error conditions, and completion events with appropriate action codes and timestamps
[Extract Master CCN Prefix - First 4 characters]
The system begins CCN creation process → The first 4 characters of the master CCN key are extracted and used as the CCN type and car identifier prefix
[Build Equipment-Specific Seal Numbers]
The system retrieves shiproot, shipmine, EBSBCBC, and equipment segments successfully → Equipment matching is performed and seal numbers are extracted from EBSBCCX segments if equipment match is found, otherwise set no seal numbers flag
[Retrieve Equipment Data from EDIBOL]
The system retrieves EBSBCCX segments with type 'SN' and processes up to 20 seal numbers → Extract up to 4 seal numbers from each M7 segment (seal-number-1 through seal-number-4) that are not spaces or low-values, and store in A2 record seal number array
[Update A2 Record with Actual Seal Numbers]
At least one seal number was found and stored in the seal number array → The A2 record data section is updated with the seal numbers and the record is marked for cloning
[Skip Record - No Seal Numbers]
No seal numbers are found in the EDI segments or equipment matching fails → The A2 record is marked for deletion if it exists on follower CCN, otherwise skip the record entirely
[Create S55 Segment Array]
The follower CCN key is not spaces or low-values → Retrieve and populate S55 segment data for the follower CCN to complete the cloning process
[Get Shipmine Data]
The system attempts to retrieve shipmine data with segment type 'SHIPMIN' and segment ID 'E' and segment number '1' → The system sets shipmine found flag and extracts EDIBOL key from data line if successful, or sets shipmine not found flag if unsuccessful
[Get EDIBOL Root Data]
The system attempts to retrieve EBSBCBC segment data using the EDIBOL key → The system sets EBSBCBC found flag if data exists or EBSBCBC not found flag if data does not exist
[Search for Equipment Match in CR Segments]
The system iterates through CR segments with dependent key format 'CR' plus sequence number until equipment match is found or last segment is reached → The system continues searching until equipment match is found or sets no equipment match flag if all segments are exhausted
[Get Equipment Details from N7 Segment]
The system processes the N7 segment data → The system extracts equipment initial and equipment number from the N7 segment for formatting and comparison
[Format Equipment for Comparison]
The system calls equipment formatter with equipment data and size 12, and formatter returns success → The system compares formatted equipment initial with cargo equipment car initial and formatted equipment number with cargo equipment car number, setting equipment match flag if both match
[Get Seal Numbers from CX Segments]
The system retrieves EBSBCCX segments with type '2' set to 'SN' and incremental sequence numbers until no more segments found or maximum 20 seal numbers reached → The system sets EBSBCCX found flag for successful retrieval or EBSBCCX not found flag when no more segments exist
[Extract Multiple Seal Numbers]
The system processes M7 seal number fields 1 through 4 → The system stores each non-empty and non-low-values seal number in the seal number array and increments the seal counter for each valid seal number found
[Set No Seal Numbers Flag]
Shiproot data is not found:
shipmine data is not found
EDIBOL root data is not found
no equipment match is found
no seal numbers are collected
→ The system sets the no seal numbers flag to indicate seal processing was unsuccessful
[Start Equipment Match Validation]
The system searches for matching equipment in EDIBOL CR segments → The system should iterate through CR segments starting from sequence 2 until a match is found or all segments are checked
[Set Starting CR Segment Number to 2]
The system starts searching CR segments → The search should begin with CR segment sequence number 2 and increment by 1 for each subsequent search
[Build CR Dependent Key]
The system needs to access a specific CR segment → The dependent key should be constructed with 'CR' prefix followed by the 3-digit sequence number
[Format Equipment Data Using GCCCARFM]
The system formats the equipment data using GCCCARFM program → The formatting should succeed and return formatted equipment initial and number for comparison
[Set Equipment Match Found]
The system validates the complete equipment match → The equipment match flag should be set to indicate successful match found
[More CR Segments to Check?]
No equipment match is found in current segment → The system should continue searching if current sequence number is less than or equal to the last available N7 segment number
[Set No Equipment Match]
No equipment match is found in any CR segment → The system should set the equipment match status to indicate no match was found
[Extract Equipment Initial from N7 Segment]
Equipment data needs to be extracted for comparison → Equipment initial is moved to temporary equipment initial field and equipment number is moved to temporary equipment number field
[Combine Initial and Number into Temp Equipment Field]
Equipment data needs to be prepared for external formatting → Equipment initial and number are combined into temporary equipment field
[Extract Equipment Initial from N7 Segment]
Equipment data extraction is performed → Equipment initial is moved to temporary equipment initial field and equipment number is moved to temporary equipment number field
[Combine Initial and Number into Temp Equipment]
Equipment data combination is performed → Temporary equipment field contains the combined equipment initial and number
[Get Shipment Root Data]
The system attempts to retrieve shipment root data from the waybill database → The system should successfully retrieve the shipment root segment or mark it as not found
[Get Shipment Mine Data]
The system attempts to retrieve shipment mine data with segment type 'SHIPMIN' and segment ID 'E' → The system should retrieve the shipment mine segment and extract the EDIBOL key from the first data line
[Get EDIBOL Root Segment]
The system attempts to retrieve EDIBOL root segment with segment type 'EBSBCBC' → The system should successfully retrieve the EDIBOL root segment or mark it as not found
[Get Equipment CR Segment]
The system attempts to retrieve equipment CR segment with dependent key 'CR' plus sequence number → The system should retrieve the equipment CR segment containing equipment initial and number
[Format Equipment Data]
The system formats the equipment data for comparison → The system should combine equipment initial and number into a formatted equipment string and call formatting service
[More Equipment to Check?]
The system checks if more equipment segments exist → If temporary sequence is less than or equal to last segment number, continue searching; otherwise terminate with no seal numbers
[Get Seal Number Segments]
The system attempts to retrieve seal segments with type 'SN' and current sequence number → The system should retrieve seal segment containing up to 4 seal numbers or mark as not found
[Extract Seal Numbers 1-4]
The system extracts seal numbers from the segment → For each of the 4 seal number positions, if the seal number is not spaces or low-values, store it in the seal array and increment counter
[Store Seal Numbers in Array]
The system stores seal numbers in the array → Each non-empty seal number should be stored in sequential positions in the seal number array
[Move to Next Seal Segment]
The system needs to check for more seal segments → The system should increment seal sequence counter by 1
[More Seal Segments?]
The system checks continuation criteria → If seal segments are still found AND seal counter is 20 or less, continue collection; otherwise complete processing
[Save Current Manifest Flags]
The system prepares to modify the manifest record → The current values of sent 309 flag, lock 309 flag, multi-car manifest flag, car sequence number, and master manifest CCN are saved for restoration
[Delete Follower Manifest]
The system retrieves the next follower cargo report that is not the master CCN → The system updates the follower manifest status to DELETE-STATUS, sets current status to DEL-STATUS, preserves original waybill data, clears index fields, updates modification timestamps and user information, creates audit log entry for automatic cargo deletion, and creates transmission if CCN was originally sent
[Delete Master Manifest]
The system processes the master CCN for deletion → The system performs broker deletion notification if the shipment is IDLER type, then executes the standard deletion process including status updates, field clearing, timestamp updates, audit logging, and transmission creation if required
[Create Customs Deletion Transmission]
The system finds that CCN-ORIGINAL-SENT is not empty and either BORDER-ARRIVAL-DATE is empty/low-values with NOT-PRE-EMANIFEST status or PRE-EMANIFEST status is set → The system sets GCWS309C-ACTION-DELETE and GCWS309C-NOTIFY-CUSTOMS to true, moves the CCN-KEY to GCWS309C-CCN-KEY, and calls the GCCS309C program
[Send Broker Deletion Notifications]
The system retrieves broker configuration and finds delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → The system sends notifications via X12 if USE-X12 is 'Y', via Merlin if USE-MERLIN is 'Y', via Internet if USE-INTERNET is 'Y', and via Fax if USE-FAX is 'Y'
[Create Audit Log Entry]
The system has successfully processed the deletion → The system creates audit log entries with CCN key, cargo type indicator, appropriate action codes (LOG-CARGO-DELETED-AUTO for deletions, LOG-CARGO-SENT-AUTOMATICALLY for transmissions), machine time, security information, and spawns the audit logging transaction
[Set Delete Flag to NOT OK]
A deletion request is processed → The system sets delete authorization to 'N' (not OK) and creates error messages indicating the manifest is on a train
[Generate Waybill Cancellation Message]
A deletion request is processed for the manifest → The system generates message 'WAYBILL HAS NOT BEEN CANCELLED' and adds it to the error message collection
[Generate Train ID Information Message]
A deletion request is processed and blocked due to train assignment → The system displays the train ID (GCCC-CP-TRAIN-ID) as an additional error message
[Set Action Code Based on Operation]
An audit log entry is created → The appropriate action code is assigned based on the operation type such as creation, deletion, transmission, or blocking actions
[Prepare Message for Queue]
The entry needs to be sent to the audit logging system → The audit input structure is moved to the message format for queue processing
[Change Message Queue Status]
The message queue needs to be prepared → The queue status is changed to active state using the appropriate program control block
[Write Log Message to Queue]
The audit entry needs to be transmitted → The message is written to the queue using the message code, content, length, and module name
[Purge Message Queue]
The transmission process needs to be completed → The message queue is purged to clean up the transmission resources
[Log Release Prevention Message]
A deletion attempt is made on the released cargo → The system adds the message 'DELETE NOT AUTHORIZED, THIS CCN HAS BEEN RELEASED' to the error text
[Create Release Prevention Message]
The system blocks the deletion → The system adds the message 'DELETE NOT AUTHORIZED, THIS CCN HAS BEEN RELEASED' to the text array for user notification
[Send Prevention Messages to User]
The text index exceeds the minimum line message threshold → The system performs the send messages function to notify the user
[Prepare Audit Message Structure]
The audit entry is ready to be sent for processing → The audit log input structure must be moved to the message structure for the audit logging program
[Queue Audit Entry for Processing]
The system needs to send the audit entry to the logging system → The system must call the message handling system to change the queue status and prepare for message transmission
[Send Audit Log to GCT1051E]
The system sends the audit entry for logging → The system must call the message writing service to transmit the audit log message to the GCT1051E program with the proper message code, content, length, and module name
[Purge Message Queue]
The message transmission is complete → The system must purge the message queue using the alternate PCB to clean up the transmitted message
[Customs Transmission Required?]
The system checks if customs notification is required → The system requires customs transmission if the CCN original sent field is not spaces or low-values
[Create 309 EDI Deletion Transmission]
The system processes customs notification → The system creates a 309 EDI transmission with delete action and customs notification flags set
[Log Automatic Deletion]
The system completes the transmission process → The system creates a log entry with CCN key, cargo type, automatic sent action code, and machine time with '999' suffix
[Original CCN Sent to Customs?]
The system checks if the original CCN was sent to customs → If the CCN original sent field is not empty, a customs deletion transmission will be created, otherwise the deletion process is complete
[Create 309 EDI Deletion Transmission]
The system creates a customs deletion transmission → A 309 EDI transmission is created with deletion action and customs notification flags set, using the manifest CCN key
[Create Transmission Audit Log]
The system creates a transmission audit log entry → An audit log entry is created with action code 'LOG-CARGO-SENT-AUTOMATICALLY', the CCN key, current system time with '999' milliseconds, and CA cargo type indicator
[Original CCN Sent to Customs?]
The customs notification check is performed → If the CCN original sent field is not empty, proceed with customs transmission, otherwise complete the deletion
[Create 309 Transmission]
The customs transmission process is executed → A 309 EDI transmission is created and sent to notify customs of the deletion
[Log Cargo Sent Automatically]
The transmission audit logging process is executed → An audit log entry is created with action code LOG-CARGO-SENT-AUTOMATICALLY, current machine time with '999' in the milliseconds portion
[Broker Config Found?]
The system searches the broker table using broker name, Canadian flag, and manifest transmission port code → If broker configuration is found, proceed with delivery schedule validation, otherwise attempt default port configuration lookup
[Default or Immediate Delivery?]
The system checks the broker delivery schedule setting → If delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, proceed with broker notifications, otherwise skip notifications and proceed to manifest deletion
[Send X12 EDI Notification]
The broker configuration indicates X12 usage is enabled → Send X12 EDI notification with broker X12 header and CCN key using the customs notification service
[Retrieve Broker Configuration by Port]
The system retrieves broker configuration using broker name, Canadian flag, and manifest transmission port code → Return broker configuration for the specific port or indicate not found
[Send X12 EDI Notification]
The system processes X12 EDI notification → Send deletion notification using X12 broker header and CCN key via GCCS309C service
[Build Waybill Key from Shiproot and Date]
System needs to search for manifests associated with the waybill → System moves shiproot key to waybill data key, converts waybill date to numeric format, and creates composite waybill key for database search
[Check First Manifest Eligibility]
The system validates the manifest for update eligibility → The manifest is marked as invalid for update and an error message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN' is generated
[Check First Manifest Eligibility]
The system validates the manifest for update eligibility → The manifest is marked as invalid for update and an error message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST' is generated
[Check First Manifest Eligibility]
The system validates the manifest for update eligibility → The manifest is marked as invalid for update and an error message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED' is generated
[Check First Manifest Eligibility]
The system validates the manifest for update eligibility → The manifest is marked as invalid for update and an error message 'BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT' is generated
[Create New Bunch Bill Message]
The system prepares to recreate manifests with updated equipment information → A spawn message is created with the saved waybill key, waybill date, and GCX005 create manifest action code
[Spawn New Manifest Creation]
The system completes the deletion of old manifests → A GCT0111E transaction is spawned to create new manifests with the updated equipment ID
[Is Equipment ID = Master Car ID?]
The equipment ID for the current manifest equals the master car ID from the input message → The system skips processing this manifest and continues to the next waybill cargo report
[Retrieve Master Manifest]
The system needs to prepare for spawning individual updates → The system retrieves the master manifest using the master CCN key from the input message
[Retrieve Master Manifest CCN]
The system attempts to retrieve the master manifest record → The master manifest data is loaded and available for use as a template
[Preserve 309 Sent Flag]
The system updates the manifest with master template data → The original 309 sent status flag value is preserved and not overwritten by the template
[Preserve 309 Lock Flag]
The system updates the manifest with master template data → The original 309 lock status flag value is preserved and not overwritten by the template
[Update Target Manifest with Master Template]
The system updates the target manifest → The target manifest is updated with master template data while preserving the original 309 flags, multi-car flag, sequence number, and master CCN reference
[Create Audit Log Entry]
The system needs to log the validation result AND the validation failed due to business rule violations → The system should create an audit log entry with the CCN key, current machine time, action code 'ZZZ', appropriate error message, and mark it as Canadian cargo
[Send to Primary User]
The system determines message recipients → If supervisor ID is valid, supervisor MERLIN ID is added as recipient, otherwise customer from-user code is added as recipient, and if DC&P ID is invalid, an error message is generated with 'DC&P MERLIN USERID INVALID' and the invalid DC&P MERLIN ID
[Call EMCSEND2]
The system sends messages via EMCSEND2 → For each non-empty text line, a GCX105 audit log entry is created with CCN as train-or-us-ccn, action code as 'ZZZ', current timestamp, and message text, and messages starting with 'LTERM: ' or 'CARGO CONTROL NUMBER: ' are excluded from audit logging
[Handle Failed Delivery]
The system handles the failed delivery → The system performs resend operation through fallback mechanism via 8730-RESEND-MERLIN procedure
[Purge Message Queue]
The system completes message transmission → The system calls CIMS with PURG function to purge the alternate PCB message queue
[Valid MERLIN IDs?]
The system checks for valid recipients → The system skips the message transmission process and exits without sending messages
[Set Message Details]
The system sets message details → The sequence cargo number is incremented by 1 and assigned to EMI-SEQ-CARGO for message tracking
[Check EMI-RETURN-STATUS-FLAG]
If EMI-RETURN-STATUS-FLAG after message transmission → If EMI-RETURN-STATUS-FLAG is not SUCCESSFUL, the system triggers failed message handling process
[Failed Message Handling Triggered]
The system detects the failed delivery status → The system performs 8730-RESEND-MERLIN section to handle the failure
[Normal Processing Complete]
The system completes normal MERLIN message processing → The system calls CIMS with PURG function to purge the ALT-PCB message queue
[Cargo Control Number exists?]
The cargo control number is empty AND the short cargo control number is not empty → The cargo control number is set to the short cargo control number AND transmission flag is set to N
[Set transmission flag to Y]
The cargo control number is empty after checking short cargo control number → The transmission flag is set to Y to enable customs transmission
[Set transmission flag to N]
The cargo control number is not empty → The transmission flag is set to N to disable customs transmission
[Restore saved transmission flags]
Transmission flag processing occurs → The saved sent 309 flag is restored to sent 309 flag AND saved lock 309 flag is restored to lock 309 flag
[Clear transmission flags]
Transmission flag initialization occurs → The sent 309 flag is set to spaces AND lock 309 flag is set to spaces
[Set waybill released flag]
Waybill release processing occurs → The waybill is set to released status AND waybill release flag is set to true
[Log waybill completion]
Audit logging is required → A log entry is created with CCN key, cargo type, machine time with 999 suffix, ZZZ action code, and 'WB COMPLETED IN FASTWAY' message
[Disable transmission]
Transmission flag is being determined → If in-transit status equals R, then transmission flag is set to N
[CPRS shipment or 6105E CCN?]
CPRS eligibility check is performed → If bill owner is CPRS AND CCN key 5th character is E, OR CCN key starts with 6105E, then shipment qualifies for CPRS processing
[Create customs transmission]
Customs transmission is required → Customs notification flag is set AND customs transmission is created using CCN key
[Log automatic transmission]
Audit logging is required → A log entry is created with automatic cargo sent action code and machine time with 999 suffix
[Log manifest update - awaiting send]
Audit logging is required → A log entry is created with ZZZ action code and 'MANIFEST UPDATE - AWAITING FINAL SEND' message
[Log manifest not sent - non-CPRS]
Customs transmission is attempted → A log entry is created with ZZZ action code and 'MANIFEST NOT SENT - NON-CPRS' message
[Is Waybill Corrector?]
The system determines this is a waybill correction operation → The system preserves the existing 309 sent flag, 309 lock flag, multi-car manifest flag, car sequence number, and master manifest CCN from the current record
[Waybill Completed and Valid Carrier?]
The system processes the waybill status update → The system sets the released waybill status to true, sets waybill release flag to true, and logs a completion message with action code ZZZ
[In Transit Status = 'R'?]
The in-transit status is 'R' (returned) → The system sets the transmission flag to 'N' to disable customs notification
[Set 309 Status Flags]
The system sets up the manifest flags → The system enables the bunch bill indicator flag
[309 Processing Required?]
If 309 processing requirements including lock status, sent status, carrier validation, and release conditions → The system processes the 309 transmission, sets the sent first 309 flag, enables customs notification, and updates status to sent
[Set Action Code to MOD - Modify]
The record is identified as a waybill corrector → The action code is set to MOD (modify) for the customs transmission
[Set Action Code to ADD]
Processing the customs transmission → The action code is set to ADD function instead of delete
[Set Action Code to ADD]
Respawn bunch billing flag is set → The action code is set to ADD function
[Set Action Code to DEL - Delete]
Respawn bunch billing flag is not set → The action code is set to DEL function
[Set First 309 Sent Flag]
The manifest is not locked and not sent:
is locked and not sent
has delete pending status
→ The first 309 sent flag is set to true
[Set 309 Change Pending Flag]
The manifest is not locked AND has been sent previously AND carrier is not 999 or 105 → The 309 change pending flag is set and processing exits without transmission
[Continue Processing]
The waybill is released AND has change pending:
is a waybill corrector
carrier code is 999
105
→ The system continues with transmission processing
[Clone A2 Records]
Processing the manifest data → A2 records are cloned from the master manifest and the CA2 cloned flag is set
[Call GCCS309C for Customs Notification]
The manifest requires customs notification → The GCCS309C program is called with the CCN key and the status is set to SENT
[Send to Secondary Broker]
Broker name 2 is not empty AND broker entry is empty → Notification is sent to the secondary broker using broker configuration
[Exit Processing]
Broker entry is not empty → Broker notification processing is skipped and exits
[Exit Processing]
Broker name equals 'UNKNOWN' → Broker notification processing is skipped and exits
[Retrieve Broker Configuration]
Retrieving broker configuration → The system looks up broker configuration using table ID 'BK', broker name, Canadian flag 'C', and manifest transmission port code
[Send X12 EDI to Broker]
Broker use X12 flag is 'Y' → GCCS309C is called with broker notification flag and X12 broker header information
[Set Action Code to MOD - Modify]
The request is identified as a waybill corrector update (WS-WB-CORRECTOR is true) → The system sets the 309 transmission action code to MOD (modify) to indicate manifest modification
[Set Action Code to ADD]
The request type is respawn bunch billing (GCX005-RESPAWN-BUNCH-BILLING is true) → The system sets the 309 transmission action code to ADD for new manifest creation
[Set Action Code to DEL - Delete]
The request type is not respawn bunch billing (GCX005-RESPAWN-BUNCH-BILLING is false) → The system sets the 309 transmission action code to DEL (delete)
[Set First 309 Sent Flag]
The manifest is not locked and not sent, or is locked and not sent, or has delete pending status → The system sets the GCCC-SENT-FIRST-309 flag to true
[Set Change Pending Flag]
GCCC-309-NOT-LOCKED is true and GCCC-SENT-FIRST-309 is true and carrier index is not '999' or '105' → The system sets GCCC-309-CHANGE-PENDING to true and skips immediate transmission
[Should Process 309?]
The waybill is released and change pending, or is a waybill corrector, or has carrier index 999/105 → The system proceeds with 309 transmission processing
[Set 309 Processing Flag]
All validation conditions for 309 processing are met → The system sets WS-309-PROCESSING to true
[Retrieve S55 Segments for Manifest]
The system needs to gather all manifest segment data → The system calls GCCCCIO2 to retrieve all S55 segments and populates the segment arrays
[Call GCCS309C for Customs Notification]
WS-DONT-NOTIFY-CUSTOMS is false → The system sets GCWS309C-NOTIFY-CUSTOMS to true and calls GCCS309C for customs transmission
[Set Status to SENT]
The GCCS309C call completes successfully → The system sets GCCC-STATUS-SENT to true
[Retrieve Broker Configuration]
The system needs broker configuration data → The system calls 7990-GET-TABLE-SEGMENT twice to retrieve BK segment with port-specific lookup and B1 segment data
[Send X12 EDI to Broker]
GCSTBRT-BK-USE-X12 equals 'Y' → The system sets GCWS309C-NOTIFY-BROKER to true, moves broker X12 header to GCWS309C-X12-BROKER, and calls GCCS309C
[Set Action Code to MOD]
The record being processed is identified as a waybill corrector → The 309 EDI action code is set to MOD (modification)
[Set Action Code to ADD]
Respawn bunch billing is active AND master car ID is not empty → The 309 EDI action code is overridden to ADD function
[Set Action Code to ADD]
Respawn bunch billing process is active → The 309 EDI action code is set to ADD function
[Set Action Code to DEL]
Respawn bunch billing process is not active → The 309 EDI action code is set to DEL (delete) function
[Set First 309 Sent Flag]
The manifest is not locked by user changes AND has never been sent to customs:
the manifest is locked but has never been sent
→ The first 309 sent flag is set to true
[Set 309 Change Pending Flag]
The carrier is not 999 or 105 → The 309 change pending flag is set AND no immediate transmission occurs
[Continue Processing]
309 transmission processing is initiated → The system continues with 309 processing
[Create 309 Transmission]
All validation conditions have been satisfied → A 309 EDI transmission is created and sent to customs
[Set Status to SENT]
The transmission process completes without errors → The manifest status is updated to SENT
[Set Action to ADD]
The system determines the appropriate action code for 309 transmission → The action code is set to ADD function
[Set Action to DEL]
The system determines the appropriate action code for 309 transmission → The action code is set to DEL function
[Set Action to MOD]
The system determines the appropriate action code for 309 transmission → The action code is set to MOD function
[Set Sent First 309 Flag]
The system processes the 309 transmission flags → The sent first 309 flag is set to true
[Set 309 Change Pending Flag]
The system processes the 309 transmission flags → The 309 change pending flag is set to true AND processing exits without transmission
[Continue Processing]
If whether to proceed with 309 transmission → The 309 processing flag is set to true and transmission processing continues
[Exit - No Processing]
If whether to proceed with 309 transmission → The system exits the 309 processing without setting transmission flags
[Set Action to MOD]
The record being processed is identified as a WB corrector → The transmission action code is set to MOD (modification)
[Set Action to ADD]
The processing mode is respawn bunch billing and master car ID is not empty → The transmission action code is changed from MOD to ADD (addition)
[Set Action to DEL for New Records]
The processing mode is respawn bunch billing → The transmission action code is set to ADD, otherwise it is set to DEL
[Set First 309 Sent Flag]
The manifest is either not locked and not sent, or locked and not sent, or has delete pending status → The sent first 309 flag is set to true
[Set 309 Change Pending Flag]
The manifest is not locked and the carrier is not 999 or 105 → The 309 change pending flag is set to true and transmission is skipped
[Continue Processing]
The waybill is released and has change pending status, or it is a WB corrector, or the carrier code is 999 or 105 → The transmission processing continues instead of being skipped
[Clone A2 Records for Transmission]
The 309 processing flag is set to true → All A2 records associated with the manifest are cloned and the CA2 cloned flag is set to true
[Call GCCS309C for Customs Notification]
The notify customs flag is set to true → The GCCS309C program is called with the manifest CCN key and the status is set to SENT
[Get Broker Configuration from BK Table]
Broker configuration is needed → The system queries the BK table using broker name, Canadian flag 'C', and manifest transmission port code
[Get B1 Table Configuration]
Additional configuration is needed for internet notifications → The system queries the B1 table for supplementary broker settings, initializing empty segments if not found
[Send X12 EDI Notification]
The broker use X12 flag equals 'Y' → The GCCS309C program is called with notify broker flag and the broker's X12 header information
[Retrieve Broker Configuration with Port]
Broker configuration retrieval is requested → Search broker table using broker name, Canadian flag 'C', and port code from positions 2-3 of manifest transmission code
[Retrieve B1 Segment for Internet/Fax Settings]
B1 segment retrieval is requested → Search for B1 table segment to obtain internet and fax communication settings
[Validate Delivery Schedule - Check broker delivery schedule against allowed values (DEFAULT or IMMEDIATE) and determine notification eligibility]
If the broker delivery schedule for notification eligibility → The system should allow notifications if the delivery schedule equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise block notifications and exit the process
[Retrieve Primary Broker Configuration from BK Table]
The system retrieves broker configuration → The system searches BK table with broker name, Canadian flag 'C', and port from manifest transmission code positions 2-3
[Retrieve B1 Table Configuration]
The system retrieves supplementary configuration → The system fetches B1 table data and initializes empty B1 segment if retrieval fails
[Validate Delivery Schedule]
The system validates delivery schedule compatibility → The system proceeds with notifications only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY
[Setup X12 EDI Notification]
The system sets up X12 notification → The system sets NOTIFY-BROKER flag, assigns X12 broker header, sets CCN key, and calls GCCS309C program
[Retrieve Broker Configuration by Port]
The system retrieves broker configuration using broker name as 'C' for Canadian and port code from manifest transmission code positions 2-3 → Broker configuration is retrieved from broker table BK segment
[Retrieve Default Port Configuration]
The system attempts to retrieve default configuration using broker name as 'C' for Canadian and port code '000' → Default broker configuration is retrieved from broker table BK segment or processing exits if not found
[Send X12 EDI Notification]
Broker X12 usage flag is 'Y' → X12 EDI notification is sent using broker X12 header and CCN key via GCCS309C program
[Send Internet Notification]
Broker internet usage flag is 'Y' and cargo is single manifest type → Internet notification is sent using internet address from B1 segment and CCN via GCT0191E program
[Retrieve All CCNs from EDIBOL Database]
The system processes EBSBCCX segments with RF type and searches for EBSBCCY segments with XC qualifier → All CCNs with XC reference qualifiers are extracted and stored in an array
[CCN Counts Match?]
The system compares the count of CCNs from both sources → If counts are equal, proceed to individual CCN matching, otherwise proceed to unmatched CCN processing
[Multi-Car Manifest?]
The system checks if any manifest is marked as multi-car manifest → If multi-car manifest is detected, generate multi-car error message, otherwise proceed to delete and recreate manifests
[Create New Manifests from EDIBOL Data]
The system processes the EDIBOL CCN data → New manifests are created by spawning GCX011 update processes for each EDIBOL CCN
[Build Waybill Search Key from Shiproot Key and Date]
The system needs to search for cargo reports by waybill → The waybill search key is constructed by combining the shiproot key as waybill data and converting the waybill date to numeric format
[Create Audit Log Entry]
The system needs to record the validation failure → The system creates an audit log entry with the CCN as the train or US CCN identifier, sets the cargo type to Canadian cargo, assigns action code 'ZZZ', records the current machine time, and includes the appropriate error message describing the validation failure
[Get Shipment Root Data]
The system attempts to retrieve shipment root data → The system calls FWCWBIO to get SHIPROOT segment data
[Get Shipment Mine Data]
The system retrieves shipment mine data with segment type 'SHIPMIN' and segment ID 'E' → The system extracts the EDIBOL key from the first data line
[Get EDIBOL Root Segment]
The system attempts to retrieve EDIBOL root segment → The system calls EBCLGIO to get EBSBCBC segment data using the EDIBOL key
[Get CR Dependent Segment]
The system retrieves CR dependent segment with dependent key 'CR001' → The system calls EBCLGIO to get EBSBCCR segment data
[Get RF Segment by Sequence]
The system retrieves an RF segment with type 'RF' and current sequence number → The system calls EBCLGIO to get EBSBCCX segment data for the specified sequence
[Process CY Segments for XC Qualifier]
The system processes CY segments with type 'CR' → The system initializes CY processing with type 'CR' and sequence counter set to zero
[Search for XC Reference Qualifier]
The system retrieves CY segments with incrementing sequence numbers until sequence reaches 99 or XC qualifier is found or no more segments → The system checks each CY segment's reference qualifier field for 'XC' value
[Extract CCN from Reference Number]
The system extracts the CCN → The reference number from the CY segment is extracted as the cargo control number
[Add CCN to EDIBOL Array]
The system adds the CCN to the array → The EDIBOL CCN counter is incremented and the CCN is stored in the EDIBOL CCN array at the current counter position
[Increment Sequence Counter]
The system prepares for the next RF segment → The sequence counter is incremented by 1
[More RF Segments?]
The system checks for more RF segments → If sequence counter is less than 99, continue to get next RF segment, otherwise complete EDIBOL CCN retrieval
[Get SHIPROOT Segment]
System attempts to retrieve SHIPROOT segment from waybill database → SHIPROOT segment is retrieved and shiproot found indicator is set, or shiproot not found indicator is set if retrieval fails
[Get SHIPMINE Segment]
System attempts to retrieve SHIPMINE segment with segment ID 'E' and segment number '1' → SHIPMINE segment is retrieved and EDIBOL key is extracted from data line, or shipmine not found indicator is set if retrieval fails
[Get EBSBCBC Root Segment]
System attempts to retrieve EBSBCBC segment using EDIBOL key as root key → EBSBCBC segment is retrieved and EBSBCBC found indicator is set, or EBSBCBC not found indicator is set if retrieval fails
[Get EBSBCCR Segment with CR001 Key]
System attempts to retrieve EBSBCCR segment with dependent key 'CR001' → EBSBCCR segment is retrieved and EBSBCCR found indicator is set, or EBSBCCR not found indicator is set if retrieval fails
[Search for RF Segment by Sequence]
System attempts to retrieve EBSBCCX segment with type 'RF' and current sequence number → EBSBCCX segment is retrieved and found indicator is set, or not found indicator is set if retrieval fails
[RF Segment Found?]
System checks if RF segment was found → If RF segment not found, navigation completes successfully, otherwise processing continues to CY segment search
[Search for CY Segment with CR Type]
System attempts to retrieve EBSBCCY segment with type 'CR' and incremented sequence number → EBSBCCY segment is retrieved and found indicator is set, or not found indicator is set if retrieval fails or sequence reaches 99
[Extract CCN from CY Segment]
System extracts CCN from CY reference number field → CCN value is extracted from CY-N9-REF-NO field for addition to EDIBOL array
[Add CCN to EDIBOL Array]
System adds CCN to EDIBOL collection → EDIBOL counter is incremented and CCN is stored in EDIBOL array at current counter position
[Increment Sequence Counter]
System prepares for next RF segment search → Sequence counter is incremented by 1 for next RF segment retrieval
[More RF Segments?]
System checks if more RF segments should be processed → If sequence counter has not reached maximum limit, RF segment search continues, otherwise navigation completes
[Navigation Complete]
EDIBOL navigation process completes → Navigation exits successfully with collected CCNs available in EDIBOL array
[Navigation Failed - Exit]
System encounters segment retrieval failure → EDIBOL navigation exits with failure status and no CCNs are collected
[Set Type-3 to 'CR']
The segment type filter is applied → The type-3 field is set to 'CR' to filter for cargo reference segments
[Set Sequence Counter to 0]
The sequence counter is initialized → The sequence counter WS-SEQ-CY is set to 0
[Increment Sequence Counter]
The sequence counter is incremented → The WS-SEQ-CY value is increased by 1
[Get Next CY Segment]
The CY segment retrieval is performed → The EBSBCCY segment data is loaded for the current sequence position
[Qualifier = 'XC'?]
The reference qualifier is examined → If CY-N9-REF-NO-QUAL equals 'XC', the segment contains CCN data, otherwise continue searching
[Extract CCN from Reference Number]
The CCN extraction is performed → The CY-N9-REF-NO value is captured as the CCN
[Add CCN to EDIBOL Array]
The CCN is added to the collection → The WS-EDIBL-CNT counter is incremented and the CCN is stored in WS-EDIBL-CCN array at the current position
[Exit - No More Segments]
The termination condition is met → The WS-EBSBCCX-NOT-FOUND indicator is set to true and the search exits
[Continue Search]
The search continuation is processed → The sequence counter check is repeated to continue searching for CCN data
[Set Segment Type to EBSBCCY]
The system prepares to retrieve CY segment data → The segment type is set to 'EBSBCCY' to identify the correct segment structure
[Copy Root Key from Previous Segment]
The system prepares to retrieve the next CY segment → The root key from the previous segment is copied to the current retrieval parameters
[Copy Dependent Key from Previous Segment]
The system prepares to retrieve the next CY segment → The dependent key from the previous segment is copied to the current retrieval parameters
[Copy Type-2 from Previous Segment]
The system prepares to retrieve the next CY segment → The Type-2 classification from the previous segment is copied to the current retrieval parameters
[Copy Sequence Number from Previous Segment]
The system prepares to retrieve the next CY segment → The sequence number from the previous segment is copied to the current retrieval parameters
[Set Type-3 Parameter]
The system sets segment classification parameters → The Type-3 parameter is set to the working storage Type-3 value for proper segment identification
[Set Sequence Number-3 Parameter]
The system sets segment sequencing parameters → The Sequence Number-3 parameter is set to the working storage sequence value for proper segment positioning
[Set Operator to Equal]
The system sets the database query operator → The operator is set to equal ('=') to Execute exact match retrieval
[Call EBCLGIO2 to Retrieve CY Segment]
The system executes the database retrieval operation → EBCLGIO2 program is called with communication control, database parameters, and CY segment structure to retrieve the requested segment
[Segment Found?]
If the database response status → If the communication control status code is spaces, the segment is considered found, otherwise it is considered not found
[Set CY Segment Found Flag]
The database response indicates successful segment retrieval → The CY segment found flag is set to true to indicate successful retrieval
[Set CY Segment Not Found Flag]
The database response indicates segment was not found or retrieval failed → The CY segment not found flag is set to true to indicate unsuccessful retrieval
[Return CY Segment Data]
The retrieval operation completes with found status → The CY segment data is made available in the segment structure for subsequent business processing
[Return Not Found Status]
The retrieval operation completes with not found status → The not found status is returned to indicate that no CY segment data is available for processing
[Set Match Status to True]
The system identifies a matching CCN between GCCC and EDIBOL records → The match status is set to 'Match' to indicate successful validation
[Match Found or End of Array?]
If continuation criteria → Processing continues if no match is found and more EDIBOL CCNs exist, otherwise matching process completes
[No Exact Match - Process Unmatched CCNs]
No exact matches are found between the two sets of CCNs → The system routes to unmatched CCN processing to handle discrepancies
[Exact Match - Proceed with Updates]
Exact matches are found for all CCNs in both datasets → The system proceeds with the standard update processing workflow
[More EDIBOL CCNs to Check?]
The system checks if there are more EDIBOL CCNs to process → Continue processing if the array index is within bounds (≤99) and the current CCN entry is not empty, otherwise stop iteration
[Set Match Status to True]
The system identifies a matching CCN between GCCC and EDIBOL arrays → The match status should be set to true to indicate a successful match
[Match Found or Array Complete?]
If whether to continue the CCN matching process → Terminate the search if a match has been found or if all EDIBOL CCNs have been checked, otherwise continue to the next EDIBOL CCN
[Compare Direct CCN Match]
The direct comparison is performed between GCCC-CCN and EDIBOL-CCN → The system should determine if the CCNs are identical
[Compare Lead CCN Match]
The lead CCN comparison is performed between GCCC-LEAD-CCN and EDIBOL-CCN → The system should determine if the lead CCN matches the EDIBOL CCN
[Continue to Next EDIBOL CCN]
The comparison process continues → The system should increment to the next EDIBOL CCN in the sequence
[EDIBOL CCN Available?]
The system checks if more EDIBOL CCNs are available for comparison → The system continues processing if CCN is not empty/spaces, otherwise terminates the matching process
[Set Match Status to True]
The system identifies a successful match between GCCC and EDIBOL CCNs → The system sets the match indicator to true and exits the comparison loop
[Get Next EDIBOL CCN from Array]
The system processes CCN comparisons → The system retrieves the next available EDIBOL CCN from the array for comparison
[EDIBOL CCN Available?]
The system checks for the next EDIBOL CCN → The system returns true if more CCNs are available, false if array is exhausted
[Build Waybill Search Key from Shiproot and Date]
The system needs to search for cargo manifests by waybill → The waybill search key is constructed by combining the shiproot key as waybill data and converting the waybill date to numeric format
[Manifest Valid for Update?]
The manifest has a Canadian customs north train ID assigned → The manifest is marked as invalid for update and an error message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN' is generated
[Manifest Valid for Update?]
The manifest has 309 locked status indicating user made changes → The manifest is marked as invalid for update and an error message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST' is generated
[Manifest Valid for Update?]
The manifest has an arrival indicator that is not empty or low-values → The manifest is marked as invalid for update and an error message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED' is generated
[Manifest Valid for Update?]
The manifest has an existing broker entry and the current broker name differs from the waybill broker name → The manifest is marked as invalid for update and an error message 'BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT' is generated
[Get Shipment Root Data]
The system attempts to retrieve shipment root data → The shipment root segment is retrieved from the waybill database
[Get Shipment Mine Data]
The system attempts to get shipment mine data with segment type 'SHIPMIN' and segment ID 'E' → The shipment mine segment is retrieved and the EDI BOL key is extracted from the first data line
[Get EDIBOL Root Segment]
The system attempts to retrieve the EDIBOL root segment with segment type 'EBSBCBC' → The EDIBOL root segment is retrieved from the EDI database
[Get CR Segment with CR001 Key]
The system attempts to retrieve the CR segment with dependent key 'CR001' → The CR segment is retrieved from the EDI database using segment type 'EBSBCCR'
[Get RF Segment by Sequence]
The system attempts to retrieve an RF segment with type '2' set to 'RF' and the current sequence number → The RF segment is retrieved from the EDI database using segment type 'EBSBCCX'
[Search for CY Segment with XC Qualifier]
The system searches for associated CY segments with type '3' set to 'CR' → CY segments are retrieved sequentially until one with reference qualifier 'XC' is found or sequence limit is reached
[Extract CCN from CY Reference Number]
The system extracts the cargo control number from the CY reference number field → The cargo control number is captured for addition to the EDIBOL array
[Add CCN to EDIBOL Array]
The system adds the CCN to the EDIBOL array → The CCN is stored in the array at the current counter position and the counter is incremented by 1
[More RF Segments?]
The system increments the sequence counter and checks for more RF segments → Processing continues with the next RF segment if available, otherwise the retrieval process completes
[Multi-Car Manifest?]
The manifest is identified as a multi-car manifest (WS-MULTI-CAR-MANIFEST is true) → The system generates an error message 'A6 CHANGE BLOCKED ON MULTI BILL/MULTICAR' and sends a multi-bill error notification
[Create New Manifests from EDIBOL CCNs]
Processing EDIBOL CCNs for manifest creation (WS-EDIBL-CNT from 1 to 99) → The system creates a new manifest for each non-empty EDIBOL CCN by moving it to WS-CCN-NUMBER and spawning a GCX011 update transaction
[Spawn GCX011 Update Transaction]
The CCN number is set in WS-CCN-NUMBER during new manifest creation → The system calls the spawn GCX011 update process to create the corresponding cargo manifest record
[Get First EDIBOL CCN from Array]
The CCN matching process begins → The system retrieves the first EDIBOL CCN from the array and sets the counter to position 1
[More EDIBOL CCNs to Check?]
The system checks for more CCNs to process → If the counter is less than or equal to 99 AND the EDIBOL CCN at current position is not spaces, continue processing; otherwise stop
[Direct CCN Match Found?]
If the comparison result → If the CCNs are exactly equal, proceed to set match status; otherwise check lead CCN
[Lead CCN Match Found?]
If the lead CCN comparison result → If the lead CCN and EDIBOL CCN are exactly equal, proceed to set match status; otherwise continue to next EDIBOL CCN
[Get Next EDIBOL CCN]
The system continues the matching process → The counter is incremented to point to the next EDIBOL CCN in the array
[Match Found?]
The system checks the overall match status → If match status is 'Match Found', return successful result; otherwise continue checking more EDIBOL CCNs
[Return Match Result]
The matching process concludes with a positive result → The system returns a match status indicating successful validation
[Return No Match Result]
The matching process concludes with no positive results → The system returns a match status indicating no match was found
[Prepare Spawn Message]
The system prepares to spawn an update process for a valid manifest → The system clears the spawn message structure and sets high-values as filler and zeros for action code
[Set Update Multi-Bill Flag]
The system configures the message for multi-bill update operation → The system sets the GCX005 update multi-bill flag to true in the spawn message
[Set Waybill Information]
The system sets waybill information for the spawn message → The system copies the first 15 characters of the shiproot key to the spawn waybill field and copies the waybill date to the spawn waybill date field
[Set CCN Information]
The system completes the spawn message configuration → The system assigns the working CCN number to the spawn CCN field in the message
[Spawn GCX011 Update Process]
The system initiates the spawn process for manifest update → The system copies the spawn message to the GCT0111E message structure and performs the spawn GCT0111E operation to queue the update process
[Retrieve Administrative Table AD]
Administrative table AD is accessed with table ID 'AD' and sequence ID 'ADMINID' → Administrative segment data is retrieved and stored for MERLIN ID configuration
[Search Terminal Table LT with LTERM]
Terminal table LT is searched with table ID 'LT' and the LTERM process ID → Terminal segment data containing supervisor MERLIN ID is retrieved
[Add Customer FROM-USERCODE to User List]
No supervisor or valid DC&P MERLIN IDs are available → Customer FROM-USERCODE is added to the user list as the default message recipient
[Set Shiproot Key from Input]
The system processes the shiproot key → The shiproot key from the input message is assigned to the waybill writer segment key
[Call FWCMSGET to Retrieve Equipment]
The system calls the FWCMSGET service with waybill writer segment, equipment request segment, and shipment address → The FWCMSGET service is invoked to retrieve equipment information and returns a success or error flag
[Extract Equipment Information]
The system processes the returned shipment data → Equipment information is extracted from SHIPROO2 segment and pattern number is extracted from PTRN-NUM
[Save Current 309 Flags]
Processing a duplicate CCN update → The current 309 sent flag and 309 lock flag values must be saved to working storage for later restoration
[Display Train ID in Message]
Error messages are being generated → The CP-TRAIN-ID value is added as a separate line in the error message text
[Set Delete Not Authorized Flag]
A deletion operation is attempted → The deletion should be blocked, okay-to-delete flag should be set to 'N', and an error message should be generated stating 'DELETE NOT AUTHORIZED, THIS CCN HAS BEEN RELEASED'
[Create 309 Transmission for Deletion]
The system processes customs notifications → A 309 transmission is created with deletion action and customs notification flags set
[Create Transmission Audit Log]
The system creates audit records → An audit log entry is created with the CCN, cargo type, automatic transmission action code, and timestamp with 999 milliseconds
[Was Manifest Previously Sent to Customs?]
The system checks the original sent indicator → If the CCN original sent field is not empty, a customs deletion transmission is created
[Create 309 EDI Deletion Transmission]
The system creates a customs deletion transmission → A 309 EDI transmission is generated to notify customs of the manifest deletion
[Create Second Audit Log Entry]
The system creates a transmission audit log → A log entry with action code 'LOG-CARGO-SENT-AUTOMATICALLY' is created with timestamp ending in '999'
[Log: CARGO-SENT-AUTOMATICALLY]
The transmission process completes → An audit log entry is created with action code LOG-CARGO-SENT-AUTOMATICALLY, CCN key as identifier, machine time with '999' appended to last 3 positions as timestamp, and spawned to GCT1051E transaction
[Log: WB-COMPLETED-IN-FASTWAY]
The waybill completion status is processed → An audit log entry is created with action code 'ZZZ', message 'WB COMPLETED IN FASTWAY', CCN key as identifier, machine time with '999' appended as timestamp, and spawned to GCT1051E transaction, and released waybill flag is set to true
[Spawn GCT1051E Transaction]
The system submits the audit entry → The audit input is moved to GCT1051E message structure, accept status is cleared, CHNG function is called on alternate PCB, message is written using WRITMSGL with message code, message content, message length and module name, and PURG function is called on alternate PCB
[Search BK Table with Broker Name]
The system searches for broker configuration in the BK table using the broker name, Canadian flag 'C', and port extracted from positions 2-3 of the manifest transmission code → The system retrieves the matching broker configuration record if it exists
[Search BK Table with Default Port 000]
The system performs a second search in the BK table using the same broker name and Canadian flag 'C' but with default port '000' → The system retrieves the default broker configuration if it exists, otherwise initializes empty broker segment
[Search B1 Table for Additional Config]
The system searches the B1 table using table ID 'B1' → The system stores B1 segment data if found, otherwise initializes empty B1 segment for internet address configuration
[Retrieve Broker Configuration from BK Table]
The system searches for broker configuration in BK table with broker name, Canadian flag 'C', and port from transmission code positions 2-3 → The broker configuration is retrieved if found, otherwise the system proceeds to try default port
[Retrieve B1 Table for Internet Configuration]
The system searches B1 table using table ID 'B1' → The B1 configuration is loaded if found, otherwise B1 segment is initialized as empty
[Setup X12 EDI Notification]
Broker X12 usage flag equals 'Y' → System sets GCWS309C-NOTIFY-BROKER flag, copies broker X12 header to GCWS309C-X12-BROKER, sets CCN key, and calls GCCS309C program
[Call GCCCCIO2 with GU Function]
The system executes the initial manifest query using GU function → The database is queried using GCCCCIO2 with GU function, waybill index is used as search criteria, and all segment types are fetched
[Load S53 and S55 Segment Data]
The system processes the manifest data → If no error occurred during retrieval, S53 segment data is moved from the array to the working segment and S55 segment data is moved from the array to the working segment
[Call GCCCCIO2 with GN Function]
The system searches for additional manifests for the same waybill → The database is queried using GCCCCIO2 with GN function, waybill index is used as search criteria, and all segment types are fetched for the next record
[Search BK Table with Port-Specific Key]
The system searches for broker configuration in BK table with broker name, Canadian indicator 'C', and port code from positions 2-3 of manifest transmission code → The system retrieves the broker configuration segment if found in BK table
[Search BK Table with Default Port '000']
The system searches BK table again with same broker name and Canadian indicator 'C' but using default port '000' → The system retrieves the broker configuration segment if found with default port, otherwise initializes empty BK segment
[Search B1 Table for Additional Config]
The system searches B1 table for additional broker configuration → The system stores B1 segment configuration if found, otherwise initializes empty B1 segment
[X12 EDI Configuration Available]
The broker USE-X12 flag equals 'Y' → The system sets notify broker flag, assigns X12 broker header, and calls customs notification service
[Retrieve Broker Configuration Using Port-Specific Key]
Retrieving broker configuration from the BK table → Use the broker name, Canadian flag 'C', and the port code from positions 2-3 of the manifest transmission code as the search key
[Get B1 Segment for Internet/Fax Settings]
Retrieving additional broker settings → Retrieve the B1 table segment for internet address and fax configuration
[Send X12 EDI Notification via GCCS309C]
The broker X12 usage flag equals 'Y' → Set notify broker flag, set X12 broker header from configuration, set CCN key, and call GCCS309C service
[Retrieve Master Manifest Data]
The system attempts to retrieve the master manifest data → The master manifest record is retrieved and saved as template for subsequent updates
[Preserve Critical Status Flags]
The system prepares the update operation → The 309 sent flag, 309 lock flag, multi-car manifest flag, car sequence number, and master manifest CCN are preserved from the existing record
[Prepare FWCMSGET Parameters]
The system prepares FWCMSGET service parameters → The shipment root key is set from GCX005 input and equipment sequence number is set from FWSWREQ segment
[Set Equipment Not Found Flag]
The system processes the failed response → An error message is generated containing shiproot key and equipment sequence, and processing is aborted
[Set High Values to Filler]
The system sets message control markers → The filler field is set to high values to mark message preparation status
[Clear Action Code]
The system prepares to set operation type → The action code field is cleared to zeros to prepare for new operation assignment
[Set Waybill Date]
The system prepares the spawn message with temporal information → The waybill date is assigned to the spawn waybill date field
[Set CCN Number]
The system prepares the spawn message with cargo identification → The CCN number is assigned to the spawn CCN field
[Set Update Multi-Bill Flag]
The system sets the operation type for the spawn message → The spawn action flag is set to indicate multi-bill update operation
[Prepare GCT0111E Message]
The system formats the message for transaction processing → The spawn message is moved to the GCT0111E message structure
[Queue Message for Processing]
The system initiates transaction spawning → The GCT0111E spawn process is performed to queue the message for processing
[Prepare GCT0111E Message]
The system prepares GCT0111E message → The spawn message content is moved to GCT0111E message structure
[Prepare GCT1051E Message]
The system prepares GCT1051E message → The GCX105 input data is moved to GCT1051E message structure
[Prepare GCT0051E Message]
The system prepares GCT0051E message → The GCX005 input data is moved to GCT0051E message structure
[Prepare GCT0191E Message]
The system prepares GCT0191E message → The GCX019 input data is moved to GCT0191E message structure
[Prepare GCT1401E Message]
The system prepares GCT1401E message → The GCX140 input data is moved to GCT1401E message structure
[Call CIMS with CHNG Operation]
The system calls CIMS with CHNG operation → The message queue is changed to ready state using the appropriate PCB
[Write Message to Queue using WRITMSGL]
The system writes message using WRITMSGL → The message is written to queue with message code, content, length and module name
[Call CIMS with PURG Operation]
The system calls CIMS with PURG operation → The message queue is purged using the appropriate PCB
[Create Audit Log Entry]
The system needs to log the validation failure for audit purposes → An audit log entry is created with action code 'ZZZ', the CCN key, current timestamp, and the specific error message describing why the update was blocked
[Preserve Existing Status Flags]
The corrector flag is set to true → The system preserves the sent 309 flag, lock 309 flag, multi-car manifest flag, car sequence number, and master manifest CCN from the existing record
[Set Transmission Flag to Y]
The cargo control number is empty → The system sets transmission flag to Y, otherwise sets transmission flag to N
[Set Transmission Flag to N]
The in-transit status is R → The system sets transmission flag to N to prevent transmission
[Set First 309 Sent Flag]
The manifest is either not locked and not sent, or locked and not sent, or has delete pending status → The system sets sent first 309 flag to true
[Set 309 Change Pending Flag]
The carrier is not 999 or 105 → The system sets 309 change pending flag to true and skips current transmission
[Continue Processing]
The waybill is released and change pending, or is a corrector, or carrier is 999 or 105 → The system continues with 309 processing instead of skipping transmission
[Broker Configuration Retrieval]
The system retrieves broker configuration from GCSTBRT broker tables → First attempt lookup using broker name, Canadian flag 'C', and manifest transmission port code, if not found then attempt lookup with port '000', if still not found then initialize empty broker segments
[Secondary Broker Configuration Retrieval]
The system retrieves secondary broker configuration from GCSTBRT broker tables → First attempt lookup using secondary broker name, Canadian flag 'C', and manifest transmission port code, if not found then attempt lookup with port '000', if not found then skip secondary broker processing
[Use X12 EDI?]
The system checks if X12 EDI notification is enabled for the broker → If GCSTBRT-BK-USE-X12 equals 'Y' then send X12 EDI notification using broker X12 header and CCN key, otherwise skip X12 processing
[Retrieve Broker Configuration from BK Table]
The system needs to validate broker delivery schedule for notifications → The system retrieves broker configuration from BK table using broker name, Canadian indicator 'C', and port code from transmission code
[Retrieve Broker Configuration from BK Table]
The initial broker table lookup fails → The system performs a second lookup using the same broker name and Canadian indicator 'C' but with default port '000'
[Log: Broker Not Found - Skip Notification]
No broker configuration is found in the BK table → The system initializes empty broker segments and skips broker notification processing
[Allow Broker Notification Processing]
The delivery schedule validation passes → The system proceeds with broker notification processing including X12, Merlin, Internet, and Fax notifications based on broker configuration settings
[Skip Broker Notification]
The delivery schedule validation fails → The system skips all broker notification processing and continues with the next broker or exits the notification process
[Set High Security Level]
The system prepares the customer report message → The security byte is set to high values to enforce maximum security
[Write Message to Queue]
The system needs to create the customer report → A GCT1401E transaction message is written to the IMS queue for processing
[Access EDIBOL Database]
System needs to build EDIBOL CCN array → Shipment root is retrieved from EDIBOL database and EDIBOL key is extracted from shipmine segment and EBSBCBC root segment is accessed for further processing
[Search RF Segments for CCNs]
System searches for CCNs in EDI data → RF segments are searched sequentially starting from sequence 1 and CY segments with XC qualifier are located within each RF segment and CCN is extracted from reference number field and CCN is added to EDIBOL array with counter increment
[Arrays Ready for Comparison]
Array building process is complete → GCCC array contains all CCNs from cargo database with validity flags and EDIBOL array contains all CCNs from EDI data and both arrays are ready for count and content comparison
[Retrieve Customs CCNs from GCCC Database]
The system begins validation processing → The GCCC CCN array and EDIBOL CCN array are initialized to empty state and counters are set to zero
[Retrieve Customs CCNs from GCCC Database]
The system needs to query the customs database → A waybill key is constructed by combining the shiproot key as waybill data and converting the waybill date to numeric format
[Retrieve EDIBOL CCNs from RF Segments]
The system needs to access EDI data for CCN comparison → The shiproot record is retrieved from the waybill database, and if not found, the EDIBOL processing is terminated
[Retrieve EDIBOL CCNs from RF Segments]
The system queries for shipment mine data with segment ID 'E' and segment number '1' → The EDI BOL key is extracted from the first data line, and if shipment mine data is not found, EDIBOL processing is terminated
[Retrieve EDIBOL CCNs from RF Segments]
The system queries the EDI database for the base control record → The EBSBCBC record is retrieved, and if not found, EDIBOL processing is terminated
[Retrieve EDIBOL CCNs from RF Segments]
The system queries for control reference record with dependent key 'CR001' → The EBSBCCR record is retrieved, and if not found, EDIBOL processing is terminated
[Build EDIBOL CCN Array from XC Qualifiers]
The system processes RF segments sequentially starting from sequence 1 → For each RF segment found, the system searches for CY segments with XC qualifiers and extracts the reference numbers as CCNs into the EDIBOL array
[Build EDIBOL CCN Array from XC Qualifiers]
The system searches CY segments for XC qualifiers and finds a matching reference → The reference number from the XC qualifier is extracted and added to the EDIBOL CCN array
[CCN Counts Match?]
The system compares the count of CCNs in each array → If the counts are not equal, the system proceeds to process unmatched CCNs, otherwise it continues to individual CCN matching
[Spawn Update Processes for Valid Manifests]
The system processes each GCCC CCN that is valid for update → An update process is spawned for each valid CCN to apply the manifest changes
[Spawn New Manifest Creation for EDIBOL CCNs]
The system processes EDIBOL CCNs for new manifest creation → A manifest update process is spawned for each EDIBOL CCN to create new customs manifests
[Multi-Car Manifest?]
The manifest type needs to be determined for error message generation → If the manifest is multi-car type, generate specific multi-car error messages, otherwise proceed with standard CCN deletion and recreation
[Delete All Existing Customs Manifests]
The system needs to synchronize the data → Delete all existing customs CCN records by setting them to delete-pending status
[Create New Manifests from EDIBOL Data]
New manifests need to be created from EDIBOL data → Spawn update processes for each EDIBOL CCN to create corresponding manifest records
[Search BK Table with Broker Name2 and Port]
The system searches for broker configuration in the BK table using broker name2, Canadian flag 'C', and port code from manifest transmission code positions 2-3 → The system attempts to retrieve the broker configuration segment for the specified port
[Search B1 Table for Additional Settings]
The system searches the B1 table for additional broker settings using table ID 'B1' → The system loads the B1 configuration segment if found, otherwise initializes empty B1 configuration
[Configure X12 EDI Notification]
The broker use X12 flag equals 'Y' → The system sets up X12 broker notification with the broker's X12 header information and CCN key
[Search Broker Table with Port]
The system searches the broker table using broker name 'C' for Canadian and port code from manifest transmission code positions 2-3 → The system retrieves broker configuration if found or proceeds to default port search
[Schedule = Default or Immediate?]
The system checks if broker delivery schedule equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → If schedule matches, proceed with notifications; otherwise skip secondary broker processing
[Process X12 EDI Notification]
The system processes X12 EDI notification using broker X12 header and CCN key → The system calls GCCS309C program to send X12 notification to secondary broker
[Process Internet Notification]
The system processes Internet notification using B1 segment Internet address and CCN information → The system spawns GCT0191E program to send Internet notification to secondary broker
[Retrieve Secondary Broker Configuration]
The system searches for broker configuration using broker name 'C' for Canadian and port code from positions 2-3 of manifest transmission code → The broker configuration segment is retrieved and stored for notification processing
[Try Default Port 000]
The system performs a second lookup using the same broker name and Canadian indicator but with default port '000' → If found, the default broker configuration is retrieved, otherwise broker segments are initialized as empty
[Send X12 EDI Notification]
The system processes X12 EDI notification with broker X12 header and CCN key → X12 EDI notification is sent to the secondary broker through the GCCS309C service
[Send Internet Notification]
The system prepares internet notification with CCN key, security byte, and internet address from B1 segment → Internet notification is spawned through GCT0191E print service using the broker's internet address
[Prepare GCT1401E Message]
The system formats the report for transmission → The GCX140-INPUT data must be moved to GCT1401E-MSG structure to create a properly formatted message
[Queue Message for Processing]
The system queues the message for processing → The system must execute CHNG operation on ALT-PCB2 with GCT1401E to prepare the message queue for transmission
[Send Message to Customer Report System]
The system sends the message to the customer report system → The system must execute WRITMSGL operation using ALT-PCB2, GCT1401E-MSG-CODE, GCT1401E-MESSAGE, GCT1401E-MSG-LGTH, and GCT1401E-MOD-NAME to deliver the message
[Purge Message Queue]
The system completes the message delivery process → The system must execute PURG operation on ALT-PCB2 to clean up the message queue
[Extract CCN from CY Segment]
The system processes RF segments and finds CY segments with N9 reference qualifier equal to 'XC' → The CCN from N9 reference number is added to EDIBOL array and EDIBOL counter is incremented
[Compare Array Counts]
The system compares EDIBOL count with GCCC count → If counts are not equal then count mismatch is flagged for unmatched CCN processing, otherwise arrays are prepared for individual CCN matching
[Build Waybill Key from Shiproot and Date]
The system needs to search for related cargo records → A waybill key is constructed by combining the shiproot key with the formatted waybill date
[Get SHIPROOT Segment]
The system attempts to retrieve shipment root information → The SHIPROOT segment is retrieved from the waybill database using the provided key
[Get SHIPMINE Segment]
The system attempts to retrieve SHIPMINE information → The SHIPMINE segment is retrieved and the EDI BOL key is extracted from the first data line
[Get EBSBCBC Root Segment]
The system attempts to retrieve the EDI root segment → The EBSBCBC segment is retrieved using the EDI BOL key
[Set CR Dependent Key to 'CR001']
The system prepares to access equipment-specific EDI data → The CR dependent key is set to 'CR001' to target the first equipment record
[Get EBSBCCR Segment]
The system attempts to retrieve equipment information → The EBSBCCR segment is retrieved using the EDI BOL key and CR dependent key
[Set Type to 'RF']
The system prepares to retrieve RF segments → The segment type is set to 'RF' to access reference segments
[Get EBSBCCX Segment by Sequence]
The system attempts to retrieve an RF segment → The EBSBCCX segment is retrieved using the EDI BOL key, segment type 'RF', and current sequence number
[Set Type to 'CR']
The system prepares to retrieve CY segments → The segment type is set to 'CR' to access cargo reference segments
[Get EBSBCCY Segment]
The system attempts to retrieve a CY segment → The EBSBCCY segment is retrieved using the EDI BOL key, segment type 'CR', and current CY sequence number
[Extract CCN from CY-N9-REF-NO]
The system processes the reference number → The cargo control number is extracted from the CY-N9-REF-NO field
[Add CCN to EDIBOL Array]
The system processes the extracted CCN → The CCN is added to the EDIBOL CCN array and the EDIBOL counter is incremented by one
[Increment Sequence Counter]
The system prepares to process the next RF segment → The RF sequence counter is incremented by one
[More RF Segments?]
If continuation of RF segment processing → If more RF segments exist, continue retrieving next RF segment; if no more segments, complete EDIBOL CCN extraction
[Complete EDIBOL CCN Extraction]
The EDIBOL CCN extraction process concludes → The system exits with the EDIBOL CCN array populated with all extracted cargo control numbers
[Extract Waybill Information]
Error message generation is required for multi-bill scenarios → Extract and set carrier code from ORIG-RD-NUM, origin station from ORIG-CSC-STN-NUM, waybill number from WB-NUM, and equipment ID from CAR-ID of shiproot into message fields
[Set Terminal and User Information]
Terminal and user information needs to be included in the message → Set terminal information from CC-ORIG-LTERM and user information from CC-ACF2-USERID into message work fields
[Add Correction Instructions Message]
User guidance needs to be provided → Add message 'PLEASE MAKE THE NECESSARY CORRECTIONS IN THE CUSTOMS APPLICATION' to the error message text
[Add CCN Comparison Header]
CCN comparison information needs to be presented → Add header line 'OLD CCNS NEW CCNS' to the error message text
[Generate A6 Multi-Car Block Message]
The system needs to block the A6 change operation → Add message 'A6 CHANGE BLOCKED ON MULTI BILL/MULTICAR' to the error message text and trigger multi-bill message processing
[Clear Message Buffer]
Message processing is complete → Clear EMI-TEXT to spaces and reset WS-IND-TEXT to LINE-MESS-MIN value
[Prepare GCX011 Spawn Message]
The system prepares to spawn a GCX011 update transaction → The spawn message structure is initialized with spaces to clear any previous data
[Set Update Multi-Bill Action Code]
The system needs to identify the type of operation being performed → The action code is set to indicate GCX005 update multi-bill operation
[Set Waybill Information]
The system needs to include waybill context information → The shiproot key is assigned to the waybill field and the waybill date is set from the input message
[Set CCN Information]
The system needs to specify which CCN to update → The working CCN number is assigned to the CCN field in the spawn message
[Queue Update Message]
The system needs to initiate the update transaction → The spawn message is queued to GCT0111E for processing and the message queue is purged to complete the operation
[Set S55 Segment Retrieval Parameters]
The system prepares to retrieve S55 segment data → Set accept status to 'GE', configure S55 segment flag, set function to GU, and set index to not used
[Call Cargo Report Database Interface]
The system calls the cargo report database interface → Execute GCCCCIO2 program with all required segment parameters including GCSCCS00, GCSCCRT, GCSCCS52, GCSCCS53, GCSCCS54, GCSCCS55, and GCSCCS56
[Move S55 Data to Working Array]
The system processes the retrieved S55 segment data → Move WS-GCSCCS55-DATA(1) to GCSCCS55 working storage
[Move S53 Data to Working Storage]
The system processes the retrieved S53 segment data → Move WS-GCSCCS53-DATA(1) to GCSCCS53 working storage

Structural Validations

[33:Message Input Validation]
The message type is not one of the valid types (BUNCH-BILLING, RESPAWN-BUNCH-BILLING, DELETE-MANIFEST, DELETE-BUNCH-MANIFEST, UPDATE-FOLLOWERS, UPDATE-BUNCH-BILL, VALIDATE-BUNCH-UPDATE, VALIDATE-MULTI-UPDATE) → The system should reject the message with an invalid process type error
[33:Message Input Validation]
The message type requires a master CCN key AND the master CCN key is empty AND the message type is not VALIDATE-BUNCH-UPDATE, DELETE-BUNCH-MANIFEST, or VALIDATE-MULTI-UPDATE → The system should reject the message with 'NO CDN CCN RECEIVED' error
[33:Message Input Validation]
The message type is BUNCH-BILLING or RESPAWN-BUNCH-BILLING AND the shiproot key is empty → The system should reject the message with 'NO SHIPROOT KEY RECEIVED' error
[8:Manifest Search and Update]
A CCN already exists with the same origin station number, railroad number, waybill number, and equipment ID:
it's a respawn operation with master car ID
→ The system should treat as corrector update and preserve existing 309 flags and sequence information, otherwise generate 'CCN ALREADY EXISTS' error message
[24:Customs Transmission Creation]
The cargo is not rejected AND transmission is required AND (cargo is CPRS with 'E' suffix:
CCN starts with '6105E')
→ The system should set 309 processing flags, create transmission using GCCS309C, set status to sent, and handle broker notifications based on delivery schedule and notification methods
[30:CCN Matching Validation]
CCN matching validation is performed → The system should compare CCN counts first, then match individual CCNs or lead CCNs between both sources, setting match status based on whether all CCNs can be matched
[Validate Message Structure]
The system validates the message structure → The message must contain a valid process type (BUNCH-BILLING, RESPAWN-BUNCH-BILLING, DELETE-MANIFEST, DELETE-BUNCH-MANIFEST, UPDATE-FOLLOWERS, UPDATE-BUNCH-BILL, VALIDATE-BUNCH-UPDATE, or VALIDATE-MULTI-UPDATE)
[Validate Message Structure]
The system checks for master CCN key presence → The master CCN key must not be spaces or the system will abort with 'NO CDN CCN RECEIVED' error
[Validate Message Structure]
The system checks for shiproot key presence → The shiproot key must not be spaces or the system will abort with 'NO SHIPROOT KEY RECEIVED' error
[Invalid Transaction Type Error]
The transaction type does not match any valid process type → The system generates error message 'INVALID PROCESS TYPE RECEIVED:' concatenated with the invalid type and aborts processing
[Check if Update Allowed]
Duplicate validation occurs → If origin station number, railroad number, waybill number, and equipment ID match the shipment data OR this is a respawn operation with master car ID, then allow update, otherwise create error message about CCN already existing
[Duplicate Validation Passed?]
The system validates the duplicate criteria → If all shipment matching criteria are satisfied, mark as corrector update and preserve original flags; otherwise generate error message about existing CCN
[Send Error Messages if Any]
The system processes the invalid duplicate → The system adds 1 to WS-IND-TEXT and moves 'CCN ALREADY EXISTS ON CARGO REPORT DB' to EMI-TEXT-LINE
[Send Error Messages if Any]
The system checks if messages need to be sent → If WS-IND-TEXT is greater than LINE-MESS-MIN, the system performs SEND-MESSAGES to notify users
[Generate Duplicate Error Message 'CCN ALREADY EXISTS ON CARGO REPORT DB']
The system processes the duplicate cargo control number → An error message 'CCN ALREADY EXISTS ON CARGO REPORT DB' is generated and added to the message text
[Validate Manifest Eligibility]
The system checks manifest eligibility → The system blocks updates if manifest is on a train (CDN CUS North train ID not empty), if manifest is locked by user (309 locked), if cargo has arrived (arrival indicator not empty for 6105E CCNs), or if broker entry exists and broker name has changed
[Match Equipment with Seal Data]
The system compares equipment initial and number from N7 segment with cargo equipment after format conversion → If equipment initial and number match, set equipment match flag to true and use the sequence for seal number retrieval, otherwise continue searching through remaining segments
[Compare Equipment Initial]
The system compares the equipment initials → The initials should match exactly for the equipment to be considered a potential match
[Format Successful?]
Formatting operation completes → Return code is checked for success status before proceeding with comparison
[EDIBOL Root Found?]
The system checks the retrieval status → If EDIBOL root is not found, seal processing should terminate with no seal numbers found status
[Seal Segments Found?]
The system checks the retrieval status → If seal segments are not found, terminate collection; if found, proceed to extract seal numbers
[Generate Duplicate Error Message]
The duplicate validation fails to confirm this as a legitimate update → The system adds an error message 'CCN ALREADY EXISTS ON CARGO REPORT DB' to the message text
[Send Error Messages if Any]
The message text index is greater than the minimum line message threshold → The system sends the accumulated messages to the appropriate recipients
[Check If Okay To Delete]
The system checks the cargo report and finds that CP-TRAIN-ID is not empty → The system sets deletion authorization to 'N', creates error messages indicating the waybill has not been cancelled and CCN cannot be deleted because it has been reported on a train, logs the cargo not deleted on train action, and displays the train ID
[Check If Okay To Delete]
The system checks the cargo report and finds that RELEASE-BY is not 'EXPORT' or 'S.A.R.' and RELEASE-INFORMATION is not empty → The system sets deletion authorization to 'N', creates error message indicating delete not authorized because CCN has been released, and logs the cargo not deleted released action
[Check CP Train ID Field]
The system checks the CP Train ID field in the cargo report → If CP Train ID is not empty, the manifest cannot be deleted and appropriate error messages are generated
[Generate Train Assignment Error Message]
A deletion attempt is made on the manifest → The system generates error messages indicating waybill cancellation is required and includes the specific train ID
[Generate Train Assignment Error Message]
A deletion request is processed for the manifest → The system generates message 'CCN NOT DELETED, IT HAS BEEN REPORTED ON A TRAIN' and adds it to the error message collection
[Send Error Messages to User]
The error message count exceeds the minimum threshold (LINE-MESS-MIN) → The system sends all accumulated error messages to the user through the messaging system
[Add Error Message: 'CCN NOT DELETED, IT HAS BEEN REPORTED ON A TRAIN']
The system needs to inform the user of the deletion failure → An error message 'CCN NOT DELETED, IT HAS BEEN REPORTED ON A TRAIN' should be added to the message queue
[Add Error Message: 'DELETE NOT AUTHORIZED, THIS CCN HAS BEEN RELEASED']
The system needs to inform the user of the deletion failure → An error message 'DELETE NOT AUTHORIZED, THIS CCN HAS BEEN RELEASED' should be added to the message queue
[Are there Error Messages?]
The system needs to determine next steps → If the message index is greater than the minimum line message count, error messages exist and should be sent
[Send Error Messages to User]
The system has completed validation and found errors → All error messages should be sent to the user through the messaging system
[Delivery Schedule Valid?]
The system checks broker delivery schedule → If delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, proceed with notifications, otherwise skip all notifications
[Check if Manifest Locked by User]
System checks if manifest is locked by user changes → If 309 locked flag is set, system logs 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST' error and marks manifest as invalid for update
[Is Manifest on Active Train?]
The system checks if the manifest has a Canadian Customs North Train ID assigned → If the train ID is not empty, the system logs a train status error message, sets the skip record flag to prevent updates, and marks the manifest as not eligible for update
[Is Manifest Locked by User?]
The system checks if the manifest has been locked due to user modifications (309-LOCKED flag is true) → If the manifest is locked, the system logs a lock status error message, sets the skip record flag to prevent updates, and marks the manifest as not eligible for update
[Is Single Car Manifest Arrived?]
The system checks if the cargo control number starts with '6105E' (indicating a single car manifest) and the arrival indicator is present and not empty → If both conditions are true, the system logs an arrival status error message, sets the skip record flag to prevent updates, and marks the manifest as not eligible for update
[Has Broker Entry Changed?]
The system checks if a broker entry exists (GCCC-BROKER-ENTRY is not empty) and the current broker name differs from the waybill broker name → If both conditions are true, the system logs a broker entry error message, sets the skip record flag to prevent updates, and marks the manifest as not eligible for update
[Is Manifest on Active Train?]
The system checks if the manifest can be updated AND the manifest has a Canadian Customs North Train ID that is not empty → The system should log 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN' message, mark the record to be skipped, and create an audit log entry with action code 'ZZZ'
[Is Manifest Locked by User Changes?]
The system checks if the manifest can be updated AND the manifest has a 309 lock flag indicating user changes → The system should log 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST' message, mark the record to be skipped, and create an audit log entry with action code 'ZZZ'
[Is Single-Car Manifest AND Cargo Arrived?]
The system checks if the manifest can be updated AND the CCN key starts with '6105E' (indicating single-car manifest) AND the arrival indicator is not empty and not low-values → The system should log 'WB UPDATE NOT APPLIED CARGO IS ARRIVED' message, mark the record to be skipped, and create an audit log entry with action code 'ZZZ'
[Is Single-Car Manifest AND Has Broker Entry AND Broker Changed?]
The system checks if the manifest can be updated AND the CCN key starts with '6105E' (indicating single-car manifest) AND the broker entry field is not empty and not low-values AND the current broker name is different from the waybill broker name → The system should log 'BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT' message, mark the record to be skipped, and create an audit log entry with action code 'ZZZ'
[Format Error Information]
The system prepares message content for transmission → The message content is formatted with cargo control number as MSG-CCN-KEY, carrier as MSG-CARRIER and EMI-CARRIER, origin station as MSG-ORIG-STN and EMI-ORIG-STN, waybill number as MSG-WB-NUM and EMI-WB-NUM, equipment ID as MSG-EQ-ID and EMI-EQ-ID, user terminal as MSG-LTERM-WK, and user ID as MSG-USER-WK
[Valid MERLIN IDs?]
The system checks MERLIN ID validity by performing EMTZ segment lookups → Supervisor ID is marked valid if EMTZ segment is found, DC&P ID is marked valid if EMTZ segment is found, customer ID is marked valid if EMTZ segment is found, and at least one valid recipient is identified for message transmission
[Error status not reject?]
Error status validation occurs → If error status is not equal to reject status, then customs transmission is allowed
[Send error messages if any]
Text index is greater than minimum line message threshold → Error messages are sent to designated recipients
[Is Delivery Schedule Valid?]
Checking delivery schedule → Processing continues only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise exits
[Valid Delivery Schedule?]
GCSTBRT-BK-DELIVERY-SCHED equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → The system proceeds with broker notifications, otherwise exits broker processing
[Valid Delivery Schedule?]
The broker delivery schedule is checked → Processing continues only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise processing exits
[Delivery Schedule = DEFAULT or IMMEDIATE?]
Delivery schedule validation is performed → Check if broker delivery schedule is either DEFAULT-DELIVERY or IMMEDIATE-DELIVERY
[Delivery Schedule Valid?]
The system checks broker delivery schedule setting → Processing continues only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY
[Compare Individual CCNs Between Databases]
The system compares each customs CCN against all EDIBOL CCNs → Each customs CCN must have an exact match in EDIBOL database or its lead CCN must match an EDIBOL CCN for multi-car manifests
[Generate Multi-Car Error Message]
The system processes the validation failure → An error message 'A6 CHANGE BLOCKED ON MULTI BILL/MULTICAR' is generated and multi-bill message is sent
[Validate Manifest for Update Eligibility]
The system validates the manifest for update eligibility → If the manifest has a Canadian customs north train ID that is not empty, the manifest is marked as invalid for update and an error message is logged stating the manifest is on a train
[Validate Manifest for Update Eligibility]
The system validates the manifest for update eligibility → If the manifest has a 309 locked status indicating user modifications, the manifest is marked as invalid for update and an error message is logged stating user made changes to the manifest
[Validate Manifest for Update Eligibility]
The system validates the manifest for update eligibility → If the manifest has an arrival indicator that is not empty and not low-values, the manifest is marked as invalid for update and an error message is logged stating cargo is arrived
[Validate Manifest for Update Eligibility]
The system validates the manifest for update eligibility → If the manifest has a broker entry that is not empty and not low-values, and the broker name does not match the waybill broker name, the manifest is marked as invalid for update and an error message is logged stating broker entry is present
[Train Status Check]
The system checks if the manifest has a Canadian Customs North Train ID assigned → If the train ID is not empty, the system logs an error message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN', creates an audit log entry with action code 'ZZZ', and sets the skip record flag to prevent further processing
[Lock Status Check]
The system checks if the manifest has been locked due to user modifications (309-LOCKED status) → If the manifest is locked, the system logs an error message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST', creates an audit log entry with action code 'ZZZ', and sets the skip record flag to prevent further processing
[Arrival Status Check for Single Car Manifests]
The system checks if the cargo has an arrival indicator that is not empty or low-values → If the cargo has arrived, the system logs an error message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED', creates an audit log entry with action code 'ZZZ', and sets the skip record flag to prevent further processing
[Broker Entry Check for Single Car Manifests]
The system compares the existing broker name with the waybill broker name → If the broker names are different, the system logs an error message 'BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT', creates an audit log entry with action code 'ZZZ', and sets the skip record flag to prevent further processing
[Shipment Root Found?]
The retrieval operation completes → If shipment root is not found, exit the EDIBOL retrieval process, otherwise continue to get shipment mine data
[Shipment Mine Found?]
The retrieval operation completes → If shipment mine is not found, exit the EDIBOL retrieval process, otherwise continue to get EDIBOL root segment
[EDIBOL Root Found?]
The retrieval operation completes → If EDIBOL root is not found, exit the EDIBOL retrieval process, otherwise continue to get CR dependent segment
[CR Segment Found?]
The retrieval operation completes → If CR segment is not found, exit the EDIBOL retrieval process, otherwise continue to initialize RF segment processing
[RF Segment Found?]
The retrieval operation completes → If RF segment is not found or sequence reaches 99, complete EDIBOL retrieval, otherwise process CY segments for XC qualifier
[XC Qualifier Found?]
The search completes → If XC qualifier is not found or CY segment is not found, increment sequence counter, otherwise extract CCN from reference number
[SHIPROOT Found?]
System checks if SHIPROOT segment was found → If SHIPROOT not found, EDIBOL navigation exits with failure, otherwise processing continues to SHIPMINE segment
[SHIPMINE Found?]
System checks if SHIPMINE segment was found → If SHIPMINE not found, EDIBOL navigation exits with failure, otherwise processing continues to EBSBCBC segment
[EBSBCBC Found?]
System checks if EBSBCBC segment was found → If EBSBCBC not found, EDIBOL navigation exits with failure, otherwise processing continues to EBSBCCR segment
[EBSBCCR Found?]
System checks if EBSBCCR segment was found → If EBSBCCR not found, EDIBOL navigation exits with failure, otherwise processing continues to RF segment search
[CY Segment Found?]
System checks if CY segment was found → If CY segment not found, sequence counter is incremented for next search, otherwise qualifier validation proceeds
[CY Qualifier = 'XC'?]
System checks if CY reference number qualifier equals 'XC' → If qualifier is not 'XC', sequence counter is incremented for next search, otherwise CCN extraction proceeds
[Sequence < 99?]
The sequence limit is checked → If sequence counter equals 99, the search terminates, otherwise it continues
[CY Segment Found?]
The segment existence is validated → If WS-EBSBCCY-NOT-FOUND is true, the search terminates, otherwise processing continues
[Compare Current GCCC CCN with EDIBOL CCN]
The system compares the GCCC CCN with the EDIBOL CCN → A match is identified if the CCN values are identical
[Check Lead CCN Match]
Direct CCN match is not found and the system checks the lead CCN → A match is identified if the GCCC lead CCN matches any EDIBOL CCN
[Direct CCN Match Found?]
The system compares the GCCC CCN with the EDIBOL CCN for exact equality → Return true if the CCNs are exactly equal, otherwise return false
[Lead CCN Match Found?]
The system compares the GCCC lead CCN with the EDIBOL CCN for exact equality → Return true if the lead CCN and EDIBOL CCN are exactly equal, otherwise return false
[EDIBOL CCN Available?]
The current EDIBOL CCN position is checked → The system should determine if an EDIBOL CCN exists at the current position and is not spaces or empty
[Compare GCCC CCN with EDIBOL CCN]
The system performs direct string comparison between GCCC CCN and each EDIBOL CCN → The system sets match status to true if exact match is found, otherwise continues to next EDIBOL CCN
[Compare GCCC Lead CCN with EDIBOL CCN]
The system performs string comparison between GCCC lead CCN and EDIBOL CCN → The system sets match status to true if exact match is found, otherwise continues to next EDIBOL CCN
[Compare GCCC CCN with EDIBOL CCN]
The system compares the GCCC CCN with the current EDIBOL CCN → The system sets match status to true if CCNs are identical, otherwise continues comparison process
[Compare GCCC Lead CCN with EDIBOL CCN]
The system compares the GCCC Lead CCN with the current EDIBOL CCN → The system sets match status to true if Lead CCN matches EDIBOL CCN, otherwise continues to next EDIBOL CCN
[EDIBOL Root Found?]
The system checks the retrieval status → If EDIBOL root segment is not found, the process exits without further processing
[CR Segment Found?]
The system checks the retrieval status → If CR segment is not found, the process exits without further processing
[RF Segment Found?]
The system checks the retrieval status and sequence counter → If RF segment is not found or sequence counter reaches 99, the processing completes
[CY Segment with XC Qualifier Found?]
The system checks if a CY segment with reference qualifier 'XC' was found → If no CY segment with 'XC' qualifier is found, processing continues to the next RF segment
[Compare Current Customs CCN with EDIBOL CCN]
The system performs the comparison → The system checks if the customs CCN exactly equals the EDIBOL CCN
[Compare Lead CCN with EDIBOL CCN]
The direct CCN comparison did not result in a match → The system checks if the lead CCN exactly equals the EDIBOL CCN
[Administrative Table Found?]
Table retrieval return flag is checked for success → If successful, administrative segment is stored; if failed, system error is generated
[Terminal Table Found?]
Table retrieval return flag is evaluated for success → If successful, terminal segment is stored and supervisor ID flag is set to 'Y'; if failed, supervisor ID flag is set to 'N'
[Validate Customer FROM-USERCODE in EMTZ]
FROM-USERCODE is searched in the EMTZ user directory → User directory lookup determines customer ID validity for MERLIN messaging
[DC-P1-ID Valid?]
DC-P1-ID flag is 'N' (invalid primary MERLIN ID) → Error message 'DC&P MERLIN USERID INVALID' is generated with the invalid MERLIN ID
[Read Input Message from Queue]
The system attempts to read the message from the queue → The system should successfully retrieve the message and set read successful flag, or generate error message if read fails
[Validate Transaction Type]
The system checks the transaction type field → The transaction type must be one of: Bunch Billing, Respawn Bunch Billing, Delete Manifest, Update Followers, Update Bunch Bill, Validate Bunch Update, Delete Bunch Manifest, or Validate Multi Update
[Log Retrieval Error]
The system handles the error condition → An error message is created containing the shiproot key and equipment sequence number, and the system terminates processing with an abend
[Add Error Message]
The CCN fails duplicate detection criteria → An error message 'CCN ALREADY EXISTS ON CARGO REPORT DB' must be added to the message text
[Create Error Message: Waybill Not Cancelled]
The system blocks the deletion due to train assignment → An error message 'WAYBILL HAS NOT BEEN CANCELLED' is added to the message text
[Create Error Message: CCN on Active Train]
The system blocks the deletion due to train assignment → An error message 'CCN NOT DELETED, IT HAS BEEN REPORTED ON A TRAIN' is added to the message text
[Send Error Messages to User]
The validation process completes → The error messages are sent to the user through the messaging system
[Log: WB-UPDATE-NOT-APPLIED]
The system validates the update request → An audit log entry is created with message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN', action code 'ZZZ', CCN key as identifier, current machine time as timestamp, spawned to GCT1051E transaction, and skip-this-record flag is set to true
[Log: WB-UPDATE-NOT-APPLIED]
The system validates the update request → An audit log entry is created with message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST', action code 'ZZZ', CCN key as identifier, current machine time as timestamp, spawned to GCT1051E transaction, and skip-this-record flag is set to true
[Log: WB-UPDATE-NOT-APPLIED]
The system validates the update request → An audit log entry is created with message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED', action code 'ZZZ', CCN key as identifier, current machine time as timestamp, spawned to GCT1051E transaction, and skip-this-record flag is set to true
[Log: BROKER-UPDATE-NOT-APPLIED]
The system validates the broker update request → An audit log entry is created with message 'BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT', action code 'ZZZ', CCN key as identifier, current machine time as timestamp, spawned to GCT1051E transaction, and skip-this-record flag is set to true
[Validate Delivery Schedule]
The system checks the broker delivery schedule setting → Processing continues only if delivery schedule is 'DEFAULT-DELIVERY' or 'IMMEDIATE-DELIVERY', otherwise broker notification is skipped
[Delivery Schedule Valid?]
The system checks if broker delivery schedule equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → Notification processing continues if schedule is valid, otherwise all notifications are skipped
[Schedule = Default or Immediate?]
The system checks if broker delivery schedule equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → The system proceeds with broker processing if schedule matches, otherwise skips broker processing
[Delivery Schedule Valid? Default or Immediate]
The broker delivery schedule is not 'DEFAULT-DELIVERY' AND not 'IMMEDIATE-DELIVERY' → Skip all broker notification processing and exit
[User Locked Manifest?]
The system checks if the manifest is locked by user changes → If the manifest has 309 locked status set to true, the manifest is considered user-locked and update is blocked
[Log: Manifest on Train Error]
The system detects the manifest is on an active train → The system logs message 'WB UPDATE NOT APPLIED MANIFEST ON A TRAIN' with action code 'ZZZ' and sets skip record flag to prevent processing
[Log: User Made Changes Error]
The system detects the manifest is locked by user changes → The system logs message 'WB UPDATE NOT APPLIED USER MADE CHANGES TO MFST' with action code 'ZZZ' and sets skip record flag to prevent processing
[Log: Cargo Arrived Error]
The system detects the cargo has already arrived → The system logs message 'WB UPDATE NOT APPLIED CARGO IS ARRIVED' with action code 'ZZZ' and sets skip record flag to prevent processing
[Log: Broker Entry Present Error]
The system detects a broker entry exists and broker name has changed → The system logs message 'BROKER UPDATE NOT APPLIED BROKER ENTRY PRESENT' with action code 'ZZZ' and sets skip record flag to prevent processing
[Send Error Messages if Any]
The error message indicator exceeds the minimum line message threshold → The system sends all accumulated error messages to the appropriate users via the messaging system
[Is Manifest Locked by User?]
The system checks if the manifest has been locked due to user modifications (309 locked status) → If the manifest is locked, the update is blocked and an error is logged indicating user changes prevent the update
[Broker Delivery Schedule Validation]
The system validates the broker delivery schedule setting → If delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY then proceed with notifications, otherwise skip all broker notifications
[Delivery Schedule = DEFAULT or IMMEDIATE?]
The system checks the broker delivery schedule setting → Notifications are allowed only if delivery schedule is set to DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise broker notifications are skipped
[Compare Individual CCNs Between Arrays]
The system compares each GCCC CCN against all EDIBOL CCNs → Each GCCC CCN must have an exact match in the EDIBOL array, or the GCCC lead CCN must match an EDIBOL CCN for the validation to pass
[Block A6 Change - Multi Bill/Multi Car Error]
The system attempts to process the update → The A6 change is blocked with error message 'A6 CHANGE BLOCKED ON MULTI BILL/MULTICAR' and multi-bill error processing is initiated
[Generate Multi-Car Error Message]
The system needs to inform users about the blocked update → Generate error message 'A6 CHANGE BLOCKED ON MULTI BILL/MULTICAR' and prepare multi-bill notification
[Send Multi-Bill Error Message to User]
The error message count exceeds the minimum threshold for message sending → Send the multi-bill error message to the user with appropriate formatting and context
[Schedule = Default or Immediate?]
The system checks if broker delivery schedule equals DEFAULT-DELIVERY or IMMEDIATE-DELIVERY → The system continues with notification processing if schedule is valid, otherwise exits without sending notifications
[Broker Found with Default Port?]
The system checks the table lookup return flag for default port search → If successful, proceed with broker configuration; if not successful, initialize empty broker segments
[Delivery Schedule Valid?]
The broker delivery schedule is checked against valid notification schedules → Notifications proceed only if delivery schedule is DEFAULT-DELIVERY or IMMEDIATE-DELIVERY, otherwise all notifications are skipped
[SHIPROOT Found?]
The retrieval operation completes → If SHIPROOT is not found, exit the EDIBOL processing; if found, continue to retrieve SHIPMINE segment
[SHIPMINE Found?]
The retrieval operation completes → If SHIPMINE is not found, exit the EDIBOL processing; if found, continue to retrieve EBSBCBC segment
[EBSBCBC Found?]
The retrieval operation completes → If EBSBCBC is not found, exit the EDIBOL processing; if found, continue to set CR dependent key
[EBSBCCR Found?]
The retrieval operation completes → If EBSBCCR is not found, exit the EDIBOL processing; if found, continue to initialize RF segment processing
[RF Segment Found?]
The retrieval operation completes → If RF segment is not found, complete EDIBOL CCN extraction; if found, continue to initialize CY segment search
[CY Segment Found?]
The retrieval operation completes → If CY segment is not found, increment RF sequence counter; if found, continue to check XC qualifier
[Qualifier = 'XC'?]
The system checks the reference number qualifier → If qualifier is not 'XC', continue searching CY segments; if qualifier is 'XC', extract the CCN from the reference number
[Multi-Bill Update Error Messaging Process]
The system determines that the update cannot be processed due to multi-bill/multi-car limitations → Generate and send error messages including correction instructions, CCN comparison headers, and specific blocking messages to the user
[Format Standard Error Message Header]
Error message header needs to be formatted → Move formatted message line 1 containing all extracted information to the first line of the error message text
[CCN Key Valid?]
The system checks if the CCN key is spaces or low-values → If CCN key is spaces or low-values, exit without processing; otherwise proceed with array creation

Module: GCX019 1 Consolidated Epic Story

Epic: GCX019 Complete EDI Specification Extracted from Legacy

Contains 295 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX019 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Seal Numbers to Spaces]
The system processes seal number requirements → All four seal number fields are initialized to spaces
[Initialize Subject Line Fields]
The system begins subject line and recipient processing → All subject line fields, keywords, and recipient codes are cleared to spaces
[Initialize Key Values and Flags]
The system initializes retrieval parameters → All key values, second PCB flag, and unqualified SSA flag are cleared to spaces
[Initialize Subject Line Fields]
The subject line construction process begins → All subject line fields are cleared to spaces and filler fields are initialized
[Initialize EMI Message Structure]
The system begins MERLIN report delivery process → All EMI message fields (subject, keywords, user codes, copy codes) are cleared to spaces

Core Acceptance Criteria

[Transmission Method Selection Logic]
The FAX number field is not empty → The system formats the FAX number into FAX line and places it in the first text line
[Transmission Method Selection Logic]
The first text line is empty → The system places train line information in the first text line, otherwise places it in the second text line
[Transmission Method Selection Logic]
The internet address starts with 'FAX:' or 'fax:' → The system clears the first text line, extracts FAX number from positions 5-14, and formats it as FAX line in first text line
[Transmission Method Selection Logic]
The internet address does not start with 'FAX:' or 'fax:' → The system formats the address as 'INTERNET: [address]' in the first text line
[Transaction Audit Logging]
The origin equals 'EXPORT' → The system sets message to 'EXPORT MANIFEST FILED' and action code to 'ZZZ'
[Transaction Audit Logging]
The origin is not 'EXPORT' → The system creates log message with MERLIN ID and file name, and sets action code to 'ZZZ'
[Transaction Audit Logging]
The internet address starts with 'FAX:' or 'fax:' → The system sets action code to 'CFR' and extracts FAX number from positions 5-14 as message
[Transaction Audit Logging]
The internet address does not start with 'FAX:' or 'fax:' → The system sets action code to 'ZZZ' and formats message as 'INTERNET: [address]'
[Transaction Audit Logging]
FAX number is not empty → The system sets action code to 'CFR' and uses FAX number as message
[Transaction Audit Logging]
Both MERLIN ID and CPRS train ID are not empty → The system creates additional communication with action code 'CTP' and MERLIN ID as message
[Transaction Audit Logging]
CPRS train ID is not empty → The system sets action code to 'CTP' and uses MERLIN ID as message
[Transaction Audit Logging]
No special communication conditions are met → The system sets action code to 'CPR' and uses MERLIN ID as message
[Entity Party Information Processing]
Entity ID code is valid for printing → The system processes entity data and prints entity information lines
[MERLIN System Report Transmission]
Internet address starts with 'FAX:' or 'fax:' → The system routes to 'EXTFAX', otherwise routes to 'EXTMAIL'
[MERLIN System Report Transmission]
FAX number is provided → The system routes to 'EXTFAX' and if MERLIN ID exists and is not 'BROKER', adds as copy recipient
[MERLIN System Report Transmission]
No special routing conditions exist → The system routes to MERLIN ID as primary destination
[MERLIN System Report Transmission]
CPRS train ID is provided → The system formats subject with 'CARGO PRT:', equipment ID, train ID, and sequence number
[MERLIN System Report Transmission]
CPRS train ID is not provided → The system formats subject with 'CARGO PRT:', CCN, and equipment ID
[Cargo Manifest Report Generation]
Line count exceeds page limit (42 lines for subsequent pages, 43 for first page) → The system starts new page, resets line count, increments page number, and adds appropriate header
[Access Cargo Control Database with CCN Key]
The system accesses the cargo control database with the CCN key → The system calls CIMS to retrieve the cargo report segment using GU function and GCCC-PCB
[Check if Follower Manifest and Replace CCN with Master Manifest CCN]
The cargo control segment indicates this is a follower manifest (GCCC-FOLLOWER-MFST is true) → The system replaces both TRAIN-CCN and CARGO-CCN with the master manifest CCN (GCCC-MASTER-MFST-CCN) to maintain proper manifest relationships
[Read Cargo Control Segment with Input CCN]
The system needs to access cargo manifest details → The system retrieves the cargo control segment using the CCN as the key and validates successful retrieval before proceeding with manifest processing
[Extract Master Manifest CCN from Cargo Control]
The system identifies the master manifest CCN that needs to be used → The system saves the current equipment ID (GCCC-EQUIPMENT-ID-FOR-INDEX) to SAVE-EQUIPMENT-ID before proceeding with master manifest processing
[Read Next Follower Car]
The system needs the next car in the collection → A GN (Get Next) call is made using GCCC-PCB7 to retrieve the next cargo report segment
[Save Current Cargo Report Segment]
The system begins follower car processing → The current cargo report segment is saved to SAVE-CARGO-REPORT-SEGMENT for later restoration
[Call Database for Next Follower Car]
The system executes database call using GN function → The next follower car record is retrieved into GCCC-CARGO-REPORT-SEGMENT using CCRT-B0RT-SSAQ
[Restore Original Cargo Report Segment]
The system completes follower car processing → The SAVE-CARGO-REPORT-SEGMENT is moved back to GCCC-CARGO-REPORT-SEGMENT
[Save Current Cargo Report Segment]
The system needs to access master manifest data → The current cargo report segment is saved to allow restoration after master processing
[Restore Original Cargo Segment]
The system needs to return to the original follower manifest context → The saved cargo report segment is restored to its original state
[Sets manifest status as DELETED or ACTIVE based on cargo state]
If the cargo delete status field GCCC-DELETE-STATUS → If the delete status equals 'D', the manifest status is set to 'DELETED', otherwise the manifest status is set to 'ACTIVE' and stored in the PT-STATUS field
[Master Manifest Processing]
The system processes the master manifest → The system saves the current cargo report segment, sets cargo found flag to true, initializes the CCN key with the current CCN, loops through all follower cars calling the follower processing routine, and restores the original cargo report segment after processing
[Follower Manifest Processing]
The system processes the follower manifest → The system saves the current cargo report segment, sets the master manifest CCN as the processing key, loops through all master cars calling the follower processing routine, and restores the original cargo report segment after processing
[Save Current Cargo Report Segment]
Processing begins for related manifests → The system saves the current cargo report segment to a temporary storage area before any modifications and restores it after processing is complete
[Save Current Cargo Report Segment]
The system begins follower manifest processing → The current cargo report segment is saved to maintain data integrity during follower processing
[Call Database for Next Follower Car]
A database call is made to get the next follower car → The system uses GN (Get Next) function to retrieve the next cargo report segment
[Restore Original Cargo Report Segment]
The follower processing loop ends → The saved cargo report segment is restored to maintain data consistency
[Continue with Report Generation]
The original cargo segment has been restored → The system continues with the standard report generation process
[Save Current Cargo Report Segment]
The system begins follower manifest processing → Save the current cargo report segment to temporary storage for later restoration
[More Cars Available?]
The system attempts to read the next car from the master manifest → Continue processing if more cars are available, otherwise terminate the loop and restore original segment
[Read Next Master Car]
The system performs a get-next operation on the cargo database → Retrieve the next car record if available, or return end-of-segment status if no more cars exist
[Restore Original Cargo Segment]
All cars have been processed or no more cars are available → Restore the previously saved cargo report segment to return to the original follower manifest context
[Retrieve Carrier Code Table CC]
The system processes carrier information lookup → The system retrieves carrier table segment using GU function with table ID 'CC' and the haulage rights SCAC as the key
[Carrier Table Found?]
If the lookup result → If lookup is successful, the system moves table segment to carrier segment, otherwise sets carrier segment to spaces
[Set Haulage Rights SCAC]
The system processes carrier identification → The system assigns the haulage rights SCAC code from the cargo segment to the report carrier identification field
[Retrieve Port Exit Table MC]
The system needs port of exit information → The system retrieves port table segment using GU function with table ID 'MC' and manifest from station name as the sequence ID key
[Extract Cargo Quantity from GCCC-LADING-QUANTITY]
The system processes cargo quantity information for report generation → The lading quantity is extracted from GCCC-LADING-QUANTITY and moved to MERLIN-UNITS field
[Extract Quantity Unit Type from GCCC-LADING-QUANTITY-QUALIFIER]
The system processes cargo unit type information → The quantity qualifier is extracted from GCCC-LADING-QUANTITY-QUALIFIER and moved to MERLIN-UNIT-TYPE field
[Extract Cargo Weight from GCCC-WEIGHT]
The system processes cargo weight information for report generation → The weight is extracted from GCCC-WEIGHT and moved to MERLIN-WEIGHT field
[Extract Weight Unit Type from GCCC-WEIGHT-UNIT-QUALIFIER]
The system processes cargo weight unit type information → The weight unit qualifier is extracted from GCCC-WEIGHT-UNIT-QUALIFIER and moved to MERLIN-WGT-TYPE field
[Access GCSCCS56 Seal Information Segment]
The system processes cargo manifest data → The system attempts to retrieve seal information from segment 56 using the cargo control number
[Extract Seal Number 1]
The system processes seal numbers for the manifest → The first seal number is extracted from GCSCCS56-SEAL-NUMBER(1) and assigned to MERLIN-SEAL-NO-1
[Extract Seal Number 2]
The system processes seal numbers for the manifest → The second seal number is extracted from GCSCCS56-SEAL-NUMBER(2) and assigned to MERLIN-SEAL-NO-2
[Extract Seal Number 3]
The system processes seal numbers for the manifest → The third seal number is extracted from GCSCCS56-SEAL-NUMBER(3) and assigned to MERLIN-SEAL-NO-3
[Extract Seal Number 4]
The system processes seal numbers for the manifest → The fourth seal number is extracted from GCSCCS56-SEAL-NUMBER(4) and assigned to MERLIN-SEAL-NO-4
[Extract UN Number from GCCC-UN-NUMBER]
The system processes dangerous goods information → The UN number is extracted from GCCC-UN-NUMBER field and moved to MERLIN-UN-NUMBER for report generation
[Extract Dangerous Goods Description from GCCC-COMODITY-DESC-DANGER]
The system processes dangerous goods information → The dangerous goods description is extracted from GCCC-COMODITY-DESC-DANGER field and moved to MERLIN-DESC-DANGEROUS for report generation
[Extract Broker Name from GCCC-BROKER-NAME]
The system processes broker information for the manifest report → The broker name from GCCC-BROKER-NAME is moved to MERLIN-BROKER field
[Get Manifest From Station Name]
Port of exit processing is initiated → The manifest from station name is obtained from the cargo segment for table lookup
[Extract Port of Exit Information]
Port of exit information extraction is performed → The table segment data is moved to the MC segment structure for data access
[Move US Station Exit to Port of Exit]
Port of exit assignment is performed → The US station exit value from MC segment is moved to the port of exit field
[Move US Station Exit Code to Exit Code]
Exit code assignment is performed → The US station exit code from MC segment is moved to the exit code field
[Retrieve Business Number from GCCC-BUSINESS-NBR]
The system processes business number information → The business number from GCCC-BUSINESS-NBR is moved to MERLIN-BUSINESS-NBR report field
[Loop Through Entity Records in GCSCCS55]
The system processes entity records sequentially from position 1 up to the maximum sequence limit → Each entity record is evaluated for valid cargo data content and processed if not empty or low-values
[More Entity Records?]
The loop counter (WS-SUB) is less than or equal to the maximum sequence (GCSCCS99-S55-MAX-SEQ) and the current entity data is not spaces or low-values → The system continues processing the next entity record, otherwise the entity processing loop terminates
[Address Line 1 Available?]
The system checks if N301-ADDRESS-INFO-1 field contains address information → If address line 1 is not spaces, format it as PT-ADDR1 and add CARGO-MERLIN-LINE30 to the report output
[Address Line 2 Available?]
The system checks if N302-ADDRESS-INFO-2 field contains address information → If address line 2 is not spaces, format it as PT-ADDR2 and add CARGO-MERLIN-LINE30A to the report output
[City Name Available?]
The system checks if N401-CITY-NAME field contains city information → If city name is not spaces, format it as PT-CITY and add CARGO-MERLIN-LINE31 to the report output
[State/Province or Postal Code or Country Available?]
The system checks if any of N402-STATE-PROV-CDE, N403-POSTAL-CDE, or N404-COUNTRY-CDE fields contain information → If any of these fields are not spaces, format them as PT-PROV, PT-PC, and PT-CC respectively, combine into CARGO-MERLIN-LINE31A and add to the report output
[Process Seal Numbers for Hazmat]
Seal numbers need to be processed for display → Set MERLIN-SEAL-NO-1 to GCSCCS56-SEAL-NUMBER(1), MERLIN-SEAL-NO-2 to GCSCCS56-SEAL-NUMBER(2), MERLIN-SEAL-NO-3 to GCSCCS56-SEAL-NUMBER(3), and MERLIN-SEAL-NO-4 to GCSCCS56-SEAL-NUMBER(4)
[Process Equipment Car Collection for Master]
Equipment car information needs to be processed → Save current cargo report segment, set cargo found flag, initialize CCN key for follower processing, and Execute follower manifest processing loop until no more cargo found
[Process Master Car Equipment Reference]
Master equipment car information needs to be processed → Save current cargo report segment, set cargo found flag, set CCN key to master manifest CCN, and Execute follower manifest processing loop until no more cargo found, then restore original cargo report segment
[Process Entity Party Information]
Entity party information needs to be processed → Loop through segment 55 data up to maximum sequence, and for each valid entity ID code, Execute entity data processing and print address lines
[Process Seal Numbers 1-4]
Building the report header → Up to four seal numbers are moved from the cargo segment to their respective report seal number fields
[Master Manifest Processing]
The system processes equipment information → The system saves the current cargo report segment, sets cargo found flag to true, initializes follower processing with the current CCN, processes all follower cars until no more are found, and restores the original cargo report segment
[Follower Manifest Processing]
The system processes equipment information → The system saves the current cargo report segment, sets cargo found flag to true, uses the master manifest CCN as the processing key, processes the master car equipment data, and restores the original cargo report segment
[Read Next Master Car Record]
The system reads the next master car record using the master CCN key → The system retrieves the cargo report segment for the master car record
[Add Barcode Equipment ID]
The manifest is a master manifest with a saved equipment ID → Use the saved equipment ID for subject line and barcode generation
[Add Barcode Equipment ID]
The manifest is not a master manifest → Use the current equipment ID for index for subject line and barcode generation
[Internet Transmission?]
The transmission method is internet (GCX019-INTERNET is not spaces) → No page break processing is performed and the system continues with normal processing
[Fax Transmission?]
The transmission method is fax (GCX019-FAX-NUMBER is not spaces) → Page break processing logic is applied to manage document pagination
[Line Count Exceeds Page Limit?]
The current LINE-COUNT exceeds the LINES-PER-PAGE limit → A page break is triggered to start a new page
[Reset Line Count to 1]
The system starts a new page → LINE-COUNT is reset to 1
[Increment Page Number]
The system starts a new page → Both CARGO-PAGE and TRAIN-PAGE are incremented by 1
[Add Train Header Line]
The cargo manifest includes train information (GCX019-CPRS-TRAIN-ID is not spaces) → TRAIN-LINE is added to EMI-TEXT-LINE at the current Merlin line count position and Merlin line count is incremented
[Add Cargo Header Line]
The cargo manifest does not include train information (GCX019-CPRS-TRAIN-ID is spaces) → CARGO-LINE is added to EMI-TEXT-LINE at the current Merlin line count position and Merlin line count is incremented
[Set Default Filename 'IN']
The file name is spaces or low values or high values → The system sets the destination filename to 'IN'
[Use Provided Filename]
The file name is not spaces and not low values and not high values → The system uses the provided file name as the destination filename
[Build Subject with Train Info]
CPRS train ID is not spaces → The system builds subject line with 'CARGO PRT:', equipment ID, train ID, and sequence number
[Build Subject with CCN Info]
CPRS train ID is spaces → The system builds subject line with 'CARGO PRT:', CCN, and equipment ID
[Set Destination as EXTFAX]
Internet address is not spaces and not high values and not low values and starts with 'FAX:' or 'fax:' → The system sets destination to 'EXTFAX'
[Set Destination as EXTMAIL]
Internet address is not spaces and not high values and not low values and does not start with 'FAX:' or 'fax:' → The system sets destination to 'EXTMAIL'
[Set Destination as EXTFAX]
FAX number is not spaces → The system sets destination to 'EXTFAX'
[Set MERLIN ID as Primary Recipient]
No internet address is available and no FAX number is available → The system sets MERLIN ID as primary recipient
[Set Admin MERLIN ID as Sender]
Sender information needs to be assigned → The system sets admin MERLIN ID as the sender
[Call EMCSEND2 to Send Report]
The system is ready to send the report → The system calls EMCSEND2 with sender, filename, recipients, subject, and report content
[Purge Message Queue]
The transmission return status indicates success → The system purges the message queue
[Internet Address Format Check]
The internet address starts with 'FAX:' or 'fax:' (case insensitive) → Set transmission destination to 'EXTFAX' for external FAX routing
[Internet Address Format Check]
The internet address does not start with 'FAX:' or 'fax:' → Set transmission destination to 'EXTMAIL' for external email routing
[FAX Number Available?]
FAX number is available for transmission → Set primary transmission destination to 'EXTFAX' for external FAX routing
[MERLIN ID Available and Not 'BROKER'?]
MERLIN ID is not spaces and not equal to 'BROKER' → Set MERLIN ID as copy recipient in addition to primary FAX destination
[Set Destination to MERLIN ID]
Only MERLIN ID is available for transmission routing → Set transmission destination to the MERLIN ID for internal routing
[Internet Address Format Check]
The system checks if GCX019-INTERNET starts with 'FAX:' or 'fax:' in positions 1-4 → The system identifies the format as FAX if it matches the pattern, otherwise treats it as email format
[Set Method: EMAIL - EXTMAIL]
The system processes transmission method assignment → The system sets EMI-TO-USERCODES(1) to 'EXTMAIL' for external email routing
[Set Method: FAX - EXTFAX]
The system processes transmission method assignment → The system sets EMI-TO-USERCODES(1) to 'EXTFAX' for external FAX routing
[Set Method: MERLIN Copy User]
The system processes copy recipient assignment → The system sets EMI-COPY-USERCODES(1) to GCX019-MERLIN-ID for copy routing
[Set Method: MERLIN Primary User]
The system processes primary recipient assignment → The system sets EMI-TO-USERCODES(1) to GCX019-MERLIN-ID for primary routing
[Set Method: Train Print - CTP]
The system processes transmission actions for train-related cargo → The system sets GCX105-ACTION-CODE to 'CTP' and GCX105-MESSAGE to GCX019-MERLIN-ID for train print processing
[Set Method: Cargo Print - CPR]
The system processes transmission actions for cargo-only processing → The system sets GCX105-ACTION-CODE to 'CPR' and GCX105-MESSAGE to GCX019-MERLIN-ID for cargo print processing
[Address Starts with 'FAX:' or 'fax:'?]
The system checks if the first 4 characters equal 'FAX:' or 'fax:' → If true, treat as FAX transmission, otherwise treat as email transmission
[Format Internet Address for Display]
The system processes the internet address for email transmission → Format the address with 'INTERNET: ' prefix and place in first EMI text line
[Set Destination to EXTFAX]
The system determines transmission routing → Set destination routing to 'EXTFAX' for external FAX processing
[Set Destination to EXTMAIL]
The system determines transmission routing → Set destination routing to 'EXTMAIL' for external email processing
[Build Train-Based Subject Line]
Building the subject line for the message → The subject line includes 'CARGO PRT: ' followed by equipment ID, train ID, and sequence number
[Build Cargo-Only Subject Line]
Building the subject line for the message → The subject line includes 'CARGO PRT: ' followed by CCN and equipment ID
[Set Admin MERLIN ID as Sender]
Setting the sender information → The system uses the administrative publication MERLIN ID as the from address
[Access Admin Table - AD]
Admin table lookup is performed with table ID 'AD' and admin key 'ADMINID' → Admin table segment data is retrieved and stored for system use
[Access Carrier Code Table - CC]
Carrier table lookup is performed with table ID 'CC' and SCAC from haulage rights → Carrier table segment data is retrieved for carrier information processing
[Store Carrier Table Data]
Table segment retrieval return flag equals SUCCESSFUL → Carrier table segment data is stored in working storage, otherwise empty carrier segment data is assigned
[Access Port Exit Table - MC]
Port table lookup is performed with table ID 'MC' and manifest from station name as key → Port table segment data is retrieved for exit port information processing
[Extract Port of Exit Information]
Table segment retrieval return flag equals SUCCESSFUL → US station exit and exit code are extracted from table data and assigned to manifest fields, otherwise empty values are assigned
[Call Table Segment Retrieval]
Table segment retrieval is executed → W300-GET-TABLE-SEGMENT procedure is performed to retrieve admin data
[Store Admin Table Data]
Admin data needs to be stored → Retrieved table segment data is moved to GCSTBRT-AD-SEGMENT for application use
[Set Function Code to GU - Get Unique]
The system prepares for database access → The function code is set to GU (Get Unique) to retrieve a single matching record
[Move Retrieved Segment to Work Area]
The retrieval operation completes without errors → The retrieved segment data is moved to the appropriate work area structure
[Set Return Flag to SUCCESSFUL]
The system updates the operation status → The return flag is set to SUCCESSFUL to indicate successful data retrieval
[Set Return Flag to SUCCESSFUL]
The database call returns successfully → The return flag is set to SUCCESSFUL and retrieved data is moved to the table segment
[Call GCCTBIO with Parameters]
The system executes the database retrieval operation → GCCTBIO is called with communication block, PCB flags, function code, and key parameters to retrieve the table segment
[Move Retrieved Segment to Working Storage]
The retrieved table segment is available → The table segment is moved to GCSTBRT-AD-SEGMENT for further processing
[Move Retrieved Segment to Working Storage]
The retrieved table segment is available → The table segment is moved to GCSTBRT-CC-SEGMENT for further processing
[Move Retrieved Segment to Working Storage]
The retrieved table segment is available → The table segment is moved to GCSTBRT-MC-SEGMENT for further processing
[Set Return Flag to NOT FOUND]
The carrier table cannot be found or retrieved → The carrier segment is set to spaces to indicate no carrier data available
[Call Table Segment Retrieval]
The system executes the table lookup operation → The table segment retrieval function is called to find matching carrier information
[Move Table Segment to CC Segment]
The lookup returns successful status with carrier data found → The retrieved table segment is moved to the CC segment for further processing
[Set CC Segment to Spaces - No Data Found]
The lookup returns unsuccessful status with no carrier data found → The CC segment is set to spaces to indicate no carrier information is available
[Use Carrier Name from Table]
The system processes the carrier data for manifest display → The carrier name from the table segment is used for carrier identification
[Extract Port of Exit Information]
The system processes the retrieved table segment → The system extracts the US station exit information and exit code from the table segment and stores them in the corresponding manifest fields
[Export Origin?]
The system determines the appropriate audit message type → If origin equals 'EXPORT ', export-specific audit processing is applied
[Set Export Manifest Filed Message]
Audit message generation is required → The message is set to 'EXPORT MANIFEST FILED' and action code is set to 'ZZZ'
[Build File Processing Message with MERLIN ID and File Name]
Audit message generation is required → The message combines MERLIN ID and file name into log message format and action code is set to 'ZZZ'
[Move Audit Record to Message Structure]
The record needs to be prepared for transmission → The GCX105 input record is moved to the GCT1051E message structure
[Set Accept Status for IMS]
IMS message status configuration is required → The accept status is set to ' ' (spaces) for standard processing
[Call IMS CHNG Function]
Message processing through IMS is required → CIMS is called with CHNG function using ALT-PCB2 and GCT1051E message
[Write Message to Audit Log]
Permanent audit log recording is required → WRITMSGL is called with message code, content, length, and module name to write the audit record
[Purge IMS Message Queue]
Message queue cleanup is required → CIMS is called with PURG function using ALT-PCB2 to purge the message queue
[Internet Transmission?]
The internet field (GCX019-INTERNET) contains a value other than spaces → Page management processing is skipped and normal processing continues
[FAX Transmission?]
The FAX number field (GCX019-FAX-NUMBER) contains spaces → Page management processing is skipped and normal processing continues
[Add Train Header Line]
The CPRS train ID (GCX019-CPRS-TRAIN-ID) is not spaces → The train header line is added to the current position in the message text AND the message line counter is incremented
[Add Cargo Header Line]
The CPRS train ID (GCX019-CPRS-TRAIN-ID) is spaces → The cargo header line is added to the current position in the message text AND the message line counter is incremented
[Add Blank Line After Header]
Either a train header or cargo header has been added → A blank line (spaces) is added to the message text AND both the line count and message line counter are incremented by 1
[Save Current Cargo Report Segment]
The system begins collecting follower equipment cars → The current cargo report segment is saved to preserve original manifest data
[Read Next Follower Equipment Car]
The system requests the next follower equipment car → The database returns the next follower cargo report segment
[Extract Equipment Car ID]
The system processes the equipment car data → The equipment car ID is extracted from the cargo report segment
[Restore Original Cargo Report Segment]
The system needs to restore original manifest data → The saved cargo report segment is restored to maintain data integrity
[Save Current Cargo Report Segment]
The system needs to access master manifest equipment data → Save the current cargo report segment to temporary storage for later restoration
[Restore Original Cargo Report Segment]
The system needs to restore the original manifest context → Restore the saved cargo report segment to return to the original manifest processing state
[Train ID Available?]
The system checks if GCX019-CPRS-TRAIN-ID is not spaces, not HIGH-VALUES, and not LOW-VALUES → If train ID is available, use train-based subject format, otherwise use CCN-based subject format
[Build Train-Based Subject Line]
Building the subject line for transmission → Set subject literal to 'CARGO PRT: ', determine equipment ID based on master manifest status, add train ID and sequence number to complete the subject
[Build CCN-Based Subject Line]
Building the subject line for transmission → Set subject literal to 'CARGO PRT: ' and determine CCN and equipment ID based on master manifest status
[Finalize Subject Line for Transmission]
Finalizing the subject line for transmission → The appropriate subject line format is ready for use in the message transmission process
[Internet Address Format Check]
The internet address starts with 'FAX:' or 'fax:' prefix → The transmission destination is set to EXTFAX for FAX routing
[Set Destination to EXTMAIL]
The internet address does not start with 'FAX:' or 'fax:' prefix → The transmission destination is set to EXTMAIL for email routing
[Set Primary Destination to EXTFAX]
The FAX number field is not spaces → The primary transmission destination is set to EXTFAX
[Set Copy Destination to MERLIN ID]
The MERLIN ID is not spaces and not equal to 'BROKER' → The MERLIN ID is set as copy destination for the transmission
[Set Destination to MERLIN ID]
A MERLIN ID exists in GCX019-MERLIN-ID field → The MERLIN ID is set as the primary transmission destination
[Call IMS Database with GN Function]
The system needs to read the next cargo report segment → The system calls the database with GN function to retrieve the next sequential cargo report segment using GCCC-PCB7 and CCRT-B0RT-SSAQ
[Start Follower Cargo Processing Loop]
The system begins processing follower cargo report segments → The system should start the loop to read cargo report segments from the follower cargo database using the next sequential read operation
[Read Next Cargo Report Segment]
The system needs to read the next cargo report segment → The system should execute a get-next operation on the cargo report segment database using PCB7 to retrieve the next available cargo record
[Status Code = 'GE'?]
The database operation returns a status code of 'GE' → The system should recognize this as an end-of-data condition and prepare to terminate the cargo processing loop
[Set Cargo Not Found Flag]
No more cargo report segments are available for processing → The system should set the cargo-not-found flag to true to terminate the processing loop
[Skip Deleted Cargo - Continue Loop]
The system processes the cargo deletion status check → The system should skip processing this deleted cargo record and continue to the next cargo segment in the loop without generating any output for this record
[Extract Equipment Car ID]
The system processes the cargo record for report generation → The system should extract the equipment car identification from the cargo report segment and assign it to the appropriate car ID field for the current line position
[Format Car ID Label for Display]
The current cargo count is greater than 1 (indicating this is not the first car in the list) → The system should clear the car ID label for this position to ensure proper formatting in the report display
[Continue to Next Cargo Segment]
The system continues the cargo processing loop → The system should return to the beginning of the loop to read and process the next cargo report segment
[Move Entity Name to Output]
The system processes entity name information → The entity name is moved to the entity name output field
[Format Address Line 1]
N301-ADDRESS-INFO-1 field contains address information (not spaces) → Format the first address line and add it to the cargo manifest report at the current line position
[Format Address Line 2]
N302-ADDRESS-INFO-2 field contains address information (not spaces) → Format the second address line and add it to the cargo manifest report at the current line position
[Format City Information]
N401-CITY-NAME field contains city information (not spaces) → Format the city information and add it to the cargo manifest report at the current line position
[Combine State, Postal, Country into Single Line]
At least one of N402-STATE-PROV-CDE, N403-POSTAL-CDE, or N404-COUNTRY-CDE fields contains information (not spaces) → Format state/province code, postal code, and country code into a combined address line and add it to the cargo manifest report at the current line position
[Internet Transmission?]
The internet transmission field (GCX019-INTERNET) contains a value other than spaces → Page management processing is skipped and normal processing continues without line count or page break controls
[Reset Line Count to 1]
Starting a new page → The line count is reset to 1 to begin counting lines on the new page
[Increment Page Numbers]
Page numbers need to be updated → Both cargo page number and train page number are incremented by 1
[Train ID Present?]
The CPRS train ID (GCX019-CPRS-TRAIN-ID) is present and not spaces → A train header line is added to the message text and the line count is incremented
[Add Cargo Header Line]
The CPRS train ID (GCX019-CPRS-TRAIN-ID) is not present or contains spaces → A cargo header line is added to the message text and the line count is incremented
[Add Blank Line]
Completing the page header formatting → A blank line is added to the message text and both line count and message line count are incremented
[Internet Transmission?]
The transmission method is internet (GCX019-INTERNET is not spaces) → Page management processing is skipped and transmission continues without pagination controls
[FAX Transmission?]
The transmission method is FAX (GCX019-FAX-NUMBER is not spaces) → Page management processing is activated to control pagination
[Reset Line Count to 1]
Starting a new page → The line count is reset to 1
[Increment Page Number]
Starting a new page → Both CARGO-PAGE and TRAIN-PAGE numbers are incremented by 1
[Add Train Header Line]
CPRS train identification (GCX019-CPRS-TRAIN-ID) is available (not spaces) → A train header line (TRAIN-LINE) is added to the message text
[Add Cargo Header Line]
CPRS train identification (GCX019-CPRS-TRAIN-ID) is not available (spaces) → A cargo header line (CARGO-LINE) is added to the message text
[Add Blank Line]
The header line has been inserted → A blank line (spaces) is added to the message text and line counts are incremented
[Check Internet Transmission?]
The internet field (GCX019-INTERNET) contains a value that is not spaces, HIGH-VALUES, or LOW-VALUES → Skip all page header formatting logic and continue with normal processing without adding page breaks or headers
[Check FAX Transmission?]
The FAX number field (GCX019-FAX-NUMBER) is spaces or empty → Skip all page header formatting logic and continue with normal processing without pagination controls
[Line Count Exceeds Page Limit?]
The current line count exceeds the lines per page limit → Reset the line count to 1 and increment both cargo page and train page numbers by 1
[Add Train Header Line]
The CPRS train ID (GCX019-CPRS-TRAIN-ID) is not spaces, HIGH-VALUES, or LOW-VALUES → Add the formatted train line to the current EMI text line position and increment the line counter
[Add Cargo Header Line]
The CPRS train ID (GCX019-CPRS-TRAIN-ID) is spaces, HIGH-VALUES, or LOW-VALUES → Add the formatted cargo line to the current EMI text line position and increment the line counter
[Is Internet Transmission?]
The transmission method is internet (GCX019-INTERNET is not spaces) → The page break checking logic is skipped and processing continues without pagination
[Is FAX Transmission?]
The transmission method is FAX (GCX019-FAX-NUMBER is not spaces) → The page break logic is applied to manage physical page formatting
[Increment Page Number]
The page break processing begins → Both CARGO-PAGE and TRAIN-PAGE counters are incremented by 1
[Add Train Header Line to Report]
The report includes train information (GCX019-CPRS-TRAIN-ID is not spaces) → A train header line (TRAIN-LINE) is added to the report at the current line position
[Add Cargo Header Line to Report]
The report does not include train information (GCX019-CPRS-TRAIN-ID is spaces) → A cargo header line (CARGO-LINE) is added to the report at the current line position
[Check Line Count for Page Break]
The transmission method is internet (GCX019-INTERNET is not spaces) → Page break processing is bypassed and report continues without pagination
[Check Line Count for Page Break]
The transmission method is not fax (GCX019-FAX-NUMBER is spaces) → Page break processing is bypassed and report continues without pagination
[Set Lines Per Page to 43]
The current page number is 1 (first page) → The lines per page limit is set to 43 lines
[Set Lines Per Page to 42]
The current page number is greater than 1 (subsequent pages) → The lines per page limit is set to 42 lines
[Line Count Exceeds Page Limit]
The current line count exceeds the lines per page limit → A page break is triggered to start a new page
[Reset Line Count to 1]
A new page is being started → The line count is reset to 1
[Increment Page Number]
A new page is being started → Both CARGO-PAGE and TRAIN-PAGE counters are incremented by 1
[Add Page Header to Report]
Train ID information is available (GCX019-CPRS-TRAIN-ID is not spaces) → The train header line is added to the report and line count is incremented
[Add Page Header to Report]
Train ID information is not available (GCX019-CPRS-TRAIN-ID is spaces) → The cargo header line is added to the report and line count is incremented
[Add Blank Line]
The header line has been processed → A blank line is added to the report and both line count and merlin line count are incremented
[Is Internet Transmission?]
The transmission method is internet (GCX019-INTERNET is not spaces) → Page break logic is skipped and processing continues without pagination checks
[Is Fax Transmission?]
The transmission method is not fax (GCX019-FAX-NUMBER is spaces) → Page break logic is skipped and processing continues without pagination checks
[Increment Page Numbers]
The line count has been reset to 1 → Both CARGO-PAGE and TRAIN-PAGE counters are incremented by 1
[Add Train Header Line to Report]
Train identification information (GCX019-CPRS-TRAIN-ID) is available and not spaces → A train header line is added to the report at the current line position and the line counter is incremented
[Add Cargo Header Line to Report]
Train identification information (GCX019-CPRS-TRAIN-ID) is not available or is spaces → A cargo header line is added to the report at the current line position and the line counter is incremented
[Add Blank Line After Header]
Either train or cargo header has been inserted → A blank line is added to the report and both line count and merlin line count are incremented by 1
[Internet Transmission?]
The transmission method is internet (GCX019-INTERNET is not spaces) → Page management logic is skipped and processing continues without pagination controls
[FAX Transmission?]
The transmission method is not FAX (GCX019-FAX-NUMBER is spaces) → Page management logic is skipped and processing continues without pagination controls
[Line Count Exceeds Page Limit?]
The current line count is greater than the established lines per page limit → A page break is required
[Increment Cargo Page Number]
Starting a new page → Both CARGO-PAGE and TRAIN-PAGE counters are incremented by 1
[Train ID Available?]
CPRS-TRAIN-ID is not spaces → A train header line should be used
[Train ID Available?]
The system checks if GCX019-CPRS-TRAIN-ID contains valid data (not spaces, not HIGH-VALUES, not LOW-VALUES) → The system routes to train-based subject line construction if train ID is available, otherwise routes to cargo-only subject line construction
[Build Subject with Train Details]
The system constructs the email subject line for train-based transmission → The system sets cargo print literal to 'CARGO PRT: ', includes equipment ID, train ID, and sequence number in the subject line format EMI-SUBJECT1
[Build Subject with Cargo Details Only]
The system constructs the email subject line for cargo-only transmission → The system sets cargo print literal to 'CARGO PRT: ', includes CCN and equipment ID in the subject line format EMI-SUBJECT2
[Finalize Subject Line for Transmission]
The system finalizes the subject line for email transmission → The system assigns EMI-SUBJECT1 to EMI-SUBJECT if train-based, or EMI-SUBJECT2 to EMI-SUBJECT if cargo-only
[Internet Address Format Check]
The internet address starts with 'FAX:' or 'fax:' in the first 4 characters → The system identifies this as a FAX transmission via internet format
[Set Method: FAX via Internet]
The system processes the transmission method setup → The system clears EMI-TEXT-LINE(1), extracts FAX number from positions 5-10 of internet address, sets action code to 'CFR', and assigns extracted FAX number to GCX105-MESSAGE
[Set Method: EMAIL via Internet]
The system processes the transmission method setup → The system sets action code to 'ZZZ' and formats message as 'INTERNET: ' concatenated with the internet address
[Set Method: Direct FAX]
The system processes the transmission method setup → The system sets action code to 'CFR' and assigns FAX-NUMBER to GCX105-MESSAGE
[Train ID Available?]
If train information availability → The system proceeds with MERLIN train print transmission setup
[Set Method: MERLIN with Train Print]
The system processes the MERLIN transmission method setup → The system sets action code to 'CTP' and assigns GCX019-MERLIN-ID to GCX105-MESSAGE
[Set Method: MERLIN with Cargo Print]
The system processes the MERLIN transmission method setup → The system sets action code to 'CPR' and assigns GCX019-MERLIN-ID to GCX105-MESSAGE
[MERLIN ID is Broker?]
If copy recipient requirements → The system assigns GCX019-MERLIN-ID to EMI-COPY-USERCODES(1) as a copy recipient
[Set Destination Code: EXTFAX]
The system sets up destination routing → The system assigns 'EXTFAX' to EMI-TO-USERCODES(1) for external FAX routing
[Set Destination Code: EXTMAIL]
The system sets up destination routing → The system assigns 'EXTMAIL' to EMI-TO-USERCODES(1) for external email routing
[Set Destination Code: Direct MERLIN]
The system sets up destination routing → The system assigns GCX019-MERLIN-ID to EMI-TO-USERCODES(1) for direct MERLIN routing
[Set Primary Recipient to EXTFAX]
The system processes communication routing for FAX transmission → The system sets 'EXTFAX' as the primary recipient in EMI-TO-USERCODES(1)
[Set MERLIN ID as Copy Recipient]
The MERLIN ID is available and not designated as 'BROKER' → The system assigns GCX019-MERLIN-ID to EMI-COPY-USERCODES(1) as copy recipient
[No Copy Recipient Set]
The MERLIN ID is either spaces or equals 'BROKER' → The system continues processing without assigning a copy recipient
[Set MERLIN ID as Message Recipient]
The system configures message routing for cargo processing notifications → The system assigns GCX019-MERLIN-ID to GCX105-MESSAGE as the message recipient
[Set EXTFAX Destination]
The system determines transmission method → Set destination to 'EXTFAX' for external FAX routing
[Set EXTMAIL Destination]
The system determines transmission method → Set destination to 'EXTMAIL' for external email routing
[Set EXTFAX with Copy to MERLIN]
The system determines transmission method → Set destination to 'EXTFAX' and if MERLIN-ID is not spaces or 'BROKER', add MERLIN-ID as copy recipient
[Set Direct MERLIN Destination]
The system determines transmission method → Set GCX019-MERLIN-ID as the direct recipient
[Set Admin MERLIN ID as Sender]
The system prepares sender information → Set GCSTBRT-AD-PUB-MERLIN-ID as the from-user code
[Call EMCSEND2 for Message Transmission]
The system executes message transmission → Call EMCSEND2 with sender, destination, recipients, subject, and message content parameters
[Purge Message Queue]
EMI-RETURN-STATUS-FLAG equals SUCCESSFUL → Call CIMS with PURG function to purge the alternate PCB message queue
[Export Origin Check]
The origin is 'EXPORT' → The audit message is set to 'EXPORT MANIFEST FILED'
[Build Log Message with MERLIN ID and File Name]
The origin is not 'EXPORT' and file name exists → The audit message is built using LOG-MESSAGE format with MERLIN ID and file name
[Write Audit Log Message to IMS Queue]
Submitting the audit record for processing → The GCX105 input is moved to GCT1051E message and submitted via CIMS with CHNG function to ALT-PCB2
[Send Message to Alternative PCB2]
Sending the message to the processing system → The message is sent using WRITMSGL to ALT-PCB2 with message code, content, length and module name
[Purge Message Queue]
Finalizing the audit transaction → The message queue is purged using CIMS with PURG function to ALT-PCB2

Structural Validations

[Reference Table Data Retrieval - Admin Table]
The admin table with table ID 'AD' and admin ID 'ADMINID' cannot be found → The system generates error message 'CAN NOT FIND ADMIN TABLE' and calls error handler
[Cargo Manifest Report Generation]
The cargo control segment cannot be found → The system generates error message with CCN and calls error handler
[Generate CCN Not Found Error]
The CC-STATUS-CODE indicates the record was not found → The system moves the CCN to ERROR-CCN, sets ERROR-MESSAGE to CC-ERROR-MESSAGE, and calls CERR for error handling
[Car Found Successfully?]
The system checks the database operation status → If status indicates 'GE' (end of segment), mark as no more cars available, otherwise proceed with car processing
[Seal Segment Found?]
The database access is completed → If the segment is found with valid data, seal numbers are extracted; otherwise, seal fields are initialized to spaces
[Business Number Qualifier is Spaces or Low-Values?]
If the business number qualifier field GCCC-BUSINESS-NBR-QUAL → If the qualifier is spaces or low-values, the qualifier line is skipped; otherwise, the qualifier line is formatted and included in the report
[Valid Entity ID Code Found?]
The system checks if the entity cargo data is spaces or low-values → Processing continues only if the entity cargo data contains valid information, otherwise the record is skipped
[Valid Entity ID Code?]
The system checks the entity identification code (GCCS-N101-ENTITY-ID-CDE) for validity → The entity record is processed only if the entity identification code is not spaces and meets valid N1 entity print criteria
[Log Error Message]
The transmission return status does not indicate success → The system logs the error status and calls error handler
[Internet Address Available?]
If transmission methods and GCX019-INTERNET field is not spaces, not HIGH-VALUES, and not LOW-VALUES → The system proceeds to check internet address format for transmission routing
[FAX Number Available?]
If alternative transmission methods and GCX019-FAX-NUMBER is not spaces → The system proceeds to configure FAX transmission method
[MERLIN ID Available?]
If MERLIN routing and GCX019-MERLIN-ID is not spaces and not equal to 'BROKER ' → The system proceeds to configure MERLIN copy user for additional routing
[Train ID Available?]
If additional transmission actions and GCX019-CPRS-TRAIN-ID is not spaces → The system proceeds to configure train-specific transmission actions
[Internet Address Present?]
If the internet address field in the input message → If internet address is not spaces, proceed with format analysis, otherwise skip internet processing
[Admin Table Found?]
Table segment retrieval return flag equals SUCCESSFUL → Admin table segment data is moved to working storage for use
[Report Table Access Error]
Table segment retrieval return flag is not SUCCESSFUL → Error message 'CAN NOT FIND ADMIN TABLE' is set and error handler is called
[Set Error Message]
Error message needs to be set → Error message is set to 'CAN NOT FIND ADMIN TABLE' to indicate admin data unavailability
[Call Error Handler]
Error handling is required → CERR error handler is called with system communication area to process the error
[Set Return Flag to ERROR]
The database call does not return the requested data → The return flag indicates an error condition for the calling process to handle
[Set Return Flag to ERROR]
The database call fails or returns no data → The return flag is set to error status and table segment data is cleared to spaces
[Set Return Flag to NOT FOUND]
The admin table cannot be found or retrieved → An error message 'CAN NOT FIND ADMIN TABLE' is set and error handler is called
[Cargo Status Deleted?]
The system checks the cargo deletion status indicator → The system should evaluate if the cargo status is marked as deleted to determine whether to skip or process this cargo record
[Entity ID Code Present?]
The system checks for entity identification code presence → If entity identification code is not spaces, proceed with array search, otherwise set entity to spaces
[Entity Name Present?]
The system checks for entity name presence → If entity name is not spaces, move it to output, otherwise continue with completion
[Address Line 1 Available?]
N301-ADDRESS-INFO-1 field is empty (spaces) → Skip address line 1 formatting and proceed to check address line 2 availability
[Address Line 2 Available?]
N302-ADDRESS-INFO-2 field is empty (spaces) → Skip address line 2 formatting and proceed to check city name availability
[City Name Available?]
N401-CITY-NAME field is empty (spaces) → Skip city formatting and proceed to check state, postal code, and country availability
[State/Province/Postal/Country Available?]
All of N402-STATE-PROV-CDE, N403-POSTAL-CDE, and N404-COUNTRY-CDE fields are empty (spaces) → Complete address formatting process without adding state/postal/country line to the report
[Internet Address Available?]
If transmission options and GCX019-INTERNET field is not spaces, not HIGH-VALUES, and not LOW-VALUES → The system proceeds to check internet address format for transmission method determination
[Fax Number Available?]
If GCX019-FAX-NUMBER field → If FAX number is not spaces, the system proceeds with direct FAX transmission setup
[MERLIN ID Available?]
If available transmission options → If MERLIN ID is available, the system proceeds to check for train ID to determine MERLIN transmission type
[Is FAX Number Available?]
The system checks for FAX number availability in GCX019-FAX-NUMBER field → The system identifies whether FAX transmission is possible based on non-empty FAX number
[Is MERLIN ID Available and Not 'BROKER'?]
If MERLIN ID in GCX019-MERLIN-ID for copy recipient assignment → The system confirms MERLIN ID is available (not spaces) and not equal to 'BROKER' for copy recipient eligibility
[Log Error Message]
EMI-RETURN-STATUS-FLAG does not equal SUCCESSFUL → Move EMI-RETURN-STATUS-FLAG to CERR-MSG1-CODE and set CERR-MSG1 as error message
[Call Error Handler]
The system needs to handle the transmission failure → Call 'CERR' service with CCCOM parameter to process the error

Module: GCX107 1 Consolidated Epic Story

Epic: GCX107 Complete EDI Specification Extracted from Legacy

Contains 1218 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX107 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Equipment Search]
The system begins equipment search initialization → Equipment search parameters are set up to retrieve FWSWREQ segment data
[Initialize U2 Segment Structure]
The system initializes the U2 segment structure → The segment identifier is set to 'U2' and sequence number is set to '0002'
[Initialize U3 Segment Structure]
The system initializes the U3 segment structure → The segment structure is prepared with empty fields ready for data population
[Initialize Equipment Search]
The system initializes equipment search → Equipment search parameters are set up and ready to retrieve FWSWREQ segment
[Initialize U1 Segment Structure]
The system begins U1 segment creation process → The U1 segment is initialized with segment ID 'U1', record type '01', and proper structure setup
[Initialize U2 Segment Structure]
The U2 segment creation process begins → The segment identifier is set to 'U2' and element separator is configured
[Initialize U3 Segment Structure]
The system begins U3 segment creation process → The U3 segment structure is initialized with default values
[Initialize Harmonized Code Counter]
The system begins processing harmonized codes from screen to database → The harmonized code counter is set to zero to begin counting codes for the current segment
[Initialize Harmonized Code Array Counter]
The harmonized code extraction process begins → The harmonized code array counter is initialized to zero to track the number of codes extracted
[Initialize Cargo Root Segment]
The system initializes the cargo root segment → The root segment is populated with CPRS default values including cargo type, status, and creation information
[Initialize M10 Segment Structure]
The M10 segment build process is initiated → The M10 segment structure is initialized with default values and proper segment keys
[Initialize Manifest Control Numbers]
Initializing manifest control numbers → The manifest control numbers are set with appropriate default values
[Initialize Entity Sequence Counter]
The system begins building N1N3N4PER segments → The entity sequence counter is set to 1 to start tracking entity records
[Initialize Quantity Fields to Zero]
The system initializes quantity fields → All quantity fields including piece count, weight, and measurement quantities are set to zero
[Initialize Weight Fields]
The system initializes weight fields → All weight fields including gross weight, net weight, and weight qualifiers are set to appropriate default values
[Initialize Commodity Quantities]
The system sets commodity quantities → All commodity quantity fields including piece count, weight, and measurement are initialized to zero
[Initialize Cargo Data Segments]
The system begins creating a new cargo record → All cargo data segments (M10, P4, M11, M13, N10, N1N3N4PER) are initialized with appropriate default values and segment keys are assigned
[Initialize Quantity Fields to Zero]
The system initializes quantity fields → All quantity fields are set to zero as default values
[Initialize Weight Fields]
The system initializes weight information → All weight fields are set to zero as default values
[Initialize Description Fields]
The system initializes commodity descriptions → Description fields are set to default empty values ready for user input
[Initialize Contact Information]
The system initializes contact information → Contact information fields are set to default empty values ready for user input
[Initialize Navigation Messages]
Navigation message initialization is performed → All scrolling navigation messages are cleared and prepared to display appropriate guidance messages for data navigation
[Initialize GCT1051E Message Structure]
The audit log generation process begins → The GCT1051E message structure is initialized with spaces and proper formatting
[Initialize GCT1131E Message Structure]
The system needs to create a bunch bill processing request → Initialize GCT1131E message structure with default values
[Initialize GCSA8RT Segment Structure]
The system prepares to access the workflow database → The GCSA8RT segment structure must be properly initialized to receive message data
[Initialize Message Deletion Process]
The system begins the message deletion workflow → The deletion process is properly initialized and ready to proceed
[Initialize Segment Counter to 0001]
The key generation process begins → The segment counter is initialized to 0001 to ensure proper sequential numbering
[Initialize U1 Segment Structure]
The system begins U1 segment creation process → The U1 segment structure is initialized with segment ID 'U1', record type '01', and all data fields are cleared to default values
[Initialize U3 Segment]
The system needs to create reference number records → The system should initialize a new U3 segment structure for storing reference data
[Initialize U3 Segment Structure]
The system initializes the U3 segment structure → The U3 segment structure is properly initialized with default values
[Initialize U3 Segment Structure]
The U3 segment structure needs to be initialized → The U3 segment structure is cleared and prepared for reference data
[Initialize Equipment Search]
The system begins equipment waybill key retrieval → Initialize search parameters and prepare to retrieve FWSWREQ segments

Core Acceptance Criteria

[11:Screen Formatting and Display]
The screen formatting process is executed → Fields are protected or unprotected based on processing mode, cursor highlighting is applied to appropriate fields, screen navigation messages are updated based on data availability and current position
[15:Manual Cargo Addition]
The manual addition process is executed → A new CPRS cargo record is created with complete cargo structure including M10, P4, M11, M13, N10, N1/N3/N4 segments, multi-car master/follower relationships are handled if applicable, lead manifest CCN is updated for multi-car operations, and addition activity is logged
[16:Cargo Deletion Processing]
The deletion process is executed → Multi-car deletion is handled by spawning GCT1131E for followers, deletion activity is logged, EDI transmission is sent, broker is notified of deletion, cargo is detached from train if attached, return to freight forwarder system is handled, and train manifest is updated if cargo was attached
[32:Database Operations]
The database operation is executed → Cargo root segment (GCSUSRT) is read or updated, all cargo segments (GCSUSS01-GCSUSS15) are processed as needed, multi-car processing is handled with proper SCAC code validation, temporary CCN handling is processed, and all segment data is loaded into or updated from working storage arrays
[33:EDI Transaction Spawning]
The EDI spawning process is executed → EDI 350 messages are spawned for bond additions/removals, electronic transmission notifications are handled, appropriate EDI processors (GCCS309E vs GCCS309) are called based on port validity and cargo type, and EDI transmission status is updated accordingly
[46:Audit Trail Creation]
The audit trail creation process is executed → Activity log entries are created via GCT1051E with action codes, messages, CCN keys, bond types, and timestamps, GCSUSS15 error tracking records are created with CCN key, record type, sequence, creation date, user identification, and car ID, and data origin tracking determines source system (Order Entry Manual/EDI, Fastway Manual/EDI)
[75:Screen Change Application Processing]
The change application process is executed → Screen change detection is performed using comparison logic, for CHANGE mode with changes: validation is performed, cargo is updated, and changes are logged, broker data is updated if filer code exists, EDI transmission is sent after successful update, finish processing and broker notification are handled, and shipment root verification is triggered for bond/broker changes
[221:EDI Transmission Control Based on Cargo Status]
The transmission control logic is executed → No transmission occurs for pending/error cargo, no transmission occurs for help, print, or initial display modes, no transmission occurs for cargo marked 'to create', for qualifying operations (DELETE, CHANGE, RESEND, VIEW, FINISH modes): amendment codes are set (defaults to '01' if empty), cargo acknowledgment status is processed, and EDI action codes are determined based on cargo type and status (DELETE, PRELIMINARY, UPDATE)
[227:SHIPMINU Waybill Processing Control Logic]
The SHIPMINU control logic is executed → SHIPMINU action is determined: CREATE when bond type is added to previously unbonded cargo or changed, DELETE when bond type is removed, UPDATE for modifications to existing records, NOACTION when no bond changes occur; permission validation requires valid waybill key and shipment root existence, entry number matching for FINISH/RESEND/CHANGE modes, and SHIPMINU records (U1, U2, U3 segments) are created, updated, or deleted accordingly
[96:User Function Permission Validation by User Type]
The permission validation is performed → If user is SUPER-USER, modification is allowed; if user is UPDATE-USER or Regular user, modification is denied and appropriate error message is displayed
[Clear Message Areas]
Message areas are being cleared → All message display areas are empty and ready for new messages
[Process Bond Type Changes]
System detects bond type modifications → System updates broker data if filer code exists, sends EDI transmission after successful update, handles finish processing and broker notification, and triggers shipment root verification for bond/broker changes
[Generate Bond Numbers]
System processes bond information → System auto-generates bond numbers when bond type specified and tracks bond type modifications for EDI notifications
[Trigger EDI Transmission]
System needs to send EDI notifications → System sends EDI transmission after successful update and handles finish processing notifications
[Create Audit Log Entry]
System completes finish processing steps → System creates activity log entries for cargo operations with action codes, messages, CCN keys, bond types, and timestamps
[Mark Cargo as DELETED]
All deletion steps are processed without errors → System marks cargo status as DELETED and sends EDI transmission
[Generate Print Message]
System generates print output → System spawns print jobs for cargo documents and generates print messages with proper formatting
[Return to Main Screen]
System finishes all processing steps → System returns user to main screen and displays appropriate status messages for completed operations
[FINISH: Complete Cargo Processing]
System processes finish request by updating broker filer codes, validating all cargo data, determining special manifest flags, and creating SHIPMINU records → System completes cargo processing, updates status to SENT, generates EDI transmission, and handles notifications
[Generate EDI Transmission]
System determines EDI transmission requirements based on cargo type, port validity, and processing mode → System calls appropriate EDI processor (GCCS309E for valid ports or GCCS309 for standard processing) and sends transmission
[RESEND: Retransmit Cargo Data]
System processes resend request → System executes finish processing logic with bypass controls and generates EDI transmission for cargo retransmission
[Process Cargo Deletion]
System processes cargo deletion → System handles multi-car deletion by spawning GCT1131E for followers, logs deletion activity, sends EDI transmission, notifies broker, detaches from train if attached, and updates train manifest
[Update Cargo Database]
System updates cargo database → System commits all cargo changes to database including root segment updates and related segment modifications
[Create Audit Trail]
System creates audit trail → System logs action details including action codes, messages, CCN keys, bond types, timestamps, and user identification via GCT1051E
[Send Event Notifications]
System sends event notifications → System sends broker notifications, EDI transmissions, and other required notifications based on action type and cargo changes
[DELETED Status]
A user attempts to perform any function on the deleted cargo → Access is denied and cargo status error message is set
[Follower Manifest]
A user attempts to perform a function on the follower manifest → Access is denied and multi-car restriction error message is set
[Block Export Operation]
The export validation check completes → The system sets an error message indicating cargo is already exported and prevents further export processing
[Control SHIPMINU Operations]
If bond type information → If bond type is present, SHIPMINU waybill segments are created or updated; otherwise SHIPMINU processing is skipped
[Create/Update SHIPMINU Waybill Segments]
The system processes SHIPMINU requirements → U1, U2, and U3 SHIPMINU segments are created or updated with bond information, broker data, and CCN references
[Generate EDI Transmission]
The system initiates EDI transmission process → EDI message is generated and transmitted to appropriate trading partners and customs authorities
[Create Audit Trail Record]
The system finalizes the FINISH process → An audit trail record is created documenting the FINISH operation, timestamp, user, and transaction details
[Check Bond Request Requirements]
Bond request validation is performed → The system calls Z9500-EDIT-REQUEST-TO-BOND to validate bond requirements and captures validation results
[Check Processing Mode]
The processing mode is evaluated for S02 validation requirements → S02 validation is performed only for modes that require segment validation
[Retrieve S02 Segment Data]
The system needs to validate S02 segment data → S02 segment data is retrieved from the cargo record
[Validate S02 Business Rules]
Business rule validation is applied to S02 segment → S02 data must comply with all applicable business rules
[Display More N1 Above Message]
The current panel start sequence (WS-N1-START-SEQ) is greater than 1 → The system displays 'More N1 above' message to indicate additional entity records exist above the current view
[Display More N1 Below Message]
The current panel end position is less than the total number of entity records (WS-N1-LAST-SEQ) → The system displays 'More N1 below' message to indicate additional entity records exist below the current view
[Display More N1 Above/Below Message]
The current panel start sequence is greater than 1 AND the current panel end position is less than the total number of entity records → The system displays 'More N1 above/below' message to indicate additional entity records exist in both directions
[Update VIN Panel Navigation]
The system updates panel navigation → The system sets appropriate navigation messages indicating available VIN data on other panels
[Validate S06 Cross-References]
The system validates cross-references between panels → Navigation messages are set correctly ('More VINs above/below') based on current panel position and total VIN count
[Update C4 Screen Arrays]
The system prepares data for screen display → The screen arrays are updated with the organized C4 data and appropriate navigation messages are set
[Set Immediate Export Flag]
Special manifest determination is processed → The system sets immediate export special manifest flag
[Set Immediate Transport Flag]
Special manifest determination is processed → The system sets immediate transport special manifest flag
[Create SHIPMINU U1 Segment]
The system builds the U1 segment with cargo information → U1 segment is created with bond type code, entry number, location identifiers, customs shipment value, in-bond control number, bond owner reference, transportation method, and vessel name
[Translate Bond Type Codes]
The system processes the bond type code for SHIPMINU format → The internal bond type code is converted using GCSUSS99-M1201 lookup table to the appropriate SHIPMINU bond type code format
[Create SHIPMINU U2 Segment]
The system checks for broker short name existence in the cargo record → If broker short name exists, U2 segment is created with broker information; if no broker exists, U2 segment creation is skipped
[Create SHIPMINU U3 Segment]
The system creates the U3 reference segment → U3 segment is created with 'REF CUB' qualifier and the cargo control number as reference data
[Insert/Update SHIPMINU Records]
The system attempts to insert or update SHIPMINU records in the database → Records are inserted for new entries or updated for existing entries, with duplicate key handling logic to manage record conflicts
[Delete SHIPMINU Records]
The system processes SHIPMINU record deletion → All associated SHIPMINU segments (U1, U2, U3) are deleted from the database using GHU/DLET sequence operations
[Retrieve FWSWREQ Segment]
The system attempts to retrieve FWSWREQ segment data → FWSWREQ segment is accessed to obtain equipment records for waybill matching
[Compare Equipment Car Number]
The system compares the target car number with equipment record car numbers → Equipment car numbers are evaluated for exact match to identify corresponding waybill
[Clear U1 Segment Fields]
The system begins U1 segment creation → All U1 segment fields are cleared to initial state
[Set Waybill Root Key]
The waybill root key needs to be established → The U1 segment waybill root key is set from the current cargo waybill root key
[Set Segment Type to U1]
The segment type needs to be defined → The segment type is set to 'U1' to identify it as a SHIPMINU U1 segment
[Set Sequence Number 0001]
The sequence number needs to be assigned → The sequence number is set to '0001' as the standard U1 segment sequence
[Populate Bond Type Code]
The bond type code needs to be set → The bond type code is copied from the cargo bond type field to the U1 segment
[Translate Internal Bond Code to EDI Code]
The U1 segment is being populated for EDI transmission → The internal bond type code is translated to the corresponding EDI bond type code using the lookup table
[Set Entry Number from RT29]
The entry number needs to be set → The entry number is copied from RT29 field to the U1 segment entry number field
[Set Location Identifier from RT32]
The location identifier needs to be set → The location identifier is copied from RT32 field to the U1 segment location identifier field
[Set Customs Shipment Value]
The customs shipment value needs to be set → The customs shipment value is copied from the cargo customs value field to the U1 segment
[Set Weight Unit Code]
The weight unit code needs to be set → The weight unit code is copied from the cargo weight unit field to the U1 segment
[Set Bond Control Number from RT42]
The bond control number needs to be set → The bond control number is copied from RT42 field to the U1 segment bond control number field
[Set Tax Reference Information]
Tax reference data needs to be processed → The system evaluates available tax numbers to determine the appropriate reference qualifier and number
[Set Reference Qualifier S4 for IRS]
The tax reference qualifier needs to be set in U1 segment → The reference qualifier is set to 'S4' to indicate IRS tax number type
[Set Reference Qualifier BI for Bond Owner]
The tax reference qualifier needs to be set in U1 segment → The reference qualifier is set to 'BI' to indicate bond owner tax number type
[Set Reference Number]
The reference number needs to be set → The corresponding tax number (IRS or bond owner) is copied to the U1 segment reference number field
[Set Creation Date and Time]
The creation timestamp needs to be recorded → The current system date and time are set as the creation date and time in the U1 segment
[Broker Short Name Available?]
The system checks if broker short name is available → If broker short name exists, move it to U2 segment, otherwise set default broker information
[Custom Broker Field Available?]
The system checks if custom broker field is available → If custom broker field exists, move it to U2 segment, otherwise leave the custom broker field empty
[Set U2 Segment Key Information]
The system sets the U2 segment key information → The segment key fields are populated with appropriate identifiers for database storage
[Set Segment Key with CCN]
The system sets the segment key → The CCN is assigned as the primary key for the U3 segment
[Set Record Type to 'U3']
The system sets the record type → The record type is set to 'U3' to identify it as a reference segment
[Set Sequence Number to '0003']
The system assigns the sequence number → The sequence number is set to '0003' to maintain proper segment ordering
[Set Reference Qualifier to 'REF']
The system sets the reference qualifier → The reference qualifier is set to 'REF' to indicate reference information
[Set Reference Code to 'CUB']
The system sets the reference code → The reference code is set to 'CUB' to identify it as a Customs reference
[Set Reference Number to CCN]
The system sets the reference number → The CCN is assigned as the reference number to maintain cargo linkage
[Set Reference Description]
The system sets the reference description → The reference description is populated to provide context for the CCN reference
[Database Operation Type?]
The system determines the operation type → The system selects either insert for new records or replace for existing records
[Insert New U3 Segment]
The system performs the database operation → A new U3 segment is inserted into the database
[Replace Existing U3 Segment]
The system performs the database operation → The existing U3 segment is replaced with the new data
[U3 Segment Created Successfully]
The system processes the successful result → The U3 segment creation is confirmed and processing continues normally
[Retrieve Internal Bond Type Code]
The system needs to translate the bond type for EDI transmission → The internal bond type code is retrieved from the cargo record's bond type field
[Use Original Bond Type Code]
The system needs to assign a bond type code for EDI processing → The original internal bond type code is used without modification
[Extract EDI Compatible Code]
The system processes the translation result → The EDI-compatible bond type code is extracted from the translation table entry
[Update SHIPMINU U1 Segment]
The system updates the SHIPMINU U1 segment → The bond type code is assigned to the appropriate field in the SHIPMINU U1 segment for EDI processing
[Update Database Records]
The system updates database records → All cargo segments and related records must be updated to reflect deletion status
[Restrict Multi-Car Operations]
If multi-car operation permissions → Multi-car operations are restricted and appropriate error messages are displayed
[Process ARRIVAL Operation]
The system processes the ARRIVAL operation → The system updates cargo status, generates event message, and creates audit trail
[Generate GCT1121E Event Message]
The system generates event message → The system creates GCT1121E event message for arrival notification
[Update Cargo Status]
The system updates cargo status → The system marks cargo as arrived with appropriate status indicators
[Generate Cancellation Event Message]
The system generates cancellation event message → The system creates cancellation event message for arrival reversal notification
[Is Date in Future?]
The arrival date is in the future compared to current system date → System displays error message 'Future Dates Not Allowed' and positions cursor on date field
[Is Date Before Cargo Creation?]
The arrival date is before the cargo creation date → System displays error message 'Date Cannot Be Before Cargo Creation' and positions cursor on date field
[Carrier Found?]
If valid carrier information was found → The system proceeds to set carrier information fields if found, otherwise sets error message for carrier not found
[Display _More C4 Above_ Message]
System updates the screen display → System displays 'More C4 Above' message to inform user of additional entries
[Display _More C4 Below_ Message]
System updates the screen display → System displays 'More C4 Below' message to inform user of additional entries
[Display Navigation Message - More HAZ Above]
Current hazmat start sequence is greater than 1 → System displays 'More HAZ above' message to indicate additional records are available for upward scrolling
[Display Navigation Message - More HAZ Below]
Current hazmat start sequence plus 4 is less than last hazmat sequence → System displays 'More HAZ below' message to indicate additional records are available for downward scrolling
[Display Navigation Message - More HAZ Above/Below]
Current hazmat start sequence is greater than 1 AND current hazmat start sequence plus 4 is less than last hazmat sequence → System displays 'More HAZ above/below' message to indicate additional records are available in both directions
[Build Hazmat Database Segments GCSUSS08]
System prepares hazmat data for database storage → System creates GCSUSS08 segments with proper segment keys, hazmat codes, descriptions, and contact information for each hazmat entry
[Map Screen Fields to Database]
System maps screen data to database segments → System maps H104 to hazmat description field, H101 to hazmat code field, and H105 to hazmat contact field in GCSUSS08 segments
[Display 'More #s above' Message]
System displays the current AES panel → System shows 'More #s above' message to indicate additional data is available
[Display 'More #s below' Message]
System displays the current AES panel → System shows 'More #s below' message to indicate additional data is available
[Display 'More #s above/below' Message]
System displays the current AES panel → System shows 'More #s above/below' message to indicate additional data is available in both directions
[PF07 - Scroll Up]
User presses PF07 to scroll up → System moves to previous panel and updates display messages to show current panel position
[PF08 - Scroll Down]
User presses PF08 to scroll down → System moves to next panel and updates display messages to show current panel position
[Validate Entity Code]
System processes entity validation → System validates entity segments using GCCUSEDB with S03 segment processing to ensure data integrity and compliance with business rules
[Update Entity Database Segments]
System processes entity data updates → System updates the appropriate database segments (S03 segments) with the validated entity information including entity codes, names, addresses, and contact information
[More VINs Above?]
The system updates panel navigation messages → Display 'More VINs Above' when on panels 2-4 with VINs in previous panels, 'More VINs Below' when on panels 1-3 with VINs in subsequent panels, or 'More VINs Above/Below' when VINs exist in both directions
[Update VIN Database Segments]
The system updates VIN information in the database → VIN segments (S06) are updated with VIN numbers, factory car orders, and reference number pairs, with automatic key generation for new VIN entries
[Processing Mode?]
The system determines the current processing mode → The system applies appropriate field attributes: VIEW mode makes all fields protected, CHANGE mode makes selected fields editable, ADD mode enables new entry fields, and DELETE mode shows confirmation fields
[Cargo Status?]
If the cargo status → The system applies appropriate editing restrictions: Active cargo allows full editing, Pending cargo allows limited editing, Deleted cargo is view-only, and Error status enables correction mode
[Apply Scrolling Messages Navigation Indicators]
The system applies scrolling messages → The system displays appropriate navigation indicators showing available scrolling directions and current data position
[Display C4 Line Release Scroll Messages]
The system displays C4 scroll messages → The system shows 'More C4 above' or 'More C4 below' messages based on current page position and available data
[Display Hazmat Data Scroll Messages]
The system displays hazmat scroll messages → The system shows 'More hazmat above' or 'More hazmat below' messages to indicate navigation options for hazmat records
[Display Entity Info Scroll Messages]
The system displays entity scroll messages → The system shows 'More N1 above' or 'More N1 below' messages based on current panel position within the 7 available entity panels
[Display VIN Data Scroll Messages]
The system displays VIN scroll messages → The system shows 'More VINs above' or 'More VINs below' messages based on current panel position within the 4 available VIN panels
[Display AES/SED Data Scroll Messages]
The system displays AES/SED scroll messages → The system shows 'More AES above' or 'More AES below' messages based on current panel position within the 5 available AES panels
[Display Formatted Screen Ready for User Input]
The system displays the formatted screen → The system presents a complete screen ready for user input with all appropriate attributes, messages, and navigation indicators in place
[Function Denied - User Type]
The system validates user permissions → Function is denied and user type error message is returned
[Function Denied - Cargo Status]
The system validates cargo eligibility → Function is denied and cargo status error message is returned
[Function Denied - Train Status]
The system validates train status → Function is denied and train status error message is returned
[Function Denied - Bond Status]
The system validates bond status → Function is denied and bond status error message is returned
[Function Denied - Multi-Car Restriction]
The system validates multi-car eligibility → Function is denied and multi-car restriction error message is returned
[Bond Type Processing]
The system processes the bond type → If bond type is added to previously unbonded cargo, auto-generate bond number using GCX111A and set bond change indicators for EDI notification
[Multi-Segment Validation]
The system performs comprehensive validation → Validate segments in sequence: root segment, S05, C4 codes, S07 commodity, S03 entity, S06 VIN, S02 segment
[Create SHIPMINU Waybill Entry]
A bond type is added to the cargo → The system creates new SHIPMINU waybill records (U1, U2, U3 segments) with bond and broker information
[Delete SHIPMINU Waybill Entry]
The bond type is removed or cleared from the cargo → The system deletes all associated SHIPMINU waybill records (U1, U2, U3 segments)
[Set Bond Type Change Flag]
A bond type change is being processed → The system sets a bond type change flag to trigger appropriate downstream processing including notifications, EDI transmissions, and SHIPMINU record updates
[Prepare Merlin System Notification]
The system processes the broker notification → The system prepares the notification message in Merlin system format with appropriate broker and cargo information
[Prepare Internet-Based Notification]
The system processes the broker notification → The system prepares the notification message in Internet format with appropriate broker and cargo information
[Prepare Fax Notification]
The system processes the broker notification → The system prepares the notification message in fax format with appropriate broker and cargo information
[Create GCT1081E Print Message]
The system needs to send the broker notification → The system creates a GCT1081E print message with the prepared notification content and delivery method
[Set Delete Notification Flag]
The notification is for a broker change or deletion → The system sets the delete notification flag to indicate the previous broker should be notified of the change
[Spawn Broker Notification Message]
The system is ready to send the notification → The system spawns the broker notification message for background processing and delivery to the broker
[Update Root Segment Total Quantity]
The system updates cargo totals → Update the root segment with the calculated total quantity value
[Retrieve C4 Data from Database Segments]
System needs to display C4 data on screen → C4 data is retrieved from cargo database segments
[Loop Through C4 Database Records]
Populating screen arrays with C4 data → System loops through each C4 database record sequentially
[Set Screen Navigation Messages]
Finalizing screen display preparation → System prepares to set appropriate navigation messages based on data availability
[More C4 Data Above Current Page?]
Determining navigation message requirements → System checks if C4 records exist with sequence numbers lower than current page start
[Set _More C4 Above_ Message]
Setting navigation messages for user guidance → System sets message indicating more C4 data is available above current page
[More C4 Data Below Current Page?]
Determining if additional navigation messages are needed → System checks if C4 records exist with sequence numbers higher than current page end
[Set _More C4 Below_ Message]
Setting navigation messages for user guidance → System sets message indicating more C4 data is available below current page
[Update Screen Array Counters]
Finalizing screen array preparation → Counters tracking displayed C4 records are updated to reflect current page content
[DELETE Operation]
The system processes the DELETE operation → The system directly proceeds to delete existing SHIPMINU segments without checking bunch bill or permissions
[Create U1 Segment - Main Data]
The system creates the U1 segment → The system populates U1 segment with bond type code, entry number, location identifiers, customs shipment value, in-bond control number, bond owner reference, transportation method, and vessel name
[Create U2 Segment - Broker Info]
The system creates the U2 segment and broker short name exists → The system populates U2 segment with broker information including broker short name and related broker data
[Create U3 Segment - CCN Reference]
The system creates the U3 segment → The system populates U3 segment with CCN reference using 'REF CUB' qualifier and the cargo control number
[Translate Bond Type Code for EDI]
The system translates the bond type code → The system converts bond type code using GCSUSS99-M1201 lookup table for EDI transmission compatibility
[Set Tax Number Reference Qualifier]
The system sets tax number reference qualifier → The system determines whether to use IRS number qualifier or bond owner qualifier based on the tax number type
[Insert/Replace SHIPMINU Segments]
The system performs database operations → The system inserts new SHIPMINU segments or replaces existing ones in the database and handles any duplicate key situations
[Delete Existing SHIPMINU Segments]
The system processes segment deletion → The system deletes U1, U2, and U3 SHIPMINU segments from the database
[Retrieve FWSWREQ Segment]
The system retrieves FWSWREQ segment → FWSWREQ segment data is available for equipment record processing
[Get Next Equipment Record]
The system gets the next equipment record → An equipment record is retrieved for comparison processing
[Set Bond Type Code]
Creating U1 segment for SHIPMINU → The bond type code from cargo data is copied to the U1 segment bond type field
[Translate Internal Bond Code to EDI Code]
The bond type code needs to be included in U1 segment → The internal bond type code is translated to corresponding EDI standard code using GCSUSS99-M1201 lookup table
[Set Entry Number Information]
Creating U1 segment for SHIPMINU → Entry number, entry type, and related identification fields are populated in the U1 segment from cargo data
[Set Bond Control Number]
Creating U1 segment for SHIPMINU → The in-bond control number is assigned to the U1 segment bond control field
[Set Location Identifiers]
Creating U1 segment for SHIPMINU → Port codes, district codes, and facility identifiers are populated in the U1 segment from cargo location data
[Calculate Customs Shipment Value]
Creating U1 segment for SHIPMINU → Customs shipment value is calculated using weight-based formula and populated in U1 segment
[Convert Kilograms to Pounds]
Calculating customs shipment value for U1 segment → Weight is converted from kilograms to pounds using conversion factor of 2.2 before applying value formula
[Use Pound Weight Directly]
Calculating customs shipment value for U1 segment → Weight value is used directly without conversion for applying value formula
[Apply Weight-Based Value Formula]
Determining customs shipment value for U1 segment → Customs value is calculated by multiplying weight in pounds by factor of 20
[Set Broker Tax Information]
Setting broker tax number in U1 segment → System evaluates carrier type to determine if CPRS internal tax number or external carrier tax number should be used
[Use CPRS Tax Number]
Setting broker tax information in U1 segment → CPRS internal tax number is assigned to the broker tax field in U1 segment
[Use External Carrier Tax Number]
Setting broker tax information in U1 segment → External carrier tax number is assigned to the broker tax field in U1 segment
[Set Reference Number Qualifier]
Setting reference information in U1 segment → Appropriate reference number qualifier is assigned based on cargo and business context
[Populate U1 Segment Fields]
Finalizing U1 segment creation → All required U1 segment fields are populated with processed bond type, entry numbers, location identifiers, customs values, and tax information
[Complete U1 Segment Creation]
Completing U1 segment creation process → U1 segment is finalized with all data properly formatted and validated for SHIPMINU record processing
[Broker Short Name Available?]
Broker short name is available in the cargo data → The broker short name is moved to U201 field, otherwise U201 field is left empty
[Custom Broker Field Available?]
Custom broker field data is available in the cargo record → The custom broker field is moved to U202 field, otherwise U202 field is left empty
[Complete U2 Segment Assembly]
All broker information fields are populated or left empty as appropriate → The U2 segment is assembled and added to the SHIPMINU record
[Set Segment Identifier to 'U3']
The segment identifier needs to be assigned → The segment identifier is set to 'U3'
[Set Reference Qualifier to 'REF']
The reference qualifier field needs to be populated → The reference qualifier is set to 'REF'
[Set Reference Code to 'CUB']
The reference code needs to be specified → The reference code is set to 'CUB' to indicate CCN reference
[Get CCN Key from Cargo Record]
The U3 segment needs the CCN reference number → The CCN key is extracted from the cargo record
[Assign CCN as Reference Number]
The U3 segment reference number field needs to be populated → The CCN key is assigned as the reference number
[Set U3 Segment Key]
The segment key needs to be assigned for database storage → A unique U3 segment key is generated and assigned
[Create U3 Database Record]
The U3 segment needs to be stored in the database → The system creates a new U3 database record with the CCN reference information
[U3 Segment Created Successfully]
The database insert operation completes successfully → The system confirms U3 segment creation success and continues processing
[Retrieve Internal Bond Type Code from Cargo Data]
The system needs to process bond type for EDI transmission → The internal bond type code is retrieved from the cargo data
[Access GCSUSS99 Translation Table]
The system needs to translate the bond type for EDI processing → The GCSUSS99 translation table is accessed to find the corresponding EDI bond code
[Lookup EDI-Compatible Bond Code]
The system searches for an EDI-compatible bond code using the internal bond type → The corresponding EDI bond code is retrieved from the translation table
[Translation Found?]
The system checks the lookup results → If a valid translation is found, use the EDI code, otherwise use the original bond type code
[Set EDI Bond Type Code]
The translation lookup is successful → The EDI bond type code is set to the translated value for use in EDI processing
[Use Original Bond Type Code]
The EDI bond code lookup fails to find a match → The original internal bond type code is retained for EDI processing
[Update SHIPMINU U1 Segment with EDI Code]
The system needs to update the SHIPMINU record for EDI processing → The SHIPMINU U1 segment is updated with the determined bond type code
[Update Root Segment with Totals]
Root segment update process is executed → The cargo root segment is updated with the calculated total values for quantities, weights, and customs values
[Move Harmonized Codes to Database Segments]
Database update is required → Harmonized codes are moved to their corresponding database segments for storage
[Update Multiple GCSUSS07 Database Segments]
Database update operation is performed → Multiple GCSUSS07 segments are updated with the harmonized code information
[Extract Harmonized Codes with 'J' Qualifiers from Database]
Harmonized code retrieval is performed → Only harmonized codes with qualifier 'J' are extracted from the database
[Process Up to 2 Codes Per Database Segment]
Multiple codes exist for a single segment → A maximum of 2 harmonized codes are processed per database segment
[Auto-Assign Qualifier 'J']
A harmonized code value is present in any of the 16 harmonized code fields (N10H5A through N10H5P) → The system automatically assigns qualifier 'J' to the harmonized code and stores it in the appropriate database segment
[Store in GCSUSS07 Database Segment]
Updating database segments with commodity information → The system stores the harmonized codes and qualifiers in the GCSUSS07 database segment
[Include Harmonized Codes with 'J' Qualifier]
Harmonized codes with 'J' qualifiers exist in the commodity data → The system includes the harmonized codes with their 'J' qualifiers in the SHIPMINU waybill segment
[Clear Database Segment Arrays]
New harmonized code processing begins → All database segment arrays are cleared to ensure clean data processing
[Move Code to Database Segment]
The system stores the code in the database segment → The harmonized code with its qualifier is moved to the current database segment position
[Increment Counter]
The system updates the processing counter → The harmonized code counter is incremented by one
[Create New Database Segment]
Additional harmonized codes need to be processed → A new database segment is created to accommodate the additional codes
[Reset Counter for New Segment]
The system prepares to process codes in the new segment → The harmonized code counter is reset to zero for the new segment
[Finalize Database Segments]
No more codes remain to be processed → The database segments are finalized and ready for storage
[Clear Existing GCSUSS07 Segments]
System begins update process for GCSUSS07 segments → System deletes all existing GCSUSS07 segments for the cargo record
[Generate New Segment Keys]
System generates segment keys → System assigns sequential segment keys starting from '0001' for each new GCSUSS07 segment
[Create Harmonized Code Segments]
System creates harmonized code segments → System creates GCSUSS07 segments with segment type 'S07', unique keys, and harmonized code data
[Create C4 Line Release Code Segments]
System creates C4 line release code segments → System creates GCSUSS07 segments with segment type 'S07', unique keys, C4 codes, and associated quantities
[Map Code and Quantity Pairs]
System maps code and quantity pairs → System ensures each C4 code is paired with its corresponding quantity value in the same database segment
[Update Database with New Segments]
System updates database with new segments → System commits all new GCSUSS07 segments to the database and confirms successful storage
[Set Success Status]
System sets completion status → System sets success indicator to confirm GCSUSS07 update process completed without errors
[Clear working storage harmonized code table]
The system prepares to process cargo segments → All existing harmonized code data in the working storage table must be cleared
[Start processing cargo segments S07]
The system begins harmonized code extraction → All S07 cargo segments must be processed sequentially
[Extract harmonized code from N10H5A field]
The system processes the harmonized code data → The harmonized code value must be extracted from the N10H5A field
[Does segment have second harmonized code?]
The system checks for additional harmonized codes in the same segment → The system must determine if a second harmonized code exists
[Extract harmonized code from N10H5B field]
The system processes the secondary harmonized code data → The harmonized code value must be extracted from the N10H5B field
[Move to next S07 segment]
The system continues the array building process → The system must move to the next available S07 segment for processing
[Complete harmonized code array building]
No more S07 segments remain to be processed → The harmonized code array building process must be marked as complete
[Read Next GCSUSS07 Segment from Database]
The system processes harmonized code extraction → Each GCSUSS07 segment is read sequentially from the database
[More Segments Available?]
A database read operation is completed → The system checks if more GCSUSS07 segments are available and continues processing if segments exist, otherwise completes the extraction process
[Complete Harmonized Code Array Building]
No more GCSUSS07 segments are available in the database → The harmonized code array building process is completed and the extracted codes are ready for use
[Set Navigation Messages More N1 Above/Below]
The current panel position is determined → The system sets navigation messages indicating 'More N1 above', 'More N1 below', or 'More N1 above/below' based on the panel position and total entity count
[Panel 1: Display More VINs Below Message]
System formats VIN screen display messages → System displays 'More VINs below' message to indicate additional VIN data on subsequent panels
[Panel 2/3: Display More VINs Above/Below Message]
System determines navigation message requirements → System displays 'More VINs above/below' or 'More VINs above' based on remaining VIN data
[Panel 4: Display More VINs Above Message]
System formats final panel navigation messages → System displays 'More VINs above' message to indicate previous VIN data exists
[Display: More VINs Below]
Total VIN count is greater than 9 → System displays 'More VINs below' navigation message
[Display: More VINs Above and Below]
Current panel is greater than 1 AND total VIN count exceeds the current panel's maximum display range → System displays 'More VINs above and below' navigation message
[Display: More VINs Above]
Current panel position is greater than 1 AND total VIN count does not exceed current panel's maximum display range → System displays 'More VINs above' navigation message
[No Navigation Message]
Total VIN count fits within current panel's display capacity without requiring additional panels → System displays no navigation message
[Build M10 Segment - Basic Manifest Data]
The system builds the M10 segment → The system sets M1009 to PRELIMINARY status, M1010 to CPRS, M1011 to US, and other required M10 fields with appropriate defaults
[Build P4 Segment - Date and Quantity Info]
The system builds the P4 segment → The system sets P401 to current date, P402 to 1 (quantity), and P403 to PLT (unit of measure)
[Build M11 Segment - BOL/Waybill Numbers]
The system builds the M11 segment → The system assigns the CCN as both M1103 (BOL number) and M1104 (waybill number)
[Build M13 Segment - Amendment and Location]
The system builds the M13 segment → The system sets M1306 to amendment code 01 and M1307 to the user's current location
[Build N10 Segment - Commodity Data]
The system builds the N10 segment → The system sets N1001 to 1 (quantity), N1002 to 01 (sequence), N1008 to 1 (weight), and N1011 to LB (weight unit)
[Build N1N3N4PER Segment - Entity Information]
The system builds the entity segments → The system creates N1 segments for shipper (SH) and consignee (CN) with sequence numbers 01 and 02 respectively
[Assign Unique Database Keys]
The system prepares for database insertion → The system assigns unique keys to all cargo segments including root, M10, P4, M11, M13, N10, and entity segments
[Insert New Cargo Record to Database]
The system attempts to insert the cargo into the database → The system successfully inserts all cargo segments and confirms the operation or returns an error if insertion fails
[Set Cargo Status to PENDING]
The system sets the initial cargo status → The system sets the cargo status to PENDING to indicate it is ready for editing but not yet transmitted
[Spawn EDI Delete Transaction]
The system processes EDI transaction → An EDI delete transaction is generated using GCCS309 with action code DELETE to notify customs and other external systems
[Process SHIPMINU Waybill Updates]
The system updates SHIPMINU records → Related SHIPMINU U1, U2, and U3 segments are deleted or updated to reflect the cargo deletion and maintain waybill consistency
[Retrieve Broker Information]
The system retrieves broker information from BK and B1 segments → The system updates cargo with current broker data if broker exists, otherwise displays broker error
[Create/Update SHIPMINU Records]
The system processes SHIPMINU requirements → The system creates U1 segment with bond data, U2 segment with broker data if present, and U3 segment with CCN reference
[Update Cargo Status to SENT]
The system updates cargo status → The system sets cargo status to SENT and updates both root segment and GCSUSS01 segment
[Port Valid for EDI?]
The system validates port for EDI transmission routing → The system routes to GCCS309E service for valid ports or standard GCCS309 for invalid ports
[Set EDI Action Code]
The system determines EDI action code based on cargo type, status, and previous transmission → The system sets PRELIMINARY for new/preliminary cargo, UPDATE for previously transmitted cargo, or DELETE for deletion operations
[Cargo Previously Transmitted?]
The system checks RT33-EDI-SENT-ELECTR flag and cargo status → The system identifies if cargo was previously transmitted electronically for action code determination
[Set Action as UPDATE]
The system assigns EDI action code → The system sets action code to UPDATE for modifications to previously transmitted cargo
[Set Action as PRELIMINARY]
The system assigns EDI action code → The system sets action code to PRELIMINARY for new transmissions or preliminary cargo
[Send EDI Transmission]
The system processes EDI transmission requirements → The system sends appropriate EDI transmission to notify external systems of the arrival or cancellation event
[Display Success Message]
The system completes all arrival processing steps → The system displays a success message confirming the arrival or cancellation has been processed
[Date/Time Valid?]
The system compares the provided export date/time against the current system date/time → The system rejects the export if the date/time is in the future and displays an appropriate error message
[Date/Time Valid?]
The system compares the export date/time against the cargo creation date/time → The system rejects the export if the export date/time is before the creation date/time and displays an error message
[Already Exported?]
The system checks the current export status of the cargo → The system rejects the export request if the cargo is already in exported status and displays appropriate error message
[Is Follower Manifest?]
The system checks if the cargo is a follower manifest in a multi-car operation → The system rejects the release request and displays an error message if the cargo is identified as a follower manifest
[Send EDI Transaction for Suspect]
The system processes EDI transmission requirements → The system sends appropriate EDI transactions to notify external systems of suspect status change
[Send EDI Transaction for Place]
The system processes EDI transmission requirements → The system sends appropriate EDI transactions to notify external systems of place status change
[Generate Event Notification Message]
The system generates event notification messages → Appropriate stakeholders are notified of the cargo diversion with relevant details
[Create Audit Trail Record]
The system creates an audit trail record → A complete audit record is created with diversion details, user information, and timestamp for compliance tracking
[Send EDI Transmission]
The system sends EDI transmission → EDI messages are transmitted to relevant external systems and trading partners to communicate the cargo diversion
[Display Success Message]
The system displays the success message → A confirmation message is displayed to the user indicating the diversion has been processed successfully
[Is BROKER Keyword?]
The system checks if the request contains the BROKER keyword → The system routes to broker data retrieval if BROKER keyword is present, otherwise proceeds with standard print message preparation
[Prepare Print Message Structure]
The system prepares the print message structure → The system creates the appropriate message format with cargo information, broker details (if applicable), and required print parameters
[Include Previous Broker Info]
The system processes broker change notifications → The system includes previous broker information in the print message when a broker change has occurred to ensure proper deletion notification
[Spawn GCT1081E Print Message]
The system spawns the GCT1081E print process → The system initiates the background print process with the prepared message structure and appropriate delivery method parameters
[Generate Audit Log Entry]
The system generates an audit log entry → The system creates a log record with print request details, user information, timestamp, and cargo control number for audit trail purposes
[Display Success Message]
The system displays the success message → The system shows a confirmation message indicating the print request has been submitted and provides any relevant reference information
[Generate PTT Request Message]
PTT validation is successful → The system generates a PTT request message containing cargo details and transfer destination
[Update Cargo Status]
The PTT message is created → The system updates the cargo status to indicate PTT request pending
[Display Success Message]
All notifications have been sent → The system displays a success message confirming PTT request submission
[Send Fax Notification]
A broker notification needs to be sent → The system sends the notification through fax transmission to the broker's registered fax number
[Spawn GCT1081E Print Message]
The system needs to generate physical notification documents → The system spawns the GCT1081E print processing module to generate and queue broker notification documents
[Set Broker Notification Flags]
The system completes broker notification processing → The system sets broker notification flags to indicate successful completion and track notification status
[Update Root Segment Totals]
The system completes commodity processing → The cargo root segment is updated with the summed totals
[Generate Database Keys for Segments]
The system moves data to database storage → Unique segment keys are automatically generated for each new commodity entry
[Update GCSUSS07 Segments]
The system performs database updates → GCSUSS07 segments are updated with the processed commodity information
[Process Multiple Harmonized Codes per Segment]
The system processes harmonized code assignments → Each commodity segment can have up to 2 harmonized codes assigned with appropriate qualifiers
[Store in GCSUSS07 Database Segments]
The system stores the harmonized code data → All harmonized codes and their qualifiers must be stored in GCSUSS07 database segments linked to their respective commodity lines
[Update Screen Display Arrays]
The system updates the user interface → Screen display arrays must be updated to show the current harmonized code data with proper formatting
[Set Navigation Messages]
System sets navigation messages for user guidance → System displays 'More desc above' when descriptions exist above current view AND displays 'More desc below' when descriptions exist below current view AND displays no navigation message when at boundaries
[Display Updated Screen]
System displays updated description screen → System shows formatted description content AND displays navigation indicators AND positions cursor appropriately AND updates screen status
[No Action - At Boundary]
System detects navigation request at data boundary → System prevents scrolling action AND maintains current screen position AND provides no error message for boundary condition
[Retrieve Cargo Data]
A GET operation is requested → The system retrieves the cargo root segment and associated data segments from the database
[Update Cargo Data]
An UPDATE operation is requested → The system updates the cargo segments in the database with the new values
[Insert New Cargo Data]
An INSERT operation is requested → The system creates new cargo root and data segments in the database
[Delete Cargo Data]
A DELETE operation is requested → The system removes the cargo root and all associated data segments from the database
[Determine Required Segments]
If the operation context and data requirements → The appropriate cargo segments (root, S01-S14) are identified for processing
[Multi-Segment Operation?]
If the segment requirements → The operation is classified as either multi-segment or single-segment processing
[Use GCCUSIO2 Service Multi-Segment Processing]
Database processing is initiated → The system invokes GCCUSIO2 service to handle multiple cargo segments simultaneously
[Use GCCUSIO Service Single Segment Processing]
Database processing is initiated → The system invokes GCCUSIO service to handle individual cargo segments
[Process Root Segment Only]
Database operation is executed → The system processes only the GCSUSRT root segment without accessing detail segments
[Process All Data Segments]
Database operation is executed → The system processes the root segment and all relevant data segments (S01-S14) based on cargo content
[Processing Context?]
If the current processing context → The context is classified as either screen-based or function-based segment selection
[Screen-Based Segment Selection]
Segment selection is performed → The system selects segments relevant to the current screen (SCRN1, SCRN2, SCRN3, SCRN4, AR-SCRN)
[Function-Based Segment Selection]
Segment selection is performed → The system selects segments relevant to the current function (ADD, DELETE, CHANGE, FINISH, etc.)
[Build Working Storage Arrays]
Working storage arrays need to be populated → The system builds arrays for C4 codes, VIN data, entity information, hazmat data, AES numbers, and harmonized codes
[Execute Database Operation]
The operation is executed → The system performs the database operation (GET, UPDATE, INSERT, DELETE) on the specified segments
[Multi-Segment Operation?]
The system checks if the operation involves multiple related cargo segments → The system routes to multi-segment processing if multiple segments are involved, otherwise routes to single segment processing
[Processing Mode?]
If the processing mode as Screen Context, Action Request, or Finish/Resend → The system selects screen-based segments for Screen Context, action-based segments for Action Request, or all segments for Finish/Resend operations
[Root Segment Operations]
The system needs to access primary cargo information → The system calls GCCUSIO with GU function to retrieve the cargo root segment using the cargo control number as key
[Detail Segment Operations]
The system identifies required segment types (S01, S02, S03, S05, S06, S07, S08, S14) → The system processes each segment type with appropriate database operations using GCCUSIO or GCCUSIO2
[Build Segment Arrays]
The system needs to organize segment data for processing → The system builds working storage arrays for each segment type including commodity data (S07), entity information (S03), VIN data (S05), hazmat data (S08), and description data (S14)
[Generate Unique Keys]
The system prepares segment data for database insertion → The system generates unique segment keys combining cargo control number, segment type, and sequence numbers
[Assign Sequence Numbers]
The system processes segment data → The system assigns sequential numbers starting from 0001 for each segment type to maintain proper ordering
[Execute Database Call]
The system calls GCCUSIO3 for CCN updates → The system updates all related segments with the new cargo control number while maintaining data relationships
[Screen-Based Processing]
The system needs to determine which cargo data segments to process for screen-based operations → The system selects the appropriate segments: Screen 1 requires root, manifest, and line release segments; Screen 2 requires root, commodity, and hazmat segments; Screen 3 requires root and entity segments; Screen 4 requires root, VIN, and commodity segments
[Action Request Processing]
The system processes the action request and determines required segments → The system selects segments based on action type: Add operations require all segments (root, manifest, entity, VIN, commodity, line release, hazmat); Delete operations require root and manifest segments; Transfer operations require root, manifest, and entity segments; Other actions require root and manifest segments
[Finish/Resend Operations]
The system processes the finish or resend request → The system selects all cargo segments (S01-S14) including root segment, manifest data, entity information, VIN data, commodity data, line release data, and hazmat data for comprehensive processing
[Set Root Segment GCSUSRT]
The system determines which segments to process → The system always includes the root segment (GCSUSRT) in the segment selection as it contains mandatory cargo identification and status information
[Screen 1 Segments]
The system determines required segments for Screen 1 processing → The system selects root segment for core data, S02 manifest data for equipment and waybill information, and S07 C4 line release data for line release processing
[Screen 2 Segments]
The system determines required segments for Screen 2 processing → The system selects root segment for core data, S06 commodity data for quantities and descriptions, and S08 hazmat data for hazardous material information
[Screen 3 Segments]
The system determines required segments for Screen 3 processing → The system selects root segment for core data and S03 entity information segments for shipper, consignee, and other business partner details
[Screen 4 Segments]
The system determines required segments for Screen 4 processing → The system selects root segment for core data, S05 VIN data for vehicle identification numbers, and S06 commodity data for related commodity information
[Add Operation Segments]
The system processes the add operation request → The system selects all available segments including root (GCSUSRT), manifest data (S02), entity information (S03), VIN data (S05), commodity data (S06), line release data (S07), and hazmat data (S08) for comprehensive cargo creation
[Delete Operation Segments]
The system processes the delete operation request → The system selects only essential segments including root segment (GCSUSRT) for core identification and S02 manifest data for basic cargo information required for deletion validation
[Transfer Operation Segments]
The system processes the transfer operation request → The system selects root segment (GCSUSRT) for core data, S02 manifest data for cargo details, and S03 entity information for shipper and consignee data required for transfer processing
[Screen-Based Processing]
The system applies screen field protection → Fields are protected or unprotected based on mode (CHANGE mode allows editing, VIEW mode protects all fields, ADD mode allows new data entry)
[Screen-Based Processing]
User presses PF7 (scroll up) or PF8 (scroll down) → System validates current page data, updates sequence positions, and displays next/previous page of data with appropriate navigation messages
[Process ADD Request]
The system processes the add request → For waybill-based adds, the system sets up background processing parameters and handles multi-car additions with master/follower relationships; for manual adds, the system creates new CPRS cargo records, builds complete cargo structure including M10, P4, M11, M13, N10, and N1/N3/N4 segments, handles multi-car master/follower relationships, updates lead manifest CCN for multi-car operations, and logs addition activities
[Process DELETE Request]
The system processes the delete request → The system handles multi-car deletion by spawning processes for followers, logs deletion activity, sends EDI transmission, notifies broker of deletion, detaches cargo from train if attached, handles return to freight forwarder system, and updates train manifest if cargo was attached
[Generate EDI Transaction]
The system generates EDI transactions → The system determines EDI action code (DELETE for delete mode, PRELIMINARY for preliminary cargo or T-VALUE without EDI transmission, UPDATE for T-VALUE with EDI transmission), calls appropriate EDI processor (GCCS309E for valid ports, GCCS309 for standard processing), and handles port-based routing for export/transit cargo
[Create Audit Record]
The system creates audit records → The system logs action codes, messages, CCN keys, bond types, timestamps, user identification, and creates activity log entries for cargo operations using the provided CCN key or defaulting to current cargo CCN
[Send Broker Notification]
The system processes broker notifications → The system skips notification for master cargo or code '66', processes only CPRS cargo, validates broker requirements (not UNKNOWN/NOT-REQ), retrieves broker table data (BK and B1 segments), and sends notifications via Merlin, Internet, or Fax based on broker preferences
[Display Success Message]
The system displays the success message → The system shows appropriate success message based on the action performed, confirms the operation completion, and provides relevant processing details to the user
[Return to Main Screen]
The system returns to the main screen → The system clears temporary processing data, resets screen attributes, maintains cargo data state, and displays the main cargo screen with updated information or error indicators
[Create Segment Keys S01-S14]
Cargo data segments need to be created or updated → Each segment receives a unique key in format CCN + segment type (01-14) + sequence number, where S01 uses '0001' as default sequence and other segments use incremental sequence numbers
[Multi-Car Manifest Check]
If the cargo type and manifest structure → If the cargo is part of a multi-car manifest, special follower sequence processing is triggered, otherwise standard segment key generation is applied
[Create Segment Keys S01-S14]
Entity segments are being created or updated → Each entity segment receives a unique key in format CCN + '03' + entity sequence number, with sequence numbers incrementing for each additional entity
[Set Sequence Numbering]
Sequence numbers are being assigned → Each segment receives an incremental sequence number starting from 0001, ensuring unique identification within the segment type
[Assign Unique Identifiers]
Final identifier assignment occurs → Each segment receives a unique identifier that combines all components to ensure system-wide uniqueness
[Generate Segment Keys S01-S14]
Cargo data segments need unique identifiers → The system generates segment keys for all segments S01 through S14
[Assign Sequential Numbers]
Segments need sequential numbering → The system assigns sequential numbers to each segment in proper order
[Complete Key Assignment]
Key assignment process is finalized → The system completes the key assignment process and the cargo record is ready for use
[Skip EDI - Help/Print/Initial Display Mode]
The processing mode is Help, Print, or Initial Display → EDI transaction generation is skipped and no electronic messages are sent
[Set EDI Action to DELETE]
The cargo processing mode is DELETE → The EDI action code is set to DELETE to notify trading partners of cargo removal
[Set EDI Action to PRELIMINARY]
The cargo has preliminary status:
is T-VALUE cargo without prior electronic transmission
is manually created cargo in FINISH/RESEND mode
→ The EDI action code is set to PRELIMINARY for initial electronic submission
[Set EDI Action to UPDATE]
The cargo is T-VALUE type AND has been electronically transmitted before → The EDI action code is set to UPDATE to modify existing electronic records
[Force PRELIMINARY Action for Returned Goods]
The vessel name starts with 'T' (indicating train cargo) AND the cargo is marked as returned goods → The EDI action is changed from UPDATE to PRELIMINARY for special processing requirements
[Auto-Assign Amendment Code '01']
No amendment code has been specified or the amendment code field is empty → The system automatically assigns amendment code '01' as the default value
[Call GCCS309E Service - Export/Transit Cargo]
The port is valid AND the cargo type is Export, US-Canada-US transit, or Multi-transit → The cargo is routed to GCCS309E service for specialized export/transit processing
[Update Cargo Acknowledgment Status]
The cargo is pending CPRS type in FINISH or VIEW mode with acknowledgment required → The cargo status is set to ACK for invalid ports or ACK-R for valid ports, and both root and GCSUSS01 segments are updated accordingly
[Skip EDI - HELP/PRINT/INITIAL Display]
The processing mode is HELP, PRINT, or INITIAL-DISPLAY → EDI transmission is skipped and control returns to the calling process
[Skip EDI - DELETED Status]
The cargo status is DELETED → EDI transmission is skipped and control returns to the calling process
[Port Validation Check]
Port validation is performed using port validity flags → If port is valid, use GCCS309E service; otherwise use standard GCCS309 service
[Set Action: DELETE]
The processing mode is DELETE → EDI action type is set to DELETE
[Set Action: PRELIMINARY]
The cargo status is PRELIMINARY or ERROR, or cargo is T-VALUE without electronic EDI transmission, or cargo is manually created without waybill → EDI action type is set to PRELIMINARY
[Set Action: UPDATE]
The cargo status is not DELETED, PRELIMINARY, or ERROR, and is T-VALUE with electronic EDI transmission → EDI action type is set to UPDATE
[Force PRELIMINARY Action]
The vessel name starts with 'T' (indicating train cargo) and cargo has returned goods status → EDI action type is changed from UPDATE to PRELIMINARY
[Translate Bond Type Codes for EDI]
SHIPMINU record creation requires EDI-compatible bond type → Bond type code is translated using GCSUSS99-M1201 lookup table for EDI transmission
[Create SHIPMINU U1 Segment]
U1 segment creation is initiated → U1 segment is created with translated bond type code, entry number, location identifiers, customs shipment value, in-bond control number, bond owner reference, transportation method, and vessel name
[Set Bond Type and Entry Numbers]
Bond type and entry number assignment is performed → Translated bond type code and cargo entry number are assigned to U1 segment
[Set Location Identifiers]
Location identifier assignment is performed → Cargo location identifiers are assigned to U1 segment
[Set Customs Values]
Customs value assignment is performed → Customs shipment value, in-bond control number, bond owner reference, transportation method, and vessel name are assigned to U1 segment
[Create SHIPMINU U2 Segment]
U2 segment creation is evaluated → U2 segment is created with broker information if broker short name exists
[Set Broker Information]
Broker information assignment is performed → Broker data is assigned to U2 segment
[Create SHIPMINU U3 Segment]
U3 segment creation is initiated → U3 segment is created with CCN reference using 'REF CUB' qualifier
[Set CCN Reference Information]
CCN reference assignment is performed → Cargo control number is assigned to U3 segment with 'REF CUB' qualifier
[Insert/Update SHIPMINU Records]
Database operation is performed → SHIPMINU records are inserted for new entries or updated for existing entries with duplicate handling
[Delete Existing SHIPMINU Records]
Database deletion is performed → Existing U1, U2, and U3 SHIPMINU segments are deleted from the database
[Update Screen Navigation Messages]
Screen navigation messages need to be updated for user orientation → The system displays appropriate 'More data above/below' messages based on the current panel position and total data available
[Set Renumbering Success Message]
All cargo records have been updated with the new CCN → The system sets a success message indicating the renumbering operation completed
[Build C4 Line Release Array]
Building C4 line release array for screen display → Extract C4 codes and quantities from each S07 segment and populate working storage arrays with proper sequence tracking
[Extract C4 Codes and Quantities]
Processing each S07 segment for C4 data → Move C4 code to working storage array and move corresponding quantity to working storage array
[Set C4 Sequence Counters]
Setting up sequence tracking for C4 data → Set last sequence counter to total number of C4 entries and initialize start sequence counter for screen display
[Build AES/SED Array]
Building AES/SED array for screen display → Extract AES qualifiers and numbers from each S07 segment and populate working storage arrays
[Extract AES/SED Qualifiers and Numbers]
Processing each S07 segment for AES data → Move AES qualifier to working storage array and move corresponding reference number to working storage array
[Set AES/SED Sequence Counters]
Setting up sequence tracking for AES/SED data → Set last sequence counter to total number of AES entries and initialize start sequence counter for screen pagination
[Build Hazmat Array]
Building hazmat array for screen display → Extract hazmat codes, descriptions, and contact details from each S08 segment and populate working storage arrays
[Extract Hazmat Codes and Descriptions]
Processing each S08 segment for hazmat data → Move hazmat code (H101) to working storage array and move hazmat description (H104) to working storage array
[Extract Contact Information]
Processing hazmat contact data from S08 segments → Move hazmat contact information (H105) to working storage array for emergency response purposes
[Set Hazmat Sequence Counters]
Setting up sequence tracking for hazmat data → Set last sequence counter to total number of hazmat entries and initialize start sequence counter for screen navigation
[Build Entity Information Array]
Building entity array for screen display → Extract entity details, addresses, and contact information from each S03 segment and populate working storage arrays
[Extract Entity Details]
Processing each S03 segment for entity data → Move entity code (N101), entity name (N102), and entity qualifier (SC301) to working storage arrays
[Extract Address Information]
Processing address data from S03 segments → Move address line (N301), city (N401), state (N402), postal code (N403), and country (N404) to working storage arrays
[Extract Contact Details]
Processing contact data from S03 segments → Move contact function (PER01), contact name (PER02), communication qualifier (PER03), and communication number (PER04) to working storage arrays
[Set Entity Sequence Counters]
Setting up sequence tracking for entity data → Set last sequence counter to total number of entity entries and initialize start sequence counter for panel navigation
[Build VIN Array]
Building VIN array for screen display → Extract VIN numbers and factory car orders from each S06 segment and populate working storage arrays
[Extract VIN Numbers]
Processing each S06 segment for VIN information → Move VIN number (VC01) and VIN type (VC10) to working storage arrays
[Extract Factory Car Orders]
Processing factory car order data from S06 segments → Move reference qualifier (N901) and reference number (N902) to working storage arrays for factory car orders
[Set VIN Sequence Counters]
Setting up sequence tracking for VIN data → Set last sequence counter to total number of VIN entries and initialize start sequence counter for panel navigation
[Build Harmonized Code Array]
Building harmonized code array for export processing → Extract harmonized codes with J qualifiers from each S07 segment and populate working storage arrays
[Handle Multiple Codes per Segment]
Processing segments with multiple harmonized codes → Extract first harmonized code to primary position and extract second harmonized code to secondary position in working storage arrays
[Set Harmonized Code Counters]
Setting up tracking for harmonized code data → Set counter to total number of harmonized codes extracted for customs classification processing
[Prepare Audit Log Entry]
The system prepares an audit log entry → The audit log entry is populated with action code, message text, CCN key information, security byte, transaction code, user identification, bond type information, and formatted date/time
[Spawn GCT1051E Audit Message]
The system needs to create the audit trail record → The system spawns GCT1051E background process with the prepared audit data
[Determine Data Origin Classification]
The system determines the data origin classification → The system sets origin as 'ORD ENT' for Order Entry Manual, 'ORD EDI' for Order Entry EDI, 'EDI' for Fastway EDI, Fastway Manual for matching user ID, or actual creation signon for other cases
[Spawn GCT1131E Message]
The system spawns GCT1131E message with bunch bill parameters → GCT1131E message is created for background bunch bill processing
[Set CCN Key for Bunch Bill]
The system sets CCN key for the bunch bill request → CCN key is assigned to link bunch bill with cargo record
[163: VIN Panel Navigation Message Display]
The system determines current panel position relative to total VIN data → Navigation messages are displayed showing 'More VINs above', 'More VINs below', or both based on panel position
[Processing Mode?]
If the processing mode → If the mode is DELETE, the system validates delete-specific business rules, otherwise it proceeds with standard EDI transmission preparation
[EDI Transmission Preparation]
The system prepares EDI transmission data → The amendment code is included in the EDI transmission payload
[Update Cargo Root Segment]
The status change processing is complete → The cargo root segment should be updated with the new status
[Generate Status Change Audit]
The status transition is complete → A status change audit record should be generated
[Cargo Status Check]
The system checks cargo status for processing eligibility → If cargo status is DELETED or ERROR, the system denies the operation and displays appropriate error message
[Cargo Status Check]
The system validates operation permissions → If user is not SUPER-USER, the system denies CHANGE/DELETE operations on released cargo and displays restriction message
[Train Attachment Check]
User attempts to return to train screen → The system denies the return operation and displays restriction message for USOR/IG train types
[Bond Status Check]
The system processes bond type changes → If bond type is added, removed, or changed, the system triggers broker notifications and EDI 350 message generation
[Set CHANGE Mode Attributes]
The system applies field protection rules → Editable fields are unprotected while maintaining protection on system-controlled fields like CCN and status indicators
[Prepare for EDI Transmission]
EDI transmission is required for the cargo changes → System prepares EDI transmission parameters including message type, recipient information, and cargo data for electronic notification
[Capture Current Screen Changes]
System processes current screen changes in CHANGE mode → System validates screen data, updates cargo information, logs changes, updates broker data if filer code exists, sends EDI transmission after successful update, handles finish processing and broker notification, and triggers shipment root verification for bond or broker changes
[Convert Screen Data to Database Format]
System moves screen data to database format based on current screen type → System converts Screen 1 equipment and cargo data, Screen 2 commodity and hazmat data, Screen 3 entity data, or Screen 4 VIN data to appropriate database segments with automatic key generation for new entries
[Update Database with Changes]
System updates cargo database with changes → System replaces cargo root segment and updates all related segments using appropriate database operations
[Display Synchronized Screen]
System displays the target screen → System presents the screen with current cargo data, proper field attributes, and appropriate navigation messages
[Screen 2 Data Sync]
System synchronizes Screen 2 data → System moves commodity data including quantities, weights, values, commodity codes, manages commodity descriptions with scrolling messages, moves 16 harmonic code fields, synchronizes hazmat data, and synchronizes AES numbers for export compliance with line release vs regular quantity display logic
[Screen 3 Data Sync]
System synchronizes Screen 3 data → System moves entity information including shipper and consignee data across multiple panels, manages panel navigation for 7 panels of entity data with scrolling messages, and synchronizes contact data including entity codes, names, addresses, and contact information
[C4 Line Release Codes]
System processes C4 line release data → System compresses C4 data by removing empty entries and reorganizing, updates screen navigation messages for C4 scrolling, validates for duplicate C4 codes within cargo, and validates each C4 code and quantity pair individually
[VIN Data Panels]
System manages VIN data panels → System compresses VIN data by removing empty entries and reorganizing, handles reference number processing for N901/N902 pairs, validates for presence of '2K' reference qualifier, manages VIN data across 4 panels with navigation, and updates navigation messages based on current panel and total VIN count
[PF07/PF08 - C4 Line Release Codes]
User presses PF07 to scroll up or PF08 to scroll down through C4 line release codes → System updates the C4 screen position, adjusts the starting sequence number for display, and shows appropriate navigation messages indicating more C4 codes above or below
[PF03/PF05 - Hazmat Data]
User presses PF03 to scroll to previous hazmat records or PF05 to scroll to next hazmat records → System updates the hazmat screen position, adjusts the hazmat starting sequence number, and displays appropriate navigation messages for hazmat data
[PF09/PF10 - AES/SED Numbers]
User presses PF09 to scroll up through AES numbers or PF10 to scroll down through AES numbers → System updates the AES panel position, adjusts the AES starting sequence number, and displays appropriate navigation messages for AES data
[PF07/PF08 - Entity Information]
User presses PF07 to scroll up through entity information or PF08 to scroll down through entity information → System updates the entity panel position, adjusts the entity starting sequence number, and displays appropriate navigation messages for entity data
[PF07/PF08 - VIN Data]
User presses PF07 to scroll up through VIN data or PF08 to scroll down through VIN data → System updates the VIN panel position, adjusts the VIN starting sequence number, and displays appropriate navigation messages for VIN data
[PF07/PF08 - Commodity Descriptions]
User presses PF07 to scroll up through descriptions or PF08 to scroll down through descriptions → System updates the description position, adjusts the description starting sequence number, and displays appropriate navigation messages for description data
[Apply Current Screen Changes]
User initiates navigation to another screen via PF01 or PF02 → System applies current screen changes and validates data before proceeding with navigation
[Process Cargo Deletion with Multi-Car Handling]
The system processes the cargo deletion → The system handles multi-car deletion by spawning GCT1131E for followers, logs deletion activity, sends EDI transmission, notifies broker of deletion, detaches cargo from train if attached, and updates train manifest if cargo was attached
[Generate EDI Transaction]
The system generates EDI transactions → The system sends appropriate EDI messages (350 for bond changes, acknowledgments for status updates) based on the action performed and cargo type
[Create Audit Record]
The system creates audit records → The system logs the action with action codes, messages, CCN keys, bond types, timestamps, and user identification for audit trail purposes
[VIEW Mode Processing]
Screen attributes are being set → All screen fields are protected with non-cursor protection attributes to prevent editing
[Set Navigation Messages]
System sets navigation messages → System displays function key instructions, field completion requirements, and next step guidance appropriate for the current mode
[Display Formatted Screen]
System displays the formatted screen → System presents the complete action request screen with all entry fields, descriptions, navigation messages, and appropriate visual attributes ready for user input
[Apply Screen Changes]
System processes navigation request (PF01 or PF02) → System validates and applies current screen changes before proceeding with navigation
[Clear Temporary Processing Fields]
Temporary field cleanup is required → All temporary variables, intermediate calculation fields, and working data areas are cleared to initial state
[Clear Message Areas]
Message area cleanup is required → All message buffers, display message fields, and notification areas are cleared to blank state
[Renumber CCN in Database]
The system needs to replace the temporary CCN throughout the database → The system updates all cargo segments and related records with the new permanent CCN
[Apply Screen Changes to Database]
The system applies screen changes to the database → The system updates all affected cargo segments with the modified screen data and validates the update was successful
[Trigger EDI Transmission]
The cargo update is complete and successful → The system triggers EDI transmission to notify external systems of the cargo changes
[Send Broker Notifications]
Broker notification is required for the cargo changes → The system sends appropriate notifications to the broker using their preferred communication method (Merlin, Internet, or Fax)
[RESEND Request Processing]
The system processes the RESEND request → The finish processing logic is executed followed by EDI transmission
[Trigger EDI Transmission]
EDI transmission is required → Customs and freight forwarder notifications are triggered via EDI transmission
[Create Audit Trail]
Audit trail creation is required → Complete audit trail is created documenting all finish processing activities
[Display Success Message]
The system completes the direct request processing → A success message is displayed to confirm successful completion
[Build M10 Manifest Segment]
The M10 manifest segment needs to be built → The system creates M10 segment with CPRS default values including manifest type, status, and basic identifiers
[Build P4 Date/Quantity Segment]
The P4 segment needs to be built → The system creates P4 segment with port information and quantity data
[Build M11 BOL/Waybill Segment]
The M11 segment needs to be built → The system creates M11 segment with bill of lading and waybill reference data
[Build M13 Amendment/Location Segment]
The M13 segment needs to be built → The system creates M13 segment with amendment codes and location identifiers
[Build N10 Commodity Segment]
The N10 commodity segment needs to be built → The system creates N10 segment with commodity description and classification data
[Build N1N3N4PER Entity Segment]
The entity segments need to be built → The system creates N1, N3, N4, and PER segments with shipper and consignee information
[Set Default Values for New Cargo]
Default values need to be applied → The system sets CPRS standard defaults for cargo type, status, and processing flags
[Determine Special Manifest Flags]
Special manifest requirements need to be evaluated → The system checks crossing table requirements and sets appropriate special manifest indicators
[Update Cargo Status to PENDING]
The cargo status needs to be initialized → The system sets the cargo status to PENDING to indicate it requires additional processing before transmission
[Save New Cargo to Database]
The cargo data needs to be persisted → The system saves all cargo segments to the database and confirms successful storage
[Display Success Message]
User confirmation is required → The system displays a success message with the new cargo control number
[Build M10 Manifest Data Segment]
The system builds the M10 manifest data segment → The M10 segment is created with SCAC code, transport type as TRUCK, vessel information, and manifest type set to CPRS defaults
[Build P4 Date and Quantity Segment]
The system builds the P4 date and quantity segment → The P4 segment is populated with current creation date, initial quantity set to 1, and weight data initialized
[Build M11 BOL/Waybill Segment]
The system builds the M11 BOL/Waybill segment → The M11 segment is created with BOL numbers, waybill information, weight details, and seal numbers initialized to default values
[Build M13 Amendment/Location Segment]
The system builds the M13 amendment/location segment → The M13 segment is populated with default amendment code '01', location codes, and port information
[Build N10 Commodity Segment]
The system builds the N10 commodity segment → The N10 segment is created with commodity codes, descriptions, and harmonized codes initialized for user input
[Build N1N3N4PER Entity Segment]
The system builds the N1N3N4PER entity segments → The entity segments are created with shipper information, consignee information, address details, and contact information initialized for user input
[Set Default Values for New Cargo]
The system sets default values for the new cargo → The cargo is configured with master-follower relationships, lead manifest CCN is updated for multi-car operations, and appropriate sequence numbers are assigned
[Assign Sequence Numbers]
The system assigns sequence numbers to segments → Each segment receives a unique sequence number starting from 0001, maintaining proper segment ordering and identification
[Create Database Keys for All Segments]
The system creates database keys for all segments → Each segment receives a unique database key combining CCN, segment type, and sequence number for database operations
[Insert Complete Cargo Record]
The system attempts to insert the complete cargo record → All segments are successfully inserted into the database or the entire transaction is rolled back if any segment fails
[Build M10 Segment - Basic Manifest Data]
The system builds the M10 segment → The system creates M10 segment with CPRS cargo type, manual creation flag, and default manifest values
[Set SCAC Code and Transport Type]
The system sets transportation details → The system assigns the user's SCAC code and sets transport method to truck
[Build P4 Segment - Date and Quantity]
The system builds the P4 segment → The system creates P4 segment with port codes and initializes quantity fields
[Set Creation Date and Time]
The system sets creation timestamp → The system records current date and time as the cargo creation date and time
[Build M11 Segment - BOL/Waybill Data]
The system builds the M11 segment → The system creates M11 segment with BOL structure and waybill data fields
[Set BOL Numbers and Weights]
The system sets BOL and weight data → The system assigns BOL numbers and initializes weight fields with default values
[Build M13 Segment - Amendment and Location]
The system builds the M13 segment → The system creates M13 segment with amendment tracking and location data structure
[Set Amendment Code and Location Data]
The system sets amendment and location data → The system assigns default amendment code and location identifiers for manual cargo
[Build N10 Segment - Commodity Data]
The system builds the N10 segment → The system creates N10 segment with commodity data structure and description fields
[Set Commodity Codes and Descriptions]
The system sets commodity information → The system assigns default commodity codes and initializes description fields
[Build N1N3N4PER Segment - Entity Information]
The system builds entity information segments → The system creates N1, N3, N4, and PER segments for entity data structure
[Generate Database Keys for All Segments]
The system generates database keys → The system creates unique keys for M10, P4, M11, M13, N10, and entity segments
[Assign Unique Sequence Numbers]
The system assigns sequence numbers → The system assigns sequential numbers to ensure proper data segment ordering and relationships
[Insert Complete Cargo Record]
The system inserts the cargo record → The system commits the complete cargo record to the database with all related segments
[Set SCAC Code from Root Segment]
Building the M10 segment → The SCAC code is copied from the root segment to the M10 segment
[Set Transport Type from Root]
Building the M10 segment → The transport type is copied from the root segment to the M10 segment
[Set Border Special Flag]
Determining special manifest flags → The border special manifest flag is set in the M10 segment
[Set Transit Special Flag]
Determining special manifest flags → The transit special manifest flag is set in the M10 segment
[Set Transport Export Special Flag]
Determining special manifest flags → The transport export special manifest flag is set in the M10 segment
[Set Standard Manifest Flag]
Determining special manifest flags → The standard manifest flag is set in the M10 segment
[Copy Vessel Name Information]
Building the M10 segment → The vessel name information is copied to the M10 segment
[Set Segment Keys and Identifiers]
Finalizing the M10 segment creation → The segment keys and identifiers are properly assigned to the M10 segment
[Create Shipper Entity Record]
The system builds entity segments → A shipper entity record is created with entity sequence number and segment key
[Create Consignee Entity Record]
The system continues building entity segments → A consignee entity record is created with incremented entity sequence number and segment key
[X3055-BUILD-M10: Build Basic Manifest Data]
The system builds the M10 manifest data segment → The manifest data is initialized with CPRS default values including manifest type 'M', record type '10', sequence '0001', and current system date
[X3060-BUILD-P4: Build Date and Quantity Data]
The system builds the P4 date and quantity segment → The segment is created with record type 'P4', sequence '0001', current system date, and all quantity fields initialized to zero
[X3065-BUILD-M11: Build BOL and Weight Data]
The system builds the M11 BOL and weight segment → The segment is created with record type 'M11', sequence '0001', and initialized BOL and weight fields
[Set BOL Type and Numbers]
The system sets BOL information → The BOL type and reference numbers are established with default values appropriate for CPRS cargo
[X3070-BUILD-M13: Build Amendment and Location Data]
The system builds the M13 amendment and location segment → The segment is created with record type 'M13', sequence '0001', and initialized amendment and location fields
[Set Amendment Code to '01']
The system sets the amendment code → The amendment code is set to '01' indicating this is the original manifest entry
[Set Origin and Destination Locations]
The system sets location information → The origin location, destination location, and related geographic codes are established with appropriate default values
[X3072-BUILD-N10: Build Commodity Data]
The system builds the N10 commodity segment → The segment is created with record type 'N10', sequence '0001', and initialized commodity fields
[Set Default Commodity Code]
The system assigns commodity codes → Default commodity classification codes are assigned based on cargo type and regulatory requirements
[Set Commodity Description]
The system sets commodity description → A default or appropriate commodity description is assigned based on commodity type and classification
[X3075-BUILD-N1N3N4PER: Build Entity Information]
The system builds entity information segments → N1, N3, N4, and PER segments are created with proper record types, sequences, and initialized entity fields
[Create Shipper Entity Record]
The system creates the shipper entity record → An N1 segment is created with entity qualifier 'SH' for shipper and appropriate sequence number
[Create Consignee Entity Record]
The system creates the consignee entity record → An N1 segment is created with entity qualifier 'CN' for consignee and appropriate sequence number
[Bunch Bill Required?]
The system checks bunch bill requirements → If bunch bill is required based on cargo characteristics, proceed to spawn bunch bill message
[Spawn Bunch Bill Message]
The system spawns bunch bill message → Call GCT1131E to create bunch bill message for the deleted cargo
[Update Database Records]
The system updates database records → Update cargo root segment and all related segments in the database
[Spawn Broker Notification Message]
The system sends broker notification → Spawn GCT1081E print message to notify broker of cargo deletion via their preferred method (Merlin, Internet, or FAX)
[Determine EDI Transmission Method]
The system determines EDI transmission requirements → System evaluates manifest type and port validity to select appropriate EDI service
[Port Valid for Manifest Type?]
If manifest type for EDI service selection → If manifest type is EXPORT OR US-CAN-US OR MULTI-TRANSIT with valid port, system uses GCCS309E EDI service OR for other manifest types, system uses standard GCCS309 EDI service
[Use GCCS309E EDI Service]
The system processes EDI transmission → System calls GCCS309E EDI service for enhanced export processing
[Use Standard GCCS309 EDI Service]
The system processes EDI transmission → System calls standard GCCS309 EDI service for regular processing
[Update Port Information in Cargo Record]
The system updates cargo record → System stores validated port name, location details, and port validity indicators in cargo record
[Validate User Permissions]
The system checks user permissions for suspect operations → The system allows access only if the user has SUPER-USER or UPDATE-USER privileges, otherwise denies access with appropriate error message
[Send EDI Notification for Place Status Change]
The place operation is completed → An EDI notification is sent to relevant parties informing them of the place status change
[Send EDI Notification for Place Cancellation]
The cancel place operation is completed → An EDI notification is sent to relevant parties informing them of the place cancellation
[Display Success Message]
All processing including database updates and notifications are finished → A success message is displayed to the user confirming the operation completion
[Set Default SCAC Code]
The system builds the basic manifest data → The default SCAC code 'CPRS' is assigned to the cargo record
[Set Transport Type and Vessel Info]
The system sets transportation details → The transport method code is set to '10' (truck) and vessel name is set to 'TRUCK'
[Set Current Date as Creation Date]
The system builds date and quantity information → The current system date is assigned as the cargo creation date
[Set Default BOL Type Code]
The system builds BOL and weight information → The BOL type code is set to 'M' (Master Bill of Lading)
[Set Default Amendment Code]
The system builds amendment and location information → The amendment code is set to '01' as the initial version
[Set Location Identifiers]
The system sets location information → Default location identifiers are assigned based on system configuration
[Set Default Commodity Code]
The system builds commodity data → A default commodity code is assigned to classify the cargo type
[Set Default Shipper Entity Type]
The system builds entity information → The shipper entity type is set to 'SH' (Shipper) as default
[Set Default Consignee Entity Type]
The system builds entity information → The consignee entity type is set to 'CN' (Consignee) as default
[Assign Unique Segment Keys]
The system assigns segment identifiers → Each segment receives a unique key that links it to the parent cargo record
[Link Segments to Root Record]
The system establishes segment relationships → All segments are linked to the root cargo record through proper key relationships
[Set Renumbering Success Message]
All related records have been updated with new CCN → The system displays a success message confirming the renumbering operation
[Retrieve Equipment Car Information]
The system prepares to build the bunch bill message → Equipment car information including car numbers and related details are retrieved from the cargo record
[Build GCT1131E Message]
The system builds the bunch bill message → A properly formatted GCT1131E message structure is created with the required message format and parameters
[Include CCN Key in Message]
The system populates the message with cargo identification data → The CCN key is included in the message to ensure proper cargo identification in the bunch bill process
[Include Equipment Details]
The system adds equipment information to the message → Equipment details including car information and related data are included in the bunch bill message
[Spawn Bunch Bill Creation Message]
The system initiates the bunch bill creation process → The GCT1131E message is spawned to trigger the bunch bill creation process in the background
[Translate Bond Type Code for EDI]
The system needs to prepare bond information for EDI transmission → The system converts bond type code using GCSUSS99-M1201 lookup table for EDI compatibility
[Create SHIPMINU U1 Segment - Bond Data]
The system creates SHIPMINU U1 segment → U1 segment is populated with bond type code, entry number, location identifiers, customs shipment value, in-bond control number, bond owner reference, transportation method, and vessel name
[Create SHIPMINU U2 Segment - Broker Info]
The system creates SHIPMINU U2 segment → U2 segment is populated with broker information from cargo record
[Create SHIPMINU U3 Segment - CCN Reference]
The system creates SHIPMINU U3 segment → U3 segment is populated with CCN reference using 'REF CUB' qualifier and cargo control number
[Insert New SHIPMINU Records]
The system performs database insertion → New SHIPMINU U1, U2, and U3 records are inserted into the database with duplicate handling
[Update Existing SHIPMINU Records]
The system performs database update → Existing SHIPMINU U1, U2, and U3 records are updated with new values
[Delete SHIPMINU Records]
The system performs database deletion → SHIPMINU U1, U2, and U3 segments are deleted using GHU/DLET sequence
[DELETED Status]
A user attempts to perform any function on the cargo → The system denies permission and displays cargo status error message
[Check Cargo Status]
The user attempts CHANGE or DELETE function → The system denies permission and displays released cargo restriction message
[Follower Manifest]
A user attempts to perform functions on the follower manifest → The system denies permission and displays multi-car restriction message
[Restrict Manual Release Operation]
The cargo is identified as a follower manifest in a multi-car scenario AND the follower manifest has a master CCN key → The system restricts the manual release operation and sets an error message indicating manual release is not permitted for follower manifests
[Manage VIN Data Across 4 Panels 9 VINs per panel]
VIN panel processing occurs → VIN data is properly distributed across panels and navigation messages are set appropriately
[Update Screen Formatting Messages]
The screen formatting messages need to be updated → The system updates the screen messages to show the current position and available navigation options such as 'More data above/below' or page indicators
[Return to Screen Display]
The error handling process is finished → The system returns control to the screen display to allow the user to view and correct the highlighted error fields
[Position on N1 Segment Fields]
The system processes the error field positioning → The cursor is positioned on the specific N1 segment field and highlighting is applied
[Update Screen Display Messages]
The system updates display messages → Screen messages are updated to show current panel information and available navigation options
[Display Navigation Message]
The system displays navigation message → The system should display appropriate navigation message indicating panel scrolling is needed to reach the error field
[Format VIN Navigation Messages]
The system prepares navigation messages for display → The system formats appropriate messages such as 'More VINs above', 'More VINs below', or 'More VINs above/below' based on current panel and total VIN count
[Prepare Panel Scrolling Message]
The system prepares navigation messages → Display 'More AES Above' message if error is on a previous panel or 'More AES Below' message if error is on a subsequent panel
[Display Navigation Message]
The system needs to guide the user to the correct panel → Display a navigation message indicating which panel contains the error field and how to navigate to it
[Set Panel Navigation Message]
The system determines the navigation context for the VIN panel → An appropriate navigation message is set to guide user interaction
[Update Cargo Records with New CCN]
System initiates cargo record update process → System calls renumbering service to update all cargo segments with new CCN
[Set Renumbering Success Message]
Renumbering process completes successfully → System sets success message and updates screen field protection settings
[Set Renumbering Success Message]
The CCN renumbering process completes without errors → The system sets a success message indicating that the CCN renumbering operation was completed successfully
[Set Renumbering Success Message]
The renumbering process completes successfully → A success message is set to confirm the CCN renumbering operation
[Check User Permissions]
The system checks user permissions using X5105-EDIT-FUNC-WITH-USER-TYP → The system allows the action if user has proper permissions or denies access and sets error flag if unauthorized
[Call X5306-EDIT-DELETE-RSN-CDE]
The system processes the delete request → The system calls the amendment code validation routine X5306-EDIT-DELETE-RSN-CDE to validate the deletion reason
[Call X5412-EDIT-M1306 for Amendment Code Validation]
The system validates the amendment code → The system calls X5412-EDIT-M1306 routine which performs AC table lookup to verify the code exists in the authorized amendment code reference table
[SCAC Code Provided?]
The system checks for SCAC code presence → If no SCAC code is provided, a SCAC error message is set; if provided, format validation proceeds
[State Code Provided?]
The system checks for state code presence → If no state code is provided, a state error message is set; if provided, format validation proceeds
[City Code Provided?]
The system checks for city code presence → If no city code is provided, a city error message is set; if provided, format validation proceeds
[Create/Update SHIPMINU Records]
SHIPMINU record management is executed → System creates U1, U2, and U3 SHIPMINU segments for new bonds, updates existing records for changes, or deletes records for removed bonds
[Parse Transfer Request Format AAAA/BB/CCCCCCCCCCCC]
The system parses the transfer request → The system extracts SCAC code from positions 1-4, state code from positions 6-7, and city code from positions 9-20
[Transfer Request Validation Failed]
Any validation step fails (format, SCAC, state, city, or tax number) → The system marks transfer request validation as failed and prevents transfer processing from proceeding
[Set Bond Change Flag]
Bond processing is completed → The system sets bond change flag to trigger downstream notifications and EDI processing
[Update C4 Database Segments]
System updates C4 database segments → System writes validated C4 code and quantity information to appropriate database segments maintaining referential integrity
[Set C4 Navigation Messages]
System sets C4 navigation messages → System displays 'More C4 Above', 'More C4 Below', or 'More C4 Above/Below' messages based on current page position and total C4 entries
[Detect Previous Broker Data]
The system needs to identify the previous broker → The system captures the original broker short name and filer code from the cargo root segment for notification purposes
[Prepare Delete Notification Message]
The system prepares the delete notification message → A properly formatted delete notification message is created with broker and cargo details
[Set Broker Notification Flag]
The system sets the broker notification flag → The notification flag is activated to track the notification process
[Spawn GCT1081E Print Message]
The system spawns the GCT1081E print process → The print process is initiated to send the delete notification to the previous broker
[Set High Security Byte]
The system sets the high security byte → The security byte is configured to ensure secure transmission of the delete notification
[Display _More C4 Above_ Message]
System updates screen display → System shows 'More C4 Above' message to inform user of additional data
[Display _More C4 Below_ Message]
System updates screen display → System shows 'More C4 Below' message to inform user of additional data
[Prepare Merlin System Notification]
The system prepares the notification message for Merlin transmission → The system formats the broker delete notification with appropriate Merlin system parameters and message structure
[Prepare Internet-based Notification]
The system prepares the notification message for Internet delivery → The system formats the broker delete notification with appropriate Internet delivery parameters and message structure
[Prepare Fax Notification]
The system prepares the notification message for Fax transmission → The system formats the broker delete notification with appropriate Fax delivery parameters and message structure
[Send Delete Notification to Previous Broker]
The system initiates the notification transmission → The system sends the delete notification to the previous broker informing them of the broker change
[Processing Mode is EDI Transmission?]
No amendment code is provided in the request → The system should automatically assign amendment code '01' as the default value
[Position Cursor on M1306 Field]
The system needs to notify the user of the validation error → The system should position the cursor on the M1306 amendment code field and display the appropriate error message
[Set Panel Messages - More VINs Above/Below]
System displays VIN panel navigation information → System shows 'More VINs above' if not on first panel, 'More VINs below' if not on last panel, or 'More VINs above and below' if on middle panel
[Build VIN Database Segments - GCSUSS05]
System needs to create database segments for VIN storage → System creates GCSUSS05 segments with sequential keys, VIN numbers, VIN types, and reference data
[Update Root Segment Totals]
The system completes commodity data summation processing → The cargo root segment must be updated with the calculated total quantity, total weight, and total customs value
[Update Harmonized Code Database Segments]
The processing is complete → The system updates the appropriate database segments with the harmonized code information
[Display Navigation Messages]
The system updates navigation messaging → Navigation messages such as 'More desc above', 'More desc below', or 'More desc above/below' are displayed based on available description data
[Set Screen Attributes for Description Fields]
The system finalizes screen display attributes → Screen attributes are set for description fields including field protection, highlighting, and cursor positioning based on current mode and data availability
[Set Panel Navigation Messages]
The current panel position is determined and there are hazmat entries above or below the current view → Navigation messages 'More HAZ above' and/or 'More HAZ below' are displayed to indicate additional data availability
[Display _More N1 Above/Below_ Message]
System determines entity availability above and below current panel → System displays 'More N1 Above' if entities exist above, 'More N1 Below' if entities exist below, or 'More N1 Above/Below' if entities exist in both directions
[Update VIN Panel Data]
VIN panel data is updated for display → Navigation messages are set based on panel position - 'More VINs below' for panel 1 with additional data, 'More VINs above/below' for middle panels, 'More VINs above' for final panel
[Update Equipment Tracking]
VIN data movement to storage occurs → VIN numbers (VC01), VIN types (VC10), and reference numbers (N901/N902) are moved to S06 segments with automatically generated segment keys
[Build Database Segments]
Database update processing is required → GCSUSS08 segments are built with proper segment keys and hazmat data (H104, H101, H105) for database storage
[Set 'More HAZ Above' Message]
There are hazmat entries with sequence numbers lower than the current starting sequence → The 'More HAZ above' message is displayed to indicate additional hazmat data is available by scrolling up
[Set 'More HAZ Below' Message]
There are hazmat entries with sequence numbers higher than what can be displayed on current panel → The 'More HAZ below' message is displayed to indicate additional hazmat data is available by scrolling down
[Clear Navigation Messages]
There are no additional hazmat entries above or below the current display → All hazmat navigation messages ('More HAZ above' and 'More HAZ below') are cleared from the screen
[Set Panel Navigation Messages]
The system displays entity information on a panel → The system shows 'More N1 Above' message if there are entities in previous panels, 'More N1 Below' message if there are entities in subsequent panels, 'More N1 Above/Below' message if there are entities in both directions, or no navigation message if all entities fit on current panel
[Refresh Panel Display]
The system needs to show the new panel content → The system reloads entity data for the new panel position and updates all display fields and navigation messages accordingly
[Panel 1 Sequences 1-9?]
If the current VIN start sequence position → If VIN start sequence is between 1 and 9, set Panel 1 navigation message, otherwise check Panel 2
[Panel 2 Sequences 10-18?]
If VIN start sequence is between 10 and 18 → If VIN start sequence is between 10 and 18, set Panel 2 navigation message, otherwise check Panel 3
[Panel 3 Sequences 19-27?]
If VIN start sequence is between 19 and 27 → If VIN start sequence is between 19 and 27, set Panel 3 navigation message, otherwise check Panel 4
[Panel 4 Sequences 28-36?]
If VIN start sequence is between 28 and 36 → If VIN start sequence is between 28 and 36, set Panel 4 navigation message
[More VINs Below Current Panel?]
The system checks if there are more VIN entries beyond the current panel's display range → If more VINs exist below current panel, display 'More VINs Below' message, otherwise check for VINs above
[More VINs Above Current Panel?]
The system checks if there are VIN entries before the current panel's display range → If more VINs exist above current panel, display 'More VINs Above' message, otherwise proceed with screen update
[Update VIN Screen Display]
The system updates the screen display → Update VIN screen fields with compressed VIN data and display appropriate navigation messages based on panel position
[Panel 1 - VINs 1-9]
More than 9 VINs exist in the cargo record → Display 'More VINs below' navigation message
[Panel 1 - VINs 1-9]
9 or fewer VINs exist in the cargo record → Clear the navigation message display
[Panel 2 - VINs 10-18, Panel 3 - VINs 19-27]
VINs exist both above and below the current panel → Display 'More VINs above and below' navigation message
[Panel 2 - VINs 10-18, Panel 3 - VINs 19-27]
VINs exist above the current panel but no VINs exist below the current panel → Display 'More VINs above' navigation message
[Panel 2 - VINs 10-18, Panel 3 - VINs 19-27]
No VINs exist above the current panel but VINs exist below the current panel → Display 'More VINs below' navigation message
[Panel 4 - VINs 28-36]
VINs exist above the current panel → Display 'More VINs above' navigation message
[Panel 4 - VINs 28-36]
No VINs exist above the current panel → Clear the navigation message display
[Description Source Type?]
The system processes description data → The system identifies whether the source is long descriptions, free-form descriptions, or additional description segments
[Process Additional Description Segments]
The system processes the additional description segments → The system extracts and formats additional description segment content for integration
[Set Navigation Messages]
The system sets navigation messages → The system displays appropriate navigation messages such as 'More desc above' or 'More desc below' to indicate scrolling availability
[Update Screen Description Fields]
The system updates screen description fields → The system populates screen description fields with properly formatted content and navigation indicators
[Extract AES/SED Qualifier and Number Data]
Building working storage arrays for screen display → Extract SED qualifier (SEDQ) and SED number (SEDN) pairs into working storage arrays maintaining proper sequence and indexing
[Extract C4 Line Release Codes and Quantities]
Processing line release data for array building → Extract C4 codes and quantities into working storage arrays with proper sequence tracking for screen pagination
[Extract Hazmat Code, Description, and Contact Fields]
Building hazmat working storage arrays → Extract hazmat code, description, and contact information into corresponding working storage arrays maintaining field relationships
[Extract Entity Fields - N101, N102, N301, Address Data]
Building entity working storage arrays → Extract entity identification codes, entity names, and complete address information into working storage arrays maintaining entity relationships
[Extract Contact Information - PER02, PER03, PER04]
Processing entity contact information → Extract contact person name, communication type, and communication number into working storage arrays with proper field mapping
[Handle Multiple Codes Per Segment - Up to 2 Codes]
Processing harmonized code data from commodity segments → Extract and store up to 2 harmonized codes per segment maintaining proper code-to-segment relationships and qualifier associations
[Build Working Storage Harmonized Code Table]
Organizing codes for screen display and processing → Build working storage harmonized code table (WS-HS-ARRAY) with proper indexing and sequence tracking for screen navigation
[Extract Vehicle Identification Numbers]
Building VIN working storage arrays → Extract VIN numbers and VIN types into working storage arrays maintaining proper VIN-to-cargo relationships
[Extract Factory Car Order Numbers]
Processing VIN-related reference information → Extract factory car order numbers and reference qualifiers into working storage arrays maintaining VIN-to-order relationships
[Processing Mode?]
If the processing mode (FINISH, RESEND, or standard operations) → The appropriate set of cargo data segments is selected for database update operations
[FINISH Operation Segments]
The system determines segments for database update → All cargo segments (S01 through S14) are selected for update to complete the cargo finalization process
[RESEND Operation Segments]
The system determines segments for database update → All cargo segments (S01 through S14) are selected for update to support complete data retransmission
[Screen Context Analysis]
The system determines segments for database update → Only the cargo segments associated with the current screen's data are selected for update
[Screen 1 Segments]
The system determines segments for database update → Basic cargo data segments (root segment, equipment data, waybill information, broker data, bond data, and C4 line release data) are selected for update
[Screen 2 Segments]
The system determines segments for database update → Commodity data segments (S07 for commodity descriptions, S08 for hazmat data, and AES number segments) are selected for update
[Screen 3 Segments]
The system determines segments for database update → Entity information segments (S03 segments containing shipper, consignee, and other party data) are selected for update
[Screen 4 Segments]
The system determines segments for database update → VIN and equipment segments (S06 segments containing vehicle identification numbers and reference data) are selected for update
[Action Request Segments]
The system determines segments for database update → Only the cargo segments relevant to the specific action being requested are selected for update
[Database Operation Request]
If the operation requirements → The system classifies the operation as either multi-segment update, single segment root operation, or complete cargo retrieve
[Operation Type?]
The operation involves updating multiple related cargo segments simultaneously → The system routes to multi-segment processing path
[X7105-SET-GCWUSIO2-SEG-NAMES Determine Required Segments]
The system needs to identify required cargo segments → The system sets the appropriate segment names for GCWUSIO2 processing based on current screen, processing mode, or special operation requirements
[Processing Context?]
If the processing context → The system classifies the context as screen-based, processing mode-based, or special operation-based
[Screen-Based Segment Selection]
The system needs to determine required segments → The system routes to screen-specific segment selection logic
[Processing Mode Selection]
The system needs to determine required segments → The system routes to processing mode-specific segment selection logic
[Special Operation Selection]
The system needs to determine required segments → The system routes to special operation segment selection logic
[Screen 1 Segments GCSUSRT, GCSUSS01, GCSUSS07]
The system determines required segments for processing → The system includes GCSUSRT (root), GCSUSS01 (basic cargo data), and GCSUSS07 (commodity data) segments
[Screen 2 Segments GCSUSRT, GCSUSS02, GCSUSS07, GCSUSS08]
The system determines required segments for processing → The system includes GCSUSRT (root), GCSUSS02 (additional cargo data), GCSUSS07 (commodity data), and GCSUSS08 (hazmat data) segments
[Screen 3 Segments GCSUSRT, GCSUSS03]
The system determines required segments for processing → The system includes GCSUSRT (root) and GCSUSS03 (entity data) segments
[Screen 4 Segments GCSUSRT, GCSUSS05]
The system determines required segments for processing → The system includes GCSUSRT (root) and GCSUSS05 (VIN data) segments
[FINISH/RESEND Mode All Required Segments]
The system determines required segments for processing → The system includes all cargo segments required for complete cargo validation and processing
[Action Request Mode Context-Specific Segments]
The system determines required segments for processing → The system includes segments specific to the requested action context
[Standard Change Mode Screen-Specific Segments]
The system determines required segments for processing → The system includes segments specific to the current screen being modified
[X7100-UPDT-USCARGO Multi-Segment Update]
The system executes the multi-segment update operation → The system processes all identified segments through GCCUSIO2 service for coordinated update
[X7110-UPDT-USCARGO-ROOT Root Segment Update]
The system executes the root segment update operation → The system processes the GCSUSRT segment through GCCUSIO service for single segment update
[X7120-DLET-USCARGO-ROOT Root Segment Delete]
The system executes the root segment delete operation → The system processes the GCSUSRT segment through GCCUSIO service for deletion
[X7122-ISRT-USCARGO-ROOT Root Segment Insert]
The system executes the root segment insert operation → The system processes the GCSUSRT segment through GCCUSIO service for insertion
[X7125-GU-USCARGO-ROOT-GCCUSIO Root Segment Retrieve]
The system executes the root segment retrieve operation → The system retrieves the GCSUSRT segment through GCCUSIO service
[X7126-REPL-USCARGO-ROOT Root Segment Replace]
The system executes the root segment replace operation → The system processes the GCSUSRT segment through GCCUSIO service for replacement
[X7000-GU-USCARGO Complete Cargo Retrieve]
The system executes the complete cargo retrieve operation → The system retrieves all cargo segments and builds working storage arrays for comprehensive cargo processing
[GCCUSIO2 Service Call Multi-Segment Processing]
The system calls GCCUSIO2 service → The system processes all identified segments in a coordinated transaction
[GCCUSIO Service Call Single Segment Processing]
The system calls GCCUSIO service → The system processes the individual segment through the appropriate database operation
[Prepare GCT1051E Message]
The system prepares the audit message → GCT1051E message structure is initialized with default values and operational context
[Set CCN Key Information]
CCN key information is available from current processing context → The provided CCN key is assigned to audit message, or current cargo CCN is used as default
[Set Security Byte]
Security byte needs to be assigned → Security byte is set to appropriate classification level for the cargo operation
[Set Transaction Code]
Transaction code needs to be assigned → Appropriate transaction code is set based on the current cargo operation type
[Set ACF2 User ID]
User identification is required for audit trail → ACF2 user ID is captured and assigned to audit message for accountability
[Bond Type Available?]
Bond type information is available in cargo data → Bond type is included in audit log, otherwise audit continues without bond information
[Include Bond Type in Audit]
Audit message is being prepared → Bond type data is captured and included in the audit log entry
[Set System Date and Time]
Timestamp information is required → Current system date and time are captured and assigned to audit log entry
[Set Action Code]
Action code needs to be classified → Appropriate action code is assigned based on the specific cargo operation being performed
[Set Audit Message Text]
Descriptive message text is required → Appropriate message text is assigned describing the cargo operation and its context
[Spawn GCT1051E Message]
Message transmission is initiated → GCT1051E audit message is spawned to audit logging system
[Create GCSUSS15 Audit Record]
Detailed audit record creation is required → GCSUSS15 audit record creation process is initiated
[Classify Data Origin]
Data origin needs to be classified → Data origin is classified as Order Entry Manual, Order Entry EDI, Fastway Manual, Fastway EDI, or actual creation signon based on user and system context
[Set Descriptive Message Text]
Operational context needs to be documented → A descriptive message text is included to explain the nature of the operation
[Send GCT1051E Message to Audit System]
The audit information is ready for permanent storage → The GCT1051E message is sent to the audit system for processing and storage
[Prepare Merlin System Notification]
The system processes Merlin notification → The system spawns GCT1081E print message with Merlin-specific parameters and broker information
[Prepare Internet-Based Notification]
The system processes Internet notification → The system spawns GCT1081E print message with Internet-specific parameters and broker information
[Prepare Fax Notification]
The system processes Fax notification → The system spawns GCT1081E print message with Fax-specific parameters and broker information
[Set Delete Notification Flag]
The notification is for a broker deletion or change → The system sets the delete notification flag in the print message parameters
[Include Previous Broker Information]
The system builds the notification content → The system includes the previous broker's information from the retrieved BK and B1 table data in the notification message
[Set High-Value Security Byte]
The system completes notification preparation → The system sets the security byte to high-value (X'FF') in the notification parameters
[Prepare GCT1131E Message]
The system prepares the bunch bill creation message → The system initializes the GCT1131E message structure with appropriate parameters
[Populate Message with CCN Key]
The system populates the message with cargo identification data → The system includes the CCN key in the message for proper cargo identification
[Set Security Parameters]
The system sets security parameters for the bunch bill creation → The system configures appropriate security and authorization parameters in the message
[Spawn Bunch Bill Creation Message]
The system initiates the bunch bill creation process → The system spawns the GCT1131E message to create the bunch bill
[Populate Event Message Data]
The system needs to prepare event notification data → The system should populate the event message with relevant cargo information including CCN, equipment details, and event-specific data
[Set Port Information]
The system needs to include port information in the event notification → The system should set the appropriate port information based on the cargo's current location and the type of event being processed
[Set Event Date and Time]
The system needs to timestamp the event notification → The system should set the event date and time based on the actual occurrence time of the cargo event
[Add Transfer-Specific Data]
The event type is TRANSFER → The system should add transfer-specific data including SCAC codes, city names, and tax numbers to the event message
[Generate GCT1121E Message]
The system needs to create the event notification message → The system should generate a GCT1121E message containing all the event information for processing
[Spawn Event Notification]
The event notification needs to be sent → The system should spawn the event notification process to deliver the message to the appropriate recipients
[Retrieve Forward IO Message]
The system calls the database service to fetch the message → The message content is loaded and returned to the requesting process
[Handle Message Not Found]
The database service cannot locate the specified message → The system returns an error status indicating message not found
[Delete Forward IO Message]
The system calls the database service to delete the message → The message is cleared from the workflow database and success status is returned
[Message Operation Type?]
If the operation type parameter → The system routes to either message retrieval or message deletion processing based on the operation type
[Retrieve Broker Data from Tables]
The system needs to gather complete broker details for notification → The system retrieves broker data from BK table and B1 table segments to populate notification parameters
[Set Delete Notification Flag]
The system prepares notification parameters for the print message → The system sets the delete notification flag to indicate that the previous broker should be notified of the change
[Prepare GCT1081E Message]
The system prepares the print message for spawning → The system constructs the GCT1081E message with cargo control number, broker details, and notification flags
[Set Broker Notification Flags]
The system determines broker notification preferences from broker table data → The system sets notification flags for enabled methods including Merlin, Internet, and FAX based on broker configuration
[Include Previous Broker Info]
The system finalizes the notification message parameters → The system includes previous broker information in the message to support proper broker change notification
[Set High Security Byte]
The system finalizes security settings for the message → The system sets the high security byte to ensure appropriate security level for the broker notification message
[Spawn GCT1081E Print Message]
The system initiates the print notification process → The system spawns GCT1081E with the prepared message parameters to trigger broker notification through the print subsystem
[Update Audit Trail]
The system completes the print request processing → The system updates the audit trail with print request details, broker notification status, and processing timestamp
[Bunch Bill Indicator Present?]
The system checks for bunch bill indicator presence → If bunch bill indicator is present, proceed to initialize bunch bill message structure, otherwise continue with cargo deletion process
[Set Message Header Information]
The system sets up message header information → Populate message header with transaction identification and routing information
[Populate CCN Key for Bunch Bill Processing]
The system populates CCN key for bunch bill processing → Set the cargo control number key in the message structure to identify the specific cargo for bunch bill creation
[Set Security Byte for Message Protection]
The system sets security byte for message protection → Assign appropriate security byte value to ensure message integrity and authorization
[Set Transaction Code for Bunch Bill Creation]
The system sets transaction code for bunch bill creation → Assign the appropriate transaction code to identify this message as a bunch bill creation request
[Call CIMS Service to Spawn Message]
The system calls CIMS service to spawn the message → Invoke CIMS service with the prepared message structure to initiate bunch bill processing
[Clear Message Structure]
The system performs cleanup operations → Clear the GCT1131E message structure to free resources
[Generate GCT1121E Message]
All event data is complete → The system generates a GCT1121E event notification message with all populated event details
[Forward IO Message Retrieval - Retrieve forward input/output messages from workflow database using message ID numbers for cargo processing]
The system attempts to retrieve the forward IO message from the workflow database → The system should successfully locate and retrieve the message content if the message ID exists in the database
[Set Message ID in GCSA8RT-MSG-ID]
The system prepares the database query structure → The message ID must be assigned to GCSA8RT-MSG-ID field for database lookup
[Load Message Data into Working Storage]
The message content is available → The system must load the message data into working storage for further processing
[Set Success Status]
The message retrieval operation completes successfully → The system must set a success status indicator for the calling process
[Set GCSA8RT Segment for Deletion]
The system prepares the GCSA8RT segment for deletion → The segment is properly configured with deletion parameters and message identification
[Call GCCUSIO Service with DELETE Function]
The system calls the GCCUSIO service with DELETE function → The database service processes the deletion request for the specified message
[Clear Message Structure]
The deletion operation returns a successful status → The system clears the associated message structure data
[Set Success Status]
The system completes the successful deletion workflow → The system sets success status indicators for the deletion operation
[Move C4 Line Release Codes]
The system processes C4 codes for display with current scroll position → C4 codes are displayed according to scroll position with appropriate navigation messages for multiple pages
[Move Commodity Codes & Descriptions]
The system processes commodity codes and descriptions for display → Commodity codes are displayed with associated descriptions, including scrolling messages when multiple description lines exist
[Move AES/SED Numbers to Screen]
The system processes AES numbers for display based on current panel position → AES qualifiers and numbers are displayed in pairs across 5 panels with appropriate panel navigation messages
[Move VIN Numbers]
The system processes VIN data for display based on current panel position → VIN numbers (VC01) and VIN types (VC10) are displayed across 4 panels with appropriate navigation messages
[Format Screen Footers]
The system processes footer information based on data availability and scroll positions → Screen footers display appropriate navigation messages such as 'More data above/below' and function key instructions
[Generate Database Keys]
The system processes new data that requires database storage → Appropriate segment keys are generated for new database entries including sequence numbers and segment identifiers
[Update Database Segments]
The system processes database segment updates → Database segments are updated with converted data while maintaining referential integrity and proper segment relationships
[Display 'Not Attached' Status]
The system formats the train display information → The system displays 'Not Attached' or equivalent status message
[Generate Database Keys for All Segments]
Converting screen data to database format → Unique segment keys are automatically generated for all new database segments to ensure proper record identification
[Store Converted Data to Database Segments]
Completing the screen data conversion process → Converted data is stored to appropriate database segments and success status is returned
[Build GCSUSS07 Database Segments]
System prepares data for database storage → GCSUSS07 segments are built containing harmonized code data with proper structure
[Store Harmonized Codes in Database]
System commits the data → Harmonized codes are stored in database with proper segment structure and qualifiers
[Generate Base Keys from CCN]
New cargo data segments need to be created → The system generates base keys using the CCN as the primary identifier component for all related segments
[Generate S03 Entity Keys Based on Entity Sequence]
The system processes entity segments for key generation → The system creates S03 segment keys using CCN plus entity sequence numbers, ensuring each entity has a unique identifier
[Generate S05 VIN Keys Based on VIN Sequence]
The system processes VIN segments for key generation → The system creates S05 segment keys using CCN plus VIN sequence numbers, ensuring each VIN record has a unique identifier
[Generate S07 C4 Line Release Keys Based on C4 Sequence]
The system processes C4 segments for key generation → The system creates S07 segment keys using CCN plus C4 sequence numbers, ensuring each line release code has a unique identifier
[Generate S08 Hazmat Keys Based on Hazmat Sequence]
The system processes hazmat segments for key generation → The system creates S08 segment keys using CCN plus hazmat sequence numbers, ensuring each hazmat record has a unique identifier
[Generate Harmonized Code Keys Multiple codes per segment]
The system processes harmonized code segments for key generation → The system creates unique keys for each harmonized code, supporting multiple codes per commodity segment with sequential numbering
[Generate AES/SED Keys Based on AES Sequence]
The system processes AES/SED segments for key generation → The system creates unique keys using CCN plus AES sequence numbers, ensuring each export document reference has a unique identifier
[Assign Sequential Numbers Within Each Segment Type]
The system assigns sequence numbers to segment records → The system assigns consecutive sequential numbers starting from 1 within each segment type, maintaining proper ordering and uniqueness
[Create Unique Database Keys CCN + Segment Type + Sequence]
The system creates database keys for cargo segments → The system combines CCN plus segment type plus sequence number to create a unique database key that ensures no duplicate records
[Key Generation Successful?]
If the success of key generation → The system confirms all required keys were generated successfully and are ready for database operations, or identifies key generation failures
[Multi-Segment Database Key Generation]
Converting screen data to database format → Unique segment keys are generated for each data type maintaining proper sequence and relationships
[Increment Segment Counter]
Processing the next segment that requires a database key → The segment counter is incremented by 1 to maintain sequential order
[Generate Segment Key]
Generating the database key for the segment → A unique key is created combining CCN number, segment type code, and current sequence number
[Set Segment Type Code]
Setting the segment type for database key generation → The appropriate segment type code (S01 for basic cargo, S02 for commodity, S03 for entity, S05 for VIN, S07 for C4 line release, S08 for hazmat, etc.) is assigned
[Assign CCN Key to Segment]
Assigning the CCN key to the segment → The segment is linked to the parent cargo record using the CCN as the primary reference key
[Set Sequence Number]
Setting the sequence number for the segment → The current counter value is assigned as the sequence number to maintain chronological order
[Create Database Key Structure]
Creating the database key structure → A complete key structure is built containing CCN number, segment type code, sequence number, and record type identifier
[Move to Next Segment]
Moving to process the next segment → The system advances to the next segment in the sequence to continue the key generation process
[Complete Key Generation]
No more segments remain to be processed → The key generation process is completed and all necessary database keys have been created for segments containing data
[Retrieve Load Empty Code from Database]
The system needs to display or process load empty code information → The load empty code is retrieved from the cargo root segment (GCUSRT-RT05) and made available for processing
[Move Load Empty Code to Screen Display]
The screen data needs to be populated for user display → The load empty code (GCUSRT-RT05) is moved to the corresponding screen field (GCM107X-RT05) for display
[Update Load Empty Status in Database]
The system processes the update request → The new load empty code value is stored in the cargo root segment (GCUSRT-RT05) in the database
[Create GCSUSS07 Segments]
System creates database segments → System generates GCSUSS07 segments with proper segment keys, sequence numbers, and C4 code data for database storage
[Format C4 Screen Messages]
System formats screen messages → System generates appropriate navigation messages indicating data availability above or below current screen page
[More AES Data Above? / More AES Data Below?]
The system checks for additional AES/SED data above and below the current panel → Display 'More #s above/below' when data exists both above and below, 'More #s above' when data exists only above, 'More #s below' when data exists only below, or no navigation message when no additional data exists
[Set Panel Navigation Messages]
The current panel has data and additional panels exist → Navigation messages are displayed indicating 'More AES above' or 'More AES below' based on panel position
[Create Database Segment Key]
The system prepares to store the code in the database → A unique segment key is generated to identify this harmonized code record in the database
[Store Code in GCSUSS07 Segment]
The system stores the harmonized code data → The harmonized code with its 'J' qualifier is stored in the GCSUSS07 database segment
[Update Harmonized Code Array]
The system updates working storage structures → The harmonized code is added to the working array for continued processing and reference
[Update VIN Database Segment]
System updates VIN database segment → System stores VIN information in appropriate database segment for persistence
[Compress VIN Array Data]
System compresses VIN array data → System optimizes VIN data storage by removing gaps and organizing entries efficiently
[Update Database Segment]
System performs database update operation → Reference number data is stored in the appropriate database segment with correct qualifier and number pairs
[Handle Message Area Underscore Processing]
The system processes message area content for display or input → Message areas receive appropriate underscore conversion treatment based on their specific formatting requirements
[Skip EDI - Help Mode]
The processing mode is HELP → EDI transmission should be skipped and processing should complete without sending any electronic messages
[Skip EDI - Print Mode]
The processing mode is PRINT → EDI transmission should be skipped and processing should complete without sending any electronic messages
[Skip EDI - Initial Display Mode]
The processing mode is INITIAL-DISPLAY → EDI transmission should be skipped and processing should complete without sending any electronic messages
[Use GCCS309E Service Export/US-CAN-US/Multi-Transit]
The port is valid AND the cargo type is Export:
US-CAN-US
Multi-Transit
→ The system should use the GCCS309E EDI service for transmission
[Set EDI Action: DELETE]
The current cargo status is DELETED → The EDI action code should be set to DELETE
[Set EDI Action: PRELIMINARY]
The current cargo status is ERROR:
PRELIMINARY
→ The EDI action code should be set to PRELIMINARY
[Set EDI Action: UPDATE]
The current cargo status is not DELETED, ERROR, or PRELIMINARY → The EDI action code should be set to UPDATE
[Force PRELIMINARY Action Returned Goods with Vessel 'T']
The vessel name starts with 'T' AND the cargo is marked as returned goods → The EDI action code should be overridden to PRELIMINARY regardless of the previously assigned action
[Update Cargo Acknowledgment Status]
The cargo is CPRS type in FINISH or VIEW mode with acknowledgment required → The system should update the cargo acknowledgment status to ACK for invalid ports or ACK-R for valid ports
[Is Port Code Valid?]
If the port code validity → The system selects GCCS309E for valid ports or GCCS309 for invalid ports
[Is Cargo Type Export, US-CAN-US, or Multi-Transit?, Use GCCS309E EDI Service]
The cargo type is Export, US-CAN-US, or Multi-Transit → The system uses GCCS309E EDI service for specialized processing
[Set Cargo Acknowledgment Flag Based on Port Validity]
The cargo type is Export, US-CAN-US, or Multi-Transit → The system sets RT21-USCARGO-ACK to 'Y' for valid ports or 'N' for invalid ports
[Set EDI Action to DELETE]
The current cargo status is DELETED → The system sets EDI action code to DELETE
[Set EDI Action to PRELIMINARY]
The current cargo status is ERROR or PRELIMINARY → The system sets EDI action code to PRELIMINARY
[Set EDI Action to UPDATE]
The current cargo status is neither DELETED, ERROR, nor PRELIMINARY → The system sets EDI action code to UPDATE
[Force EDI Action to PRELIMINARY]
The cargo is returned goods AND the vessel name starts with 'T' (indicating train transport) → The system overrides the EDI action code to PRELIMINARY
[Execute Selected EDI Service]
All validation and determination steps are complete → The system executes the selected EDI service (GCCS309 or GCCS309E) with the determined action code
[Auto-Assign Amendment Code '01']
The amendment code field (M1306) is empty or contains only spaces → The system automatically assigns amendment code '01' to the cargo record before proceeding with EDI transmission
[Check M1306 Amendment Code Field]
The system checks the M1306 amendment code field → The system determines if the field is empty, contains spaces, or has a valid value to decide on appropriate processing action
[Cargo Status = DELETED?]
The processing mode is DELETE → The EDI action code must be set to DELETE to notify trading partners of the cargo deletion
[Cargo Status = PRELIMINARY?]
The cargo status is PRELIMINARY:
the cargo has manual creation flag set
the cargo is T-VALUE type without previous electronic transmission
→ The EDI action code must be set to PRELIMINARY to indicate this is initial cargo data submission
[Cargo Previously Transmitted?]
The cargo is T-VALUE type AND has been previously sent electronically (EDI-SENT-ELECTR flag is set) → The EDI action code must be set to UPDATE to indicate this is a modification to existing cargo data
[Special Returned Goods Case?]
The vessel name starts with 'T' (indicating train cargo) AND the cargo has returned goods status (M1109-RTNED-GOODS) → The EDI action code must be overridden to PRELIMINARY regardless of previous transmission status
[Determine EDI Service Route]
The cargo type is EXPORT, US-CAN-US, or MULTI-TRANSIT AND the port is valid → The EDI message must be routed to GCCS309E service, otherwise route to standard GCCS309 service
[Look up Broker Information in BK Table]
The system looks up broker information using the broker short name → The system retrieves broker data from BK table segments
[Get Broker Details from B1 Table]
The system needs detailed broker information for notification → The system retrieves broker details from B1 table segments
[Send Notification to Previous Broker]
Broker has Merlin enabled:
Internet enabled
Fax enabled
→ The system spawns GCT1081E print message for each enabled notification method
[Operation Type?]
The system processes the database operation request → If operation is CREATE, insert new SHIPMINU records; if operation is UPDATE, replace existing SHIPMINU records; if operation is DELETE, remove SHIPMINU records from database
[Prepare U1 Segment - Bond Data]
The system builds the U1 segment for SHIPMINU processing → Populate U1 segment with translated bond type code, entry number, location identifiers, customs shipment value, in-bond control number, bond owner reference, transportation method, and vessel name
[Prepare U2 Segment - Broker Info]
The system checks for broker short name existence in cargo data → If broker short name exists, create U2 segment with broker information, otherwise skip U2 segment creation
[Prepare U3 Segment - CCN Reference]
The system builds the U3 segment for SHIPMINU processing → Create U3 segment with 'REF CUB' qualifier and cargo control number as reference data
[Translate Bond Type Codes for EDI]
The system processes bond type code for EDI transmission → Convert internal bond type code to EDI format using GCSUSS99-M1201 lookup table translation
[Translate Bond Type Codes]
The system processes bond type information for SHIPMINU U1 segment creation → Translate bond type code using GCSUSS99-M1201 lookup table to get appropriate SHIPMINU bond type code
[Create SHIPMINU U1 Segment]
The system creates SHIPMINU U1 segment → Populate U1 segment with translated bond type code, entry number, location identifiers, customs shipment value, in-bond control number, bond owner reference, transportation method, and vessel name
[Create SHIPMINU U2 Segment]
The system creates SHIPMINU U2 segment → Create U2 segment with broker short name if broker information exists in the cargo record
[Create SHIPMINU U3 Segment]
The system creates SHIPMINU U3 segment → Create U3 segment with 'REF CUB' qualifier and cargo control number as reference data
[Insert/Update SHIPMINU Records]
The system performs database operations for SHIPMINU records → Insert new SHIPMINU records or update existing records, handling duplicate key situations appropriately
[Delete Existing SHIPMINU Records]
The system processes SHIPMINU deletion → Delete all associated SHIPMINU segments (U1, U2, U3) from the database in sequence
[Delete U1 Segment]
The system deletes SHIPMINU U1 segment → Remove U1 segment containing bond type, entry number, and shipment information from the database
[Delete U2 Segment]
The system deletes SHIPMINU U2 segment → Remove U2 segment containing broker information from the database
[Delete U3 Segment]
The system deletes SHIPMINU U3 segment → Remove U3 segment containing CCN reference information from the database
[Is Entry Number 3 Present in SHIPMINU U1?]
The system checks for the presence of Entry Number 3 in SHIPMINU U1 segment (SHIPU1-U103) → If Entry Number 3 is present and not empty in SHIPMINU U1, proceed to compare values. If Entry Number 3 is not present or empty in SHIPMINU U1, set validation success flag and continue processing
[Set Permission Denied Flag - Block SHIPMINU Operation]
If SHIPMINU operation permissions → Set permission denied flag to block the SHIPMINU operation from proceeding
[Bond Type Present?]
The system checks for bond type presence in the cargo data → If bond type is not present, skip SHIPMINU processing; if bond type is present, proceed with segment creation
[Retrieve Bond Type Translation]
The system processes the bond type for SHIPMINU U1 segment creation → The internal bond type code is translated to its corresponding EDI-compatible code using the GCSUSS99-M1201 lookup table
[Set Bond Type Code]
The U1 segment is being created → The translated bond type code is assigned to the U1 segment bond type field
[Set Entry Numbers]
The U1 segment is being populated → The entry number is assigned to U1-M1202 field and location identifier is assigned to U1-M1203 field
[Set Location Identifiers]
The U1 segment is being populated → Port of loading is assigned to U1-R4-01, port of discharge to U1-R4-02, place of delivery to U1-R4-03, and place of receipt to U1-R4-04
[Set Customs Values]
The U1 segment is being populated → The customs shipment value is assigned to U1-N1006 field and currency code 'USD' is assigned to U1-CUR-01 field
[Set Weight Information]
The U1 segment is being populated → The weight is assigned to U1-N1008 field and weight unit is assigned to U1-N1009 field
[Set Broker Short Name]
The U2 segment is being created → The broker short name is assigned to U2-N102 field
[Set Custom Broker Field]
The U2 segment fields are being populated → The custom broker identifier 'CB' is assigned to U2-N101 field
[Set CCN Reference]
The U3 segment is being created → The cargo control number is assigned to U3-REF-02 field
[Set Reference Qualifier 'REF CUB']
The U3 segment reference fields are being populated → The reference qualifier 'CUB' is assigned to U3-REF-01 field
[Tax Number Type?]
The system processes tax number for U3 segment reference → If tax number is IRS number, use 'S4' qualifier; if tax number is bond owner number, use 'BI' qualifier
[Set IRS Reference 'S4']
The U3 segment tax reference is being populated → The IRS tax number is assigned to U3-REF-02 field and 'S4' qualifier is assigned to U3-REF-01 field
[Set Bond Owner Reference 'BI']
The U3 segment tax reference is being populated → The bond owner tax number is assigned to U3-REF-02 field and 'BI' qualifier is assigned to U3-REF-01 field
[Store SHIPMINU Segments]
The SHIPMINU segment creation process is complete → All created segments are stored to the database using the appropriate database operations
[Skip SHIPMINU Processing]
No bond type is present in the cargo data → The system skips all SHIPMINU segment creation and proceeds to end the process
[Set Bond Type Code]
The system processes bond type assignment → The bond type code from cargo manifest (M1201) is assigned to the U1 segment bond type field
[Translate Internal Bond Code to EDI Code]
The system processes bond code translation → The internal bond code is converted to corresponding EDI standard code using GCSUSS99-M1201 lookup table
[Set Entry Number Information]
The system processes entry number assignment → Entry number, entry type, and related identification fields are populated from cargo manifest data (M1202, M1203) into corresponding U1 segment fields
[Set Location Identifiers]
The system processes location identifier assignment → Port of entry, destination port, and other location identifiers are populated from cargo data into U1 segment location fields
[Set Customs Shipment Value]
The system processes customs value assignment → The customs shipment value from cargo data is assigned to the U1 segment value field with proper formatting
[Set Weight Information]
The system processes weight assignment → Weight amount and weight unit of measure are populated from cargo data into corresponding U1 segment weight fields
[Set Date Information]
The system processes date assignment → Relevant dates from cargo processing are assigned to U1 segment date fields in proper format
[Set Reference Numbers]
The system processes reference number assignment → Control numbers, tracking identifiers, and other reference numbers are populated from cargo data into U1 segment reference fields
[Tax Number Required?]
If tax number requirements → If CPRS bond owner, require IRS tax number with S4 qualifier; if external bond owner, require bond owner tax number with BI qualifier; if no bond owner, no tax number required
[Set IRS Tax Number with S4 Qualifier]
The system processes IRS tax number assignment → IRS tax number is assigned to U1 segment with S4 qualifier indicating IRS tax identification
[Set Bond Owner Tax Number with BI Qualifier]
The system processes bond owner tax number assignment → Bond owner tax number is assigned to U1 segment with BI qualifier indicating bond issuer identification
[Validation Successful?]
If validation results → If validation successful, mark U1 segment ready for database storage; if validation failed, set error status and terminate creation
[U1 Segment Ready for Database]
The system completes U1 segment preparation → U1 segment is marked as ready for database storage with all required fields properly formatted
[Start Bond Code Translation]
The system processes the internal bond type code for EDI transmission → The system should initiate the bond code translation process
[Access GCSUSS99 Translation Table]
The system needs to convert the internal code to EDI format → The system should access the GCSUSS99 translation table for code lookup
[Translation Found?]
The lookup operation completes → If a matching translation is found, use the EDI code from table, otherwise use a default EDI code
[Set EDI Bond Code from Table]
The system processes the translation result → The system should assign the EDI bond code value from the translation table
[Use Default EDI Code]
The system needs to assign an EDI bond code → The system should use a predefined default EDI bond code
[Update SHIPMINU U1 Segment]
The system updates the SHIPMINU record → The system should populate the U1 segment with the appropriate EDI bond code
[Set Origin Location from GCUSRT-RT05]
The system processes SHIPMINU U1 segment creation → The origin location identifier is set from GCUSRT-RT05 to GCSUSS01-U1-ORIG-LOC-ID
[Set Destination Location from GCUSRT-RT32]
The system processes SHIPMINU U1 segment creation → The destination location identifier is set from GCUSRT-RT32 to GCSUSS01-U1-DEST-LOC-ID
[Set Port of Loading]
The system processes SHIPMINU U1 segment creation → The port of loading identifier is set from GCUSRT-RT05 to GCSUSS01-U1-PORT-OF-LOADING
[Set Port of Discharge]
The system processes SHIPMINU U1 segment creation → The port of discharge identifier is set from GCUSRT-RT32 to GCSUSS01-U1-PORT-OF-DISCHARGE
[Set Place of Receipt]
The system processes SHIPMINU U1 segment creation → The place of receipt identifier is set from GCUSRT-RT05 to GCSUSS01-U1-PLACE-OF-RECEIPT
[Set Place of Delivery]
The system processes SHIPMINU U1 segment creation → The place of delivery identifier is set from GCUSRT-RT32 to GCSUSS01-U1-PLACE-OF-DELIVERY
[Update SHIPMINU U1 Segment]
The system processes SHIPMINU record updates → Update the U1 segment of SHIPMINU with the customs shipment value for regulatory reporting
[Convert Weight to Proper Format]
The system processes the weight information for SHIPMINU U1 segment → The weight data is converted to the proper format suitable for database storage and transmission
[Set SHIPU1-M1115-WEIGHT Field]
The system creates or updates the SHIPMINU U1 segment → The converted weight value is assigned to the SHIPU1-M1115-WEIGHT field
[Apply Weight to SHIPMINU U1 Segment]
The system processes the SHIPMINU U1 segment update → The validated weight information is applied to the SHIPMINU U1 segment in the database
[Set Default Weight Value]
The system processes weight information for SHIPMINU U1 segment → A default weight value is assigned to ensure SHIPMINU segment completeness
[Set Reference Qualifier to 'REF CUB']
The system sets the reference qualifier field → The reference qualifier should be set to 'REF CUB' to indicate this is a Cargo Control Number reference
[Store U3 Segment Data]
The system completes the reference number setup → The U3 segment data should be stored for subsequent SHIPMINU database operations
[Set IRS Tax Number with S4 Qualifier]
The system processes tax number assignment and IRS tax number is available from CC table lookup → The system sets reference number qualifier to 'S4', assigns the IRS tax number to the reference number field, and creates the SHIPMINU U3 segment with S4 qualifier
[Set SHIPMINU U3 Segment with S4 Qualifier]
The system creates the SHIPMINU U3 segment → The system generates SHIPMINU U3 segment with S4 qualifier and IRS tax number for shipment processing
[Skip Tax Number Processing]
Tax number is not available from CC table lookup → The system skips tax number processing and continues without creating tax number reference
[Update SHIPMINU U1 Segment with Tax Information]
The system needs to update the shipment record → The system should update the SHIPMINU U1 segment with the bond owner tax information
[Translate Bond Type to EDI Code]
The system translates the bond type code for EDI transmission → The internal bond type code is converted to the appropriate EDI format code using established business mapping rules
[Set U1 Segment Data Fields]
The system sets U1 segment data fields → All validated data values are populated into their corresponding U1 segment fields for SHIPMINU record processing
[U1 Segment Validation Complete]
The system completes U1 segment validation → Validation completion status is confirmed and the U1 segment is ready for SHIPMINU record processing
[Is Broker Information Available?]
The system checks for broker information availability → The system should proceed to create U2 segment if broker short name exists, otherwise skip U2 creation
[Retrieve Broker Short Name]
The system needs to create U2 segment → The system should retrieve the broker short name from the cargo data
[Set U2 Segment Identifier]
The system initializes the U2 segment structure → The system should set the segment identifier to 'U2' for proper segment identification
[Populate Custom Broker Field]
The system populates broker-specific fields → The system should set the custom broker field with the appropriate broker identifier value
[Set Broker Name in U2 Segment]
The system populates the U2 segment fields → The system should assign the broker short name to the designated broker name field in U2 segment
[Complete U2 Segment Structure]
The system completes U2 segment creation → The system should finalize the U2 segment structure with all required broker information properly formatted
[U2 Segment Ready for Database]
The system prepares for database operations → The system should mark the U2 segment as ready for database insertion or update operations
[Skip U2 Creation - No Broker Data]
No broker information is available in the cargo record → The system should skip U2 segment creation and proceed without broker segment
[Broker Code Available?]
If broker code availability → If broker code exists and is not empty, proceed to broker lookup, otherwise use default empty broker information
[Retrieve Broker Short Name]
The system processes the broker record → Extract and store the broker short name for SHIPMINU U2 segment creation
[Prepare SHIPMINU U2 Segment]
The system creates SHIPMINU U2 segment → Populate U2 segment with broker information including short name and related broker data
[Store Broker Information]
The system performs database storage operation → Store the U2 segment with complete broker information in the database
[Retrieve Broker Short Name from GCUSRT-RT50-OWNER]
The system processes U2 segment creation → The broker short name is retrieved from GCUSRT-RT50-OWNER field
[Set U2 Segment Custom Broker Field]
The U2 segment is being populated → The custom broker field in U2 segment is set with the broker short name
[Use Default Broker Information]
The system processes U2 segment broker information → Default broker information is used for the U2 segment
[Complete U2 Segment Preparation]
The U2 segment processing is finalized → The U2 segment preparation is completed with properly formatted broker information
[Set U2 Segment Broker Field with Short Name]
The cargo data contains a broker short name (GCUSRT-M1115-BROKER-SHORT-NAME is not empty) → The system sets the U2 segment broker field (GCSHIPMINU-U2-BROKER) with the broker short name value
[Set U2 Segment Custom Broker Field]
The cargo data contains custom broker field information → The system sets the U2 segment custom broker field with the retrieved custom broker information
[Complete U2 Segment Broker Information]
Both broker short name and custom broker fields have been evaluated and populated as applicable → The system completes the U2 segment broker information structure and marks it ready for database operations
[Set Segment Type to 'U3']
The system sets the segment type → The segment type is set to 'U3'
[Set Reference Qualifier to 'REF']
The system assigns the reference qualifier → The reference qualifier is set to 'REF'
[Set Reference Code to 'CUB']
The system assigns the reference code → The reference code is set to 'CUB'
[Assign CCN as Reference Number]
The system assigns the CCN as the reference number → The U3 segment reference number field contains the CCN
[Set Segment Sequence Number]
The system assigns a sequence number → The U3 segment has a valid sequence number for identification
[U3 Data Valid?]
If the validation results → The system determines if the data is valid or invalid and proceeds accordingly
[Insert U3 Segment to Database]
The system attempts to insert the U3 segment into the database → The U3 segment is inserted into the SHIPMINU database
[Insert Successful?]
The system checks the insertion result → The system determines if the insertion was successful or failed
[Mark U3 Creation Complete]
The system marks the creation process as complete → The U3 segment creation status is set to complete
[Set Reference Qualifier to 'REF']
The system initializes the reference qualifier field → The reference qualifier must be set to 'REF'
[Set Reference ID Qualifier to 'CUB']
The system sets the reference ID qualifier field → The reference ID qualifier must be set to 'CUB'
[Set Reference Number to CCN Key]
The system assigns the reference number value → The reference number must be set to the cargo control number key
[Set Reference Qualifier to 'CUB']
The system initializes the reference qualifier field → The reference qualifier must be set to 'CUB'
[Set Reference Number to CCN Key]
The system assigns the reference number field → The reference number must be set to the cargo control number key value
[Extract CCN Key from GCUSRT-US-CCN-KEY]
The system needs to extract the CCN key for processing → The CCN key is retrieved from GCUSRT-US-CCN-KEY field
[Create CCN Reference for SHIPMINU U3 Segment]
The system creates a CCN reference for SHIPMINU U3 segment → A properly structured CCN reference is prepared for the U3 segment
[Set Reference Qualifier to 'REF CUB']
The system sets the reference qualifier → The reference qualifier is set to 'REF CUB' according to business standards
[Assign CCN as Reference Number]
The system processes the CCN reference assignment → The U3 segment is created with reference qualifier 'REF CUB' and the cargo's CCN as the reference number
[Set Reference Qualifier to 'REF CUB']
The reference qualifier field is populated → The reference qualifier is set to 'REF CUB'
[Access Current Cargo CCN Key]
The CCN reference assignment process begins → The system accesses the CCN key from the cargo root segment (GCUSRT-US-CCN-KEY)
[Create SHIPMINU U3 Segment]
The U3 segment creation process is initiated → A new SHIPMINU U3 segment structure is created with proper segment identification
[Set Segment Key and Sequence]
The segment is prepared for database storage → The segment key and sequence number are assigned to ensure unique identification
[Business Process Not Found]
The validation process is invoked → The system indicates that the business process for U3 segment data validation is not located in the provided source
[Prepare U3 Segment Data]
The system prepares the U3 segment data structure → The U3 segment data structure is initialized and ready for population
[Set CCN Reference Information]
The system sets up CCN reference information → The CCN reference data is properly configured for the U3 segment
[Set Qualifier Code to 'REF CUB']
The system assigns the qualifier code → The qualifier code is set to 'REF CUB' to identify this as a CCN reference
[Move CCN Key to Reference Number]
The system moves the CCN key to the reference number field → The CCN key value is stored in the U3 segment reference number field
[Set U3 Segment Key]
The system sets the U3 segment key → A unique segment key is assigned to the U3 segment for database identification
[Call Database Insert Operation]
The system calls the database insert operation → The database insert operation is invoked to store the U3 segment
[U3 Segment Successfully Created]
The insert operation returns a successful status → The system confirms the U3 segment has been successfully created in the database
[Get Next FWSWREQ Equipment Segment]
The system processes equipment records → Retrieve the next FWSWREQ equipment segment for car number matching
[Translate Bond Type Codes for EDI]
The system processes the bond type code for EDI transmission → The internal bond type code is translated using GCSUSS99-M1201 lookup table to produce the appropriate EDI-compliant bond type code
[Set Bond Type and Entry Numbers]
The system populates segment data fields → Bond type code, entry number, location identifiers, customs shipment value, in-bond control number, bond owner reference, transportation method, and vessel name are populated from corresponding cargo data fields
[Set Broker Information]
The system checks for broker short name in cargo data → U2 segment is created with broker information if broker short name exists; otherwise U2 segment creation is skipped
[Set CCN Reference Information]
The system populates reference information → U3 segment is created with 'REF CUB' qualifier and cargo control number as reference value
[Delete U1 Segment]
The system processes the deletion request → U1, U2, and U3 segments are deleted in sequence using GHU/DLET database operations
[Lookup Internal Bond Type Code]
The system accesses GCSUSS99 table to lookup the internal bond type code → The system retrieves the corresponding EDI-compatible bond code translation if found in the table
[Set Translated Bond Code for SHIPMINU U1 Segment]
The system processes the translated bond code → The system sets the EDI-compatible bond code in the SHIPMINU U1 segment for proper EDI transmission
[Use Original Bond Type Code as Default]
The translation lookup fails to find a matching EDI-compatible code → The system uses the original internal bond type code as the default value for SHIPMINU processing
[Broker Information Available?]
The system checks for broker information availability → If broker short name exists and is not empty, broker information is considered available, otherwise it is not available
[Retrieve Broker Short Name]
The system retrieves broker short name → The broker short name is obtained from the cargo root segment broker field
[Process Custom Broker Field]
The system processes custom broker field → The custom broker field is extracted and prepared for U2 segment mapping
[Set Default Broker Information]
The system sets default broker information → Default broker values are assigned to ensure U2 segment can be created with standard broker information
[Populate U2 Segment with Broker Data]
The system populates U2 segment with broker data → U2 segment fields are populated with the appropriate broker information for SHIPMINU record creation
[Map Broker Short Name to U2 Field]
The system maps broker short name to U2 field → Broker short name is assigned to the designated broker name field in the U2 segment
[Map Custom Broker Field to U2]
The system maps custom broker field to U2 → Custom broker field is assigned to the designated custom field in the U2 segment
[Complete U2 Segment Creation]
The system completes U2 segment creation → U2 segment is finalized with all required broker information and ready for database storage
[Return Success]
The system returns success status → Processing continues with successful U2 segment creation confirmation
[Set Reference Qualifier to 'REF']
The reference qualifier needs to be assigned → The reference qualifier is set to 'REF'
[Set Reference Code to 'CUB']
The reference code needs to be assigned → The reference code is set to 'CUB' to indicate Cargo Control Number
[Assign CCN as Reference Number]
The reference number field in the U3 segment needs to be populated → The CCN is assigned as the reference number
[Set Segment Key and Sequence]
The segment key and sequence number need to be assigned → The segment key and sequence are set according to SHIPMINU standards
[Create U3 Database Record]
The database record creation is initiated → The U3 segment is created in the database
[U3 Reference Segment Created]
The creation process is completed → The U3 reference segment creation is confirmed and logged
[Insert U1 Waybill Segment]
The system attempts to insert a U1 waybill segment → The U1 segment is successfully inserted with complete waybill data, or the operation fails with error handling
[Insert U2 Broker Segment]
The system attempts to insert a U2 broker segment → The U2 segment is successfully inserted with broker data, or the operation fails with error handling
[Insert U3 Reference Segment]
The system attempts to insert a U3 reference segment → The U3 segment is successfully inserted with CCN reference data, or the operation fails with error handling
[Replace U1 Waybill Segment]
The system attempts to replace the U1 waybill segment → The U1 segment is successfully replaced with updated waybill data, or the operation fails with error handling
[Replace U2 Broker Segment]
The system attempts to replace the U2 broker segment → The U2 segment is successfully replaced with updated broker data, or the operation fails with error handling
[Replace U3 Reference Segment]
The system attempts to replace the U3 reference segment → The U3 segment is successfully replaced with updated CCN reference data, or the operation fails with error handling
[U1 Found?]
The system searches for an existing U1 segment → If U1 segment is found, it is deleted; if not found, the system proceeds to check for U2 segment
[U2 Found?]
The system searches for an existing U2 segment → If U2 segment is found, it is deleted; if not found, the system proceeds to check for U3 segment
[U3 Found?]
The system searches for an existing U3 segment → If U3 segment is found, it is deleted; if not found, the deletion operation is considered complete
[Retrieve FWSWREQ Segment]
The system attempts to retrieve FWSWREQ segment data → Read equipment waybill request data from FWSWREQ segment
[Extract Equipment ID from Segment]
The system processes the segment data → Extract equipment ID from the FWSWREQ segment for comparison
[Retrieve Waybill Key from Segment]
The system processes the matching segment → Retrieve waybill key from the FWSWREQ segment
[Store Waybill Key for Processing]
The system processes the waybill key → Store waybill key in processing storage for bunch bill operations
[Continue to Next FWSWREQ Segment]
The system completes current segment processing → Move to process the next available FWSWREQ segment
[More FWSWREQ Segments?]
The system checks for additional segments → If more FWSWREQ segments exist, continue retrieval process, otherwise complete waybill key retrieval
[Complete Waybill Key Retrieval]
The system determines no more segments exist → Complete the equipment waybill key retrieval process
[Equipment Waybill Key Not Found]
FWSWREQ segment is not found → Indicate that equipment waybill key could not be retrieved
[Set Order Entry EDI Origin]
The system determines data origin classification → The data origin is set to 'ORD EDI' for Order Entry EDI
[Set Fastway EDI Origin]
The system determines data origin classification → The data origin is set to 'EDI' for Fastway EDI
[Update Database with Audit Record]
The system updates the database → The audit record is permanently stored in the GCSUSS15 segment
[Set Origin: Order Entry EDI]
The data source is identified as Order Entry EDI process → The system sets the data origin classification to 'ORD EDI' in the audit record
[Set Origin: Fastway EDI]
The data source does not match other classification criteria and is identified as EDI transmission → The system sets the data origin classification to 'EDI' in the audit record

Structural Validations

[13:Cargo Data Validation]
The validation process is executed → All cargo segments are validated in sequence (root, S05, C4 line release, S07 commodity, S03 entity, S06 VIN, S02), duplicate C4 codes are checked, line release consistency is verified, bond requirements are validated, and all business rule constraints are enforced
[190:Screen Change Detection and Validation]
The change detection process is executed → Current screen data is compared with original cargo data, equipment validation includes special checks for equipment car and description changes, data normalization removes underscores and low-values for accurate comparison, change flag is set when modifications are detected, and appropriate messages are displayed to inform users of detected changes
[Valid Function Code?]
Function code is validated against system function table → System accepts valid codes (ADD, CHG, DEL, VW, FINISH, RESEND, PRINT, etc.) and rejects invalid codes with error message
[Validate Broker Information]
System validates broker data for print → System validates broker requirements (not UNKNOWN/NOT-REQ), retrieves broker table data (BK and B1 segments), and ensures broker information completeness
[INVALID-USER]
The user type is classified as INVALID-USER → Access is denied and permission denied error message is set
[ERROR Status]
A user attempts to perform any function on the error status cargo → Access is denied and cargo status error message is set
[Check if Cargo DELETED]
The system checks if the cargo status is 'DELETED' before allowing any operation → If cargo status equals 'DELETED', the system sets error code 4032 with message 'Cannot Execute operation on deleted cargo', highlights the function code field, and returns operation not permitted status
[Check Already Arrived]
An arrival processing request is initiated for the cargo → The system checks if the cargo status is already set to ARRIVED and if arrival date/time fields are populated, and if so, prevents the arrival processing and displays an appropriate error message
[Set Error: Cargo Already Arrived]
The system determines arrival has already been processed → The system sets an error message indicating the cargo has already arrived
[Set Error Code 4XXX]
The system sets the error message → The system assigns error code 4XXX to categorize the already arrived error
[Validate All Cargo Segments]
The system validates all cargo segments including root segment, commodity data, entity data, VIN data, and hazmat data → All segments must pass validation rules or FINISH processing is rejected with validation errors
[Display Validation Errors]
The system encounters validation errors → Validation errors are displayed to the user with specific field-level error messages and cursor positioning on the first error field
[Validate S02 Segment Data]
The system performs comprehensive cargo validation → The root segment is validated using GCCUSEDB with all segments included and validation results are captured
[Validate S02 Segment Data]
S05 segment validation is performed → The S05 segment is validated using GCCUSEDB and validation results are recorded
[Validate S06 Cargo Segment Data]
S07 segment validation is performed → The S07 segment is validated using GCCUSEDB and validation results are captured
[Validate S03 Entity Information Segment]
Entity segment validation is performed → Each S03 segment is validated using GCCUSEDB and validation results are recorded for all entity records
[Validate S05 VIN Data Segment]
VIN segment validation is performed → Each S06 segment is validated using GCCUSEDB and validation results are captured for all VIN records
[Validate S02 Segment Data]
Final S02 validation is performed → The S02 segment is validated using GCCUSEDB and validation results are recorded
[Compile All Validation Errors]
Error compilation is performed → All validation errors are filled into error array using X5205-FILL-X5000-ERROR-ARRAY and cursor is positioned on first error field using X5210-SET-CUR-ON-1ST-ERR-FLD
[Validate S02 Field Format]
Field format validation is performed on S02 data → All S02 fields must meet format requirements or validation fails
[Check S02 Data Completeness]
Data completeness is checked for S02 segment → All mandatory S02 fields must contain valid data
[Retrieve S06 Segment Data]
The system retrieves S06 segment data → The system determines if VIN data segments exist in the cargo record
[Equipment Found?]
The system checks for equipment record availability → If no equipment records are found, the waybill search terminates without finding waybill key
[Operation Successful?]
The system checks the operation result → The system determines if the operation was successful or failed
[Handle Database Error]
The system detects the error condition → The system handles the error and takes appropriate corrective action
[Set Error Message - Master CCN Not Found]
The system handles the master CCN not found condition → The system sets an appropriate error message indicating that the master CCN could not be located
[Display Error - Invalid Master CCN]
The system needs to inform the user of the validation failure → An error message is displayed indicating that the master CCN is invalid or does not exist
[Check if Port Code Empty]
The port code field is left empty → The system displays error message 4032 'Port name required' and positions cursor on port field for correction
[Perform SD Table Lookup for Port Validation]
The system performs lookup against the SD table using GCCTBIO service → If the port code is not found in the SD table, the system displays error message 4033 'Invalid port name' and positions cursor on port field for correction
[Is Date Field Empty?]
The arrival date field is empty or not provided → System displays error message 'Date Required for Arrival' and positions cursor on date field
[Is Date Format Valid?]
The date format is invalid or cannot be converted by ISCDATCV utility → System displays error message 'Invalid Date Format' and positions cursor on date field
[Is Hour Valid?]
The hour value is not between 00 and 23 inclusive → System displays error message 'Invalid Hour Range' and positions cursor on time field
[Is Minute Valid?]
The minute value is not between 00 and 59 inclusive → System displays error message 'Invalid Minute Range' and positions cursor on time field
[Hour >= 00? and Hour <= 23?]
The system validates the hour value after converting it to numeric format → If the hour is less than 00 or greater than 23, set error code 4035 and display hour range error message; if the hour is between 00 and 23 inclusive, accept the hour as valid and continue processing
[Set Error Code 4035, Position Cursor on Hour Field, Display Hour Range Error Message]
The hour validation fails → Set error code 4035, position the cursor on the hour input field, and display an error message indicating the valid hour range
[Display Error Message: Date Cannot Be Before Cargo Creation]
The system processes the validation failure → Error code 4185 is set, the cursor is positioned on the invalid date field, error message 'Date cannot be before cargo creation date' is displayed, and control returns to user for correction
[Display Hour Range Error Message]
The system presents validation results to the user → Display an error message indicating that the hour must be within the valid range of 00-23
[Minute Numeric?]
The minute field contains non-numeric characters → The system generates error code 4032, positions the cursor on the minute field, and displays an error message
[Minute >= 0 AND <= 59?]
The minute value is less than 0 or greater than 59 → The system generates error code 4032, positions the cursor on the minute field, and displays an error message
[Is Input Date Before Cargo Creation Date?]
The system validates the input date against the cargo creation date → If the input date is before the cargo creation date, the system sets error code 4185, positions cursor on the date field, and displays an error message, otherwise the date validation passes and processing continues
[Display Error Message]
The system displays the screen to the user → The system displays an error message indicating that the date cannot be before the cargo creation date
[Parse Transfer Format AAAA/BB/CCCCCCCCCCCC]
The system parses the transfer format string → The format must be AAAA/BB/CCCCCCCCCCCC where AAAA is SCAC code, BB is state code, and CCCCCCCCCCCC is city code
[Display Error Message]
The system encounters invalid format, SCAC code, state code, city code, or tax number retrieval failure → An error message must be displayed and the user returned to the screen for correction
[Validate City Code Against SD Table]
The system performs a lookup against the SD reference table → If the city code exists in the SD table, the system retrieves the city description and sets validation success flag, otherwise it sets a city code error flag and generates an error message
[Generate City Code Error Message]
The lookup operation fails → The system sets a city code error flag and generates an appropriate error message
[SCAC Code Format Valid?]
The system validates the SCAC code format → The system accepts the code if it meets format requirements or displays a format error message if invalid
[Display Invalid SCAC Error]
The system processes the lookup failure → The system displays an invalid SCAC error message and returns to input field
[Set Error Message]
The system processes the carrier not found condition → The system sets an error message indicating carrier information could not be retrieved or is invalid
[Validate AES/SED Qualifier Codes]
System validates the AES qualifier codes against approved values → System accepts valid qualifier codes and rejects invalid ones with appropriate error message
[Panel Navigation Valid?]
The system checks if the requested panel contains valid VIN data or is within allowable range → Navigation proceeds if the target panel is valid, otherwise system displays panel boundary message and remains on current panel
[Entity Information Validation]
The system validates entity data → Validate entity segments using GCCUSEDB, clear entire entity record if all key fields are empty, and validate entity relationships
[Set Error Messages]
The system processes error conditions → Assign specific error messages corresponding to each validation failure type
[Validate All Segments Together]
The system performs comprehensive cross-segment validation → All segments must be consistent with each other, referential integrity must be maintained, and business rules across segments must be satisfied
[Set Error Messages]
The system processes validation failures → Appropriate error messages are assigned to guide users in correcting the validation issues
[Validate Amendment Code M1306]
The system validates the amendment code against the AC table → The system accepts valid amendment codes and rejects invalid ones with appropriate error messages
[Validate C4 Line Release Codes]
The system validates the C4 codes for duplicates → The system identifies any duplicate C4 codes within the same cargo and generates error messages for duplicate entries
[Format Error Message]
The system needs to format the complete error message → The system formats the error message including field name, error description, and any relevant validation details
[Position Cursor on Error Field]
The system needs to position the cursor for user correction → The system positions the cursor on the specific error field and navigates to the appropriate screen/panel if necessary
[Update Error Array]
The system needs to update the error tracking array → The system adds the error information to the error array including field name, error message, and position details
[Display Error to User]
The system needs to display the error to the user → The system displays the formatted error message on the screen with the cursor positioned on the error field for immediate correction
[Display Error Message]
The system prepares to inform the user of the validation failure → An appropriate error message is displayed indicating the specific type of C4 code validation failure
[Validate CCN Reference Data]
The segment data needs validation before database insertion → The system validates that segment identifier, reference qualifier, reference code, and CCN number are all present and valid
[Log U3 Creation Error]
An error occurs during U3 segment creation process → The system logs the U3 creation error with appropriate error details
[Return Error Status]
The calling process needs to be notified of the failure → The system returns an error status indicating U3 creation failure
[Bond Type Code Present?]
Processing bond type for EDI translation → If bond type code is present, proceed with translation lookup, otherwise skip translation process
[Set Error Message Non-Numeric Entry]
Numeric validation is performed → An error message indicating non-numeric entry is set and processing continues to next field
[Set Field Error Message]
The system processes the validation error → A specific error message is set indicating the nature of the numeric format violation
[Position Cursor on Error Field]
The system prepares the screen for user interaction → The cursor is positioned on the field containing the validation error
[Generate FIRMS Code Error]
FIRMS code is missing, empty, or invalid → Generate error message indicating FIRMS code is required for transport export cargo and stop processing
[Counter Exceeds 16 Codes?]
The system checks if the counter exceeds 16 codes → A new database segment is created if the limit is exceeded, otherwise processing continues with the current segment
[Set Error Status]
System sets completion status → System sets error indicator to indicate GCSUSS07 update process failed and requires correction
[Does segment contain harmonized code with 'J' qualifier?]
The system checks for harmonized code data → Only harmonized codes with 'J' qualifier must be processed
[Has 'J' Qualifier?]
The system examines the first harmonized code field → The system checks if the harmonized code has a 'J' qualifier and processes the code only if the qualifier is present
[Has 'J' Qualifier?]
The system examines the second harmonized code field → The system checks if the second harmonized code has a 'J' qualifier and processes the code only if the qualifier is present
[Check N401 Address Line 1]
The system processes the N401 address line 1 field → The address line 1 is validated for proper format and content before proceeding to next address component
[Check N402 Address Line 2]
The system processes the N402 address line 2 field → The address line 2 is validated for proper format and content before proceeding to city validation
[Check N403 City]
The system processes the N403 city field → The city name is validated for proper format and content before proceeding to state validation
[Position Error on VIN Field]
The validation error needs to be communicated to the user → Position the cursor on the VIN field and display appropriate error message to guide user input
[Determine Manifest Type]
The cargo type is CPRS → The system prevents the multi-car operation and displays an error message that CPRS cargo cannot be used in multi-car operations
[Validate Manual CCN Entry]
The system validates the CCN format and checks if it is a temporary CCN → The system either accepts the CCN for processing or rejects it with appropriate error message
[Validate Amendment/Reason Code]
The system validates the amendment code field → The amendment code must not be empty and must exist in the Amendment Code reference table, otherwise deletion is rejected with appropriate error message
[Validate Cargo Data Completeness]
The system validates all cargo segments and required fields → The system proceeds if all required data is present, otherwise displays validation errors and returns to screen
[Validate Port Information]
The system validates the port information provided in the request → The system accepts the request if the port is valid, otherwise displays an error message and returns to main screen
[Validate Arrival Date and Time]
The system validates the arrival date and time → The system accepts the date/time if it is not in the future and not before cargo creation date, otherwise displays an error message and returns to main screen
[Check Cargo Status]
The system checks the current cargo status → The system proceeds with arrival processing if cargo has not already arrived, otherwise displays an error message indicating cargo already arrived and returns to main screen
[Check Train Attachment Status]
The system checks if cargo is attached to a train and validates train arrival status → The system allows arrival processing if train has arrived or manual override is permitted, otherwise displays an error message and returns to main screen
[Date/Time Valid?]
The system validates the export date and time using date conversion utilities → The system accepts the date/time if valid format and business rules are met, otherwise rejects with appropriate error message
[Merlin ID Valid?]
The system validates the provided Merlin ID → The system allows the print request to proceed if the Merlin ID is valid and properly formatted, otherwise displays an error message
[Broker Name Valid?]
The system validates the broker information → The system allows the print request to proceed if broker name and related information are valid, otherwise displays an error message
[Broker Data Found?]
The system checks if broker data was found → The system proceeds with print message preparation if broker data exists, otherwise displays an error message indicating broker not found
[Display Error Message]
The system displays an error message → The system shows a specific error message indicating the reason for failure (invalid Merlin ID, invalid broker information, or broker not found)
[Display Error Message]
Any validation step returns an error condition → The system displays specific error message indicating the reason for PTT request failure
[Display Error Message]
Validation errors occur → Appropriate error messages are displayed to inform user of validation failures
[Set Error Messages for Invalid Codes]
The system processes invalid harmonized codes → Appropriate error messages must be generated for each invalid harmonized code to inform the user of the validation failure
[Position Cursor on Error Field]
The system displays error messages to the user → The cursor must be positioned on the first harmonized code field that contains an error to guide user attention
[Data Valid?]
The system validates data integrity including segment keys, sequence numbers, and data format → The system proceeds with database operation if data is valid, otherwise handles validation error
[Display Error Message]
The system displays error messages → The system shows specific error messages based on the validation failure or processing error, positions cursor on the error field, highlights the problematic data, and provides guidance for correction
[Skip EDI - Help/Print/Initial Display Mode]
The cargo status is pending or contains validation errors → EDI transaction generation is bypassed to prevent transmission of incomplete data
[Call GCCS309 Service - Standard Processing]
The port is invalid:
the cargo type is not Export/US-Canada-US/Multi-transit
→ The cargo is routed to GCCS309 service for standard EDI processing
[Auto-Assign Amendment Code '01']
No amendment code is present in the cargo data → Amendment code '01' is automatically assigned to the transaction
[Display Error Message]
The user needs to understand what validation failed → The system displays the appropriate error message describing the validation failure in business terms
[Generate Range Error Message]
The value falls outside the acceptable range limits → A range validation error message is generated and the cursor is positioned on the error field
[Generate Field-Specific Error Message]
An error message is generated → A field-specific error message is created indicating the nature of the validation failure
[Position Cursor on Error Field]
Cursor positioning is performed → The screen cursor is positioned on the field that failed validation to guide user correction
[Return to Screen with Error]
Screen return processing is initiated → Control returns to the user screen with error messages displayed and cursor positioned for correction
[Date Format Valid?]
The system validates the date format using ISCDATCV utility → The system accepts valid date formats and rejects invalid formats with appropriate error message
[Fatal Error Processing]
The CCN generation service fails to create a valid CCN → The system initiates fatal error processing and displays appropriate error message
[CCN Update Successful?]
The CCN update process completes → The system checks if the update was successful and either sets success message or displays error
[Display Error Message]
Either CCN generation or CCN update operations fail → The system displays an error message to inform the user of the processing failure
[Extract Harmonized Codes with J Qualifiers]
Processing harmonized code data with J qualifiers → Move harmonized code to working storage array only if the qualifier equals 'J' for customs classification purposes
[Validate Geographic Information]
The system validates the provided state code → State code must be valid or transfer validation fails with error message
[AC Table Lookup]
The system performs validation against the AC reference table → The amendment code is accepted if it exists in the AC table, otherwise an error message 4036 is displayed
[Reject Delete Request]
The system validates the delete reason → The delete request is rejected and an appropriate error message is displayed to the user
[Equipment Car Number Changed?]
Equipment car number field has been changed from its original value → Special equipment car validation process is triggered before proceeding with general field comparison
[Validate Data Consistency]
System performs comprehensive validation of all cargo segments → System validates root segment with all segments, S05 segment, C4 line release with duplicate checking, S07 commodity data, S03 entity data, S06 VIN data, and S02 segment in sequential order, and routes user to appropriate screen based on error field type if validation fails
[Return Error to User]
The system needs to notify the user of the failure → The system returns a user-friendly error message indicating TRIEX load number assignment failure
[Stay on Current Screen - Boundary Reached]
User presses PF01 (Page Backward) function key → System remains on Screen 1 and displays message indicating no previous screen available
[Stay on Current Screen - Boundary Reached]
User presses PF02 (Page Forward) function key → System remains on Screen 4 and displays message indicating no next screen available
[Stack Error Handling Default Return Path]
Stack error handling is initiated → A default return path is implemented and working storage is cleared before proceeding
[Clear Error Handling Fields]
The transition type is error recovery → All error arrays, error flags, error message buffers, and error tracking variables are reset to initial state
[Return Error]
The database update operation fails or encounters an error → The system returns an error status and does not proceed with EDI transmission or notifications
[Validate Temporary CCN]
The system checks if the CCN is temporary or invalid → Temporary CCNs are rejected with error message and valid CCNs proceed to processing
[Validate Cargo Data]
The system validates all cargo segments → All cargo segments including root, commodity, entity, VIN, and hazmat data are validated for completeness and accuracy
[Display Error Message]
The system encounters validation errors → An appropriate error message is displayed indicating the validation failure
[Validate Waybill ID Entry]
The waybill ID field is empty or contains invalid format → The system displays an error message and prevents cargo creation
[Cargo Already Exists?]
A cargo record with the same waybill ID already exists in the system → The system displays an error message and prevents duplicate cargo creation
[Display Error Message]
User notification is required → The system displays specific error messages indicating the reason for failure
[Validate Manual CCN Entry]
The system validates the CCN format and availability → The system either accepts the CCN for cargo creation or rejects it with appropriate error message
[Delete Reason Code Provided?]
The system checks for delete reason code in the action request → If no delete reason code is provided, display error message and stop deletion process
[Display Error Message]
The system displays error message → Show specific error message indicating why deletion cannot proceed and return to previous screen
[Set Invalid Port Error]
The system processes the failed validation → System sets SW-NOT-VALID-PORT flag to true AND generates appropriate error message
[Reason Code Valid?]
The system validates the release reason code → The system accepts valid reason codes and rejects empty, spaces, or ignored values with error message
[Display Authorization Error]
System processes authorization failure → System displays authorization error message and terminates release processing
[Display Status Error]
System processes status validation failure → System displays status error message indicating cargo cannot be released in current state
[Display Multi-Car Error]
System processes multi-car validation failure → System displays multi-car error message indicating follower manifests cannot be released independently
[Display Train Error]
System processes train attachment validation failure → System displays train error message indicating cargo must be attached to train before release
[Display Duplicate Release Error]
System processes duplicate release validation failure → System displays duplicate release error message indicating cargo has already been processed
[Display Error Message - Unauthorized]
The system validates user permissions and finds insufficient privileges → An unauthorized error message is displayed and the operation is rejected
[INVALID-USER Level]
The user has INVALID-USER security level → The system denies permission and returns error message without checking function type or cargo status
[ERROR Status]
A user attempts to perform any function on the cargo → The system denies permission and displays cargo status error message
[SCAC Found in SS Table?]
The system checks if the SCAC code was found in the SS table → The system either proceeds with carrier information retrieval or displays error message 4185 if not found
[Display Error Message 4185]
The system displays error message 4185 → The system shows appropriate error message to inform user of SCAC validation failure
[Display Format Error]
The system displays format error → The system shows format error message and positions cursor on SCAC field for correction
[Set Error: Duplicate Export Not Allowed]
A regular export operation (not cancellation) is requested → The system sets an error indicating duplicate export is not allowed and displays error message to user
[Process 16 Harmonized Code Fields N10H5A through N10H5P]
Harmonized codes are validated → Each field must be 6-digit numeric format, right-justified, and properly assigned to commodity segments with 'J' qualifier
[Navigate to Error Page]
The error field is determined to be on a different page than currently displayed → The system navigates to the page containing the error field and updates the screen formatting messages to reflect the new page position
[Display Error Message to User]
The system displays the error information to the user → The system shows the relevant error message that describes the validation issue in business terms to guide user correction
[Error Field Type?]
If the error field name → The system classifies the field as N1 segment, harmonized code, commodity, hazmat, or AES/SED field type
[Set Error on Current Panel Flag]
The system confirms the error is on the currently visible panel → The system sets the current panel error flag to enable immediate cursor positioning without panel navigation
[Display Error Message]
The system displays error information to the user → The system shows relevant error message describing the validation failure for the VIN, factory car order, reference number, or description field
[Display Error Message]
The system is ready to present the error to the user → The validation error message is displayed to inform the user of the VIN field issue
[Position Error Message]
Displaying the validation error to the user → The system positions the cursor on the specific error field, applies error highlighting attributes, and displays the error message in the appropriate screen location
[Is Waybill ID Empty?]
The waybill ID field is empty or null → The system sets error code 4001, displays 'Waybill ID Required' message, positions cursor on WAYBILL field, and sets validation failed flag
[Is Waybill ID = 'IGNORE'?]
The waybill ID field contains the value 'IGNORE' → The system sets error code 4001, displays 'Waybill ID Required' message, positions cursor on WAYBILL field, and sets validation failed flag
[Check if Amendment Code Field is Empty]
The amendment code field (M1306) is empty or contains only spaces → The system displays error message 4001 indicating amendment code is required and positions cursor on the amendment code field
[Perform AC Table Lookup for Amendment Code]
The amendment code is looked up in the AC (Amendment Code) reference table → If the code is not found in the table, the system displays error message 4002 for invalid amendment code and positions cursor on the amendment code field
[Set Error Message 4032]
The destination city field is found to be empty → The system sets error message 4032 indicating missing destination city information
[Display Port Validation Error]
The system displays port validation error → The system must show a clear error message indicating the specific port validation failure and position the cursor on the port field
[Set Error Status and Position Cursor]
Error processing is initiated → System sets error status, positions cursor on first error field, and prepares error messages for display
[Check if Port Name Provided]
The port name field is empty or not provided → The system sets a port name required error and prevents the operation from proceeding
[Set Invalid Port Error]
The port name is not found in the SD table during validation lookup → The system sets an invalid port error and prevents the operation from proceeding
[Set Validation Error]
Error handling is initiated → The system sets validation error indicators and prepares appropriate error messages for user display
[Validate Amendment Code M1306]
The system validates the amendment code format and checks it against the AC table using GCCTBIO → The amendment code must be valid in the reference table, otherwise validation fails with appropriate error message
[Validate C4 Code Duplicates]
The system validates all C4 codes in the cargo record → No two C4 codes within the same cargo record can be identical, and if duplicates are found, validation fails with error message
[Validate C4 Code Format]
System validates the C4 code format → System accepts codes that meet format requirements and rejects codes with invalid format, displaying appropriate error messages
[Check for Duplicate C4 Codes in Array]
System checks for duplicate C4 codes within the cargo record → System identifies any duplicate codes and prevents processing, displaying error message for duplicate entries
[Validate Code-Quantity Relationship]
System validates the quantity associated with the C4 code → System accepts valid code-quantity combinations and rejects invalid relationships, displaying appropriate error messages
[Set Error on Duplicate C4 Field]
System processes validation results → System sets error indicator on duplicate C4 field and prepares error message
[Amendment Code Present?]
The amendment code field (M1306) is empty or not provided → The system should reject the operation and display an error message requiring amendment code entry
[Generate Validation Error]
VIN validation fails → Generate error 4168 with message about missing VIN data and position cursor on VIN field
[Validate All Cargo Data Segments S02-S07]
The system performs multi-segment validation → All segments are validated using GCCUSEDB, and if any validation fails, the system positions cursor on the first error field and routes user to appropriate screen based on error type
[Set Error Position for Segment Validation]
The system processes validation errors → User is routed to the appropriate screen (SCRN1 for basic data, SCRN2 for commodity/hazmat/AES, SCRN3 for entity data, SCRN4 for VIN data) and cursor is positioned on the first error field
[Remove Empty Hazmat Entries During Building]
Building hazmat arrays from S08 segments → Remove entries where hazmat code, description, or contact fields are empty and compress remaining data for efficient display
[Extract Harmonized Codes with J Qualifiers]
Building harmonized code arrays for customs processing → Extract only harmonized codes that have 'J' qualifiers and organize them into working storage arrays for tariff classification
[Message Spawned Successfully?]
System checks transmission status → Processing continues to audit record creation if successful, otherwise error handling is initiated
[Log Error and Continue]
Error handling is initiated → Error is logged for investigation and cargo processing continues without interruption
[Return Error - Unauthorized Detachment]
The system handles unauthorized detachment request → Error message is returned indicating unauthorized detachment attempt
[Check Bond Type Requirements]
System processes customs value calculation → System validates bond type requirements before proceeding with value calculations
[Handle Deletion Error]
The database service encounters an error during deletion process → The system returns a failure status indicating deletion was unsuccessful
[Merlin ID Valid?]
The system checks the provided Merlin ID against system records → The system either proceeds with print processing if Merlin ID is valid or displays an error message if invalid
[Broker Available?]
The system checks for broker information availability in the cargo record → The system either proceeds with broker data retrieval if broker is available or displays an error message if broker information is not available
[Display Error Message]
The system encounters validation errors during print processing → The system displays a specific error message indicating the reason for print request failure and terminates the print process
[Message Successfully Spawned?]
The system checks if message was successfully spawned → If message spawn was successful, clear message structure and continue, otherwise log error and continue process
[Log Error and Continue Process]
The system handles the spawn failure → Log the error information and continue with the cargo deletion process without stopping
[Message Found in Workflow Database?]
The database query is executed → The system should determine if the message exists and branch processing accordingly
[Set Error Status - Message Not Found]
The requested message does not exist in the database → The system must set an error status indicating the message was not found
[Clear Message Structure on Error]
The message was not found in the database → The system must clear the message structure to prevent processing of invalid data
[Deletion Successful?]
The system checks the deletion operation status → The system determines if the deletion was successful (SPACES or LOW-VALUES) or failed (error status)
[Set Error Status]
The GCCUSIO service returns an error status → The system sets error status indicators to reflect the deletion failure
[Validate Bond Type Code Format]
The system validates the bond type code format → The system should verify the code meets format requirements and proceed to lookup if valid, or display error message if invalid
[Display Error Message]
The system validates the bond type code format → The system should display an appropriate error message to inform the user of the invalid format
[Process Harmonized Codes with Qualifiers]
Processing commodity data conversion → Harmonized codes are processed with 'J' qualifiers and assigned to commodity segments with support for up to 2 codes per commodity line
[Generate Error Messages]
Processing validation results → Appropriate error messages are generated for each validation failure to inform the user of required corrections
[Set Field Error Message]
System validates the field → Error message is set indicating invalid numeric format
[Validate Key Uniqueness]
The system validates key uniqueness before database insertion → The system checks that each generated key is unique and does not conflict with existing database records
[Display Status Conversion]
Converting screen 1 data to database format → FIRMS code field must contain a valid value and cannot be empty
[Segment Has Data?]
Checking if the segment contains data → If the segment has data, proceed with key creation; if empty, skip key creation for that segment
[Set Error Message for Invalid Format]
The system processes the invalid car number → An error message is set indicating the car number format is invalid
[Return to Screen with Error]
The system completes error processing → The user is returned to the input screen with the error message displayed for correction
[Set Error for Invalid Waybill Key]
The system handles the error condition → An appropriate error message is set indicating the waybill key is invalid and cannot be used for cargo identification
[Set Validation Error - FIRMS Required for Immediate Transport, Set Validation Error - FIRMS Required for Immediate Export]
The system validates FIRMS code requirements → FIRMS code must be present or validation error is set
[Generate Validation Error]
The system generates validation errors → Appropriate error messages are created indicating the specific SCAC validation failure
[Validate VIN Format]
System validates the VIN format against standard requirements → System accepts valid VIN format or rejects invalid format with appropriate error message
[Validate Factory Car Order Format]
System validates the factory car order format → System accepts valid factory order format or rejects invalid format with appropriate error message
[Auto-Assign Amendment Code '01']
The amendment code field is empty or spaces → The system should automatically assign amendment code '01' as the default value
[Use Standard GCCS309 Service]
The port is invalid:
the cargo type is not Export, US-CAN-US
Multi-Transit
→ The system should use the standard GCCS309 EDI service for transmission
[Use Standard GCCS309 EDI Service]
The port is invalid:
the cargo type is not Export, US-CAN-US
Multi-Transit
→ The system uses standard GCCS309 EDI service
[Keep Existing Amendment Code]
The amendment code field (M1306) contains a valid non-empty value → The system retains the existing amendment code without modification and proceeds with EDI transmission
[Assign Amendment Code if Empty]
The amendment code field is empty or contains spaces → The amendment code must be defaulted to '01' to ensure proper EDI message formatting
[Check Entry Number 3 GCUSRT-M1203 vs SHIPU1-U103]
The system validates Entry Number 3 consistency between cargo record and SHIPMINU U1 segment → If Entry Number 3 is present in cargo record and SHIPMINU U1 segment and they match, set validation success flag and continue SHIPMINU processing. If Entry Number 3 is not present in cargo record, set validation success flag and continue processing. If Entry Number 3 is present in cargo record but not in SHIPMINU U1 segment, set validation success flag and continue processing. If Entry Number 3 values do not match, set validation error flag and block SHIPMINU operation
[Do Entry Numbers Match?]
The system compares the Entry Number 3 values from both sources → If the Entry Number 3 values match exactly, set validation success flag. If the Entry Number 3 values do not match, set validation error flag
[Log Bond Number Mismatch Error]
The bond number comparison fails → The system logs a bond number mismatch error and blocks the SHIPMINU operation from proceeding
[Bond Type Present?]
The system checks for bond type presence → If bond type is present, continue with U1 creation; if bond type is missing, set error status and terminate U1 creation
[Validate U1 Segment Data]
The system performs U1 segment validation → All required fields are verified for presence and proper format; missing or invalid data triggers validation failure
[Set Error Status]
The system processes the failure condition → Error status is set indicating U1 segment creation failure and appropriate error information is logged
[Internal Bond Type Present?]
The internal bond type field is evaluated for presence → If internal bond type is present, proceed with translation lookup, otherwise skip translation process
[Weight Data Available?]
The system accesses the cargo weight data from GCUSRT-M1115-WEIGHT field → The system determines if weight data is available or not available for further processing
[Is Tax Number Available?]
The system checks tax number availability → The system proceeds with tax number assignment if available, otherwise skips tax number processing
[Bond Type Code Present?]
The system checks for bond type code presence → If bond type code is not present, validation fails and error status is returned
[Validate Bond Type Code]
The system validates the bond type code format and value → The bond type code must conform to valid format specifications and contain acceptable business values
[Validate Entry Numbers]
The system validates entry numbers for the U1 segment → Entry numbers must conform to required format specifications and contain valid business content
[Validate Location Identifiers]
The system validates location identifiers for the U1 segment → Location identifiers must conform to required format specifications and reference valid business locations
[Validate Customs Values]
The system validates customs values for the U1 segment → Customs values must conform to required numeric format specifications and fall within acceptable business value ranges
[Validate Tax Reference Numbers]
The system validates tax reference numbers for the U1 segment → Tax reference numbers must conform to required format specifications and reference valid tax entities
[Return Error Status]
The system returns control to the calling process → Error status is returned to indicate that U1 segment validation was unsuccessful
[Is Broker Short Name Available?]
If the broker short name field (GCUSRT-RT50-OWNER) → The system determines if broker information is available for U2 segment population
[Is Custom Broker Field Empty?]
The system validates the field population → The system determines if the custom broker field contains valid broker information or is empty
[Validate Broker Field Length]
The system validates the field specifications → The broker field length is checked against maximum allowed length requirements
[Is Broker Short Name Available?]
The system checks for broker short name availability → The system evaluates if GCUSRT-M1115-BROKER-SHORT-NAME contains a value (not spaces or low-values)
[Is Custom Broker Field Available?]
The system checks for custom broker field availability → The system evaluates if additional custom broker information exists in the cargo data
[Validate U3 Segment Data]
The system validates the U3 segment data → All required fields are present and properly formatted
[Log U3 Creation Error]
The system logs the error → The error details are recorded for troubleshooting and audit purposes
[Validate CCN Format and Structure]
The system validates the CCN format and structure → The CCN is verified to meet business format requirements and structural integrity
[Insert Successful?]
The system checks the insert operation result → The system determines if the insert was successful or failed
[Handle Insert Error]
The insert operation returns an error status → The system handles the insert error appropriately
[Set Broker Error Flag]
The system sets broker error flag → Error flag is set to indicate broker validation failure and prevent U2 segment creation
[Return Error]
The system returns error status → Processing terminates with error status indicating U2 segment creation failure due to broker issues
[U3 Segment Data Complete?]
The segment data completeness is validated → All required fields (reference qualifier, code, number, key, sequence) are verified as complete
[Log Reference Creation Error]
An error condition is detected → The error is logged for troubleshooting and the process continues
[Operation Successful]
If the overall operation status → The operation is marked as successful and processing continues
[FWSWREQ Found?]
The system checks the retrieval result → If FWSWREQ segment is found, proceed with equipment ID extraction, otherwise indicate equipment waybill key not found
[Equipment ID Matches Cargo Equipment?]
The system compares the extracted equipment ID with cargo equipment → If equipment IDs match, proceed with waybill key retrieval, otherwise continue to next FWSWREQ segment

Module: GCX141 1 Consolidated Epic Story

Epic: GCX141 Complete EDI Specification Extracted from Legacy

Contains 123 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX141 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Page Limits Array]
The page limits array needs to be initialized → All 15 page limit entries are set to zero to prepare for report generation
[Reinitialize Fields for Next Message]
The system prepares for the next message → All working fields are reinitialized to their default state
[Initialize GCCUTRIO Parameters]
Preparing to call the GCCUTRIO module → The system should initialize GCCUTRIO parameters, train header, and segment data structures to ensure clean data state
[Initialize US Cargo Retrieval Parameters]
The system begins cargo retrieval process → All cargo retrieval parameters are initialized to default values and fetch-all flag is set to retrieve complete cargo segments
[Initialize Communication Settings]
The system needs to establish a communication session → Call CCISCOM to initialize the communication session with Merlin
[Initialize GCX101 Input Message]
The system needs to create a port change transaction → The system should initialize the GCX101 input message structure
[Initialize New Page Segment]
A new page segment needs to be created → The system initializes a new report line, adds a continuation marker, and increments the report line counter

Core Acceptance Criteria

[2:Process Input Messages]
Input messages are being processed → System continues processing until WS-NO-MORE-INPUT-MSG condition is true
[2:Process Input Messages]
Security validation is performed → If GCX141-SECURITY-BYTE is not equal to HIGH-VALUES, system terminates processing and returns control
[10:Format Customer Information]
Customer information formatting is performed → Extract shipper name from segments with shipper key sequence and consignee name from segments with consignee key sequence
[12:Format Bond Information]
Bond type code is evaluated → If bond type is 'IT', display 'IMPORT BOND'. If 'TE', display 'EXPORT BOND' and increment B13 counter. If 'IE', display 'IMMEDIATE EXPORT'. If 'TR', display 'US CAN US BOND'. If 'MT', display 'MULTI IT PORTS'. If none match, skip bond processing
[12:Format Bond Information]
Shipping value is available → If customs ship value is not blank, format value with default currency 'USD', then search for specific currency code in reference segments and update if found
[14:Format Export Permits]
Reference qualifier is evaluated → If reference qualifier is 'EP' or 'CW', increment EXP summary counter, format export permit line with permit number, and store permit number in hold area as summary record
[21:Spawn Manifest Release Transactions]
Audit trail creation is performed → Create GCT1051E transaction with message 'EXPORTED ON' plus train ID, set CCN as train or US CCN, mark as CA cargo type, set action code to 'ZZZ', capture current date and time, and send transaction
[Read Input Message from Queue]
A message retrieval is requested from the queue → The system reads the next message and updates the return code status
[Security Validation Passed?]
The system checks the security byte in the message → If security byte is not equal to HIGH-VALUES, access is denied and processing terminates
[Process Current Message]
The system begins processing the message content → The main business logic workflow is executed to handle the message
[More Messages Available?]
The system checks for additional messages in the queue → If no more messages are available, the no-more-input flag is set to terminate processing loop
[Set No More Input Messages Flag]
No more messages are found in the queue → The WS-NO-MORE-INPUT-MSG flag is set to true to exit the processing loop
[Clear Train Equipment Segments]
The system initializes data structures → The train equipment segments structure is cleared to ensure clean data loading
[Set Fetch All Segments Flag]
The system prepares to call the cargo retrieval module → Fetch-all flag is set to true and underscore movement flag is enabled to retrieve complete cargo segment data
[Call GCCUSIO2 Module with US CCN Key]
The system calls GCCUSIO2 module with the CCN key → The module is invoked with all required cargo segment parameters to retrieve comprehensive cargo data
[Load All US Cargo Segments]
The system processes the retrieved cargo data → All cargo segments including customer information, reference numbers, names and addresses, hazmat data, and cargo descriptions are loaded from array positions into working storage
[Set Cargo Found Status]
The system completes cargo data loading process → Cargo found status flag is set to true to indicate valid cargo data is available for processing
[Set Fetch All Segments Flag]
The system needs to retrieve complete cargo information → The fetch all segments flag is set to true, move underscore flag is enabled, function is set to get unique operation, and index usage is disabled
[Call GCCUSIO2 Module]
The system needs to retrieve cargo data for a specific CCN key → The GCCUSIO2 module is called with all required parameters including segment arrays for customer, reference, commodity, hazmat, equipment, and description data
[Move Segment Data to Work Areas]
The system processes the retrieved data → Customer data (GCSUSS03), reference data (GCSUSS06), commodity data (GCSUSS07), hazmat data (GCSUSS08), equipment data (GCSUSS09), and description data (GCSUSS12) are moved to their respective working storage areas
[Call GCCUSIO2 to Retrieve All Cargo Segments]
The system calls the cargo retrieval service GCCUSIO2 with fetch-all parameters → All cargo segments are retrieved including customer, reference, commodity, weight, quantity, and description data
[Move GCSUSS03 Customer Data to Work Area]
The system processes the first customer segment → Customer data from GCSUSS03 segment is moved to the working storage area
[Move GCSUSS06 Reference Data to Work Area]
The system processes the first reference segment → Reference data from GCSUSS06 segment is moved to the working storage area
[Move GCSUSS07 Commodity Data to Work Area]
The system processes the first commodity segment → Commodity data from GCSUSS07 segment is moved to the working storage area
[Move GCSUSS08 Weight Data to Work Area]
The system processes the first weight segment → Weight data from GCSUSS08 segment is moved to the working storage area
[Move GCSUSS09 Quantity Data to Work Area]
The system processes the first quantity segment → Quantity data from GCSUSS09 segment is moved to the working storage area
[Move GCSUSS12 Description Data to Work Area]
The system processes the first description segment → Description data from GCSUSS12 segment is moved to the working storage area
[Set Cargo Found Status]
All cargo segments have been processed successfully → The cargo found status indicator is set to true
[Save Current Manifest Data]
The system prepares to process related manifests → The current cargo report segment and CCN are saved to working storage for later restoration
[Restore Original Manifest Data]
The system finishes processing all related manifests → The saved cargo report segment is restored to continue with the original manifest processing
[Create GCT1051E Release Transaction]
All release processing is complete → A GCT1051E transaction is created with export message, CCN, release details, and system timestamp for audit trail
[Save Current Manifest Data]
The system begins multi-manifest processing → Save the current cargo report segment to WS-SAVE-GCSCCRT and save the master manifest CCN to WS-SAVE-CCN
[Restore Original Manifest Data]
The system completes multi-manifest processing → Move WS-SAVE-GCSCCRT back to GCCC-CARGO-REPORT-SEGMENT to restore original manifest data
[Multi-Manifest Scenario Detected?]
The system checks if the manifest is multi-manifest type AND the manifest has been exported → The system saves current manifest data and initiates follower manifest processing
[Save Current Manifest Data]
The system needs to process follower manifests → The current cargo report segment and master manifest CCN are saved for later restoration
[Restore Original Manifest Data]
The system completes the multi-manifest processing → The saved cargo report segment is restored to continue with original manifest processing
[Loop Through Customer Data Segments]
The system processes customer information → The system loops through customer data segments from 1 to 4 sequentially
[Read Customer Segment Data]
The system processes a customer segment → The customer segment data is moved from the array to the working segment structure
[Extract Shipper Name]
The customer segment key sequence indicates shipper data → The shipper name is extracted and moved to the report shipper field
[Extract Consignee Name]
The customer segment key sequence indicates consignee data → The consignee name is extracted and moved to the report consignee field
[Check Bond Type Code]
The bond type code is 'IT', 'TE', 'IE', 'TR', 'MT', or any other value → The system displays the corresponding bond type description: 'IT' shows '*IMPORT BOND :', 'TE' shows '*EXPORT BOND :', 'IE' shows '*IMMEDIATE EXPORT:', 'TR' shows '*US CAN US BOND :', 'MT' shows '*MULTI IT PORTS :', and any other value exits without display
[Returned Goods or Master In-Bond?]
The cargo is returned goods:
(master in-bond AND US-Canada-US bond type)
→ The system displays 'FGN CARRIER DOC REQUIRED' message and sets summary record flag
[Format Immediate Export IE]
The bond information formatting process is executed → The bond type should be formatted as '*IMMEDIATE EXPORT:' and the appropriate bond number should be assigned
[Loop Through Reference Data Segments]
The system loops through all available reference data segments up to the maximum occurrences → Each reference data segment is evaluated for export permit and document processing
[Reference Qualifier = 'EP' or 'CW'?]
The reference number qualifier equals 'EP' or 'CW' → The segment is identified as containing export permit information
[Extract Commodity Code from Cargo Data]
The system needs to process special export forms → The commodity code is extracted from the first GCSUSS07 data segment and moved to GCSUSS07 working storage
[Update Summary Counts in Report Lines]
The system prepares the report for transmission → Move WS-SUMMARY-B13 to the B13 summary line, WS-SUMMARY-EXP to the EXP summary line, and WS-SUMMARY-INTRANSIT to the INTRANSIT summary line in the report
[More Report Pages?]
The system checks for remaining pages → Continue processing while the next page line limit is not zero, indicating more pages exist
[Create Subject with Report Number]
The system creates the email subject line → Concatenate the header line 3 content with ' RPT ' and the message counter to create a numbered subject line
[Use Standard Subject Line]
The system creates the email subject line → Use the header line 3 content as the subject line without additional numbering
[Send Page to Merlin via EMCSEND2]
The system sends the page to Merlin → Call EMCSEND2 with communication session, user codes, destination filename, subject line, and formatted report content
[Increment Message Counter]
The transmission is completed → Add 1 to the message counter to track the total number of messages sent
[Clean Up Message Queue]
The system needs to clean up resources → Initialize the accept status and call CIMS with PURG function to clean up the message queue
[Format Subject with Report Number]
The system formats the email subject line → The subject line should include the train header information, the text 'RPT', and the current message counter number
[Use Standard Subject Line]
The system formats the email subject line → The subject line should contain only the standard train header information without any sequence numbering
[Clear Report Work Area]
The system begins the page transmission process → The report work area must be cleared of any previous data
[Copy Report Lines to Work Area]
The system prepares report data for transmission → Only the lines within the current page limits should be copied to the transmission work area with proper indexing
[Call EMCSEND2 Communication Module]
The system initiates the transmission to Merlin → The EMCSEND2 module should be called with all required parameters including sender, destination, subject, and report content
[Increment Message Counter]
The transmission process completes → The message counter must be incremented by 1 to track the sequence for subsequent pages
[Increment Line Counter]
Each summary record is processed and added to the email → The email line counter is incremented to track total lines in current email segment
[Lines > 698?]
The line count reaches more than 698 lines → The system determines that the current email segment must be sent and a new segment must be started
[Set No More Email Flag]
The line limit check is performed → The no-more-email flag is set to false and more-email flag is set to true to trigger segment completion
[Reset Line Counter to Zero]
A new email segment needs to be started → The line counter is reset to zero to begin counting lines for the new segment
[Increment Mail Counter]
The system needs to start a new email segment → The mail counter is incremented by 1 to track the sequence number of email segments
[Mail Counter > 1?]
The mail counter is evaluated → If mail counter is greater than 1, sequential numbering is required in the subject line
[Update Subject with Sequential Number]
The email subject line needs to be updated → The subject line is updated to include the train header information, 'SUMMARY RPT', and the mail counter number
[Send Current Email Segment]
The email segment needs to be transmitted → The email is sent using EMCSEND2 with sender OM01247, destination EXPORT, and the formatted subject and content
[Reset Email Content]
A new email segment needs to be prepared → Email text content is cleared and email parameters are reset for the next segment
[Add Header to New Email]
The new email content is being initialized → The summary header is added as the first line of the new email segment and email line counter is set to 1
[Final Email Needed?]
The system determines if final email transmission is needed → If more-email flag is true, indicating content exists in the current segment, a final email transmission is required
[Update Final Subject with Counter]
The final email subject line is being prepared → The mail counter is incremented by 1 and the subject line includes train header, 'SUMMARY RPT', and the updated counter number
[Send Final Email Segment]
The final email transmission is initiated → The final email is sent using EMCSEND2 with all email parameters and the complete remaining summary content
[Create Export Transaction Message]
The manifest status has been updated in the database → The system creates a transaction message with 'EXPORTED ON' plus train ID, CCN key, action code 'ZZZ', and current date/time
[Send Transaction to Queue]
The message is ready for transmission → The system sends the message to the transaction queue and purges the message buffer
[Save Current Manifest Data]
The system begins follower processing → The current cargo report segment is saved and the master manifest CCN is stored for reference
[Restore Original Manifest Data]
The follower processing loop ends → The saved original cargo report segment is restored to continue with the main manifest processing
[Call Database with GU Function]
The system executes a Get Unique database call with equipment positioning → The database should be accessed using GU function with the cargo report segment and equipment-based search criteria
[Call Database with GHU Function]
A Get-Hold-Unique database call is executed → The database should retrieve the cargo report segment with exclusive lock using GHU function
[Build Export Message with Train ID]
The system builds the transaction message → The message contains 'EXPORTED ON ' followed by the train ID
[Write Transaction Message]
The system performs logging operations → The transaction message is written to the log using WRITMSGL with message code, content, length and module name
[Set Security Byte to High Values]
Security authorization is required for the transaction → The system should set the security byte to high values to authorize the operation
[Move Canadian CCN to Message]
The port change transaction requires cargo identification → The system should move the Canadian CCN key to the transaction message CCN field
[Move Border Station Name from Train]
The transaction requires border station identification → The system should move the US border station name from train data to the transaction border name field
[Move Border Station Code from Train]
The transaction requires border station code identification → The system should move the US border station code from train data to the transaction border code field
[Prepare GCT1011E Message]
The system needs to format the transaction for transmission → The system should move the GCX101 input data to the GCT1011E message format
[Send Transaction to Message Queue]
The transaction is ready for processing → The system should send the transaction to the message queue using CHNG operation
[Send Current Email Segment]
The system sends the current email segment → EMCSEND2 is called with email parameters, email text is reset to spaces, line counter is reset to 1, and summary header is added to new email
[Send Final Email Segment]
The system completes summary processing → EMCSEND2 is called with final email parameters and content
[Current Report Lines > 650?]
The current page line count exceeds 650 lines from the page starting limit → The system creates a new page segment with continuation markers and increments the page index
[Increment Page Index]
The page continuation process is executed → The system increments the page index by 1 and sets the current report line counter as the line limit for the new page
[Format New Report Header]
The page setup is being completed → The system generates a complete report header for the new page segment
[Move Page Data to Merlin Format]
The system processes each page from the current page index until the next page line limit → The system moves each report line to the Merlin report format and calculates the appropriate line position within the page segment
[Generate Sequential Subject Line]
The message counter is greater than 1 → The system creates a subject line by concatenating the report header with 'RPT' and the message counter number
[Use Standard Subject Line]
The message counter equals 1 indicating a single page report → The system uses the standard report header as the email subject line without additional numbering
[Send Page Segment to Merlin]
The page is ready for transmission → The system calls the email service to send the page segment to Merlin with all required parameters including sender, destination, subject, and report content
[Increment Message Counter]
The transmission is completed → The system increments the message counter by 1 to track the next page segment
[ST Table Lookup Successful?]
The lookup operation completes → If the lookup is successful, the system should move table segment data to GCSTBRT structure, otherwise set the structure to spaces

Structural Validations

[3:Retrieve Train List Data]
Train ID validation is performed → If GCX141-TRAIN-ID is blank, system sets error message 'BLANK TRAIN ID PASSED TO PGM GCX141' and abends
[3:Retrieve Train List Data]
Error conditions are encountered → If invalid parameters are passed, system abends with 'INVALID PARM PASSED TO MODULE GCCUTRIO'. If more than 2500 equipment items exist, system abends with 'MORE THAN 2500.' message. If train list is not found, system abends with 'TRAIN LIST NOT FOUND' message
[14:Format Export Permits]
Export qualifier validation is performed → If reference qualifier is a valid export qualifier, format export document line with document number
[Message Retrieved Successfully?]
The system checks the return code from the message queue operation → If return code is zero, message retrieval is successful, otherwise no message is available
[System Return Code OK?]
The system checks the overall return code status → If return code is not zero, an error condition exists and error handling is invoked
[Exit with Security Error]
The security byte equals HIGH-VALUES indicating unauthorized access → The system immediately exits processing without further action
[Train ID Provided?]
The train ID field is blank or empty → The system should Throw error: 'BLANK TRAIN ID PASSED TO PGM GCX141' and terminate processing
[Error: Invalid Parameters]
The module returns an invalid parameter status → The system should generate error message 'INVALID PARM PASSED TO MODULE GCCUTRIO' and terminate processing
[Error: Too Many Equipment Items >2500]
The train contains more than 2500 equipment items → The system should generate error message with train ID and 'MORE THAN 2500.' and terminate processing
[Error: Train List Not Found]
The GCCUTRIO module cannot find the specified train → The system should generate error message 'TRAIN LIST NOT FOUND' with the train ID and terminate processing
[Validate Train ID Input]
The train ID field is blank or empty → The system should reject the request with error message 'BLANK TRAIN ID PASSED TO PGM GCX141' and terminate processing
[Set Error: INVALID PARM]
The module returns GCWUTRIO-INVALID-PARM status → The system should set error message 'INVALID PARM PASSED TO MODULE GCCUTRIO' and terminate processing with system abend
[Set Error: MORE THAN 2500 EQUIPMENT]
The module returns GCWUTRIO-TO-MANY-EQP status indicating more than 2500 equipment items → The system should set error message 'MORE THAN 2500.' with the train ID and terminate processing with system abend
[Set Error: TRAIN LIST NOT FOUND]
The module returns GCWUTRIO-NOT-FOUND status → The system should set error message 'TRAIN LIST NOT FOUND' with the train ID and terminate processing with system abend
[System Error - Cargo Retrieval Failed]
The system detects cargo retrieval failure → An error message is constructed containing the failure code and message, and the system performs abnormal termination
[Build Error Message]
The system processes the failure condition → An error message is built containing 'GCCUSIO2 FAILED RC=' followed by the error number and error message, system abend is performed, and cargo not found status is set
[Handle Cargo Retrieval Error]
The system detects the cargo retrieval failure → An error message is constructed with the error number and message details and the system terminates processing
[Valid Export Document Qualifier?]
The reference qualifier is checked against valid export qualifier codes → The system determines if the qualifier represents a valid export document type
[Log Error Message]
The transmission is not successful → Set error message to 'SEND TO MERLIN FAILED' and call CERR to log the error

Module: GCX148 1 Consolidated Epic Story

Epic: GCX148 Complete EDI Specification Extracted from Legacy

Contains 312 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX148 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[1:Initialize Program Fields]
The system initializes program fields → Work areas are cleared, system date and time are captured, user security table is retrieved, and table segments are initialized
[Initialize Empty US Table Data]
Table retrieval return flag indicates unsuccessful operation → US segment storage area is initialized to empty state
[Initialize EDI Segments]
The system begins creating EDI transmission segments → All EDI segments are initialized and assigned their standard three-character identifiers (ST, BGM, DTM, RFF, LOC)
[Initialize Transmission Segment]
The transmission segment needs to be prepared → The transmission segment is initialized to clear any previous data
[Initialize Transmission Root Segment]
The root segment is prepared → The transmission root segment is initialized with default values
[Initialize Transmission Segment]
The transmission segment is being prepared → The transmission segment is initialized with default values including transmission number, read-and-delete flag as spaces, and transaction set as REP
[Initialize Transmission Segment]
The CCN key equals '6105ETEST999999999999' → The transmission number is set to 'CUSREPCCRA', read-and-delete flag is set to spaces, transaction set is set to REP, and accept status is set to spaces
[Initialize Transmission Segment]
The CCN key is not '6105ETEST999999999999' → The transmission number is set from generated value, read-and-delete flag is set to spaces, transaction set is set to REP, and accept status is set to 'II'
[Initialize AU Segment to Spaces]
The table lookup operation fails to find matching configuration → The system initializes the AU segment to spaces indicating no automotive release configuration is available
[Initialize EDI Segments ST, BGM, DTM, RFF, LOC]
The system begins creating EDI segments → All segments (ST, BGM, DTM, RFF, LOC) are initialized and their identifiers are set to proper values
[Initialize Transmission Root Segment]
The system initializes the transmission segment → The transmission root segment should be cleared and ready for data population
[Initialize EDI Segments ST, BGM, DTM, RFF, LOC]
The system begins EDI message preparation → All EDI segments (ST, BGM, DTM, RFF, LOC) are initialized and assigned their respective identifiers
[Initialize EDI Segment Structures]
EDI segments need to be created for train arrival notification → All EDI segment structures are initialized and standard segment identifiers are set (ST, BGM, DTM, RFF, LOC)
[Initialize Key Values and Flags]
The system initializes lookup parameters → All key values, dependent key values, second PCB flag, and unqualified SSA flag are set to spaces
[Initialize EDI Segment Structures]
The system begins creating train EDI segments → All EDI segment structures are initialized and standard segment identifiers are set (ST, BGM, DTM, RFF, LOC)
[Initialize Broker Segment]
The system handles the lookup failure → The broker configuration segment is initialized to clear any existing data
[Initialize Empty Broker Configuration]
No valid broker configuration can be retrieved → Initialize both broker segment and B1 segment to empty values and continue processing
[Initialize AU Segment as Empty]
The table return flag indicates unsuccessful retrieval → The automotive release segment is initialized to spaces indicating no configuration found
[Initialize Empty Configuration]
The lookup does not return successful status → Initialize the automotive release segment structure with spaces
[Initialize Empty Broker Configuration]
No broker configuration is found in the system → The system initializes empty broker configuration segments and continues processing
[Initialize AU Segment as Empty]
The lookup does not return successful status → The AU segment is initialized to spaces indicating no configuration found

Core Acceptance Criteria

[2:Read Input Message]
The system reads the input message → The message content is loaded into the input structure for validation and processing
[4:Process Canadian Cargo Arrival]
The system processes the Canadian cargo arrival → Action codes are normalized, cargo information is retrieved, EDI segments are created, and arrival status is updated
[9:Create EDI Transmission Segments]
The system creates EDI transmission segments → ST, BGM, DTM, RFF, and LOC segments are populated with cargo arrival information
[10:Generate Transmission Number]
The system generates a transmission number → A unique transmission number is created using prefix 148 and machine time, with special handling for test CCN
[11:Store Transmission Data]
The system stores transmission data → Transmission root and dependent segments are created with sequential numbering
[12:Update Cargo Arrival Status]
The system updates cargo arrival status → Arrival indicator is set to Y, arrival date and time are recorded, and original arrival date is preserved if not previously set
[14:Send EDI Message]
The system sends the EDI message → EDI transmission is queued for delivery to customs system
[15:Create Customer Report]
The system creates customer report → Customer arrival report is generated with CCN, action type, and CA designation
[17:Process Canadian Train Arrival]
The system processes the Canadian train arrival → Train EDI segments are created, border port is validated, train car list is retrieved, and each car is processed
[18:Create Train EDI Segments]
The system creates train EDI segments → ST, BGM, DTM, RFF, and LOC segments are populated with train arrival information and function code 9
[9:Create EDI Transmission Segments]
The system sets document message type → If action code is CAA or MAA, set to ARRIVAL; otherwise set to BILL-QUERY
[9:Create EDI Transmission Segments]
The system sets date-time information → If input date-time is not spaces, use input value; otherwise concatenate machine century, date, hour, and minute
[9:Create EDI Transmission Segments]
The system checks for sub-location code → If cargo sub-location code is not spaces or low-values, set code list qualifier to 129 and place sub-location in LOC place field
[10:Generate Transmission Number]
The system checks CCN key → If CCN key is 6105ETEST999999999999, set transmission number to CUSREPCCRA and clear accept status; otherwise use generated transmission number and set accept status to II
[12:Update Cargo Arrival Status]
The system checks action code for arrival update → If action code is CAA or MAA, set arrival indicator to Y, set arrival date from DTM segment, set arrival time from machine time, and preserve original arrival date if not previously set
[13:Log Cargo Activity]
The system determines message content → If already arrived and action is CAA, message is 'CARGO RE-ARRIVAL AUTOMATICALLY AT [PORT]'; if already arrived and action is MAA, message is 'CARGO RE-ARRIVAL MANUALLY AT [PORT]'; if not arrived and action is CAA, message is 'CARGO ARRIVAL AUTOMATICALLY AT [PORT]'; if not arrived and action is MAA, message is 'CARGO ARRIVAL MANUALLY AT [PORT]'; otherwise message is 'RELEASE INFO REQUESTED FROM CCRA'
[16:Update Iron Highway System]
The system checks Iron Highway configuration → If origin station number exists in IH table, populate Iron Highway record with record type, ARRIVED status, car ID, waybill, CCN, and shipment ID from N9 segments with CN qualifier
[33:Trigger Auto Release]
The system triggers auto release → Set message ID to GCW123, set export release type, populate CCN key, clear release quantity, and spawn release transaction
[Retrieve US Table Segment]
Table segment retrieval is requested → System calls table I/O service to retrieve US table segment data
[Store US Table Data]
Table retrieval return flag indicates successful operation → Retrieved table segment data is moved to US segment storage area
[Read Message into GCX148-INPUT Buffer]
The system initiates message reading process → The message is read into GCX148-INPUT buffer and message length is captured in INPUT-MESSAGE-LENGTH
[Set Processing Path to Canadian Cargo]
The input code indicates Canadian cargo processing (GCX148-CA-CARGO is true) → The system should route to Canadian cargo processing routine (B300-CA-CARGO-ROUTINE)
[Set Processing Path to Canadian Train]
The input code indicates Canadian train processing (GCX148-CA-TRAIN is true) → The system should route to Canadian train processing routine (B400-CA-TRAIN-ROUTINE)
[Retrieve Cargo Information]
The system needs cargo information for arrival processing → The system retrieves all cargo segments and related data using the CCN key
[Skip Manual/Pending Cargo]
The cargo status indicates manual handling or delivery pending → The system terminates cargo processing without creating transmissions or notifications
[Create EDI Transmission Segments]
Creating customs transmission → The system initializes and populates ST, BGM, DTM, RFF, and LOC segments with cargo arrival data including destination, transaction type, date/time, reference number, and location
[Generate Transmission Number]
A transmission number is needed for the customs message → The system generates a transmission number using prefix 148 and machine time, with special handling for test CCN 6105ETEST999999999999 using CUSREPCCRA
[Store Transmission Data]
Storing transmission data → The system creates dependent segments for ST (00001), BGM (00002), DTM (00003), RFF (00004), and LOC (00005) in sequence
[Update Cargo Arrival Status]
The action code is CAA (Cargo Arrival Automatic) or MAA (Manual Arrival Automatic) → The system sets arrival indicator to Y, updates arrival date from DTM segment, and sets arrival time from machine time
[Send EDI Message]
Sending the EDI message → The system spawns GCT1211E transaction with the transmission number to send the message to customs
[Create Customer Report]
Creating customer report → The system creates GCX140 report with CCN, ARR action, and CA type for customer notification
[Process Shipment Reference Numbers]
Processing reference numbers up to 10 N9 segments → The system searches for N901 reference qualifier CN and extracts the corresponding N902 reference number as shipment ID
[Build ST Segment - Set Destination and Transaction]
The ST segment is being built → The destination is set to 'CACUSTOMS-UNH-O' and transaction type is set to 'REP'
[Set BGM to ARRIVAL or BILL-QUERY]
The action code is 'CAA' or 'MAA' → The document message name is set to ARRIVAL, otherwise it is set to BILL-QUERY
[Build BGM Segment - Set Document Message Name]
The BGM segment is being built → The document message name is set to TRAIN-ARRIVAL and the document message function is set to '9'
[Use Input Date/Time]
The input contains a non-blank date-time value → The input date-time is used for the DTM segment date-time field
[Use System Date/Time]
The input date-time is blank or spaces → The system concatenates machine century, date, hour, and minute to create the DTM date-time value
[Build DTM Segment - Set Date/Time Information]
The date-time qualifiers need to be set → The date-time qualifier is set to '132' and the date-time format is set to '203'
[Set RFF Reference Qualifier to ABT]
The RFF segment is being built → The reference qualifier is set to 'ABT' and the reference value is set to the train or US CCN
[Set RFF Reference Qualifier to ABY]
The RFF segment is being built → The reference qualifier is set to 'ABY' and the reference value is set to the train or US CCN
[Set LOC Location Qualifier to 14]
The location qualifier needs to be set → The location qualifier is set to '14'
[Set Port Code from Input]
The LOC segment location code needs to be set → The location code is set to the port code from the input message
[Lookup Border Port from Station Name]
The border port code needs to be determined → The system looks up the station name in the MC table and uses characters 2-4 of the Canadian customs code as the location code, or generates an error if lookup fails
[Add Sub-Location Code to LOC Segment]
The cargo has a non-blank and non-low-values sub-location code → The code list qualifier is set to '129' and the place field is set to the sub-location code
[Set Document Message Name to ARRIVAL]
The action code is 'CAA' (Cargo Arrival Automatic) or 'MAA' (Manual Arrival Automatic) → The document message name is set to ARRIVAL in the BGM segment
[Set Document Message Name to BILL-QUERY]
The action code is not 'CAA' (Cargo Arrival Automatic) and not 'MAA' (Manual Arrival Automatic) → The document message name is set to BILL-QUERY in the BGM segment
[Set Document Message Name to TRAIN-ARRIVAL]
The processing type is train arrival → The document message name is set to TRAIN-ARRIVAL in the BGM segment
[Set Document Message Function to '9']
The document message name has been set to TRAIN-ARRIVAL → The document message function is set to '9' in the BGM segment
[Check Action Code - Evaluate input action code (CAA, MAA, or other codes) and determine appropriate document message type for EDI transmission]
The action code is 'CAA' (Cargo Arrival Automatic) or 'MAA' (Manual Arrival Automatic) → The document message type is set to 'ARRIVAL' for the EDI BGM segment
[Check Action Code - Evaluate input action code (CAA, MAA, or other codes) and determine appropriate document message type for EDI transmission]
The action code is not 'CAA' or 'MAA' → The document message type is set to 'BILL-QUERY' for the EDI BGM segment
[Set Transmission Prefix to 148]
The system initiates transmission number creation → The transmission prefix is set to 148
[Use Machine Time as Base Number]
The system needs to create a unique identifier → The machine time is used as the base number component
[Is Test CCN Key?]
The CCN key equals '6105ETEST999999999999' → The system identifies this as test environment processing
[Set Fixed Test Transmission Number 'CUSREPCCRA']
A transmission number is needed → The transmission number is set to 'CUSREPCCRA' and spaces are assigned to read-and-delete flag
[Create Dynamic Transmission Number from Prefix + Time]
A transmission number is needed → The transmission number is created by combining the transmission prefix with the time-based number and accept status is set to 'II'
[Set Transaction Type to 'REP']
The transaction type needs to be specified → The transaction set is set to 'REP'
[Attempt to Create Transmission Root]
The system needs to create the transmission record → The system calls the database insert function to create the transmission root
[Increment Time-Based Number]
A new unique number is needed → The time-based number component is incremented by 1
[Retry with New Number]
The system needs to retry transmission creation → The transmission number is updated and the creation process is repeated
[Generate Transmission Number]
The system generates transmission number → The transmission number is set with prefix 148 and current machine time
[Set Transmission Prefix to 148]
The transmission prefix is set → The prefix is set to 148
[Use Machine Time for Number]
The system creates the number → The current machine time is used as the transmission number base
[Test CCN Key?]
The CCN key equals '6105ETEST999999999999' → The transmission number is set to 'CUSREPCCRA' and read-and-delete flag is set to spaces
[Set Production Transmission Number]
The CCN key is not the test key '6105ETEST999999999999' → The transmission number is set to generated value and accept status is set to 'II'
[Set Transaction Type to REP]
The transaction type is set → The transaction set is set to 'REP'
[Create Transmission Root Record]
The root record is created → The transmission root segment is inserted into the database
[Root Creation Successful?]
The root creation fails (status code is not space) → The transmission number is incremented by 1 and root creation is retried
[Create ST Segment Record]
ST segment is created → ST segment data is stored with sequence number '00001'
[Create BGM Segment Record]
BGM segment is created → BGM segment data is stored with sequence number '00002'
[Create DTM Segment Record]
DTM segment is created → DTM segment data is stored with sequence number '00003'
[Create RFF Segment Record]
RFF segment is created → RFF segment data is stored with sequence number '00004'
[Create LOC Segment Record]
LOC segment is created → LOC segment data is stored with sequence number '00005'
[Generate Initial Transmission Number]
The system generates an initial transmission number → The transmission number is set with prefix 148 and current machine time
[Set Transmission Prefix to 148]
The transmission prefix needs to be set → The prefix is set to 148
[Set Transmission Number from Machine Time]
The system creates the transmission number → The machine time is used as the transmission number component
[Set Transaction Type to REP]
The transaction type needs to be set → The transaction set is set to REP for reporting purposes
[Attempt to Create Transmission Root]
The system attempts to create the transmission root → The transmission root creation is attempted using database insert operation
[Increment Transmission Number]
The system needs to generate a new transmission number → The transmission number is incremented by 1
[Retry Create Transmission Root]
The system retries creating the transmission root → The transmission root creation is attempted again with the new transmission number
[Duplicate Number Detected?]
Each retry attempt is evaluated → The process continues until the status code equals space indicating successful creation
[Generate Initial Transmission Number]
The system generates an initial transmission number → The transmission number should be composed of prefix 148 concatenated with the current machine time
[Create Transmission Root Record]
Creating a transmission root record → The transmission number should be set to 'CUSREPCCRA', read and delete flag should be spaces, transaction set should be 'REP', and accept status should be spaces
[Create Transmission Root Record]
Creating a transmission root record → The transmission number should use the generated transmission number, read and delete flag should be spaces, transaction set should be 'REP', and accept status should be 'II'
[Increment Transmission Number]
The system needs to generate a new transmission number → The transmission number should be incremented by 1 and the new number should be assigned to the transmission record
[Retry Database Insert]
The system retries the database insert operation → The insert operation should be performed again with the new transmission number and continue until successful
[Set Arrival Date from DTM Segment]
The system processes the arrival date information → The arrival date is set from the DTM-02-DATE-TIME field in the transaction message
[Check Input Type]
If the record type code → Route to cargo processing if CA-CARGO type, route to train processing if CA-TRAIN type, or return error for invalid types
[Log: Cargo Re-Arrival Automatically]
Processing cargo arrival notification → Set log message to 'CARGO RE-ARRIVAL AUTOMATICALLY AT' with port code and change action code to ZZZ
[Log: Cargo Re-Arrival Manually]
Processing cargo arrival notification → Set log message to 'CARGO RE-ARRIVAL MANUALLY AT' with port code and change action code to ZZZ
[Log: Release Info Requested]
Processing cargo arrival notification → Set log message to 'RELEASE INFO REQUESTED FROM CCRA' and change action code to ZZZ
[Log: Cargo Arrival Automatically]
Processing cargo arrival notification → Set log message to 'CARGO ARRIVAL AUTOMATICALLY AT' with port code and change action code to ZZZ
[Log: Cargo Arrival Manually]
Processing cargo arrival notification → Set log message to 'CARGO ARRIVAL MANUALLY AT' with port code and change action code to ZZZ
[Log: Train Arrived at Border]
Processing train arrival notification → Set log message to 'CCRA DC:#1 ARRIVED AT BORDER' with port code and change action code to ZZZ
[Check Arrival Status]
The system checks the cargo arrival indicator → Route to re-arrival message generation if arrival indicator is Y, otherwise route to first arrival message generation
[Check Action Code]
If the action code (CAA, MAA, or other) → Generate appropriate message for automatic arrival, manual arrival, or release request
[Extract Equipment ID from Cargo]
Building Iron Highway notification message → The system moves the equipment ID for index from cargo data to the Iron Highway car ID field
[Extract Waybill Number from Cargo]
Building Iron Highway notification message → The system moves the first 15 characters of the waybill key for index from cargo data to the Iron Highway waybill field
[Extract CCN Key]
Building Iron Highway notification message → The system moves the CCN key from cargo data to the Iron Highway CCN field
[Trigger Export Release Processing]
Export release processing is triggered → The system sets export release message type, populates cargo CCN key, clears release quantity, and spawns export release transaction GCT1231E
[Trigger Automotive Release Processing]
Automotive release processing is triggered → The system sets SAR release message type, populates cargo CCN key, clears release quantity, and spawns automotive release transaction GCT1231E
[Move Table Data to AU Segment]
The table lookup operation returns successful results → The system loads the retrieved automotive release configuration data into the AU segment for further processing
[Set CCN Key from Input Message]
The system prepares to retrieve cargo information → The CCN key is set from the input message train or US CCN field
[Set Fetch All Segments Flag]
The system configures the retrieval parameters → The fetch all segments flag is set to retrieve complete cargo information including all sub-segments
[Call Cargo Database Interface]
The system executes the database call → The cargo database interface is called with all required parameters to retrieve cargo segments
[Move Retrieved Cargo Data to Working Storage]
The system processes the retrieved data → The main cargo segment data is moved to the appropriate working storage area
[Move Additional Segment Data if Available]
The system processes additional segment data → Sub-segment 53 data is moved from the array to working storage AND sub-segment 55 data is moved from the array to working storage
[Set ST Segment Destination: CACUSTOMS-UNH-O Transaction: REP, Set ST Segment - Destination and Transaction]
The ST segment is being populated → The destination is set to 'CACUSTOMS-UNH-O' and transaction type is set to 'REP'
[Set BGM Document Type ARRIVAL for CAA/MAA BILL-QUERY for others]
The action code is 'CAA' or 'MAA' → The BGM document message name is set to ARRIVAL, otherwise it is set to BILL-QUERY
[Set BGM Document Type TRAIN-ARRIVAL Function: 9]
The BGM segment is being populated for train processing → The document message name is set to TRAIN-ARRIVAL and document message function is set to '9'
[Use Input Date/Time]
Input date time is not spaces → The input date time value is used for the DTM segment date time field
[Use System Date/Time Century + Date + Hour + Min]
Input date time is spaces → System concatenates machine century, date, hour, and minute to create the DTM segment date time
[Set DTM Segment Qualifier: 132 Format: 203]
The date time qualifier and format need to be set → The date time qualifier is set to '132' and date time format is set to '203'
[Set RFF Segment Qualifier: ABT for Cargo Qualifier: ABY for Train Reference: CCN/Train ID]
Processing type is train → Reference qualifier is set to 'ABY' and reference is set to the train ID
[Set LOC Segment Qualifier: 14 Location: Port Code]
The location qualifier and port code need to be set → The location qualifier is set to '14' and location is set to the determined port code
[Add Sub-Location Code Qualifier: 129]
Sub-location code is not spaces or low-values → Code list qualifier is set to '129' and place is set to the sub-location code
[Set Transmission Number to Current Machine Time]
The system creates the base transmission number → The transmission number is set to the current machine time value
[Check if Test Cargo CCN Key?]
The cargo CCN key equals '6105ETEST999999999999' → The transmission number is set to 'CUSREPCCRA' and read-and-delete flag is set to spaces
[Use Generated Transmission Number]
The cargo CCN key != '6105ETEST999999999999' → The transmission number uses the generated machine-time value and accept status is set to 'II'
[Set Transaction Type to 'REP']
The transmission parameters are being set → The transaction set is assigned value 'REP'
[Create Initial Transmission Root]
The system creates the initial transmission root record → A transmission root record is inserted using the generated transmission number
[Transmission Creation Successful?]
The transmission creation fails due to duplicate number (status code is not space) → The transmission number is incremented by 1 and creation is retried
[Increment Transmission Number by 1]
The system needs to generate a new unique number → The transmission number is incremented by 1
[Retry Creating Transmission Root]
The system retries transmission creation → A new transmission root record creation is attempted with the incremented number
[Generate Transmission Number with Prefix 148]
The system generates a transmission number → The transmission number should have prefix 148 followed by the current machine time
[Set Transaction Type to REP]
The system sets the transaction type → The transaction set should be set to REP and read-and-delete flag should be cleared
[Use Test Transmission Number CUSREPCCRA]
The system determines the transmission number to use → The transmission number should be set to 'CUSREPCCRA' and accept status should remain blank
[Use Generated Transmission Number]
The system determines the transmission number to use → The transmission number should be the generated number and accept status should be set to 'II'
[Insert Transmission Root Segment]
The system attempts to insert the transmission root segment → The transmission root segment should be inserted into the database
[Increment Transmission Number]
The system encounters a duplicate key error → The transmission number should be incremented by 1 and the insert should be retried
[Store ST Segment as Sequence 00001]
The system stores the ST segment data → The ST segment should be stored as dependent segment with sequence number '00001'
[Store BGM Segment as Sequence 00002]
The system stores the BGM segment data → The BGM segment should be stored as dependent segment with sequence number '00002'
[Store DTM Segment as Sequence 00003]
The system stores the DTM segment data → The DTM segment should be stored as dependent segment with sequence number '00003'
[Store RFF Segment as Sequence 00004]
The system stores the RFF segment data → The RFF segment should be stored as dependent segment with sequence number '00004'
[Store LOC Segment as Sequence 00005]
The system stores the LOC segment data → The LOC segment should be stored as dependent segment with sequence number '00005'
[Set Arrival Date from DTM Segment]
The system updates arrival information → The arrival date is set from the DTM-02-DATE-TIME field in the transaction
[Check Input Type]
If the input type → Route to cargo processing if CA-CARGO type, route to train processing if CA-TRAIN type, or generate error for invalid input codes
[Process Cargo Log Entry]
The system determines the arrival status and action code → Generate re-arrival automatic message if already arrived with CAA action, generate re-arrival manual message if already arrived with MAA action, generate release info request message if already arrived with other actions, generate new arrival automatic message if first arrival with CAA action, generate new arrival manual message if first arrival with MAA action, or generate release info request message if first arrival with other actions
[Process Train Log Entry]
The system processes the train arrival → Generate train border arrival message with port code from customs location lookup
[Check Action Code]
If the action code → Use CAA-specific re-arrival message if action code is 'CAA', use MAA-specific re-arrival message if action code is 'MAA', or use release info request message for all other action codes
[Check Action Code for New Arrival]
If the action code → Use CAA-specific new arrival message if action code is 'CAA', use MAA-specific new arrival message if action code is 'MAA', or use release info request message for all other action codes
[Set Port Code in Message]
The system formats the log message → Include the port code in the appropriate position within the log message text
[Create Activity Log Entry]
The system needs to record the activity → Spawn GCT1051E transaction with the formatted message, user ID, date, time, and CCN information
[Prepare GCX121 Input Message]
The system prepares the GCX121 input message → All fields in the GCX121-INPUT structure are initialized to spaces
[Set Security Byte to High Values]
The system sets the security authorization level → The security byte is set to high values indicating maximum authorization
[Move Transmission Number to Message]
The system assigns the reference number to the message → The transmission number is moved to the GCX121-TRANSMISSION-NUMBER field
[Call GCT1211E Transaction]
The system needs to transmit the message to Canadian customs → The GCT1211E transaction service is invoked to process the transmission
[Set Cargo/Train CCN Number]
The customer report is being prepared → The CCN number from the input message is assigned to the customer report identifier
[Prepare Report Message]
The report message needs to be formatted for transmission → The customer report input is formatted into a transmittable message structure
[Queue Report for Processing]
The report needs to be submitted for processing → The system queues the report message to the customer report processing system
[Send Report to Customer]
The report transmission process is initiated → The report is transmitted to the customer notification system for delivery
[Check Iron Highway Configuration]
The system looks up Iron Highway configuration using table ID 'IH' and the cargo's origin station number → The system retrieves the Iron Highway segment configuration if it exists
[Is Origin Station Configured for Iron Highway?]
The lookup return flag indicates successful retrieval of configuration data → Iron Highway processing is enabled and the system proceeds with Iron Highway message preparation
[Prepare Iron Highway Message]
The system prepares the Iron Highway message → The record type code from the input message is set in the Iron Highway message structure
[Set CCN Status to 'ARRIVED']
The system sets the cargo status in the Iron Highway message → The CCN status is set to 'ARRIVED' to reflect the current arrival state
[Extract Equipment ID from Cargo]
The system prepares Iron Highway message data → The equipment ID for index is extracted from cargo data and assigned to the Iron Highway car ID field
[Extract Waybill Number from Cargo]
The system prepares Iron Highway message data → The first 15 characters of the waybill key for index are extracted and assigned to the Iron Highway waybill field
[Extract CCN Key]
The system prepares Iron Highway message data → The CCN key from cargo data is assigned to the Iron Highway CCN field
[Send Message to Iron Highway System]
The system sends the notification to the Iron Highway system → The message is transmitted using the GCCIH interface with the cargo and Iron Highway message data
[Build Train EDI Data - Set destination to CACUSTOMS - Set transaction type to REP - Set message type to TRAIN-ARRIVAL]
The system sets message properties → The destination is set to 'CACUSTOMS-UNH-O', transaction type is set to 'REP', message type is set to TRAIN-ARRIVAL, and document function is set to '9'
[Set Date/Time Information - Use input date/time or current system time - Format as CCYYMMDDHHNN]
The system needs to set the date and time information → If input date/time is provided and not spaces, use the input date/time; otherwise use current system date/time formatted as century+date+hour+minute
[Set Date/Time Information - Use input date/time or current system time - Format as CCYYMMDDHHNN]
The system configures date time segment → Date time qualifier is set to '132', format code is set to '203', and reference qualifier is set to 'ABY'
[Lookup Border Port Code - Use city name from input - Get Canadian customs code from MC table]
The system looks up the border port code → The system searches the MC table using the city name as station name and retrieves the corresponding Canadian customs code
[Lookup Border Port Code - Use city name from input - Get Canadian customs code from MC table]
The system sets the location code for EDI message → The location code is set to characters 2-5 of the Canadian customs code and location qualifier is set to '14'
[Create Transmission Record - Generate unique transmission number - Store in database]
The system creates the transmission record → The transmission number is created using prefix '148' combined with current machine time, and if CCN key equals '6105ETEST999999999999' then use 'CUSREPCCRA' as transmission number
[Store EDI Segments - ST segment 'sequence 00001' - BGM segment 'sequence 00002' - DTM segment 'sequence 00003' - RFF segment 'sequence 00004' - LOC segment 'sequence 00005']
The system stores the segments → ST segment is stored with sequence '00001', BGM with '00002', DTM with '00003', RFF with '00004', and LOC with '00005'
[Send EDI Message to Customs - Trigger GCT1211E process]
The system sends the message to customs → GCT1211E process is spawned with the transmission number to handle EDI message delivery
[Set ST Segment - Destination and Transaction Type]
ST segment needs to be populated → Destination is set to 'CACUSTOMS-UNH-O' and transaction type is set to 'REP'
[Set BGM Segment - Train Arrival Document Type]
BGM segment needs to be populated → Document message name is set to TRAIN-ARRIVAL and function code is set to '9'
[Date/Time Provided in Input?]
Date/time needs to be set for the arrival notification → If input date/time is not spaces, use input date/time; otherwise use current system date/time (century + date + hour + minute)
[Set DTM Segment - Date/Time Qualifier and Format]
DTM segment needs to be populated → Date/time qualifier is set to '132' and format is set to '203'
[Set RFF Segment - Train Reference Number]
RFF segment needs to be populated → Reference qualifier is set to 'ABY' and reference number is set to the train or US CCN identifier
[Set LOC Segment with Border Port Code]
LOC segment needs to be populated → Location qualifier is set to '14' and location code is set to characters 2-5 of the Canadian customs code
[Call Table Segment Retrieval]
The system executes the table retrieval operation → The table segment retrieval function is called to fetch station data
[Extract Canadian Customs Code]
The system processes the retrieved station segment → The Canadian customs code is extracted from positions 2-5 of the MC segment customs code field
[Set Port Code in Location Segment]
The system prepares the location segment for transmission → The extracted customs code is assigned to the location field in the location segment
[Set Function Code to GU]
The system prepares to lookup station information → The function code is set to 'GU' for database retrieval
[Set Station Name from Input]
The system prepares to lookup station information → The input city name is assigned as the station name key for table lookup
[Execute Table Segment Lookup]
The system executes the table segment lookup operation → The table lookup is performed and return status is captured
[Store Retrieved Table Segment]
The system processes the retrieved table data → The retrieved table segment is stored in the MC segment work area
[Extract Canadian Customs Code]
The system processes the Canadian customs code information → Characters 2 through 4 of the Canadian customs code are extracted from the MC segment
[Set Location Code for EDI]
The system prepares EDI location information → The extracted customs code is assigned to the EDI location code field
[Lookup MC Table Using City Name]
The system performs a table lookup using the city name as the station name key in the MC table → The system attempts to retrieve the corresponding table segment containing border crossing information
[Extract Canadian Customs Code]
The system processes the segment data to extract the Canadian customs code → The system obtains the customs code from the MC segment's Canadian customs code field
[Validate Code Structure - Position 2:4]
The system processes the customs code to extract characters from position 2 through 4 → The system assigns the extracted 3-character code to the EDI location field
[Call Train List Database Service]
The system executes the train list retrieval operation → Database service is called to fetch train car list data from GCWB4TL train list segment
[Set Train ID from Input Message]
The system prepares to query the train list database → The train identifier from the input message is assigned to the database query search field
[Set BGM Segment - Train Arrival Document]
The BGM segment is being populated → The document message name is set to TRAIN-ARRIVAL
[Set BGM Function Code to '9']
The document function code needs to be set → The function code is set to '9'
[Check Date/Time Input]
The date/time needs to be set for the arrival → If input date/time is provided and not spaces, use input date/time; otherwise generate current system date/time from machine century, date, hour, and minute
[Set DTM Segment - Date/Time Qualifier '132']
Date/time qualifiers need to be specified → Date/time qualifier is set to '132' and format is set to '203'
[Set RFF Segment - Reference Qualifier 'ABY']
The reference segment needs to be populated → Reference qualifier is set to 'ABY' and reference number is set to the train or US CCN identifier
[Set LOC Segment - Location Qualifier '14']
The LOC segment is being populated → Location qualifier is set to '14'
[Set Station Name from Input]
The system prepares to lookup the border port code → The station name key is set to the input city name for table lookup
[Extract Port Code from Table Data]
The system processes the returned table data → The table segment data is moved to the MC segment structure for port code extraction
[Set Port Code in Location Segment]
The system builds the location segment for EDI transmission → Characters 2-5 of the Canadian customs code are moved to the location code field
[Update Cargo Border Arrival Date]
The cargo record is successfully retrieved → The system sets the border arrival date to the current date-time from DTM segment
[Execute Get Next Call with GN Function]
The system executes the get next call with GN function code → The database call is made using the master manifest CCN key and follower manifest segment structure
[Schedule Restriction]
The cargo has CSA indicator ON or entry type is PARS (paper, EDI, or OGD) and the broker delivery schedule is not 'A' → The system skips broker notification and ends the process
[Send X12 EDI Notification]
The broker configuration indicates X12 usage is 'Y' → The system sends X12 EDI notification using the broker's X12 header information and cargo CCN key
[Lookup Secondary Broker Configuration by Port]
The system looks up broker configuration using table ID 'BK', secondary broker name, Canadian indicator 'C', and manifest TO transport code port (positions 2-3) → The broker configuration segment is retrieved if found
[Lookup Secondary Broker Configuration with Default Port 000]
The system performs a second lookup using table ID 'BK', secondary broker name, Canadian indicator 'C', and default port '000' → The broker configuration segment is retrieved if found, otherwise processing ends
[Get Broker Delivery Schedule Configuration]
The system looks up delivery schedule configuration using table ID 'B1' → The delivery schedule segment is retrieved if available, otherwise initialized as spaces
[Apply Broker Delivery Schedule Rules]
The cargo has CSA indicator ON:
entry type is PARS (paper, EDI
OGD) AND broker delivery schedule is not 'A'
→ Secondary broker processing ends due to schedule restriction
[Send X12 EDI Notification to Secondary Broker]
The broker configuration indicates X12 usage is 'Y' → An X12 EDI notification is sent to the secondary broker using their X12 header configuration
[Store Broker Configuration]
The system stores the configuration data → The table segment data is moved to the broker configuration segment for use in notification processing
[Block Broker Notification - Schedule Restriction]
The broker delivery schedule != 'A' (All) → The system blocks broker notification due to schedule restrictions
[Allow Broker Notification]
The entry type is not CSA and not PARS (paper, EDI, or OGD) → The system allows broker notification to proceed
[Skip Notification - Not Eligible]
The entry type is not PARS Paper, not PARS EDI, and not PARS OGD → Skip broker notification process and exit the notification routine
[Set Border Arrival Date]
Updating follower cargo arrival information → The DTM segment date/time is moved to the follower cargo border arrival date field
[Validate Broker Notification Rules]
The cargo arrival indicator is 'Y':
the CCN key does not start with '6105E'
'6105P'
(CSA indicator is on
entry type is PARS paper/EDI/OGD) AND broker delivery schedule is not 'A'
→ The system blocks broker notification and terminates the process
[Lookup Broker Configuration by Port]
The system looks up broker configuration using table ID 'BK', broker name, Canadian flag 'C', and port from manifest-to-transport-code positions 2-4 → The system retrieves the broker configuration segment if found
[Send X12 EDI Notification]
The broker configuration indicates X12 usage is 'Y' → The system calls GCCS309C with notify-broker flag, X12 broker header, and CCN key to send EDI notification
[Send Internet Notification]
The broker configuration indicates internet usage is 'Y' → The system spawns GCT0191E print process with CCN key and internet address from B1 segment
[Check CSA Indicator or Entry Type]
The cargo has CSA indicator turned ON or has PARS entry type (paper, EDI, or OGD) → The system should proceed to check broker delivery schedule for notification eligibility
[Check CSA Indicator or Entry Type]
The cargo does not have CSA indicator turned ON and does not have PARS entry types (paper, EDI, or OGD) → The system should proceed with broker notification process without checking delivery schedule
[Check Entry Type - PARS EDI]
The cargo entry type is PARS EDI → The system should proceed to check broker delivery schedule for notification eligibility
[Check Entry Type - PARS OGD]
The cargo entry type is PARS OGD → The system should proceed to check broker delivery schedule for notification eligibility
[Check Entry Type - PARS OGD]
The cargo entry type is not PARS paper, not PARS EDI, and not PARS OGD → The system should skip broker notification and exit the notification process
[Use Port-Specific Broker Config, Use Default Broker Config]
Broker configuration data is needed for operations → The retrieved table segment is assigned to the broker configuration structure
[Check if Broker Uses X12]
The system checks if the broker uses X12 EDI format for notifications → The system proceeds with X12 notification if BK-USE-X12 equals 'Y', otherwise skips X12 processing
[Set Notification Parameters]
The system prepares X12 notification parameters → The system sets notification type to broker notification and assigns broker X12 header information
[Move Broker X12 Header Information]
The system prepares X12 notification message → The system moves the broker's X12 header from broker table to the notification structure
[Move CCN Key to Notification]
The system prepares X12 notification message → The system assigns the CCN key to the notification structure for broker reference
[Call X12 Notification Service]
The system is ready to send X12 EDI notification → The system calls the X12 notification service with the prepared notification structure
[Get Broker Internet Address from Table]
The system retrieves the broker's internet address → The system should obtain the internet address from the B1 segment of the broker table and assign it to the internet notification input
[Send Fax Notification via GCT0191E]
The system executes fax notification transmission → The system calls the GCT0191E print service to send the fax notification to the broker
[Check CSA Indicator or Entry Type]
The CSA indicator is ON or the entry type is PARS Paper or the entry type is PARS EDI or the entry type is PARS OGD → The system should proceed to check broker delivery schedule for notification eligibility
[Check if Broker Uses X12 EDI]
The system checks the broker's X12 usage flag in the configuration → X12 EDI notification is prepared if broker X12 usage flag equals 'Y', otherwise X12 notification is skipped
[Set Notification Parameters]
The system prepares X12 notification parameters → Notification type is set to broker notification, X12 broker header is populated from broker configuration, and CCN key is assigned
[Send X12 EDI Message to Primary Broker]
The system calls the broker notification service with configured parameters → X12 EDI message is transmitted to the primary broker's system
[Send X12 EDI Message to Secondary Broker]
The system calls the broker notification service with secondary broker parameters → X12 EDI message is transmitted to the secondary broker's system
[Send Merlin Notification]
All notification data has been prepared → The system executes the Merlin notification transmission process
[Get Internet Address from Broker Table]
The system needs to send an internet notification → The system should retrieve the broker's internet address from the B1 segment of the broker table
[Send Internet Notification via GCT0191E]
The system initiates the internet notification transmission → The system should invoke the GCT0191E print service to send the notification via internet to the broker
[Set Export Release Flag]
The system prepares to initiate export release processing → The system sets the message ID flag to GCW123 and sets the export release flag to true
[Set Automotive Release Parameters]
The system prepares automotive release parameters → GCW123 message ID is set to GCW123, SAR release flag is activated, CCN key is populated, and release quantity is set to spaces
[Set Automotive Release Parameters]
The system prepares export release parameters → GCW123 message ID is set to GCW123, export release flag is activated, CCN key is populated, and release quantity is set to spaces
[Move Table Data to AU Segment]
The table return flag indicates successful retrieval → The retrieved table segment data is moved to the automotive release segment for processing
[Lookup Automotive Release - Check if cargo qualifies for automotive release based on consignee and commodity]
The system performs automotive release lookup using table ID 'AU' with consignee CHOP and commodity code as search keys → If configuration is found, store the automotive release segment data, otherwise initialize empty configuration
[Store Automotive Release Configuration]
The lookup returns successful status → Move the retrieved table segment data to the automotive release segment structure
[Set Record Type from Input]
Setting up Iron Highway status data → The record type from the input message is assigned to the Iron Highway record type field
[Check Entry Type and CSA Indicator]
The CSA indicator is ON:
the entry type is PARS Paper
the entry type is PARS EDI
the entry type is PARS OGD
→ The system applies broker delivery schedule restrictions for notification processing
[Entry Type Invalid - Skip Notification]
The entry type is not PARS paper and not PARS EDI and not PARS OGD → The system skips broker notification processing and exits the notification routine
[Check Broker Delivery Schedule]
The broker delivery schedule != 'A' → The system skips broker notification processing and exits the notification routine
[Entry Type Valid for Notification]
The broker delivery schedule equals 'A' → The system proceeds with broker notification processing using available notification methods
[Broker Delivery Schedule Valid?]
If delivery schedule compatibility → Notification proceeds if delivery schedule is 'A' OR cargo does not have CSA/PARS entry types (PARS-PAPER, PARS-EDI, PARS-OGD), otherwise notification is skipped
[Send X12 EDI Notification]
The system processes X12 notification → Notification is sent using broker X12 header and CCN key via GCCS309C program call
[Set Port Code in Location Segment]
The system prepares the EDI location segment → The customs port code is assigned to the location field in the location segment
[Lookup Secondary Broker Configuration by Port]
The system looks up broker configuration with table ID 'BK', secondary broker name, Canadian flag 'C', and port code from positions 2-4 of manifest destination transport code → The system retrieves the broker configuration segment if found
[Lookup Secondary Broker Configuration with Default Port 000]
The system performs a fallback lookup with table ID 'BK', secondary broker name, Canadian flag 'C', and default port '000' → The system retrieves the default broker configuration segment if available
[Retrieve B1 Table Segment for Additional Broker Info]
The system retrieves B1 table segment with table ID 'B1' → Additional broker information is loaded if available, otherwise B1 segment is initialized as empty
[Apply Broker Delivery Schedule Rules]
The system checks if (CSA indicator is ON:
entry type is PARS paper
entry type is PARS EDI
entry type is PARS OGD) AND broker delivery schedule is not 'A'
→ Secondary broker processing is terminated if delivery schedule conditions are not met
[Send X12 EDI Notification to Secondary Broker]
The broker X12 usage flag equals 'Y' → The system sends X12 EDI notification using broker X12 header and CCN key through GCCS309C program
[Lookup Additional B1 Segment Data]
The system needs complete broker setup information → The system performs lookup on 'B1' table to retrieve additional broker segment data, initializing empty segment if not found
[Check Entry Type and CSA Indicator]
The CSA indicator is ON or the entry type is PARS (paper, EDI, or OGD) → The system should proceed to check broker delivery schedule restrictions before allowing notification
[Allow Broker Notification Processing]
The entry type is not CSA and not PARS (paper, EDI, or OGD) → The system should allow broker notification processing to continue with notification methods
[Set CCN Key for Report]
The customer report requires cargo identification → The CCN key from the input message is assigned to the customer report
[Queue Report Message]
The report needs to be delivered for processing → The report is queued to the customer report processing system
[Trigger Export Release Transaction]
Export release processing is triggered → The system sets export release message ID, assigns CCN key, clears release quantity, and spawns GCT1231E transaction
[Trigger Export Release Transaction]
SAR release processing is triggered → The system sets SAR release message ID, assigns CCN key, clears release quantity, and spawns GCT1231E transaction
[Lookup Automotive Release Configuration]
The system performs table lookup using table ID 'AU', consignee CHOP code, and commodity code → Return the automotive release configuration segment if found, otherwise initialize empty segment
[Set SAR Release Flag]
The system prepares the release message → Set message ID flag to GCW123, set SAR release flag to true, move cargo CCN key to release CCN key, and clear release quantity to spaces
[Trigger Automotive Release Processing]
The system triggers the release processing → Spawn GCT1231E transaction with the configured release message parameters
[Call Table Segment Retrieval]
The system executes the table segment retrieval → The table lookup is performed to find matching automotive release configuration
[Move Table Data to AU Segment]
The lookup returns successful status → The retrieved table segment data is moved to the AU segment for further processing

Structural Validations

[3:Validate Input Code]
The system validates the input code type → If the code is CA-CARGO, route to cargo processing; if CA-TRAIN, route to train processing; otherwise generate an error
[19:Lookup Border Port Code]
The system looks up border port code → If city name exists in MC table, use Canadian customs code; otherwise generate error for invalid border arrival port
[Generate Invalid Input Code Error]
The input code is neither Canadian cargo (GCX148-CA-CARGO) nor Canadian train (GCX148-CA-TRAIN) → The system should generate error message 'INVALID INPUT CODE SHOWN IN CC-PROG' and terminate processing
[Transmission Number Already Exists?]
The database operation completes → If the status code is not space, the transmission number already exists and needs to be regenerated
[Transmission Number Successfully Created]
The database status code is space (successful) → The transmission number is confirmed as unique and successfully created
[Duplicate Number Detected?]
The system checks the creation status → If the status code is not space, a duplicate number is detected and retry is required
[Database Insert Successful?]
The database insert operation returns a non-space status code → The system should recognize this as a duplicate transmission number condition
[Transmission Number Accepted]
The database insert operation returns a space status code → The transmission number should be accepted as unique and the process should continue with transmission creation
[Return Error - Invalid Border Port]
Invalid border port condition is detected → Error message 'INVALID INPUT BORDER ARRIVAL PORT OF ENTRY' is set and system terminates processing
[Display Invalid Border Port Error]
The system cannot find a valid border port entry → An error message 'INVALID INPUT BORDER ARRIVAL PORT OF ENTRY' is displayed
[Lookup Successful?]
The system checks the lookup operation result → If the return flag equals 'SUCCESSFUL', the lookup is considered successful, otherwise it failed
[Generate Error Message]
The system handles the lookup failure → An error message 'INVALID INPUT BORDER ARRIVAL PORT OF ENTRY' is generated
[Table Segment Found?]
The system checks if the table segment retrieval was successful → If successful, the system proceeds to parse the segment data, otherwise it triggers an invalid border port error
[Invalid Border Port Error]
The MC table lookup fails to find a matching station record → The system generates an 'INVALID INPUT BORDER ARRIVAL PORT OF ENTRY' error message and terminates processing
[Port Code Found?]
The system checks if a valid port code was found → If lookup is successful, extract the Canadian customs code (positions 2-4) and set it as the location code; if lookup fails, return error message 'INVALID INPUT BORDER ARRIVAL PORT OF ENTRY'
[Display Invalid Port Error]
The system processes the failed lookup result → An error message 'INVALID INPUT BORDER ARRIVAL PORT OF ENTRY' is displayed
[Check Entry Type - PARS EDI?]
The entry type is PARS EDI → Proceed to check broker delivery schedule for notification eligibility
[Check Entry Type - PARS OGD?]
The entry type is PARS OGD → Proceed to check broker delivery schedule for notification eligibility
[Check Primary Broker Name]
The system checks the primary broker name from cargo data → Processing continues if broker name is valid, otherwise X12 EDI notification is skipped for primary broker
[Check PARS EDI Entry]
The entry type is PARS EDI → The system proceeds to check broker delivery schedule for notification eligibility
[Check PARS OGD Entry]
The entry type is PARS OGD → The system proceeds to check broker delivery schedule for notification eligibility
[Display Error Message]
The system cannot resolve the input city name to a valid border port → An error message 'INVALID INPUT BORDER ARRIVAL PORT OF ENTRY' is displayed

Module: GCX113 1 Consolidated Epic Story

Epic: GCX113 Complete EDI Specification Extracted from Legacy

Contains 520 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX113 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize FEN Processing Variables]
The system begins FEN slot allocation processing → All FEN processing counters and indexes are reset to zero to prepare for N9 segment scanning
[Initialize N9 Segment Counter]
The system starts checking for available segment slots → All segment counters and indices are reset to zero
[Initialize Search Parameters]
The system needs to search for a matching car in the waybill → The search parameters are initialized with cleared waybill segments and sequence counter set to 1
[Initialize KCM Search Variables]
KCM segment search process begins → KCM segment position counter is reset to zero AND KCM found flag is reset to zero
[Initialize Commodity Segment]
The system processes commodity information → Initialize commodity segment to empty values
[Initialize IB Segment Search]
The system needs to preserve IB segment data during CCN key modifications → The IB segment search flags are initialized to 'not found' state and segment sequence counter is set to start processing
[Initialize IB Segment Search]
The IB segment search process is initiated → The system sets IB segment found flag to false and prepares to iterate through S07 segments
[Initialize Segment Parameters]
The system prepares for database access → The system sets segment type to GCSA2RT, function code to GU (Get Unique), operator to '= ', and initializes all control fields
[Initialize N9 Segment Counters]
The system initializes N9 segment counters → DSP counter, FEN counter, and KCM counter are all set to zero
[Initialize N9 Scanning Variables]
The system prepares to scan N9 segments → All qualifier position tracking variables (WS-DSP-SUB, WS-FEN-SUB, WS-KCM-SUB) are set to zero
[Begin N9 Segment Loop - Initialize N9 segment iteration with counter management and boundary validation]
The system begins N9 segment loop processing → The system shall initialize the N9 counter to 1 and establish maximum occurrence boundary validation using GCSUSS99-N9-MAX-OCURS-BYSEQ
[Initialize Dispatch Message Structure]
The system prepares to send dispatch messages → The dispatch message structure (FWIOMSG) is cleared and initialized to spaces
[Initialize A2RT Segment Processing]
The A2RT segment deletion process is initiated → The system sets up for processing multiple A2RT segments and establishes the processing flag

Core Acceptance Criteria

[63:Message Input Reading]
Messages are available in the input queue → The system reads each message sequentially and processes them until the queue is empty
[63:Message Input Reading]
The system checks user access permissions → Processing continues only if access is granted, otherwise the message is skipped
[2:Action Code Routing]
If the action code type → Processing is routed to multi-car delete if action is multi-car delete, otherwise to standard preparation processing
[1:Message Input Processing]
The system processes the action type → Clone mode is set to true and the action type is changed to BUNCH-BILLING
[5:Processing Mode Determination]
The cargo status is not valid for bunch bill operations → The system logs 'BB NOT CREATED. 1ST CCN HAS INVALID STATUS' message and sets exit mode
[28:EDI Message Transmission]
The cargo port is valid for export, US-Canada-US, or multi-transit → The system calls GCCS309E for EDI transmission, otherwise calls GCCS309
[49:Shipminu Segment Deletion]
The SCAC is authorized for deletion and all cargo has been successfully deleted → The system deletes associated shipminu segments
[Call READQ to Read Message from Queue]
A message read operation is initiated from the input queue → The system calls READQ to retrieve the next available message and stores it in the input buffer
[Extract Message Length]
The system processes the message metadata → The message length is extracted and stored for further processing validation
[Store Message in GCX113-INPUT]
The system processes the message content → The complete message is stored in the GCX113-INPUT buffer for subsequent processing
[Set Message Processing Flag]
The system completes the message input processing → The message input indicator is set to indicate successful reading for continuation to action code processing
[Perform System Abend]
The system determines the error is critical and cannot continue processing → The system performs an abend operation to terminate processing gracefully
[Continue to Next Processing Step]
All message input processing steps are completed successfully → The system is ready to proceed to the next phase of cargo processing with the action code evaluation
[Read Lead Car Shipminu Segments]
The system reads lead shipment data → The system should read segment 1 for entry data, segment 2 for customs data, and segment 3 for Canadian CCN data using the waybill root key
[SCAC is Temporary?]
The system checks if the SCAC is temporary → If the SCAC is temporary (US-CCN-SCAC-TEMP), reject the request with error message 'TEMP US CCN NOT ALLOWED IN CREATION'
[Read Lead Car Shipment Data]
The system needs to process the lead car shipment details → Read shipment data segments 1, 2, and 3 from the waybill database using the cargo's root key
[Access First Additional Car in Waybill]
Accessing additional cars for bunch billing operations → The system retrieves the first additional car record from the waybill request segment
[Create New Cargo Record]
The system creates a new cargo record → A new cargo record is created with cleared status fields, equipment ID, train type, and proper initialization
[Read Lead Car Shipminu Data]
The system reads lead car shipminu data → Three shipminu segments are read and stored for the lead car with proper segment numbering
[Add Shipminu Segments to New Car]
The system adds shipminu segments to the new car → Entry number and customs shipment value are updated in segment 1, segments 2 and 3 are copied as-is, and Canadian CCN formatting is applied if needed
[Process Secondary Location Notification]
M1203 location ID1 is not empty → GCCUSEDA service is called with 2nd-notify, background, and activate-edits flags for secondary location processing
[Determine EDI Action Type]
The system determines EDI action type → If cargo is preliminary status, action is set to preliminary; if cargo has T-value and EDI was sent electronically, action is update; if cargo has T-value but EDI not sent electronically, action is preliminary; otherwise action is update
[Log Cargo Creation Activity]
The system logs cargo creation activity → If in update mode, action code is 'ZZZ' with message 'CARGO BUNCH BILL UPDATED AUTOMATICALLY'; if bunch billing, action code is bunch billing constant; otherwise action code is cargo addition constant
[Send Cargo to EDI System]
The cargo bill owner is 'CPRS' or empty spaces → The cargo information is transmitted to the EDI system for electronic processing
[Send Broker Notification]
Broker notification is required → Notification is sent to the broker through available channels (Merlin, Internet, or Fax) based on broker configuration
[Get Next Additional Car from Waybill]
The system gets the next additional car from waybill → The next FWSWREQ segment is retrieved and if more cars exist, clone processing is spawned with updated sequence information
[Extract Pedimento Numbers]
The system processes the dispatch hold data → If a pedimento number exists and there is an existing FEN reference, the system updates the FEN reference with the new pedimento number, otherwise it adds a new FEN reference, and updates the pedimento type if different from the current type
[Validate Equipment Information]
The system validates the equipment → The system calls GCCCARTP service with equipment ID and container code, and if successful, updates equipment description code, equipment car ID, equipment initial, and equipment number; if unsuccessful, the system abends with error message
[Update Waybill References]
The system processes N9 reference segments → If reference qualifier is WY and mode is more duplication, update reference number with waybill root key positions 10-15; if reference qualifier is BM and mode is more duplication and shipper bill number exists, update reference number with shipper bill number
[Parse Broker Name from XU Format]
The system parses instructions starting with 'CUSTOMS BROKER ', 'CUSTOMS BROKER: ', 'BROKER ', 'BROKER: ', 'XU ', 'XU: ', 'CB ', or 'CB: ' → The broker name portion is extracted after the format prefix, or the entire instruction is used if no recognized format is found
[Process WY - Waybill Reference]
Processing N9 reference segments during more duplication → The waybill reference number should be updated with the waybill root key positions 10-15
[Process BM - Bill of Lading Reference]
Processing N9 reference segments during more duplication → The bill of lading reference number should be updated with the shipper bill of lading number from the shipment root
[Identify Empty N9 Segment Slot]
An N9 reference qualifier is empty or spaces → The segment index should be stored as the dispatch hold segment index for later use
[Update Existing FEN Reference]
Processing dispatch hold data for FEN references → The existing FEN reference number should be updated with the dispatch hold pedimento number, the pedimento type should be updated if different, and the change should be logged
[Add New FEN Reference]
Processing dispatch hold data for FEN references → A new FEN reference should be added using the empty segment slot, the pedimento number and type should be set from dispatch hold data, and the addition should be logged
[Remove FEN Reference Data]
Processing dispatch hold data for FEN references → The existing FEN reference qualifier and number should be cleared, the pedimento type should be updated if different from dispatch hold, and the removal should be logged
[Add New KCM Reference]
Processing dispatch hold data for KCM references → A new KCM reference should be added using the empty segment slot, the Mexican CCN should be set from dispatch hold data, and the addition should be logged
[Check Current FEN Value vs New Value]
The system compares the current FEN reference number value with the new dispatch hold FEN pedimento number → The system determines if the values are different and an update is required
[Update Existing FEN Slot]
The system processes the FEN update and the dispatch hold FEN pedimento number is not empty → The system updates the existing FEN reference number value with the new dispatch hold FEN pedimento number and increments the display subscription counter
[Log FEN Update Message]
The system completes the FEN update process → The system logs the FEN update activity with action code 'ZZZ', the new FEN pedimento number, pedimento type, and a formatted log message
[Allocate New FEN Slot]
The system processes a new FEN addition and an empty slot is available → The system allocates the available slot, sets the reference number qualifier to 'FEN', stores the dispatch hold FEN pedimento number, and increments the display subscription counter
[Log FEN Addition Message]
The system completes the new FEN addition process → The system logs the FEN addition activity with action code 'ZZZ', the new FEN pedimento number, pedimento type, and a formatted log message
[Clear Existing FEN Slot]
The system processes FEN clearing and an existing FEN slot is found → The system clears the FEN reference number qualifier and value, increments the display subscription counter, and updates the cargo pedimento type if different
[Log FEN Removal Message]
The system completes the FEN removal process → The system logs the FEN removal activity with action code 'ZZZ', empty FEN value, pedimento type, and a formatted log message
[Does Dispatch Hold Have Pedimento Number?]
The new pedimento number from dispatch hold is different from the current FEN value in the manifest → Update the pedimento type if different, add new FEN entry to N9 segment, and log FEN update message with new value and type
[Is Empty FEN Position Available?]
Processing FEN data from dispatch hold → Add FEN to available N9 position, update pedimento type if different from current, and log FEN addition message with value and type
[Current FEN Position Exists?]
Processing dispatch hold data without pedimento number → Clear existing FEN N9 position, update pedimento type if different, and log FEN removal message with type only
[Log FEN Update Message with New Value and Type]
FEN update processing is completed → Create log entry with action code 'ZZZ', new pedimento number, pedimento type, and update message
[Scan N9 Segments for Available Slot]
The system scans through all available N9 segment positions → The system identifies existing FEN qualifiers, existing KCM qualifiers, and records the first available empty slot index for potential use
[Update Existing FEN Entry]
The system processes the FEN update → The existing FEN reference number is replaced with the new value from dispatch hold data AND the pedimento type is updated if different AND a log entry is created documenting the FEN update
[Assign FEN Qualifier to Slot]
The system processes the new FEN assignment → The FEN qualifier 'FEN' is assigned to the available N9 slot AND the FEN reference number from dispatch hold is assigned to the slot AND the pedimento type is updated if different AND a log entry is created documenting the FEN assignment
[Update Existing FEN Entry]
The system processes the KCM update → The existing KCM reference number is replaced with the new value from dispatch hold data AND a log entry is created documenting the KCM update
[Assign FEN Qualifier to Slot]
The system processes the new KCM assignment → The KCM qualifier 'KCM' is assigned to the available N9 slot AND the Mexican CCN from dispatch hold is assigned to the slot AND a log entry is created documenting the KCM assignment
[Add New KCM Reference]
Adding a new KCM reference within segment limits → The system adds the KCM qualifier and reference number to the available slot and logs the addition
[Find Empty Reference Slot]
Searching for an empty slot to add KCM reference → The system identifies the first available empty slot position
[Retrieve Existing KCM from Manifest N9 Segments]
The system scans through N9 segments to locate KCM reference qualifiers → The system identifies the position and value of existing KCM reference numbers for comparison purposes
[KCM Found in Manifest?]
If the scan results → The system determines if a KCM reference qualifier exists and records its position if found
[Add New KCM to Available N9 Segment]
The system processes the new KCM addition → The system adds the KCM qualifier and Mexican CCN value to an available N9 segment slot
[Clear Existing KCM Reference]
The system processes the KCM clearing → The system clears the existing KCM reference qualifier and value from the N9 segment
[Log KCM Update Activity]
The system completes the KCM processing action → The system logs the KCM change activity with appropriate action code and message details
[Check if KCM Reference Type]
A segment contains a FEN reference qualifier and no FEN position has been recorded → The segment index is stored as the FEN reference position
[Is KCM Segment?]
A segment contains a KCM reference qualifier and no KCM position has been recorded → The segment index is stored as the KCM reference position
[Loop Through N9 Segments]
The system processes segments from index 1 to maximum N9 segment occurrences → Each segment is examined for availability and reference type classification
[Set Second Notify Flag]
The system configures second notification → The system sets 88-GCWUSEDA-2ND-NOTIFY to true and enables background and edit flags
[Update Segment Keys: GCSUSS01, GCSUSS02, GCSUSS04, GCSUSS05]
The CCN key propagation process executes → The system should update the US CCN key field in segments GCSUSS01, GCSUSS02, GCSUSS04, and GCSUSS05 with the new CCN key
[Update Multi-Occurrence Segments: GCSUSS03, GCSUSS06, GCSUSS08, GCSUSS12]
The CCN key propagation process executes for multi-occurrence segments → The system should iterate through all occurrences of each segment type AND update the US CCN key field in each non-empty occurrence with the new CCN key
[Update Weight/Value Segments: GCSUSS07]
The CCN key propagation process executes for GCSUSS07 segments → The system should update the US CCN key in each GCSUSS07 occurrence AND preserve the saved in-bond segment data for segments starting with 'IB '
[Update Reference Segments: GCSUSS10, GCSUSS11, GCSUSS13, GCSUSS14]
The CCN key propagation process executes for reference segments → The system should update the US CCN key field in segments GCSUSS10, GCSUSS11, GCSUSS13, and GCSUSS14 with the new CCN key
[Clear Dispatch Hold Reference Numbers]
The reference number cleanup process executes → The system should clear all reference number qualifiers and values where the qualifier is 'FEN' or 'KCM' to remove dispatch hold references
[Clear FEN and KCM Reference Numbers]
CCN key is being updated for the cargo → All FEN and KCM reference number qualifiers and their corresponding reference numbers are cleared to spaces
[Update All Cargo Segments with New CCN]
The CCN update process is executed → All cargo segment records (S01, S02, S03, S04, S05, S06, S07, S08, S10, S11, S12, S13, S14) are updated with the new CCN key
[Apply CCN to All Segments]
The system needs to update cargo segment keys → Apply the CCN to all non-empty segment keys including GCSUSS01, GCSUSS02, GCSUSS04, GCSUSS05, GCSUSS08, GCSUSS03, GCSUSS06, GCSUSS07, GCSUSS10, GCSUSS11, GCSUSS12, GCSUSS13, and GCSUSS14
[Apply CCN to All Segments]
The system updates the cargo record → The system applies the CCN to all non-empty cargo segments including GCSUSS01, GCSUSS02, GCSUSS04, GCSUSS05, GCSUSS08, GCSUSS03, GCSUSS06, GCSUSS07, GCSUSS10, GCSUSS11, GCSUSS12, GCSUSS13, and GCSUSS14
[Update Primary CCN Segment GCSUSS01]
System updates cargo segments with new CCN → GCSUSS01 CCN key is updated with the generated CCN key
[Update Reference Number Segment GCSUSS02]
System updates cargo segments with new CCN → GCSUSS02 is restored from saved data, otherwise GCSUSS02 CCN key is updated with generated CCN key, and FEN/KCM reference qualifiers are cleared from N9 segments
[Update Additional Segments GCSUSS04-05]
System updates cargo segments with new CCN → CCN keys in GCSUSS04 and GCSUSS05 are updated with the generated CCN key
[Update Multiple S08 Commodity Segments]
System updates cargo segments with new CCN → CCN key is updated in each non-empty GCSUSS08 segment up to maximum sequence limit
[Update Multiple S03 Name Segments]
System updates cargo segments with new CCN → CCN key is updated in each non-empty GCSUSS03 segment up to maximum sequence limit
[Update Multiple S06 Address Segments]
System updates cargo segments with new CCN → CCN key is updated in each non-empty GCSUSS06 segment up to maximum sequence limit
[Update Multiple S07 Special Segments]
System updates cargo segments with new CCN → CCN key is updated in each non-empty GCSUSS07 segment up to maximum sequence limit, and if segment contains IB data and IB segment was previously found, the saved SED data is restored
[Update Remaining Segments S10-S14]
System updates cargo segments with new CCN → CCN keys are updated in non-empty segments GCSUSS10, GCSUSS11, GCSUSS13, GCSUSS14, and all non-empty GCSUSS12 segments up to maximum sequence limit
[Update Waybill Reference Number from WB Root Key]
The system processes the reference number management for waybill references → The waybill reference number should be updated with characters 10-15 from the WB root key to establish proper waybill cross-reference
[Update Bill of Lading Reference from Shipment Root]
The system processes the reference number management for bill of lading references → The bill of lading reference number should be updated with the shipper bill number from the shipment root data
[Mark Available Position for Dispatch Hold Data]
An empty reference number qualifier slot is encountered AND no dispatch hold slot has been identified yet → The system should mark this position as available for dispatch hold data and record the slot index for future use
[Bunch Billing Mode?]
The system is in bunch billing mode → The equipment key from the waybill request segment is used as the waybill root key
[Update Entry Number in Segment 1]
Processing shipminu data addition → The entry number from cargo manifest is moved to segment 1 entry number and the calculated shipment value is moved to customs shipment value
[Insert Shipminu Segment 1]
Completing segment 1 processing → The updated shipminu segment 1 is inserted into the shipment database
[Insert Shipminu Segment 2]
Processing shipminu data addition → Shipminu segment 2 is inserted into the shipment database without modifications
[Format Canadian CCN]
Processing shipminu segment 3 → The system formats a Canadian CCN by concatenating prefix '6105E', compressed car ID, and waybill date
[Update US CCN Key in Segment 3]
Processing segment 3 data → The cargo US CCN key is moved to the CCN US field in shipminu segment 3
[Insert Shipminu Segment 3]
Completing segment 3 processing → The processed shipminu segment 3 is inserted into the shipment database
[Create Shipminu Segments]
The system creates shipminu segments → Set the waybill root key from the equipment key for shipminu processing
[Add Entry Number to Shipminu1]
The system processes the segment → Move the cargo entry number to the Shipminu1 entry number field
[Add Customs Value to Shipminu1]
The system processes customs value → Move the calculated shipment value to the Shipminu1 customs shipment value field
[Insert Shipminu1 Segment]
The system inserts the segment → Insert the Shipminu1 segment using the waybill root key
[Insert Shipminu2 Segment]
The system inserts the segment → Insert the Shipminu2 segment using the waybill root key
[Format Canadian CCN]
The system formats the Canadian CCN → Create Canadian CCN by concatenating '6105E', compressed equipment ID, and waybill date
[Insert Shipminu3 Segment]
The system inserts the segment → Insert the Shipminu3 segment with the formatted Canadian CCN using the waybill root key
[Update Manifest Status]
The system updates manifest status → Call cargo editing service, send to EDI if bill owner is CPRS, and notify brokers
[Retrieve IB Segment Data]
The system searches through S07 segments sequentially → If a segment is found where the SED field starts with 'IB ', the system marks it as found and saves the SED data
[Delete Associated A2RT Segments]
The cargo record is being updated → All A2RT segments linked to the US CCN key are retrieved and deleted from the database
[Search for Matching Car in Waybill]
The system searches for matching equipment in the waybill → The system iterates through waybill equipment segments until it finds a car ID that matches the cargo's car ID number index or reaches the maximum search limit
[Send Secondary Notification]
The system processes secondary location notifications → A second notification is sent with background processing, second notify flag, and activate edits flag enabled
[Determine EDI Action Type]
The system determines the EDI action type → If the manifest is preliminary, set preliminary action; if the manifest is T-value and was previously sent electronically, set update action; if the manifest is T-value but not previously sent electronically, set preliminary action; otherwise, set update action
[Set Preliminary Action]
The EDI action type is determined as preliminary → The EDI action is set to preliminary for subsequent processing
[Set Update Action]
The EDI action type is determined as update → The EDI action is set to update for subsequent processing
[Log Update Message]
The system logs the update activity → An update log entry is created with action code 'ZZZ' and message 'CARGO BUNCH BILL UPDATED AUTOMATICALLY'
[Send Cargo to EDI System]
The system processes EDI transmission → The cargo information is sent to the EDI system for electronic transmission
[Delete Existing Cargo Root Segment]
The system performs cargo root deletion → The cargo root segment is located by US CCN key and deleted from the database
[Delete Associated A2RT Segments]
The system deletes associated segments → All A2RT segments with matching US CCN key are located and deleted until no more segments exist for that CCN
[Create New Cargo Record Structure]
The system creates the new cargo structure → The cargo creation process is invoked to build the complete cargo record structure with all required segments
[Add Shipment Minutes Data]
The system adds shipment minutes data → Lead shipment minutes data is read and shipment minutes segments are added to the new cargo record
[Update Broker Notification Status]
The system processes second broker notification → Call GCCUSEDA with second notify flag, background flag, and activate edits flag set to true
[Send EDI Transmission]
The system determines EDI action type → If cargo is preliminary status, set preliminary action; if cargo is T-value and previously sent electronically, set update action; if cargo is T-value but not previously sent, set preliminary action; otherwise set update action
[Send EDI Transmission]
The cargo bill owner is CPRS or spaces → Send the cargo information to the EDI transmission system
[Log Cargo Update Activity]
The system logs the update activity → Create log entry with action code 'ZZZ', message 'CARGO BUNCH BILL UPDATED AUTOMATICALLY', US CCN key, and current timestamp
[Set Waybill Root Key from Input]
The system prepares to search for cars in the waybill → The waybill root key is set from the input key to target the correct waybill
[Clear Waybill Segments]
The system prepares to read waybill data for a specific sequence → All waybill segment areas are cleared to spaces to prevent data contamination
[Set Current Sequence Number]
The system needs to search a specific sequence position in the waybill → The current sequence counter value is assigned to the waybill request segment sequence field
[Export Status Check]
The in-bond type code is 'TR' and the cargo status description is 'EXPORT' → The system logs an error message 'CANNOT DELETE MANIFEST, MANIFEST EXPORTED' and skips deletion
[Send Cargo to EDI for Deletion]
The cargo bill owner is 'CPRS' or spaces → The system sends the cargo deletion information to the EDI system with delete action code
[Delete Shipminu Segment 1]
The system needs to clean up associated shipment data → The system accesses shipminu segment 1 using the equipment key
[Remove Shipminu Segment 1]
The system processes segment cleanup → The system removes shipminu segment 1 from the database
[Delete Shipminu Segment 2]
The system continues shipment segment cleanup → The system accesses shipminu segment 2 using the equipment key
[Remove Shipminu Segment 2]
The system processes segment cleanup → The system removes shipminu segment 2 from the database
[Cargo on Train?]
The cargo vessel name is not 'TRAIN' and not spaces → The system blocks the deletion and logs an error message indicating the cargo cannot be deleted because it is on a train
[Log: Cannot Delete - Cargo on Train]
The system detects cargo is on a train → The system logs action code 'ZZZ' with message 'CANNOT DELETE MANIFEST, CARGO ON A TRAIN'
[Non-CPRS with Broker Entry Filed?]
The cargo SCAC is not 'CPRS' and the broker entry number is not spaces and not low-values → The system blocks the deletion and logs an error message indicating the cargo cannot be deleted because a broker entry is filed
[Log: Cannot Delete - Broker Entry Filed]
The system detects non-CPRS cargo with broker entry → The system logs action code 'ZZZ' with message 'CANNOT DELETE MANIFEST, BROKER ENTRY FILED'
[Non-CPRS with Released Status?]
The cargo SCAC is not 'CPRS' and the cargo status description is 'RELEASE' → The system blocks the deletion and logs an error message indicating the cargo cannot be deleted because the manifest is released
[Log: Cannot Delete - Manifest Released]
The system detects non-CPRS cargo with released status → The system logs action code 'ZZZ' with message 'CANNOT DELETE MANIFEST, MANIFEST RELEASED'
[Export Status with TR Bond Type?]
The in-bond type code is 'TR' and the cargo status description is 'EXPORT' → The system blocks the deletion and logs an error message indicating the cargo cannot be deleted because the manifest is exported
[Log: Cannot Delete - Manifest Exported]
The system detects transit cargo with exported status → The system logs action code 'ZZZ' with message 'CANNOT DELETE MANIFEST, MANIFEST EXPORTED'
[Get C4 Commodity Code for Bill Types 00/10/99]
The bill of lading type code is '00' or '10' or '99' → Execute B9180-GET-C4-CODE to retrieve the C4 code segment, otherwise initialize the segment to spaces
[Extract from 'CUSTOMS BROKER ' format]
The system parses the broker name → Extract characters from position 16 to 43 (28 characters) as the broker long name
[Extract from 'CUSTOMS BROKER: ' format]
The system parses the broker name → Extract characters from position 17 to 43 (27 characters) as the broker long name
[Extract from 'BROKER ' format]
The system parses the broker name → Extract characters from position 8 to 43 (36 characters) as the broker long name
[Extract from 'BROKER: ' format]
The system parses the broker name → Extract characters from position 9 to 43 (35 characters) as the broker long name
[Extract from 'XU ' format, Extract from 'CB ' format]
The system parses the broker name → Extract characters from position 4 to 44 (41 characters) as the broker long name
[Extract from 'XU: ' format, Extract from 'CB: ' format]
The system parses the broker name → Extract characters from position 5 to 44 (40 characters) as the broker long name
[Use Full Instruction as Name]
The system parses the broker name → Use the entire instruction text as the broker long name
[Extract from 'CUSTOMS BROKER ' Format Position 16-28]
The system parses the broker instruction format → The broker name is extracted from character positions 16 through 28 of the instruction string
[Extract from 'CUSTOMS BROKER: ' Format Position 17-27]
The system parses the broker instruction format → The broker name is extracted from character positions 17 through 27 of the instruction string
[Extract from 'BROKER ' Format Position 8-36]
The system parses the broker instruction format → The broker name is extracted from character positions 8 through 36 of the instruction string
[Extract from 'BROKER: ' Format Position 9-35]
The system parses the broker instruction format → The broker name is extracted from character positions 9 through 35 of the instruction string
[Extract from 'XU ' Format Position 4-41, Extract from 'CB ' Format Position 4-41]
The system parses the broker instruction format → The broker name is extracted from character positions 4 through 41 of the instruction string
[Extract from 'XU: ' Format Position 5-40, Extract from 'CB: ' Format Position 5-40]
The system parses the broker instruction format → The broker name is extracted from character positions 5 through 40 of the instruction string
[Use Complete Instruction As Broker Name]
The system parses the broker instruction format → The entire instruction string is used as the broker name without any extraction
[Bill of Lading Type 00/10/99?]
The bill of lading type code is evaluated → If type is 00, 10, or 99, retrieve C4 commodity code, otherwise initialize empty commodity segment
[Retrieve C4 Commodity Code]
The system needs C4 commodity code → Retrieve C4 commodity code segment from cargo data
[Broker Entry vs Waybill Broker Match?]
The broker name in the entry does not match the broker name in the waybill → The system sets update error flag, sets do-not-update flag, and logs 'WB BROKER UPDATE NOT APPLIED BROKER ENTRY FILED' message
[Line Release Broker vs Waybill Broker Match?]
The broker name associated with the line release does not match the broker name in the waybill → The system sets update error flag, sets do-not-update flag, and logs 'WB BROKER UPDATE NOT APPLIED LINE RELEASE FILED' message
[Log Export Restriction Message]
An update attempt is made on the cargo → The system should log 'WB UPDATE NOT APPLIED, MANIFEST EXPORTED' with action code 'ZZZ'
[Compare Current Broker vs Waybill Broker]
The system attempts to update the waybill broker information → The system sets update error flag AND sets do not update flag AND logs message 'WB BROKER UPDATE NOT APPLIED LINE RELEASE FILED'
[Extract Pedimento Received Timestamp]
The system processes the dispatch hold information → The system should extract the pedimento received timestamp and assign it to the cargo manifest
[Update Existing FEN Reference]
The pedimento number from dispatch hold differs from the existing FEN reference number → The system should update the FEN reference number with the new pedimento number and log the change
[Add New FEN Reference]
No existing FEN reference is found in the N9 segments → The system should add a new N9 segment with FEN qualifier and pedimento number, then log the addition
[Update Pedimento Type]
The pedimento type from dispatch hold data differs from the cargo manifest pedimento type → The system should update the cargo manifest pedimento type to match the dispatch hold data
[Add New KCM Reference]
No existing KCM reference is found and the next available segment position does not exceed maximum N9 occurrences → The system should add a new N9 segment with KCM qualifier and Mexican CCN, then log the addition
[Clear Empty FEN Reference]
Dispatch hold data does not contain a pedimento number but an existing FEN reference exists → The system should clear the FEN reference qualifier and number, update pedimento type if different, and log the clearing
[Update Existing FEN Reference Number]
Processing FEN reference numbers during cargo creation → Update existing FEN reference number with dispatch hold pedimento number AND update pedimento type if different AND log FEN update message
[Add New FEN Reference Number]
Processing FEN reference numbers during cargo creation → Add new FEN reference number from dispatch hold pedimento number AND set pedimento type AND log FEN addition message
[Clear Existing FEN Reference]
Processing FEN reference numbers during cargo creation → Clear existing FEN reference number AND update pedimento type if changed AND log FEN removal message
[Log FEN Update Message]
Completing FEN reference processing operation → Log message with action code ZZZ AND include pedimento number and type in log message AND Execute update log operation
[Update Existing FEN Slot]
The system updates the existing FEN reference → Move 'FEN' to GCUS-N901-REF-NUM-QUAL for the slot index and move GCWDSPIO-PDMNTO-NUM to GCUS-N902-REF-NUM for the slot index
[Clear FEN Reference Data]
The system processes the empty pedimento number → Move SPACES to both GCUS-N901-REF-NUM-QUAL and GCUS-N902-REF-NUM for the existing FEN slot index
[Update Pedimento Type in Cargo]
The system updates the cargo pedimento type → Move GCWDSPIO-PDMNTO-TYPE to GCUSRT-PEDIMENTO-TYPE
[Log FEN Update Message]
The system logs the FEN change → Set GCX105-ACTION-CODE to 'ZZZ', move pedimento number to WS-LOG-MSG-FEN, move pedimento type to WS-LOG-MSG-TYP, move WS-LOG-MESSAGE-FEN to GCX105-MESSAGE, and Execute X200-UPDATE-LOG
[Retrieve Current Pedimento Number from Manifest]
The system searches for existing FEN reference number qualifiers → Locate and store the current pedimento number and its position in the N9 segment array
[Retrieve New Pedimento Number from Dispatch Hold]
The system accesses the pedimento number field in dispatch hold data → Extract the new pedimento number and pedimento type for processing
[Compare Current vs New Pedimento Numbers]
The system compares the pedimento number values → Determine if the numbers are different and require updating
[Numbers Different?]
The pedimento numbers are not equal → Proceed with pedimento type validation and number update process
[Update Pedimento Number in N9 Segment]
The system updates the FEN reference number in the N9 segment → Replace the existing pedimento number with the new value at the identified position
[Update Pedimento Type in Cargo Record]
The system processes pedimento type updates → Update the cargo record pedimento type to match the dispatch hold pedimento type
[Log Pedimento Number Change]
The system completes the pedimento number change → Create a log entry with action code ZZZ documenting the pedimento number and type change
[Clear Existing Pedimento Number]
The system processes the pedimento clearing → Clear the FEN reference number qualifier and reference number from the N9 segment
[Log Pedimento Number Removal]
The system completes the pedimento number removal → Create a log entry with action code ZZZ documenting the pedimento number removal and type update
[Add New Pedimento Number to Available Slot]
The system adds the pedimento number → Set the reference number qualifier to FEN and populate the reference number with the dispatch hold pedimento number
[Log New Pedimento Number Addition]
The system completes the pedimento number addition → Create a log entry with action code ZZZ documenting the new pedimento number and type addition
[Pedimento Numbers Different?]
The system compares the current pedimento number from the FEN segment with the new pedimento number from dispatch hold → If the pedimento numbers are different, proceed with pedimento type validation, otherwise complete validation
[Update FEN Segment with New Pedimento]
The system updates the FEN segment reference number → The FEN segment is updated with the new pedimento number and the change is logged
[Update Pedimento Type if Different]
The system updates both the FEN segment and the manifest pedimento type → Both the pedimento number in FEN segment and the pedimento type in manifest are updated, and the change is logged
[Add New FEN Segment]
The system creates a new FEN segment entry → A new FEN segment is added with the pedimento number and type, and the addition is logged
[Remove Pedimento Required?]
If pedimento removal is required → If removal is required, clear the FEN segment and pedimento references, otherwise complete validation
[Clear FEN Segment]
The system clears the FEN segment and related pedimento references → The FEN segment is cleared, pedimento references are removed, and the removal is logged
[Add New KCM Reference]
The system processes the KCM addition → The system adds the KCM qualifier and reference number to the available empty slot
[Log KCM Update Message]
The system completes the KCM update process → The system logs an update message with action code ZZZ and the new KCM value
[Log KCM Addition Message]
The system completes the KCM addition process → The system logs an addition message with action code ZZZ and the new KCM value
[Log KCM Removal Message]
The system completes the KCM removal process → The system logs a removal message with action code ZZZ and empty KCM value
[Find Existing KCM Segment]
The system iterates through segments from 1 to GCSUSS99-N9-MAX-OCURS-BYSEQ looking for qualifier 'KCM' → The system identifies the segment index (WS-KCM-SUB) where GCUS-N901-REF-NUM-QUAL equals 'KCM' and WS-KCM-SUB equals 0
[KCM Value Different?]
The system compares GCWDSPIO-MX-CCN with the saved reference number WS-SAVE-GCUS-N902-REF-NUM at the KCM segment index → Update processing continues only if GCWDSPIO-MX-CCN is not equal to WS-SAVE-GCUS-N902-REF-NUM(WS-KCM-SUB)
[Update Existing KCM Reference]
The system processes the KCM reference update → The system sets GCUS-N901-REF-NUM-QUAL(WS-SUB-N9) to 'KCM' and GCUS-N902-REF-NUM(WS-SUB-N9) to GCWDSPIO-MX-CCN
[Find Empty Slot in N9 Segments]
The system needs to add a new KCM reference → The system uses WS-DSP-SUB as the segment index (WS-SUB-N9) for the new KCM reference
[Add New KCM Reference]
The system adds a new KCM reference → The system sets GCUS-N901-REF-NUM-QUAL(WS-SUB-N9) to 'KCM' and GCUS-N902-REF-NUM(WS-SUB-N9) to GCWDSPIO-MX-CCN
[Clear Existing KCM Reference]
The system processes the KCM reference removal → The system clears both GCUS-N901-REF-NUM-QUAL(WS-SUB-N9) and GCUS-N902-REF-NUM(WS-SUB-N9) to SPACES
[Log KCM Update Activity]
The system completes the KCM reference processing → The system sets GCX105-ACTION-CODE to 'ZZZ', populates WS-LOG-MSG-KCM with the Mexican CCN value (or SPACES for removal), sets GCX105-MESSAGE to WS-LOG-MESSAGE-KCM, and performs X200-UPDATE-LOG
[Current Segment = 'KCM'?]
Current N9 segment qualifier equals 'KCM' → KCM segment is identified for further processing
[KCM Segment Already Found?]
KCM segment is found for the first time → Current segment position is stored in KCM segment counter
[Continue to Next Segment]
Current segment processing is complete → System advances to next N9 segment position for continued processing
[Update Waybill Reference Number from WB Root Key]
The system processes the N9 segment for waybill reference updates → The waybill reference number should be updated with characters 10-15 from the waybill root key
[Update Bill of Lading Reference from Shipment Bill Number]
The system processes the N9 segment for bill of lading reference updates → The bill of lading reference number should be updated with the shipper's bill of lading number from the shipment root
[Mark Position for Dispatch Hold Data]
The system processes the N9 segment loop → The current position should be marked as the dispatch hold data position for future use
[Iterate through all N9 segments with position tracking and qualifier validation]
The system processes N9 segments for reference number updates → All N9 segments should be processed sequentially from position 1 up to the maximum allowed occurrences
[Check EDI Transmission Status]
The system processes the cargo status → The system should check if EDI was previously sent electronically and set the EDI sent flag accordingly
[Set EDI Sent Flag]
The cargo is being processed for updates → The EDI sent flag should be set to true and amendment code should be set to '01' if cargo is acknowledged
[Log Status Change]
The status update is processed → The status change should be logged with appropriate action code and message details
[Perform Secondary Notification]
The secondary location identifier is not empty spaces → The system must Execute secondary notification processing with background mode, second notify flag, and edit validation activated
[Determine EDI Transmission Type]
The cargo has preliminary status (M1009-PRELIMINARY) → The EDI action code must be set to preliminary transmission type
[Determine EDI Transmission Type]
The cargo has already been sent electronically (RT33-EDI-SENT-ELECTR) → The EDI action code must be set to update transmission type, otherwise it must be set to preliminary transmission type
[Set Update Action Code]
The cargo is neither preliminary status nor T-Value status → The EDI action code must be set to update transmission type
[Set US CCN Key for Transmission]
The system prepares to send cargo data to EDI systems → The US CCN key from the cargo record is set as the transmission identifier in the EDI message structure
[Set Transmission Source as GCX113]
The system needs to identify the source of the transmission → The transmission source is set to GCX113 to indicate the originating program
[Check Port Validity and Cargo Type]
If routing for EDI transmission → If the port is valid AND the cargo is export type OR US-Canada transit OR multi-transit, route to export EDI system, otherwise route to standard EDI system
[Send to Export EDI System GCCS309E]
The system transmits the cargo data → The cargo data is sent to the GCCS309E export EDI system
[Send to Standard EDI System GCCS309]
The system transmits the cargo data → The cargo data is sent to the GCCS309 standard EDI system
[Broker Table Lookup Processing]
The system performs broker table lookup using table ID 'BK' → The system should retrieve the broker segment configuration or initialize empty configuration if not found
[Retrieve B1 Broker Configuration]
The system performs B1 table lookup using table ID 'B1' → The system should retrieve B1 configuration segment if available, otherwise initialize empty B1 configuration
[Set EDI Sent Status]
The system processes EDI transmission status restoration → The EDI sent electronic status (88-GCUSRT-RT33-EDI-SENT-ELECTR) is set to true AND the amendment code (GCUS-M1306-AMENDMENT-CDE) is set to '01'
[Set Acknowledgment Release Status]
The system processes cargo acknowledgment status → The cargo status is updated to acknowledgment release (88-GCUSRT-RT21-USCARGO-ACK-R is set to true)
[Update CCN Keys in All Cargo Segments]
The CCN key needs to be applied to cargo data → The CCN key is updated in all cargo segments including GCSUSS01, GCSUSS02, GCSUSS04, GCSUSS05, GCSUSS08, GCSUSS03, GCSUSS06, GCSUSS07, GCSUSS10, GCSUSS11, GCSUSS12, GCSUSS13, and GCSUSS14
[Finalize Transaction State]
All message processing is complete and the system is preparing to commit the transaction → The system restores the saved program name to the common communication area before calling the commit function
[Is Canadian Qualifier Present?]
The system checks the qualifier field in the shipminu3 segment → If the qualifier-CA field contains spaces, skip Canadian CCN generation, otherwise proceed with CCN generation
[Store Canadian CCN in Shipminu Segment]
Finalizing the Canadian CCN generation process → The CCN is stored in the CCN-CA field of the shipminu3 segment
[Extract Pedimento Received Timestamp]
The dispatch hold data contains a pedimento received timestamp → The system should assign the timestamp to the cargo pedimento received timestamp field
[Pedimento Number Present?]
The dispatch hold data contains a non-empty pedimento number → The system should proceed with FEN reference number processing
[Update Existing FEN Reference]
The dispatch hold pedimento number differs from the existing FEN reference number or pedimento type differs → The system should update the FEN reference number and pedimento type, then log the change
[Add New FEN Reference]
An empty N9 segment slot is available → The system should create a new FEN reference with the pedimento number and type, then log the addition
[Update Existing FEN Reference]
The dispatch hold pedimento number is empty → The system should clear the existing FEN reference number and update pedimento type if different, then log the removal
[Add New KCM Reference]
An empty N9 segment slot is available and within maximum occurrence limits → The system should create a new KCM reference with the Mexican CCN and log the addition
[Retrieve Dispatch Hold Data for Car]
The system needs to process pedimento information for the car → The system retrieves dispatch hold data using the car ID and waybill number
[Dispatch Hold Data Found?]
The system checks the result of the dispatch hold data retrieval → If data is found successfully or key not found, continue processing, otherwise skip pedimento processing
[Extract Pedimento Number from Hold Data]
The system processes the hold data for pedimento information → The pedimento number and type are extracted from the hold data fields
[Check Existing FEN Reference in Manifest]
The system processes the manifest reference segments → The system identifies if an existing FEN reference is present and its position
[FEN Reference Found?]
Processing pedimento number updates → If FEN reference exists, compare and update if different, otherwise add new FEN reference segment
[Compare Pedimento Numbers]
The system compares the pedimento numbers → The system determines if the numbers are different and require updating
[Update Existing FEN Reference]
The system processes the pedimento update → The existing FEN reference is updated with the new pedimento number and the reference counter is incremented
[Add New FEN Reference Segment]
The system processes the pedimento information → A new FEN reference segment is added with the pedimento number and the reference counter is incremented
[Update Pedimento Type if Different]
The system compares the current pedimento type with the new type from dispatch hold → If the types are different, update the cargo record with the new pedimento type
[Log Pedimento Update Message]
The system completes the pedimento processing → An audit log entry is created with action code ZZZ documenting the pedimento update with number and type
[Clear Existing FEN Reference]
The system processes the pedimento information → The existing FEN reference segment is cleared and the reference counter is incremented
[Update Pedimento Type Only]
The system processes the pedimento type update → Only the pedimento type is updated in the cargo record without adding FEN references
[Log Pedimento Removal Message]
The system completes the pedimento removal processing → An audit log entry is created with action code ZZZ documenting the pedimento removal with type information
[Update Existing KCM Reference]
The current KCM reference value differs from the dispatch hold Mexican CCN → The existing KCM reference segment is updated with the new Mexican CCN value and activity is logged
[Add New KCM Reference Segment]
The system has available segment slots within the maximum N9 segment limit → A new KCM reference segment is created with the Mexican CCN value and activity is logged
[Log Mexican CCN Update]
The system completes KCM reference segment processing → Activity log entry is created with action code ZZZ and message containing the Mexican CCN value
[Clear Mexican CCN Data]
The system processes the KCM reference segment → The KCM reference qualifier and number fields are cleared to spaces and removal activity is logged
[Process WY - Waybill Reference]
The system processes the N9 segment during more duplication operation → The reference number field is updated with positions 10-15 of the waybill root key
[Process BM - Bill of Lading Reference]
The system processes the N9 segment during more duplication operation → The reference number field is updated with the shipper bill of lading number from the shipment root
[Identify Empty N9 Segment Position]
An N9 segment with empty reference number qualifier is encountered → The segment position is stored as the dispatch hold data position index
[Scan for FEN - Mexican Pedimento Numbers]
A segment with reference number qualifier 'FEN' is found → The segment position is stored as the FEN segment position index
[Scan for KCM - Mexican CCN References]
A segment with reference number qualifier 'KCM' is found → The segment position is stored as the KCM segment position index
[Store Empty Position Index]
A segment with empty reference number qualifier is encountered → The segment position is stored as the dispatch hold data position index
[Process WY - Waybill Reference]
Processing reference number qualifiers of type 'WY' (Waybill Reference) → Extract positions 10-15 from the waybill root key AND update the corresponding N9 reference number field
[Process BM - Bill of Lading Reference]
Processing reference number qualifiers of type 'BM' (Bill of Lading Reference) → Extract the shipper bill number from the shiproot segment AND update the corresponding N9 reference number field
[Identify Empty Reference Slots]
A reference number qualifier field contains spaces (empty) → Record the position index as the first available slot for dispatcher hold updates
[Update N9 Segment with Bill of Lading Number]
The system processes the N9 reference segments → The N9 segment reference number is updated with the bill of lading number from the shipment root
[Update N9 Segment with Bill of Lading Number]
The system processes the N9 reference segments → The N9 segment reference number is updated with characters 10-15 of the waybill root key
[Move to Next N9 Segment]
The system encounters the empty N9 segment → The system records this segment index as the first available empty position
[Set Pedimento Timestamp in Cargo]
Pedimento received timestamp is available in the response → Set the pedimento received timestamp in the cargo record
[Pedimento Number Available?]
Pedimento number field is not empty → Proceed with FEN reference number processing
[FEN Already Exists in Manifest?]
FEN subscript is not zero indicating existing FEN entry → Update the existing FEN entry with new pedimento number
[Update Existing FEN Entry]
The new pedimento number differs from existing FEN reference number → Update the FEN reference number and pedimento type, then log the change
[Add New FEN Entry]
Available N9 segment slot exists → Add new FEN qualifier and pedimento number, update pedimento type, and log the addition
[Update Existing FEN Entry]
FEN subscript is not zero but pedimento number is empty → Clear the FEN reference number and qualifier, update pedimento type, and log the removal
[KCM Already Exists in Manifest?]
KCM subscript is not zero indicating existing KCM entry → Update the existing KCM entry with new Mexican CCN
[Add New KCM Entry]
Available N9 segment slot exists and within maximum occurrences limit → Add new KCM qualifier and Mexican CCN, then log the addition
[Check Broker Entry Status]
The broker entry number is not spaces or low-values and the cargo broker name differs from the waybill broker name → Set validation error flag and log message 'WB BROKER UPDATE NOT APPLIED BROKER ENTRY FILED'
[Check Quantity Changes]
The broker entry number is not spaces or low-values and the cargo quantity differs from the shipment commodity quantity → Set validation error flag and log message 'WB QUANTITY UPDATE NOT APPLIED BROKER ENTRY FILED'
[Check Line Release Status]
The line release number is not spaces or low-values and the cargo broker name differs from the waybill broker name → Set validation error flag and log message 'WB BROKER UPDATE NOT APPLIED LINE RELEASE FILED'
[Check Export Status]
The in-bond type code is 'TR' and the cargo status description is 'EXPORT' → Set validation error flag and log message 'WB UPDATE NOT APPLIED, MANIFEST EXPORTED'
[Bill of Lading Type 00/10/99?]
The bill of lading type code is 00, 10, or 99 → Retrieve C4 commodity code segment for the cargo
[Retrieve C4 Commodity Code]
The system needs commodity code information → Read segment 07 with sequence 0001 to get C4 commodity code data
[Current Code = 'XU'?]
The system encounters the XU code during processing → The XU instructions are extracted, broker name is parsed, and CB found flag is set to prevent CB code processing
[Parse Broker Name from XU Code]
The system parses the instruction text → Broker name is extracted based on prefixes: 'CUSTOMS BROKER ', 'CUSTOMS BROKER: ', 'BROKER ', 'BROKER: ', 'XU ', 'XU: ', 'CB ', 'CB: ', or the entire instruction if no prefix matches
[Generate Equipment Update Message]
The system generates the waybill recreation message → A GCX111 message is created with waybill key, date, and recreation action, then sent to GCT1113E process
[Cargo on Train?]
The system checks if the cargo vessel name is not 'TRAIN' and not empty → If cargo is on a train, log error message 'CANNOT DELETE MANIFEST, CARGO ON A TRAIN' and skip deletion; otherwise continue validation
[Broker Entry Filed for Non-CPRS?]
The system checks if the cargo has a broker entry number that is not empty or low-values → If broker entry exists for non-CPRS cargo, log error message 'CANNOT DELETE MANIFEST, BROKER ENTRY FILED' and skip deletion; otherwise continue validation
[Manifest Released for Non-CPRS?]
The system checks if the cargo status description is 'RELEASE' → If manifest is released for non-CPRS cargo, log error message 'CANNOT DELETE MANIFEST, MANIFEST RELEASED' and skip deletion; otherwise continue validation
[Export Manifest?]
The system checks if the in-bond type code is 'TR' and the cargo status description is 'EXPORT' → If cargo is transit type and exported, log error message 'CANNOT DELETE MANIFEST, MANIFEST EXPORTED' and skip deletion; otherwise proceed with deletion
[Is Export Manifest?]
The system validates cargo deletion eligibility → If in-bond type code equals 'TR' and cargo status description equals 'EXPORT', deletion is blocked with error message 'CANNOT DELETE MANIFEST, MANIFEST EXPORTED'
[Is Broker Entry Filed?]
The system validates cargo deletion for non-CPRS cargo → If SCAC is not 'CPRS' and broker entry number is not spaces and not low-values, deletion is blocked with error message 'CANNOT DELETE MANIFEST, BROKER ENTRY FILED'
[Is Manifest Released?]
The system validates cargo deletion for non-CPRS cargo → If SCAC is not 'CPRS' and cargo status description equals 'RELEASE', deletion is blocked with error message 'CANNOT DELETE MANIFEST, MANIFEST RELEASED'
[Delete Shipminu Segment 1]
The system attempts to delete customs shipment segment 1 using segment number '1' → If the segment is found, it should be deleted from the customs shipment database
[Delete Shipminu Segment 2]
The system attempts to delete customs shipment segment 2 using segment number '2' → If the segment is found, it should be deleted from the customs shipment database
[Execute Delete Operation for Segment 1, Execute Delete Operation for Segment 2]
The segment deletion operation is executed → The segment should be permanently removed from the customs shipment database
[Bill of Lading Type = '00', '10', or '99'?]
The bill of lading type is '00' (standard), '10' (hazardous), or '99' (special) → The system should retrieve C4 commodity code data from the additional cargo segment
[Set up C4 Code Retrieval Parameters]
The system needs to access commodity code data → The system should set segment type to GCSA2RT, record type to '07', and sequence to '0001' for database access
[Process Pedimento Number Data]
Pedimento number exists in the dispatch hold data → Update FEN reference numbers in cargo segments and log the pedimento number changes with type information
[Process Mexican CCN Data]
Mexican CCN exists in the dispatch hold data → Update KCM reference numbers in cargo segments and log the Mexican CCN changes
[Bill of Lading Type 00/10/99?]
The bill of lading type is evaluated → If bill of lading type code is '00' or '10' or '99', retrieve C4 commodity code from segment 07
[Retrieve C4 Commodity Code]
The system retrieves segment 07 data → The C4 commodity code should be extracted from record type 07 sequence 0001
[Log: Cannot Update - Cargo on Train]
The system logs the restriction → Action code should be set to 'ZZZ' and message should be 'WAYBILL UPDATE NOT APPLIED CARGO ON A TRAIN'
[Log: Cannot Update - Broker Entry Filed]
The system logs the restriction → Action code should be set to 'ZZZ' and message should be 'WB BROKER UPDATE NOT APPLIED BROKER ENTRY FILED'
[Log: Cannot Update - Quantity Changed]
The system logs the restriction → Action code should be set to 'ZZZ' and message should be 'WB QUANTITY UPDATE NOT APPLIED BROKER ENTRY FILED'
[Log: Cannot Update - Line Release Filed]
The system logs the restriction → Action code should be set to 'ZZZ' and message should be 'WB BROKER UPDATE NOT APPLIED LINE RELEASE FILED'
[Log: Cannot Update - Manifest Exported]
The system logs the restriction → Action code should be set to 'ZZZ' and message should be 'WB UPDATE NOT APPLIED, MANIFEST EXPORTED'
[Parse Special Handling Instructions]
The instruction starts with 'CUSTOMS BROKER ', 'CUSTOMS BROKER: ', 'BROKER ', 'BROKER: ', 'XU ', 'XU: ', 'CB ', or 'CB: ' → The broker name is extracted by removing the prefix and capturing the remaining text as the broker long name
[Special Handling Code = 'XU'?]
The special handling code equals 'XU' → Extract the special handling instructions, parse the broker name from XU code format, and set the CB found flag to prevent further CB code processing
[CB Found from Temporary Storage?]
CB instructions were temporarily stored during the scan → Process the CB instructions and parse the broker name from CB code format
[Read Lead Car Shipminu Segments]
The system needs to create new cargo and requires customs shipment data → The system reads shipminu segment 1, segment 2, and segment 3 from the lead car and stores the data and availability status for each segment
[Update Entry Number in Segment 1]
Creating new cargo shipment data → The system updates the entry number field in shipminu segment 1 with the cargo's entry number and updates the customs shipment value with the calculated ship value
[Format Canadian CCN with Prefix]
Processing shipminu segment 3 for Canadian CCN formatting → The system compresses the car ID by removing leading zeros and spaces, then formats the Canadian CCN as '6105E' + compressed car ID + waybill date
[Insert Shipminu Segment 1, Insert Shipminu Segment 2, Insert Shipminu Segment 3]
Creating new cargo shipment records → The system inserts each available shipminu segment (1, 2, and 3 if found) into the database using the waybill root key
[Delete Segment 1, Delete Segment 2]
Processing cargo deletion → The system attempts to delete shipminu segment 1 and segment 2 if they are found for the equipment key
[Prepare Shipminu Data for New Cargo]
The operation type is bunch billing → The system uses the equipment key as the waybill root key, otherwise uses the shiproot key as the waybill root key
[Export Status Check]
The system validates cargo for deletion → The system logs an error message 'CANNOT DELETE MANIFEST, MANIFEST EXPORTED' and skips deletion
[Send Cargo to EDI System]
The cargo bill owner is 'CPRS' or spaces → The cargo deletion is sent to the EDI system with delete action
[Delete Shipminu Segments]
The system completes cargo deletion processing → Associated shipminu segments are deleted from the system
[Train Status Check]
The vessel name is not 'TRAIN' and not spaces → Log error message 'CANNOT DELETE MANIFEST, CARGO ON A TRAIN' and skip deletion of this cargo record
[Export Status Check]
The in-bond type code equals 'TR' and the cargo status description equals 'EXPORT' → Log error message 'CANNOT DELETE MANIFEST, MANIFEST EXPORTED' and skip deletion of this cargo record
[Send Cargo to EDI]
The cargo bill owner is 'CPRS' or spaces → Send the cargo deletion information to the EDI system
[Extract Equipment ID from Waybill]
Equipment key management is initiated → The equipment ID is extracted from FWEQ-EQP-ID in the waybill equipment request segment
[Store Equipment Key for Waybill Operations]
The equipment key needs to be stored for waybill operations → The equipment ID is moved to GCWCARTPIF-CAR-ID and car indicator is set to true
[Call READQ to Read Message from Queue]
The READQ function is called to retrieve a message from the input queue → The system should read the message into the input structure and set the message length
[Access Granted?]
The system checks the access permissions for GCX113 operations → If access is granted, proceed to action code processing, otherwise skip to next message
[More Messages in Queue?]
A message processing cycle is completed → If the no-more-input-message flag is not set, continue reading next message, otherwise end the processing loop
[Set Segment Keys with US CCN]
Processing GCSUSS01, GCSUSS02, GCSUSS04, GCSUSS05, GCSUSS10, GCSUSS11, GCSUSS13, or GCSUSS14 segments that are not empty → The US CCN key must be assigned to each non-empty segment's key field to establish proper cargo manifest relationships
[Set Segment Keys with US CCN]
Each segment occurrence contains data that is not spaces, low-values, or has a non-empty key → The US CCN key must be assigned to each valid occurrence's key field and the updated segment must be stored back to the working storage array
[Handle Special Reference Numbers]
Processing N9 segments that contain FEN or KCM reference number qualifiers → The reference number qualifier and reference number fields must be cleared to spaces for FEN and KCM entries
[Process GCSUSS07 SED Segments]
Processing a GCSUSS07 segment where the SED field starts with 'IB ' and the IB segment was found → The saved SED data must be restored to the current segment's SED field to preserve the in-bond information
[Delete GCSUSRT Root Segment]
Deleting cargo segments → The GCSUSRT root segment must be located using the saved US CCN key and deleted from the cargo database
[Delete A2RT Associated Segments]
Processing A2RT associated segments for deletion → All A2RT segments matching the US CCN key must be located using both AX and PX access methods and deleted until no more matching segments exist
[Process GCSUSS03 Segments]
Processing GCSUSS03 segments and the segment data is not empty or low-values and the CCN key is not empty → Update the US CCN key in each GCSUSS03 segment and store the updated segment back to the array
[Process GCSUSS06 Segments]
Processing GCSUSS06 segments and the segment data is not empty or low-values and the CCN key is not empty → Update the US CCN key in each GCSUSS06 segment and store the updated segment back to the array
[Check for IB Segment Data]
Processing GCSUSS07 segments and the segment SED field starts with 'IB ' and IB segment was previously found → Restore the saved SED data to preserve the IB segment information and update the CCN key
[Process GCSUSS08 Segments]
Processing GCSUSS08 segments and the segment data is not empty or low-values and the CCN key is not empty → Update the US CCN key in each GCSUSS08 segment and store the updated segment back to the array
[Process GCSUSS12 Segments]
Processing GCSUSS12 segments and the segment data is not empty or low-values and the CCN key is not empty → Update the US CCN key in each GCSUSS12 segment and store the updated segment back to the array
[Loop Through S07 Segments]
The system processes each S07 segment sequentially until IB segment is found or maximum segments reached → Each segment is retrieved and checked for IB data, continuing until found or all segments processed
[Save SED Data to Working Storage]
The system needs to preserve the original SED data before CCN modifications → The complete SED field content is copied to working storage variable WS-SAVE-SED and IB segment found flag is set to true
[Restore Saved SED Data]
The system processes S07 segments during CCN key updates and encounters the IB segment → The saved SED data from working storage is restored back to the S07 segment, overriding any modifications that may have occurred
[Set S07 Sequence Counter to 1]
The system prepares to iterate through S07 segments → The S07 sequence counter is set to 1 to start from the first segment
[Retrieve S07 Segment by Sequence]
The system attempts to retrieve an S07 segment → The system calls Z610-GET-SEG07 to fetch the S07 segment data for the current sequence number
[Mark IB Segment as Found]
The system confirms the IB segment identification → WS-IB-SEG-FOUND is set to true to indicate successful location of IB segment data
[Save SED Data for Recovery]
The system needs to preserve the IB segment data → The GCUS-SED data is moved to WS-SAVE-SED for later recovery and processing
[Increment S07 Sequence Counter]
The system prepares to examine the next S07 segment → The WS-GCSUSS07-SEQ counter is incremented by 1 to move to the next segment
[More S07 Segments Available?]
If whether to continue the search process → If IB segment is not yet found AND the sequence counter has not exceeded maximum segments, more segments are available for processing
[End IB Segment Search]
The search termination conditions are met → The IB segment search process is completed and control returns to the calling procedure
[Set US CCN Key, Set Record Type to '07', Set Sequence Number]
The system constructs the segment access key → The system sets the US CCN key to the cargo manifest identifier, sets record type to '07' for commodity segments, and sets the sequence number to the provided sequence value
[Return Segment Data, Return Empty Segment]
The system prepares to return segment data to the caller → If segment was found, the system returns the retrieved S07 commodity segment data; if segment was not found, the system returns an initialized empty S07 segment structure
[Extract FEN Pedimento Number]
Processing FEN pedimento information → The system extracts the pedimento number, pedimento type, and determines if an existing FEN reference needs to be updated or a new one added
[Update Existing FEN Reference]
The pedimento number from dispatch hold differs from the existing FEN reference → The system updates the existing FEN reference with the new pedimento number, updates the pedimento type if different, and logs the change
[Add New FEN Reference to N9 Segment]
An empty N9 segment slot is available → The system adds a new FEN reference with qualifier 'FEN', sets the pedimento number, updates the pedimento type if different, and logs the addition
[Remove FEN from N9 Segment]
The existing FEN reference needs to be cleared → The system clears the FEN reference qualifier and number from the N9 segment, updates the pedimento type if different, and logs the removal
[Extract KCM Mexican CCN]
Processing KCM Mexican CCN information → The system extracts the Mexican CCN and determines if an existing KCM reference needs to be updated or a new one added
[Update Existing KCM Reference]
The Mexican CCN from dispatch hold differs from the existing KCM reference → The system updates the existing KCM reference with the new Mexican CCN and logs the change
[Add New KCM Reference to N9 Segment]
Adding a new KCM reference → The system adds a new KCM reference with qualifier 'KCM', sets the Mexican CCN, and logs the addition
[Remove KCM from N9 Segment]
The existing KCM reference needs to be cleared → The system clears the KCM reference qualifier and number from the N9 segment and logs the removal
[Update Pedimento Received Timestamp]
Updating cargo record with timing information → The system updates the cargo record with the pedimento received timestamp from the dispatch hold data
[Update Existing FEN Reference]
The dispatcher hold pedimento type differs from cargo pedimento type → Update the pedimento type in cargo record, increment DSP counter, set FEN qualifier and number, and log the FEN update
[Add New FEN Reference]
Dispatcher hold contains pedimento data → Use DSP slot index, increment DSP counter, set FEN qualifier and pedimento number, update pedimento type if different, and log the FEN addition
[Clear FEN Reference]
Dispatcher hold pedimento type differs from cargo pedimento type → Increment DSP counter, clear the FEN qualifier and reference number, update pedimento type, and log the FEN clearing
[Process WY Qualifier Waybill Reference]
The system processes the WY qualifier → The reference number is updated with characters 10-15 of the waybill root key
[Process BM Qualifier Bill of Lading Reference]
The system processes the BM qualifier → The reference number is updated with the shipper bill number from shiproot
[Identify Empty N9 Slot]
The system scans the N9 qualifier → The position is stored in WS-DSP-SUB for future use
[Process FEN Qualifier Mexican Pedimento Number]
The system processes the FEN qualifier → The qualifier position is stored in WS-FEN-SUB for pedimento number management
[Process KCM Qualifier Mexican CCN Number]
The system processes the KCM qualifier → The qualifier position is stored in WS-KCM-SUB for Mexican CCN management
[Access N9 Reference Number Qualifier]
The system accesses N9 reference number qualifier at current counter position → The system shall retrieve the N9 reference number qualifier value from GCUS-N901-REF-NUM-QUAL array using current counter index
[Increment N9 Counter / Continue to Next N9 Segment]
The system completes processing of current N9 segment position → The system shall increment the N9 counter by 1 and continue to the next N9 segment iteration
[Read SHIPROOT Segment]
The system performs SHIPROOT segment read operation → The SHIPROOT segment data is retrieved and made available for processing
[Extract Waybill Root Key]
The system processes the SHIPROOT data → The waybill root key is extracted and stored for use in related operations
[Get Equipment Information]
The system processes equipment information → Car ID, equipment type, and related equipment details are extracted and made available
[Retrieve Special Handling Codes]
The system processes special handling codes → Broker information is extracted from customs broker or XU special handling instructions
[Read SHIPCOMM Segment]
The system performs SHIPCOMM segment read operation → The SHIPCOMM segment data is retrieved for commodity processing
[Extract Commodity Weight]
The system processes weight information and the cargo uses KG units → The metric commodity weight is extracted, otherwise standard commodity weight is used
[Get Number of Units]
The system processes commodity data → The number of units is extracted and assigned to cargo quantity fields
[Read SHIPMINU Segment 1]
The system performs SHIPMINU segment 1 read operation → The first SHIPMINU segment data is retrieved and stored for processing
[Read SHIPMINU Segment 2]
The system performs SHIPMINU segment 2 read operation → The second SHIPMINU segment data is retrieved and stored for processing
[Read SHIPMINU Segment 3]
The system performs SHIPMINU segment 3 read operation → The third SHIPMINU segment data is retrieved for Canadian CCN processing
[Update Entry Numbers]
The system processes SHIPMINU updates → The entry number from cargo is assigned to the SHIPMINU segment entry number field
[Update Customs Shipment Values]
The system processes SHIPMINU updates → The calculated shipment value is assigned to the customs shipment value field
[Format Canadian CCN]
The system processes Canadian CCN formatting → The Canadian CCN is formatted as '6105E' + compressed equipment ID + waybill date
[Insert SHIPMINU Segments]
The system performs SHIPMINU insert operations → Each found SHIPMINU segment is inserted into the waybill with the appropriate root key
[Delete SHIPMINU Segments]
The system performs SHIPMINU delete operations for segments 1 and 2 → The existing SHIPMINU segments are removed from the waybill
[Apply CCN to All Segments]
CCN application is performed → The system updates CCN keys in segments GCSUSS01, GCSUSS02, GCSUSS04, GCSUSS05, GCSUSS08, GCSUSS03, GCSUSS06, GCSUSS07, GCSUSS10, GCSUSS11, GCSUSS12, GCSUSS13, and GCSUSS14
[Extract Waybill Key from Cargo]
Dispatch processing is initiated → The waybill key is extracted from the cargo root waybill key field (GCUSRT-RT082-WAYBILL-KEY) and stored in the dispatch message non-dispatch waybill key field (FWIOMSG-NDSP-WB-KEY)
[Call Dispatch Processing Module GCCCS417]
Dispatch processing is required → The system calls the GCCCS417 module using the prepared dispatch message structure
[Send Notification via Merlin]
The system sends notification via Merlin → Notification message is prepared with cargo CCN and action type, then transmitted to GCT1081E for Merlin delivery using broker Merlin ID
[Send Notification via Internet]
The system sends notification via Internet → Notification message is prepared with cargo CCN and action type, then transmitted to GCT1081E for Internet delivery using broker Internet address
[Send Notification via Fax]
The system sends notification via Fax → Notification message is prepared with cargo CCN and action type, then transmitted to GCT1081E for Fax delivery using broker fax number
[Send to Enhanced EDI Processing]
The port is valid AND the cargo is export type:
the port is valid AND the cargo is US-Canada transit
the port is valid AND the cargo is multi-transit
→ The system should send the cargo to enhanced EDI processing via GCCS309E
[Send to Standard EDI Processing]
The port is valid AND the cargo is NOT export type AND NOT US-Canada transit AND NOT multi-transit → The system should send the cargo to standard EDI processing via GCCS309
[Send EDI Deletion Message]
The cargo bill owner is 'CPRS' or spaces → Send EDI deletion message through the X100-SEND-CARGO-TO-EDI process
[Retrieve Next A2RT Segment by US CCN Key]
The system searches for A2RT segments using the US CCN key → The system retrieves the next A2RT segment that matches the US CCN key or returns not found status
[Position to A2RT Segment for Deletion]
The system needs to delete the specific segment → The system positions to the exact A2RT segment using its key for deletion operation
[Delete A2RT Segment from Database]
The deletion operation is executed → The A2RT segment is permanently removed from the database
[Set No More A2RT Segments Flag]
No more A2RT segments need to be processed for the current cargo → The system sets the flag to indicate no more A2RT segments require processing
[Check Previous EDI Status]
The system checks previous EDI status and finds that EDI was previously sent → The EDI sent electronic status is set to true and the amendment code is set to '01'
[Check Cargo Acknowledgment]
The system checks if cargo was previously acknowledged and finds acknowledgment status is true → The cargo acknowledgment received status is set to true
[Set Segment Type to SHIPROOT]
The system configures database access parameters → The segment type must be set to 'SHIPROOT' to target the correct data segment in the waybill database
[Set Operator to Equal]
The system configures search criteria for data retrieval → The operator must be set to equal (' =') to Execute exact match searches on the waybill root key
[Set Waybill Root Key]
The system prepares to identify the target shipment record → The waybill root key from the input message (GCX113-WB-ROOT-KEY) must be assigned to the database access parameter (FWWB-ROOT-KEY)

Structural Validations

[1:Message Input Processing]
The action type is not one of BUNCH-BILLING, MORE-DUPLICATION, BUNCH-BILL-CLONE, SEND-BUNCH-417, MULTI-CAR-DELETE, BUNCH-BILL-CANCEL, BUNCH-BILL-UPDATE, VALIDATE-BUNCH-UPDATE, or BUNCH-BILL-DELETE → The system terminates processing with an invalid action type error
[6:Waybill Relationship Processing]
The waybill root key already exists in the system → The system terminates with 'WAYBILL ALREADY USED' error message
[Message Read Successfully?]
The system checks the return code from the READQ operation → If the return code indicates a non-acceptable result, the system identifies this as a read failure
[Handle Read Error]
The system detects a non-acceptable return code from READQ → An error message is constructed indicating READQ failure with the message length details
[US CCN Key = SPACES?]
The US CCN key field is empty or contains only spaces → The system should set error message 'NO US CCN RECEIVE' and abort processing
[Valid Action Code?]
The action code is not one of BUNCH-BILLING, MORE-DUPLICATION, BUNCH-BILL-CLONE, SEND-BUNCH-417, MULTI-CAR-DELETE, BUNCH-BILL-CANCEL, BUNCH-BILL-UPDATE, VALIDATE-BUNCH-UPDATE, or BUNCH-BILL-DELETE → The system should set error message 'INVALIDE (BUNCH/MORE)TYPE RECEIVE' with the invalid action code and abort processing
[Check CCN Key Format]
The WB root key field is empty or contains only spaces → The system should set error message 'NO WB ROOT KEY RECEIVE IN MORE REQUEST' and abort processing
[Validate US CCN Key Format]
The US CCN key is empty or contains only spaces → The system should terminate processing with error message 'NO US CCN RECEIVE'
[Log Invalid Status Message Set Exit Mode]
The cargo status is not valid for bunch billing operations → The system should log message 'BB NOT CREATED. 1ST CCN HAS INVALID STATUS: [status]' with action code 'ZZZ' and set exit mode to true
[Log Invalid Status Message]
The system encounters an invalid cargo status → Log message 'BB NOT CREATED. 1ST CCN HAS INVALID STATUS: [status]' with action code 'ZZZ' and set exit mode
[Validate Duplicate CCN]
The system validates for duplicate CCN using GCCUSEDA service with background, check-dup-CCN, and activate-edits flags → The system identifies if a duplicate CCN exists and prepares appropriate error handling
[Generate Error Message]
The table access failure is detected → An error message 'CCN SEQUENCE NUMBER TABLE CW NOT FOUND' is generated with the failure details and system processing is terminated
[FEN Slot Already Exists?]
The system processes FEN reference numbers and checks if a FEN qualifier already exists in the reference number segments → The system identifies whether a FEN slot is already allocated by finding a reference number qualifier equal to 'FEN'
[Validate Pedimento Type]
The system processes the FEN update and the dispatch hold pedimento type is different from the current cargo pedimento type → The system updates the cargo pedimento type with the dispatch hold pedimento type
[Update Pedimento Type if Different]
The system processes the new FEN addition and the dispatch hold pedimento type is different from the current cargo pedimento type → The system updates the cargo pedimento type with the dispatch hold pedimento type
[New Pedimento Type ≠ Current Pedimento Type?]
Comparing pedimento types during FEN processing → Update the pedimento type in the cargo record to match dispatch hold value
[Clear Invalid FEN Entry]
The system processes the FEN validation → The FEN qualifier is cleared from the N9 segment AND the FEN reference number is cleared from the N9 segment AND the pedimento type is updated if different AND a log entry is created documenting the FEN removal
[Clear Invalid FEN Entry]
The system processes the KCM validation → The KCM qualifier is cleared from the N9 segment AND the KCM reference number is cleared from the N9 segment AND a log entry is created documenting the KCM removal
[Check for Existing KCM Reference]
Processing KCM reference numbers → The system identifies if a KCM reference qualifier exists and records its position
[Check Available Segment Slots]
Adding a KCM reference to an available slot → The system ensures the segment limit is not exceeded before adding the KCM
[Current Segment Empty?]
The reference number qualifier field is spaces and no available slot has been found yet → The segment index is recorded as the first available slot position
[Within Maximum Capacity?]
The target segment index exceeds the maximum allowed N9 segment occurrences → The KCM reference addition is not performed to maintain system capacity limits
[Activate Edit Validations]
The system prepares for validation → The system activates all edit validation flags
[Log Equipment Processing Error]
The validation service call fails → System creates error message with service parameters and performs abend processing
[Shipminu1 Available?]
Shipminu1 segment is checked for availability → If Shipminu1 is found, proceed with entry number and customs value assignment
[Shipminu2 Available?]
Shipminu2 segment is checked for availability → If Shipminu2 is found, proceed with segment insertion
[Shipminu3 Available?]
Shipminu3 segment is checked for availability → If Shipminu3 is found and has a Canadian qualifier, proceed with Canadian CCN formatting
[Log Validation Error]
The system processes the validation failure → Log the specific business error message, set action code to 'ZZZ', mark update as invalid, and set do-not-update flag
[Validate Previous EDI Transmission Status]
If the cargo's EDI status → If the cargo was previously sent electronically, the system sets the sent-309-previous flag to true
[Save Current Cargo Data to Work Area]
The cargo data is being saved to work area → If EDI was previously sent electronically, the system sets the sent-309-previous flag to true
[Cargo on Train?]
The cargo vessel name is not 'TRAIN' and not spaces → The system logs an error message 'CANNOT DELETE MANIFEST, CARGO ON A TRAIN' and skips deletion
[All Authorized Cargo Deleted?]
The system has authorization for deletion and the read cargo count equals the deleted cargo count → The system proceeds to delete associated shipment segments
[Check Train Status]
The system checks the train assignment status → If the US train ID is not spaces and not 'TRAIN', set update error flag and log message 'WAYBILL UPDATE NOT APPLIED CARGO ON A TRAIN'
[Check Broker Entry vs Waybill Broker]
Broker entry number is not spaces and not low values and the manifest broker name does not match the waybill broker name → Set update error flag, set do not update flag, and log message 'WB BROKER UPDATE NOT APPLIED BROKER ENTRY FILED'
[Check Quantity vs Broker Entry]
Broker entry number is not spaces and not low values and the manifest quantity does not equal the shipment commodity number of units → Set update error flag, set do not update flag, and log message 'WB QUANTITY UPDATE NOT APPLIED BROKER ENTRY FILED'
[Check Line Release vs Broker]
Line release number is not spaces and not low values and the manifest broker name does not match the waybill broker name → Set update error flag, set do not update flag, and log message 'WB BROKER UPDATE NOT APPLIED LINE RELEASE FILED'
[Check Export Status for Transit Bond]
The in-bond type code is 'TR' and the cargo status description is 'EXPORT' → Set update error flag, set do not update flag, and log message 'WB UPDATE NOT APPLIED, MANIFEST EXPORTED'
[Check Train Status Field]
The train ID field is not empty and not equal to 'TRAIN' and an update operation is attempted → Set update error flag, log error message 'WAYBILL UPDATE NOT APPLIED CARGO ON A TRAIN', and block the update operation
[Check M1005-VESSEL-NAME Field]
The vessel name != 'TRAIN' and not is empty and a delete operation is attempted → Log error message 'CANNOT DELETE MANIFEST, CARGO ON A TRAIN' and block the delete operation
[Entry Quantity vs Waybill Quantity Match?]
The quantity in the manifest does not match the quantity in the shipment commodity data → The system sets update error flag, sets do-not-update flag, and logs 'WB QUANTITY UPDATE NOT APPLIED BROKER ENTRY FILED' message
[Line Release Filed?]
The system checks the line release number field in the N9 segment → The system determines if a line release number exists (not spaces or low-values) and proceeds to line release broker validation or completes validation successfully
[Check Bond Type]
The system attempts to validate the cargo for update → The system should set update error flag and log 'WB UPDATE NOT APPLIED, MANIFEST EXPORTED' message
[Check Line Release Number]
The system checks the line release number in segment N1009 → The system identifies whether a line release number exists and is not empty
[Pedimento Number Available?]
The system checks for pedimento number in the dispatch data → The system should determine if a valid pedimento number exists and is not spaces
[FEN Already Exists in Manifest?]
The system searches through existing N9 reference segments for FEN qualifier → The system should identify if an existing FEN reference is found and determine its position
[KCM Already Exists in Manifest?]
The system searches through existing N9 reference segments for KCM qualifier → The system should identify if an existing KCM reference is found and determine its position
[Update Pedimento Type if Different]
Processing FEN reference numbers from dispatch hold data → Update cargo pedimento type to match dispatch hold pedimento type if they are different
[Pedimento Number Changed?]
The system compares the dispatcher pedimento number with the existing manifest FEN reference number → If GCWDSPIO-PDMNTO-NUM is not equal to WS-SAVE-GCUS-N902-REF-NUM for the FEN slot, then the pedimento number has changed
[Pedimento Type Changed?]
The system compares the dispatcher pedimento type with the cargo pedimento type → If GCWDSPIO-PDMNTO-TYPE is not equal to GCUSRT-PEDIMENTO-TYPE, then the pedimento type has changed and must be updated
[Dispatch Hold Data Available?]
The system attempts to retrieve dispatch hold data → If dispatch hold data is successfully retrieved, proceed with pedimento validation, otherwise skip pedimento processing
[Pedimento Number Exists in Dispatch Hold?]
The system checks the pedimento number field → If pedimento number is not spaces, proceed with validation, otherwise check for existing FEN segments to clear
[Current FEN Segment Exists?]
Checking if a FEN segment was found → If FEN segment exists, proceed with comparison logic, otherwise look for available slots to add new pedimento
[Validate Pedimento Type Consistency]
The system checks pedimento type consistency → Validate that the pedimento type matches cargo record requirements
[Type Conflict Detected?]
The dispatch hold pedimento type differs from the cargo record pedimento type → Flag the conflict and update the cargo record pedimento type to match dispatch hold
[Empty Slot Available in N9?]
The system searches for empty N9 segment positions → If an empty slot is found, use it for the new pedimento number, otherwise skip the addition
[Dispatch Hold Data Available?]
The system checks for dispatch hold data availability → If dispatch hold data is successfully retrieved, proceed with pedimento validation, otherwise skip pedimento processing
[Current FEN Segment Exists?]
The system searches for existing FEN reference number qualifiers in the manifest segments → If a FEN segment exists, retrieve the current pedimento number, otherwise mark as no current pedimento
[New Pedimento Number Present?]
The system checks the pedimento number field in the dispatch hold data → If the pedimento number field is not spaces, proceed with pedimento comparison, otherwise check if removal is required
[Pedimento Types Match?]
The system compares the dispatch hold pedimento type with the current manifest pedimento type → If pedimento types do not match, update the manifest pedimento type, otherwise proceed with number update only
[Check for Existing KCM Reference]
The system searches through N9 reference segments for existing KCM qualifiers → The system identifies the position of any existing KCM reference and stores the subscript for further processing
[Validate KCM Format]
The system checks if the target slot is within the maximum allowed N9 segment occurrences → The system either allows the addition if within limits or skips processing if the limit would be exceeded
[Within Segment Limits?]
The system validates the segment index against the maximum occurrence limit → The update proceeds only if WS-SUB-N9 is not greater than GCSUSS99-N9-MAX-OCURS-BYSEQ
[More N9 Segments?]
Current segment index is less than or equal to maximum N9 segment occurrences → Additional segments are available for processing
[Set Status Error - On Train]
The cargo vessel name is not 'TRAIN' and not spaces → The update should be blocked and error message 'CANNOT DELETE MANIFEST, CARGO ON A TRAIN' should be logged
[Set Status Error - Entry Filed]
The cargo has a broker entry number that is not spaces and not low-values → The update should be blocked and error message 'CANNOT DELETE MANIFEST, BROKER ENTRY FILED' should be logged
[Set Status Error - Release Filed]
The cargo status description is 'RELEASE' → The update should be blocked and error message 'CANNOT DELETE MANIFEST, MANIFEST RELEASED' should be logged
[Set Status Error - Exported]
The cargo in-bond type code is 'TR' and the cargo status description is 'EXPORT' → The update should be blocked and error message 'CANNOT DELETE MANIFEST, MANIFEST EXPORTED' should be logged
[Call GCCUSEDA for CCN Validation]
The CCN validation service detects a duplicate CCN in the system → The cargo status must be set to error, duplicate CCN flag must be activated, status description must be updated to 'ERROR', and the cargo record must be replaced with error status while preserving original data
[FEN Already Exists in Manifest?]
An existing N9 segment contains a FEN reference qualifier → The system should identify the existing FEN reference for update rather than creating a new one
[KCM Already Exists in Manifest?]
An existing N9 segment contains a KCM reference qualifier → The system should identify the existing KCM reference for update rather than creating a new one
[Pedimento Number Exists?]
The system validates the presence of a pedimento number → If pedimento number is not spaces, proceed with pedimento processing, otherwise clear existing FEN references
[KCM Segment Limit Reached?]
The system checks current segment count against maximum N9 segment limit → New KCM segment is only added if current segment index does not exceed GCSUSS99-N9-MAX-OCURS-BYSEQ limit
[Equipment Validation Failed - Abort Process]
The validation service returns a failure result → An error message should be generated indicating GCCCARTP failure with parameter details AND the process should be terminated
[Check Train Status]
The cargo vessel name is checked → If the vessel name is not 'TRAIN' and not spaces, set validation error flag and log message 'WAYBILL UPDATE NOT APPLIED CARGO ON A TRAIN'
[Cargo on Train?]
The cargo vessel name != TRAIN and not is empty → Set update error flag and log message 'WAYBILL UPDATE NOT APPLIED CARGO ON A TRAIN'
[Log Train Status Error]
An update attempt is made on train cargo → Log action code ZZZ with message 'WAYBILL UPDATE NOT APPLIED CARGO ON A TRAIN'
[Broker Entry Filed with Different Broker?, Broker Entry Filed?]
The cargo broker short name does not match the waybill broker name → Set update error flag and log message 'WB BROKER UPDATE NOT APPLIED BROKER ENTRY FILED'
[Log Broker Conflict Error]
A broker update is attempted → Log action code ZZZ with message 'WB BROKER UPDATE NOT APPLIED BROKER ENTRY FILED'
[Broker Entry Filed with Quantity Change?]
The cargo quantity does not match the shipment commodity quantity → Set update error flag and log message 'WB QUANTITY UPDATE NOT APPLIED BROKER ENTRY FILED'
[Log Quantity Change Error]
A quantity update is attempted → Log action code ZZZ with message 'WB QUANTITY UPDATE NOT APPLIED BROKER ENTRY FILED'
[Line Release Filed with Different Broker?, Line Release Filed?]
The cargo broker short name does not match the waybill broker name → Set update error flag and log message 'WB BROKER UPDATE NOT APPLIED LINE RELEASE FILED'
[Log Line Release Conflict Error]
A broker update is attempted → Log action code ZZZ with message 'WB BROKER UPDATE NOT APPLIED LINE RELEASE FILED'
[Export Manifest with Transit Bond?]
The cargo status short description is EXPORT → Set update error flag and log message 'WB UPDATE NOT APPLIED, MANIFEST EXPORTED'
[Log Export Restriction Error]
An update attempt is made on exported transit cargo → Log action code ZZZ with message 'WB UPDATE NOT APPLIED, MANIFEST EXPORTED'
[Broker Name Matches Filed Entry?]
An update is attempted AND the waybill broker name does not match the filed broker entry name → The system must block the update AND set an error flag AND log a broker entry conflict message
[Quantity Matches Shipment Data?]
An update is attempted AND the manifest quantity does not match the shipment data quantity → The system must block the update AND set an error flag AND log a quantity change conflict message
[Is Cargo on Train?]
The system checks if cargo is on a train for deletion validation → If vessel name is not 'TRAIN' and not spaces, the cargo is considered on a train and deletion is blocked with error message 'CANNOT DELETE MANIFEST, CARGO ON A TRAIN'
[Extract Pedimento Receipt Timestamp]
Dispatch hold data contains pedimento receipt timestamp → Assign the pedimento receipt timestamp to the cargo record
[Train Status Check]
The cargo vessel name is not 'TRAIN' and not spaces → Set update error flag and log message 'WAYBILL UPDATE NOT APPLIED CARGO ON A TRAIN'
[Quantity Matches?]
The cargo quantity does not match the number of units in the shipment → Set update error flag and log message 'WB QUANTITY UPDATE NOT APPLIED BROKER ENTRY FILED'
[Export Status Check]
The in-bond type code is 'TR' and the cargo status description is 'EXPORT' → Set update error flag and log message 'WB UPDATE NOT APPLIED, MANIFEST EXPORTED'
[All Cars Deleted Successfully?]
The SCAC is authorized for deletion and the reed cargo count equals the deleted cargo count → The system proceeds to delete associated shipminu segments
[Handle Equipment Key Error]
The GCCCARTP call fails → An error message is constructed with GCCCARTP failure details and parameters, and the system performs abend processing
[Message Read Successfully?]
The return code from READQ operation is evaluated → If the return code indicates non-acceptable result, the system should prepare error handling, otherwise continue processing
[Handle Read Error - Set Error Message]
The system detects the read failure condition → The system should create an error message including the input length details and prepare for program termination
[Is SED Data = 'IB '?]
The system checks if the SED field in the segment starts with 'IB ' (including trailing space) → The segment is identified as an IB segment if SED field matches 'IB ' pattern, otherwise it continues searching
[S07 Segment Found?]
If the retrieval result → If WS-GCSUSS07-FOUND is true, the segment is available for processing, otherwise continue to next sequence
[SED Data Starts with 'IB '?]
The system examines the SED data within the segment → If GCUS-SED starts with 'IB ' (positions 1-3), the segment is identified as an IB segment
[Maximum S07 Segments Reached?]
The current sequence counter value is compared against the maximum limit → If WS-GCSUSS07-SEQ is greater than GCSUSS99-S07-MAX-SEQ, the maximum segment limit has been reached
[Retrieve S07 Segment by Sequence - Access commodity segment data with sequence validation and error handling]
The system attempts to retrieve the S07 commodity segment data using the CCN key, record type '07', and sequence number → The system returns the commodity segment data if found, or returns empty segment data if not found, and sets the appropriate status flag
[Segment Found?]
If the database response status → If the status code is spaces (successful), the system sets found status to true; otherwise, the system sets not found status to true
[Counter <= Maximum N9 Occurrences?]
The system checks if the current N9 counter is less than or equal to maximum N9 occurrences boundary → The system shall continue processing if within boundary limits or terminate loop if maximum occurrences exceeded
[Validate Segment Data]
The system performs segment validation → Data integrity is verified and any validation errors are identified for business rule enforcement
[Validate Cargo Not on Train]
The cargo vessel name is not 'TRAIN' and not spaces → Log error message 'CANNOT DELETE MANIFEST, CARGO ON A TRAIN' with action code 'ZZZ' and do not proceed with deletion
[Validate Export Status]
The in-bond type code is 'TR' and the cargo status description is 'EXPORT' → Log error message 'CANNOT DELETE MANIFEST, MANIFEST EXPORTED' with action code 'ZZZ' and do not proceed with deletion
[Validate Broker Entry Status]
The cargo SCAC is not 'CPRS' and broker entry number is not spaces and not low-values → Log error message 'CANNOT DELETE MANIFEST, BROKER ENTRY FILED' with action code 'ZZZ' and do not proceed with deletion
[Validate Broker Entry Status]
The cargo SCAC is not 'CPRS' and cargo status description is 'RELEASE' → Log error message 'CANNOT DELETE MANIFEST, MANIFEST RELEASED' with action code 'ZZZ' and do not proceed with deletion
[US CCN Key Matches Current Cargo?]
The system compares the segment's US CCN key with the current cargo's US CCN key → The system confirms if the segment belongs to the current cargo or identifies it as belonging to a different cargo

Module: GCX123 1 Consolidated Epic Story

Epic: GCX123 Complete EDI Specification Extracted from Legacy

Contains 763 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX123 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

[Initialize Status Flags]
Status flags need to be initialized → All segment flags (header, trailer, BGM, RFF, ERC, ERP, DTM, EQD, LOC, GIS, end) are set to not found and cargo status is set to not found
[Initialize Status Flags]
Counters and status need to be set → Line counter is set to 1, new counter is set to 1, report is cleared, accept status is set to 'GE', and EMI from user code is set to 'OM01247'
[Initialize Message Array for GCW123]
Message array initialization is performed → MQS message array is initialized for internal message processing
[Queue Open Successful?]
Queue open completion code != MQCC-OK → System abends with open failed error message
[Initialize Message Array for Auto Release]
The system processes the message for auto release → The system creates BGM segment with identifier 'BGM', DTM segment with identifier 'DTM', GIS segment with identifier 'GIS' and process indicator '4', and RFF segment with identifier 'RFF' and reference qualifier 'XC'
[Initialize BGM Segment for SAR]
The message array needs to be populated → A BGM segment must be initialized with identifier 'BGM'
[Initialize DTM Segment with Date/Time]
The DTM segment is being created → The DTM segment must be initialized with identifier 'DTM' and populated with GCW123 date and time if available, otherwise current machine date and time
[Initialize GIS Segment with Release Indicator]
The GIS segment is being created → The GIS segment must be initialized with identifier 'GIS' and process indicator set to '4' indicating release
[Initialize RFF Segment with CCN Reference]
The RFF segment is being created → The RFF segment must be initialized with identifier 'RFF', reference qualifier 'XC', and the GCW123 CCN key as the reference
[Initialize Export Message Segments]
The message segments are being initialized → All required message segments are prepared for export processing
[Initialize Merlin Line Counter to 1]
The preparation process begins → The line counter is set to 1 to start message formatting
[Initialize Hold Message Lines]
The hold notification preparation process begins → All message detail lines should be cleared to spaces to ensure clean message formatting
[Initialize Query Structure GCX148]
Query message structure GCX148 is being prepared → Set action code to 'QUP', populate cargo CCN key, set cargo type to Canadian cargo, and include the retrieved port code
[Initialize BGM Business Message Segment]
The BGM segment is created → The BGM segment is initialized and the identifier is set to 'BGM'
[Initialize LOC Location Segment]
The release type is auto release → The system initializes a LOC segment with identifier 'LOC' and extracts location from positions 19-22 of comments
[Initialize DTM Date Time Segment]
The DTM segment is created → The DTM segment is initialized with identifier 'DTM'
[Initialize GIS General Indicator Segment]
The GIS segment is created → The GIS segment is initialized with identifier 'GIS'
[Initialize ERP Error Position Segment]
The message type is reject → The system initializes an ERP segment with identifier 'ERP'
[Initialize ERC Error Code Segment]
The ERC segment is created → The ERC segment is initialized with identifier 'ERC'
[Initialize RFF Reference Segment]
The RFF segment is created → The RFF segment is initialized with identifier 'RFF'
[Initialize BGM Segment]
The BGM segment is being created → The BGM segment is initialized with identifier 'BGM'
[Initialize LOC Segment]
LOC segment is being created → LOC segment is initialized with identifier 'LOC' and location extracted from positions 19-22 of comments
[Initialize GIS Segment]
GIS segment is being created → GIS segment is initialized with identifier 'GIS'
[Initialize ERP Segment]
ERP segment is being created → ERP segment is initialized with identifier 'ERP' and stored in the message array
[Initialize ERC Segment]
ERC segment is being created → ERC segment is initialized with identifier 'ERC' and error code extracted from positions 19-20 of comments
[Initialize RFF Segment]
RFF segment is being created → RFF segment is initialized with identifier 'RFF', reference qualifier 'XC ', and GCW123 CCN key as reference
[Initialize BGM Segment Structure]
The system initializes the BGM segment structure → The BGM segment is initialized and the BGM identifier is set to 'BGM'
[Initialize DTM Segment Structure]
The system begins DTM segment initialization → The DTM segment structure is cleared and prepared for data population
[Initialize GCW123 Message Structure]
The system begins processing follower manifests → A new GCW123 general information structure is initialized to prepare for follower message creation
[Initialize Auto-Release Action]
The system needs to set up auto-release processing → The system initializes GCW123-GENERAL-INFO structure to prepare for auto-release action
[Initialize Reject Action]
The system needs to set up reject processing → The system initializes GCW123-GENERAL-INFO structure to prepare for reject action
[MQ Open Error]
The open completion code is not MQCC-OK → The system calls error handler GCCMQERR, formats error message, and performs abnormal termination
[Call MQOPEN to Open Queue]
The system attempts to open the message queue → MQOPEN should be called with connection handle, object descriptor, options, and response handle
[Queue Open Successful?]
The completion code is evaluated → If completion code equals MQCC-OK then queue is ready for operations, otherwise handle error
[Open MQ Queue for Input]
System attempts to open queue for input operations → Queue should be opened successfully for message retrieval or processing should abort with open failure message
[Initialize Message Buffer]
System prepares to retrieve messages → Message buffer should be initialized with proper length settings and message identifiers cleared
[Initialize Key Values and Flags]
The system initializes access parameters → All key values, return flags, and segment data are cleared to spaces
[Initialize Message Buffer]
The system initializes the message buffer → The message buffer is cleared to spaces and ready to receive new message data
[Initialize GCT1231E Transaction]
The system initializes the GCT1231E transaction → The system sets the GCW123 message ID flag to true AND moves the cargo CCN key to the GCW123 CCN key field AND moves the GCW123 general information to the GCT1231E message field

Core Acceptance Criteria

[2:Determine Message Type Processing]
The system checks the message ID type → If message ID is GCW123, set cargo acknowledgment mode and process internal message array, otherwise set no special action mode and load messages from MQ queue
[4:Process EDI Header Segments]
System checks the UNH release version → If UNH release is 08A, set conversion acknowledgment mode, otherwise set cargo acknowledgment mode and clear conversion error flag
[7:Process Equipment Details]
Car ID field is evaluated → If car ID is not spaces, log the car ID with type 'CCRA RNS EQP#' and increment log index
[14:Detect Heartbeat Messages]
Reference number is evaluated → If reference number equals '6105ETEST999999999999', process as heartbeat message, otherwise process as normal CUSRES segment
[20:Process Heartbeat Acknowledgment]
System processes the heartbeat → Retrieve T2 table segment, update CUSRES acknowledgment timestamp with current machine date and time, and replace the table segment
[21:Process Individual Cargo Release]
Document message name is evaluated → Log appropriate entry type message: Type 34 for Aerospace, Type 67 for ETA Paper, Type 75 for First Paper, Type 117 for PARS Paper, Type 125 for PARS EDI, Type 174 for RMD Paper, Type 232 for VI Paper, Type 257 for RMD EDI, Type 331 for Cash Paper, Type 463 for PARS OGD, Type 471 for RMD OGD, or Error Report for RNS Error
[21:Process Individual Cargo Release]
Broker entry number or customs transaction number differs from current cargo values → Update cargo with new broker entry number, customs transaction number, entry type, broker date, broker time, and broker port, then set updated entry flag
[23:Process Cargo Released Status]
Release type is determined → For GCW123 auto release: set type 'A', user 'AUTO', use GCW123 date/time/comments/entry type; For manual release: set type 'M', include manual release reason; For SAR release: set type 'A', user 'S.A.R.', autopact traffic reason; For export release: set type 'A', user 'EXPORT', export traffic reason, in-transit status 'E'; For other: set type 'A', use DTM date/time, user 'AUTO'
[24:Process Cargo Examination Hold]
Examination hold is processed → Log examination hold message, set cargo status to hold, update cargo record, send hold notification if CCN starts with '6105', and process log lines
[25:Process Y51 Release Requirement]
Y51 release is processed → Log Y51 release documentation required message, update cargo record, and process log lines
[26:Process Agriculture Inspection Hold]
Agriculture inspection is processed → Log agriculture inspection required message, set cargo status to agriculture hold, update cargo record, and process log lines
[27:Process Declaration Acceptance]
Declaration acceptance is processed → Log declaration accepted message, update cargo record if entry was updated, and process log lines
[28:Process CSA Authorization to Deliver]
CSA authorization is processed → If cargo has CSA indicator on, log 'ACCEPTED - CSA' message and set CSA delivery status and authorization received flag, otherwise log 'NOT ACCEPTED - NON-CSA' message
[29:Process Awaiting Processing Status]
Awaiting processing is handled → Log awaiting processing message, update cargo record if entry was updated, and process log lines
[Clear Working Storage Fields]
Working storage fields need to be cleared → Update entry field is set to spaces, log array is cleared, and log index is set to 1
[Set Message Processing Parameters]
Message processing parameters are being initialized → MQS header length, unused entry length, and single entry length are calculated and stored
[Retrieve Admin Configuration from Database]
Admin configuration is requested from database with table ID 'AD' and sequence ID 'ADMINID' → Database query is executed using function code 'GU' to retrieve admin segment
[Set Merlin User Code from Config]
Database return flag equals '0' indicating successful retrieval → Admin segment found flag is set to true, table segment is moved to admin segment, and Merlin user code is set from admin configuration
[Message ID is GCW123?]
Message ID is checked for GCW123 type → If message ID is GCW123, initialize message array for internal processing, otherwise establish MQ connection for external message processing
[Establish MQ Connection]
MQ connection is established → Connection to MQ manager is created and MQ queue is opened for input processing
[Message ID is GCW123?]
The system checks the message ID against GCW123 identifier → If message ID is GCW123, set cargo acknowledgment flag and process spawned message, otherwise set no special action flag and load from message queue
[Set Cargo Acknowledgment Flag]
The system processes the message type determination → Set cargo acknowledgment flag to true and proceed to message processing
[Set No Special Action Flag]
The system processes the message type determination → Set no special action flag to true and proceed to load message table
[Load Message Table from Queue]
The system needs to load message data → Execute message table loading from queue and evaluate message availability
[Extract Message Header]
The system processes the message header → Move message header to workspace and determine message version type
[Message Version is 08A?]
The system checks if UNH release version is 08A → If version is 08A, set conveyance acknowledgment flag, otherwise set cargo acknowledgment flag and clear conveyance error flag
[Set Conveyance Acknowledgment Flag]
The system sets acknowledgment type → Set conveyance acknowledgment flag to true and continue to message processing
[Set Cargo Acknowledgment Flag]
The system sets acknowledgment type → Set cargo acknowledgment flag to true and clear conveyance error flag
[Connect to MQ Manager]
Connection to MQ manager is attempted → Connection is established successfully or system terminates with connection failure error
[Retrieve Message from Queue]
Message retrieval is requested from queue → Message is retrieved with message ID and correlation ID set to none
[Message Retrieved?]
Message retrieval completion code != MQCC-OK → System processes the retrieval failure condition
[Calculate Message Entries]
Message data length is available → Maximum message entries is calculated as (data length minus header length) divided by single entry length, capped at maximum allowed entries
[Message Available?]
Completion code is MQCC-OK → Message is considered available for processing
[Set Skip Message Flag]
Message skip condition is met → Skip message found flag is set to true
[Set Good Message Found Flag]
Message passes all validation checks → Good message found flag is set to true
[No Message Available?]
Completion code is MQCC-FAILED and reason is MQRC-NO-MSG-AVAILABLE → System abends with no message available error
[Set Message Not Available Flag]
Reason code is 2033 (message not available) → Message not available flag is set to true
[Set End of Queue Flag]
Completion code and reason indicate queue exhaustion → End of message queue flag is set to true and system abends with retrieval error
[Segment ID = 'UNH'?]
If the segment table ID → If the segment ID equals 'UNH', the system sets the header found flag and continues with header processing, otherwise it continues with regular message processing
[Set Header Found Flag]
The system processes the UNH segment → The system sets the header found flag to true to track that header processing has occurred
[Message Version = '08A'?]
If the UNH release version → If the UNH release version is '08A', the system sets conveyance acknowledgment mode, otherwise it sets cargo acknowledgment mode
[Set Conveyance Acknowledgment Mode]
The system sets the acknowledgment processing mode → The system sets the conveyance acknowledgment flag to true for conveyance-specific processing
[Set Cargo Acknowledgment Mode]
The system sets the acknowledgment processing mode → The system sets the cargo acknowledgment flag to true and clears the conveyance error flag for cargo-specific processing
[Set BGM Found Flag]
The BGM segment is identified → The BGM found flag must be set to true to indicate BGM segment has been processed
[Reset Processing Flags]
Processing the BGM segment → All related segment flags (LOC, GIS, DTM, EQD, RFF, ERP, ERC) must be reset to 'not found' state
[Move BGM Segment Data]
The segment data needs to be stored → The MQS table entry data must be moved to the BGM segment structure
[Conveyance Acknowledgment?]
The processing mode needs to be determined → If conveyance acknowledgment flag is set, route to conveyance processing, otherwise route to cargo processing
[Process BGM for Conveyance]
Conveyance processing is required → The BGM conveyance processing procedure must be executed
[Document Message Name = '992'?]
The document message name in BGM-04-DOC-MSG-NAME equals '992' → The system proceeds with conveyance-specific processing for arrival acknowledgment
[Extract Train Number from BGM Document Message]
The system processes the BGM document message number → The first 25 characters of BGM-05-DOC-MSG-NO are extracted as the train key value for database retrieval
[Retrieve Train Information from Database]
The system performs a database lookup using the train key → The system attempts to retrieve the corresponding train record from the B4 train database
[Prepare Unknown Entry Merlin Message]
The system prepares the notification message → The message line count is set to 4 and the Merlin type is set to unknown for proper routing
[Send Unknown Entry Notification]
The system processes the notification → The notification is sent through the EMC send process to inform stakeholders of the unknown entry
[Set Message Type to CA Train]
The system sets the message categorization → The GCX105-CA-TRAIN flag is set to true to indicate this is a Canadian train operation
[Set Message: 'CCRA RNS ACK - ARRIVAL ACK AT BORDER']
The system prepares the acknowledgment message → The message text is set to 'CCRA RNS ACK - ARRIVAL ACK AT BORDER' to indicate successful border arrival processing
[Receive LOC Segment]
The system encounters the LOC segment during message processing → The system sets the LOC found flag to true and stores the LOC segment data
[Set LOC Found Flag]
The message table ID equals 'LOC' → The system sets WS-LOC-FOUND flag to true
[Move LOC Segment Data to Working Storage]
The LOC segment data needs to be processed → The system moves the complete MQS table entry to the LOC segment working storage area
[Continue to Next Segment Processing]
Location data has been validated and stored → The system continues to process the next message segment in the sequence
[Extract Car ID from EQD-02-CAR-ID]
The car ID validation passes and car ID is not spaces → The car ID value is extracted from EQD-02-CAR-ID field for further processing
[Store Car ID in Log Data Array]
The car ID needs to be logged for audit purposes → The car ID is stored in the log data array at the current log index position
[DTM Segment Received]
The message table ID equals 'DTM' → The DTM found flag is set to true and the DTM segment data is moved to working storage
[Extract Date Components]
Processing CUSRES segment in B100-PROCESS-CUSRES-SEG → Date components are extracted from DTM-02-DATE-TIME positions 3-8 and formatted as MM/DD/YY, and time components are extracted from positions 9-12 and formatted as HH:MM
[Use DTM Date/Time for Release Information]
The release type is automatic (not GCW123 message types) → The release date is set to DTM-02-DATE-TIME positions 3-8 and release time is set to DTM-02-DATE-TIME positions 9-12
[Use DTM Date/Time for IIS Integration]
Cargo status is being updated to released → The IIS date field is set to DTM-02-DATE-TIME positions 1-8 and IIS time field is set to DTM-02-DATE-TIME positions 9-12
[Set GIS Found Flag]
The system identifies the segment as a GIS type → The GIS found flag is set to true to indicate this segment has been encountered
[Move GIS Data to Working Storage]
The segment data needs to be processed → The complete GIS segment data is moved to the working storage area for access by business logic
[Route to CUSRES Processing]
If the complete segment set → The processing is routed to CUSRES (Customs Response) segment processing
[Route to Heartbeat Processing]
If the reference pattern → The processing is routed to heartbeat processing instead of normal CUSRES processing
[Route to Conveyance Rejection Processing]
If the conveyance error conditions → The processing is routed to conveyance rejection processing
[Reset Processing Flags]
The processing for the current segment set is complete → The GIS, DTM, EQD, RFF, ERP, and ERC found flags are reset to false AND the log array is cleared AND the log index is reset to 1
[Message Table ID = 'GEI'?]
The message table ID equals 'GEI' → The system should identify this as a GEI segment and proceed with GEI-specific processing
[Set GEI Found Flag to True]
The message table ID is confirmed to be 'GEI' → The system should set the GEI found flag to true to indicate successful GEI segment detection
[Move Message Table Entry to GEI Segment]
The system needs to process the GEI segment data → The system should move the message table entry data to the GEI segment structure for access to equipment information
[Set RFF Found Flag]
An RFF segment is identified in the message → The RFF found flag should be set to true
[Move RFF Segment Data]
The segment data needs to be processed → The RFF segment data should be moved to the appropriate data structure
[Conveyance Acknowledgment Mode?]
The system is in conveyance acknowledgment mode → RFF conveyance reference processing should be initiated
[Log CCRA RNS ACK Arrival Message]
Logging the arrival acknowledgment → A 'CCRA RNS ACK - ARRIVAL ACK AT BORDER' message should be logged
[Update Cargo Border Status]
Cargo border update is performed → System performs cargo lookup, logs arrival acknowledgment message, sets border arrival acknowledgment flag, and replaces cargo record
[Set ERP Found Flag to True]
The current message segment table ID equals 'ERP' → The ERP found flag is set to true and the ERP segment data is moved to working storage
[Move ERP Segment Data to Working Storage]
The ERP segment processing is triggered → The message table entry data is moved to the ERP segment working storage
[BGM, ERC, ERP and GIS Segments All Found?]
BGM found flag is true AND ERC found flag is true AND ERP found flag is true AND GIS found flag is true AND conveyance error condition exists → The conveyance rejection processing is triggered
[Reset ERP Found Flag]
The segment processing cycle is complete → The ERP found flag is reset to false along with other segment flags
[ERC Segment Detected in Message]
The system encounters a segment with table ID 'ERC' → The system sets the ERC found flag to true and moves the ERC segment data to working storage for further processing
[Move ERC Segment Data to Working Storage]
The system processes the ERC segment → The system moves the complete ERC segment entry to the ERC working storage area and sets the ERC found indicator
[Release A6 Manifests]
The application error code from ERC-01-APPLICATION-ERR equals '15' → The system calls the A6 manifest release process for the current cargo control number
[Check RFF Reference Pattern]
The RFF-02-REFERENCE field contains the value '6105ETEST999999999999' → The message is identified as a heartbeat message and heartbeat processing is initiated
[Identify as Heartbeat Message]
The system identifies this as a heartbeat message → The system performs heartbeat processing by calling B200-CUSRES-HEARTBEAT
[Get Current Machine Date/Time]
The system needs to create an acknowledgment timestamp → The system captures machine century, date, and time from CCCOM and formats them into CUSRES acknowledgment datetime
[Access T2 Table Segment]
The system needs to access T2 table configuration → The system calls GCCTBIO with table ID 'T2' and empty sequence ID to retrieve the T2 segment
[Load T2 Segment Data]
The return flag indicates successful retrieval → The system moves the table segment data to GCSTBRT-T2-SEGMENT for processing
[Update CUSRES ACK Timestamp]
The heartbeat acknowledgment needs to be recorded → The system updates GCSTBRT-T2-CUSRES-ACK with the formatted machine datetime and moves the updated segment back to working storage
[Replace T2 Segment in Database]
The updated segment needs to be saved → The system calls GCCTBIO with REPL function code to replace the T2 segment in the database
[Extract Train Number from BGM Document Message]
The system processes the BGM segment for train identification → The train number is extracted from the first 25 characters of the BGM document message number field and used as the key for train record retrieval
[Retrieve Train Record by Train Number]
The system performs a database lookup using the train number as the key → The system retrieves the train record if it exists, or returns a not found status if the train does not exist in the database
[Train Found?]
The train record is not found in the database (status code is not spaces) → The system creates an unknown arrival response message with the train number, sets the error message 'THIS CRN WAS NOT FOUND', and sends the notification via Merlin system
[Set Action Code to 'ZZZ']
The system prepares the final error report structure → The system sets action code to 'ZZZ', assigns the train number from BGM document message as the target train, sets the cargo type flag to true, and populates the message field with the determined error content
[Document Message Name = '992'?]
If the document message name field → Processing continues to arrival acknowledgment if message name equals '992', otherwise processing ends
[Extract Train Reference Number from BGM Segment]
The system processes the arrival acknowledgment for message type 992 → The first 25 characters of the document message number are extracted as the train reference key
[Retrieve Train Information by B4 Key]
The system needs to validate the train exists in the database → A database lookup is performed using the train reference as the B4 key to retrieve train information
[Send Unknown Entry Notification to Merlin]
The system needs to notify operations of the error condition → The error notification is sent to Merlin operations system with unknown message type classification
[Set Message: 'CCRA RNS ACK - ARRIVAL ACK AT BORDER']
The system sets the descriptive message for the transaction → The message text is set to 'CCRA RNS ACK - ARRIVAL ACK AT BORDER' to describe the border arrival acknowledgment
[Reference Qualifier = 'XC'?]
The reference qualifier field equals 'XC' → The system should proceed to update cargo border information
[Update Cargo Border Information]
Processing cargo border update → The system should set border arrival acknowledgment flag, log arrival message, and update the cargo record
[Retrieve Cargo by Reference CCN]
The system needs to find the associated cargo → The system should Execute cargo lookup using the reference CCN from positions 1-25 of the RFF reference field
[Retrieve Cargo by CCN Key]
The system needs to update cargo border status → The system retrieves cargo information using the CCN key and sets cargo status switches
[Log CCRA RNS ACK Arrival Message]
The system processes the acknowledgment → The system logs the message 'CCRA RNS ACK - ARRIVAL ACK AT BORDER'
[Format Date/Time from DTM Segment]
Processing CUSRES segment information → Format date as MM/DD/YY from positions 03-04, 05-06, 07-08 and format time as HH:MM from positions 09-10, 11-12
[Retrieve Cargo by CCN Key]
Processing cargo lookup request → Use the reference number as CCN key to retrieve cargo information from the cargo database
[Save Current Cargo Information]
Beginning cargo processing → Save cargo report segment, CCN key, equipment car ID, release information, and waybill index for processing context
[Determine Entry Type Processing]
Processing entry type classification → Map document message name to specific entry types: 34 for Aerospace, 67 for ETA Paper, 75 for First Paper, 117 for PARS Paper, 125 for PARS EDI, 174 for RMD Paper, 232 for VI Paper, 257 for RMD EDI, 331 for Cash Paper, 463 for PARS OGD, 471 for RMD OGD, 992 for RNS Error, or other for unspecified types
[Log Entry Type Information]
Logging entry type information → Create specific log message for the entry type and Execute cargo information logging if message is not empty
[Entry Number Changed?]
Updating broker entry fields → Set broker entry to document message number positions 1-15, customs transaction number to positions 1-14, entry type to document message code value, broker date to current machine date, broker time to current machine time positions 1-4, and broker port to location positions 1-4
[Log Broker Entry Message]
Logging the broker entry update → Create log message containing 'CCRA RNS BROKER ENTRY:' followed by the document message number positions 1-15 and Execute cargo information logging
[GIS indicates Released?]
The GIS segment indicates released status → The system should format an unknown 6105 release message
[GIS indicates Entry?]
The GIS segment indicates entry status (not released) → The system should format an unknown 6105 entry message
[Format Unknown Release Message]
The system needs to format an unknown release message → The system should create message 'UNKNOWN 6105 RELEASE' concatenated with the cargo control number from reference
[Set Release Details]
The system needs to set release details → The system should set 'THIS CCN WAS NOT FOUND.' as line 3, format release number from BGM document message number (first 15 characters), port from LOC location (first 4 characters), and transaction type from BGM document message name (first 3 characters) as line 4, and set message line count to 5
[Format Unknown Entry Message]
The system needs to format an unknown entry message → The system should create message 'UNKNOWN 6105 ENTRY' concatenated with the cargo control number from reference
[Set Entry Details]
The system needs to set entry details → The system should set 'THIS CCN WAS NOT FOUND.' as line 3, format entry number from BGM document message number (first 15 characters) and port from LOC location as line 4, and set message line count to 5
[Set Message Type to Unknown]
The system prepares to send notifications → The system should set the Merlin message type indicator to 'UNKNOWN'
[Send Merlin Notification]
The system needs to notify about unknown cargo → The system should send the prepared message to Merlin notification system
[Save Current Cargo Information]
The system begins cargo processing operations → The current cargo report segment, CCN key, equipment car ID, release information, and waybill index are saved to working storage variables
[Determine Entry Type]
If the document message name code → The system sets the appropriate entry type message for aerospace (34), ETA paper (67), first paper (75), PARS paper (117), PARS EDI (125), RMD paper (174), VI paper (232), RMD EDI (257), cash paper (331), PARS OGD (463), RMD OGD (471), or RNS error, and for RNS error sends a query if applicable
[Process Cargo Release]
The system processes the cargo release → The system sets release information based on message type (auto, manual, SAR, or export), logs release message with appropriate details, processes US manifest matching, updates cargo records with release status, processes multi-manifest relationships if master manifest, checks current car ID release status, and processes log lines
[Process Cargo Hold Status]
The system processes the examination hold status → The system logs 'CCRA RNS GOODS HELD FOR EXAMINATION' message, sets cargo status to hold, updates cargo records, sends Merlin hold notification if CCN key starts with '6105', and processes log lines
[Process Y51 Release Requirement]
The system processes the Y51 release status → The system logs 'CCRA RNS Y51 RELEASE DOCS REQUIRED' message, updates cargo records, and processes log lines
[Process Agriculture Inspection]
The system processes the agriculture examination status → The system logs 'CCRA RNS RELEASED BUT REQUIRE AGRICULTURE INSPECTION' message, sets cargo status to agriculture hold, updates cargo records, and processes log lines
[Process Declaration Acceptance]
The system processes the declaration acceptance status → The system logs 'CCRA RNS: DECLARATION ACCEPTED, AWAIT ARRIVAL' message, updates cargo records if entry was updated, and processes log lines
[Process CSA Authorization]
The system processes the CSA authorization → If cargo has CSA indicator on, the system logs 'ACCEPTED - CSA' message, sets cargo status to CSA delivery and CSA authorization received, and updates cargo records; otherwise logs 'NOT ACCEPTED - NON-CSA' message, processes log lines, and processes US manifests
[Process Awaiting Status]
The system processes the awaiting status → The system logs 'CCRA RNS: TRANSACTION AWAITING PROCESSING' message, updates cargo records if entry was updated, and processes log lines
[Prepare Port Mismatch Message]
The system prepares the mismatch notification → The system prepares Merlin message with cargo control number, broker name, transaction number, and port comparison details; if IIS-A6 port is available, shows broker port versus CPR IIS-A6 port, otherwise shows broker port versus CPR manifest transaction code; sets message type to info and sends notification
[Message Found in Table?]
The system searches the message table using the key → If message is found, retrieve English error text from table segment, otherwise create unknown error message with error code
[Build Message Table Key]
The system needs to lookup error message details in the message table → The system constructs a key using MS table identifier, BB prefix, and the first 2 characters of the application error code
[Call GCCTBIO Function]
The system calls the table lookup function GCCTBIO → The system attempts to retrieve the corresponding error message details from the message table
[Load Message Segment]
The system processes the retrieved message segment → The system loads the table segment data and extracts the English text message for display
[Build Key with BB Prefix]
The system needs to build a message table lookup key → The system sets the MS table ID as the table identifier and initializes the key sequence ID with spaces
[Complete Table Key Construction]
The system performs the table lookup operation → The system calls the table I/O function to retrieve the error message description
[Key Ready for Table Lookup]
The lookup operation returns successfully (return flag equals '0') → The system moves the retrieved table segment to the message segment structure for use
[Key Ready for Table Lookup]
The lookup operation fails (return flag not equal to '0') → The system creates a default error message stating the application error code is unknown and not on the message table
[Complete Table Key Construction]
The application error code equals '15' → The system performs A6 manifest release processing
[Set Auto Release Type A]
The system processes the release information → Set release type to 'A' (automatic) AND set release by to 'AUTO' AND extract release date from GCW123 date field (positions 3-8) AND extract release time from GCW123 time field AND set release reason to GCW123 comments AND extract entry type from GCW123 comments (positions 26-28)
[Set Manual Release Type M]
The system processes the release information → Set release type to 'M' (manual) AND concatenate 'MANUAL RELEASE' with GCW123 comments for release reason AND IF GCW123 comments are spaces THEN set release reason to 'MANUAL RELEASE' and set release by to current user ID
[Set SAR Release Type A]
The system processes the release information → Set release type to 'A' (automatic) AND set auto release comment indicator AND set release reason to GCW123 comments OR 'AUTO RELEASE - AUTOPACT TRAFFIC' if comments are spaces AND set release by to 'S.A.R.'
[Set Export Release Type E]
The system processes the release information → Set release type to 'A' (automatic) AND set export comment indicator AND set release reason to GCW123 comments OR 'AUTO RELEASE - EXPORT TRAFFIC' if comments are spaces AND set release by to 'EXPORT' AND set in-transit status to 'E'
[Set Default Release Values]
The system processes the release information → Set release type to 'A' (automatic) AND extract release date from DTM date-time field (positions 3-8) AND extract release time from DTM date-time field (positions 9-12) AND set release by to 'AUTO' AND IF message is GCW123 type THEN concatenate 'CCRA ACQUITTAL:' with GCW123 comments for release reason
[Create US Manifest Release Log]
The system creates the release log → Create GCT1051E log entry with current machine date and time AND set action code to LOG-USE-INPUT-MESSAGE AND set cargo type to US cargo AND concatenate 'CDN CCN RLSED:' with Canadian CCN key for the message AND set US CCN key as the target
[Update Cargo Records]
The system updates the cargo records → Clear status code AND set accept status to spaces AND call CIMS with REPL function to update cargo segment AND restore saved cargo segment after update
[Prepare Merlin Release Notification]
The system prepares the Merlin notification → Format message with 'CCRA RELEASE' AND include equipment car ID, release date, release time, piece count, destination station number (positions 3-6), and entry type (positions 1-3) AND add header 'Below is a list of CCNs for this Car:' AND set return status to OK
[Message Source Type?]
If the message source type → If message ID is GCW123 with auto release flag, process as GCW123 auto release; if GCW123 with manual release flag, process as manual release; if GCW123 with SAR release flag, process as SAR release; if GCW123 with export flag, process as export release; otherwise process as CUSRES message
[GCW123 Auto Release]
The system processes the auto release → The release type is set to A for automatic, release by is set to AUTO, release date is extracted from GCW123 date field positions 3-8, release time is extracted from GCW123 time field, release reason is set to GCW123 comments, and entry type is extracted from GCW123 comments positions 26-28
[GCW123 Manual Release]
The system processes the manual release → The release type is set to M for manual, and if GCW123 comments are empty then release reason is set to 'MANUAL RELEASE' and release by remains as current user ID, otherwise release reason is built by concatenating 'MANUAL RELEASE ' with GCW123 comments
[GCW123 SAR Release]
The system processes the SAR release → The release type is set to A for automatic, release by is set to 'S.A.R.', auto release comment flag is set to true, and if GCW123 comments are empty then release reason is set to 'AUTO RELEASE - AUTOPACT TRAFFIC' otherwise release reason is set to GCW123 comments
[GCW123 Export Release]
The system processes the export release → The release type is set to A for automatic, release by is set to 'EXPORT', export comment flag is set to true, in-transit status is set to 'E', and if GCW123 comments are empty then release reason is set to 'AUTO RELEASE - EXPORT TRAFFIC' otherwise release reason is set to GCW123 comments
[CUSRES Message]
The system processes the CUSRES release → The release type is set to A for automatic, release date is extracted from DTM date-time field positions 3-8, release time is extracted from DTM date-time field positions 9-12, release by is set to 'AUTO', and if the message ID is GCW123 then release reason is built by concatenating 'CCRA ACQUITTAL: ' with GCW123 comments
[Use Machine Date from System]
The GCW123 date field is empty, high-values, or low-values → The system uses the machine century and machine date from the system to populate the date-time field positions 1-8
[Extract Date from GCW123 Position 3-8]
The GCW123 date field contains valid data (not spaces, high-values, or low-values) → The system extracts the date from GCW123-DATE and populates it into the date-time field positions 1-8
[Use Machine Time from System]
The GCW123 time field is empty, high-values, or low-values → The system uses the machine time from the system to populate the date-time field positions 9-12
[Extract Time from GCW123 Position 9-12]
The GCW123 time field contains valid data (not spaces, high-values, or low-values) → The system extracts the time from GCW123-TIME and populates it into the date-time field positions 9-12
[Set Release Type to Auto]
The message type is auto release → The system sets release type to 'A', sets release by to 'AUTO', extracts date from GCW123 date position 3-6, extracts time from GCW123 time, extracts comments for release reason, and extracts entry type from comments position 26-29
[Set Release Type to Manual]
The message type is manual release → The system sets release type to 'M', concatenates 'MANUAL RELEASE' with GCW123 comments for release reason, and if comments are empty sets release reason to 'MANUAL RELEASE' and uses ACF2 user ID as release by
[Set Release Type to SAR]
The message type is SAR release → The system sets release type to 'A', sets auto release comment indicator to true, extracts comments for release reason, sets default reason to 'AUTO RELEASE - AUTOPACT TRAFFIC' if comments are empty, and sets release by to 'S.A.R.'
[Set Release Type to Export]
The message type is export → The system sets release type to 'A', sets export comment indicator to true, extracts comments for release reason, sets default reason to 'AUTO RELEASE - EXPORT TRAFFIC' if comments are empty, sets release by to 'EXPORT', and sets in-transit status to 'E'
[Set Release Type to Auto]
The message type is other than the specific release types → The system sets release type to 'A', extracts date from DTM date-time position 3-6, extracts time from DTM date-time position 9-12, sets release by to 'AUTO', and if GCW123 message ID is present concatenates 'CCRA ACQUITTAL:' with GCW123 comments for release reason
[Set Log Information with Current Date/Time]
The system prepares to create a release notification log entry → Log information is populated with machine century and date as log date, machine time as log time, input message as action code, and current ACF2 user ID
[Create Log Entry with Canadian CCN Released Message]
The system creates the log message content → US CCN key is set as train or US CCN, cargo type is set to US cargo, and message is formatted as 'CDN CCN RLSED: ' followed by the Canadian cargo CCN key
[Spawn Cargo Information Log Transaction]
The system submits the log entry for processing → GCT1051E transaction is spawned to record the Canadian CCN release notification in the cargo information log
[IIS-A6 Port Available?]
The system checks if IIS-A6 port code from CM table is available → Format message with CM port if available, otherwise use manifest transaction code
[Log Port Mismatch Information]
The system generates the port mismatch notification → Create Merlin notification and log mismatch information showing broker port versus system port
[Start Heartbeat Processing]
The system processes the heartbeat message → The system should initiate heartbeat processing workflow
[Retrieve T2 Table Segment]
The system needs to update the T2 table with heartbeat information → The system should call the table I/O service to retrieve the T2 table segment using 'T2' as table ID and spaces as sequence ID
[Update T2 Segment with CUSRES ACK Timestamp]
The system needs to record the heartbeat acknowledgment → The system should move the T2 segment to working storage, update the CUSRES acknowledgment field with the current timestamp, and move the updated segment back to the T2 segment area
[Replace T2 Segment in Database]
The system needs to persist the heartbeat acknowledgment → The system should call the table I/O service with REPL function code to replace the T2 segment in the database
[Entry Type: 34 - Aerospace]
The BGM document message name indicates aerospace entry type (34) → The system logs 'CCRA RNS ENTRY TYPE 34 AEROSPACE ENTRY' message
[Entry Type: 67 - ETA Paper]
The BGM document message name indicates ETA paper entry type (67) → The system logs 'CCRA RNS ENTRY TYPE 67 ETA - PAPER' message
[Entry Type: 75 - First Paper]
The BGM document message name indicates first paper entry type (75) → The system logs 'CCRA RNS ENTRY TYPE 75 FIRST - PAPER' message
[Entry Type: 117 - PARS Paper]
The BGM document message name indicates PARS paper entry type (117) → The system logs 'CCRA RNS ENTRY TYPE 117 PARS - PAPER' message
[Entry Type: 125 - PARS EDI]
The BGM document message name indicates PARS EDI entry type (125) → The system logs 'CCRA RNS ENTRY TYPE 125 PARS - EDI' message
[Entry Type: 174 - RMD Paper]
The BGM document message name indicates RMD paper entry type (174) → The system logs 'CCRA RNS ENTRY TYPE 174 RMD - PAPER' message
[Entry Type: 232 - VI Paper]
The BGM document message name indicates VI paper entry type (232) → The system logs 'CCRA RNS ENTRY TYPE 232 VI - PAPER' message
[Entry Type: 257 - RMD EDI]
The BGM document message name indicates RMD EDI entry type (257) → The system logs 'CCRA RNS ENTRY TYPE 257 RMD - EDI' message
[Entry Type: 331 - Cash Paper]
The BGM document message name indicates cash paper entry type (331) → The system logs 'CCRA RNS ENTRY TYPE 331 CASH - PAPER' message
[Entry Type: 463 - PARS OGD]
The BGM document message name indicates PARS OGD entry type (463) → The system logs 'CCRA RNS ENTRY TYPE 463 PARS - OGD' message
[Entry Type: 471 - RMD OGD]
The BGM document message name indicates RMD OGD entry type (471) → The system logs 'CCRA RNS ENTRY TYPE 471 RMD - OGD' message
[Update Broker Entry Information]
The document message number (first 15 characters) is spaces:
the entry type is RNS error
→ The system continues processing without updating broker entry information
[Entry Type?]
If the BGM document message name value → The system sets the corresponding entry type information message for aerospace (34), ETA paper (67), first paper (75), PARS paper (117), PARS EDI (125), RMD paper (174), VI paper (232), RMD EDI (257), cash paper (331), PARS OGD (463), RMD OGD (471), or RNS error processing
[Set Aerospace Entry Message Type 34]
The BGM document message name matches aerospace entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 34 AEROSPACE ENTRY'
[Set ETA Paper Entry Message Type 67]
The BGM document message name matches ETA paper entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 67 ETA - PAPER'
[Set First Paper Entry Message Type 75]
The BGM document message name matches first paper entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 75 FIRST - PAPER'
[Set PARS Paper Entry Message Type 117]
The BGM document message name matches PARS paper entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 117 PARS - PAPER'
[Set PARS EDI Entry Message Type 125]
The BGM document message name matches PARS EDI entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 125 PARS - EDI'
[Set RMD Paper Entry Message Type 174]
The BGM document message name matches RMD paper entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 174 RMD - PAPER'
[Set VI Paper Entry Message Type 232]
The BGM document message name matches VI paper entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 232 VI - PAPER'
[Set RMD EDI Entry Message Type 257]
The BGM document message name matches RMD EDI entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 257 RMD - EDI'
[Set Cash Paper Entry Message Type 331]
The BGM document message name matches cash paper entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 331 CASH - PAPER'
[Set PARS OGD Entry Message Type 463]
The BGM document message name matches PARS OGD entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 463 PARS - OGD'
[Set RMD OGD Entry Message Type 471]
The BGM document message name matches RMD OGD entry criteria → The system sets information message to 'CCRA RNS ENTRY TYPE 471 RMD - OGD'
[Log Cargo Information Message]
The information message is not empty or spaces → The system logs the cargo information message for audit and tracking purposes
[Extract Port Code from CM Segment]
The CM table is accessed using the destination station number → The port code should be extracted from the CM segment port code field for use in the query transaction
[Extract Port Code from MC Segment]
The MC table is accessed using the manifest station name → The port code should be extracted from positions 2-4 of the MC Canadian customs code field for use in the query transaction
[Extract Port Code from CM Segment]
Processing port information for query → The system extracts port code from CM segment port code field
[Extract Port Code from MC Segment]
Processing port information for query → The system extracts port code from MC Canadian customs code field positions 2-4
[Call GCCTBIO to Retrieve CM Segment]
The system performs port code lookup → Set table ID to 'CM', use destination station number as key, and call GCCTBIO to retrieve CM segment data
[Extract CM Port Code]
The system processes the CM segment data → Parse the CM segment and extract the CM port code for port validation processing
[Call GCCTBIO to Retrieve MC Segment]
The system performs port code lookup → Set table ID to 'MC', use manifest destination station name as key, and call GCCTBIO to retrieve MC segment data
[Extract MC Customs Code]
The system processes the MC segment data → Parse the MC segment and extract positions 2-5 of the Canadian customs code for port validation processing
[Release A6 Manifests]
The cargo CCN key does not start with '6105E' (test cargo) → The system calls GCCCCREL to release the A6 manifest for the cargo
[Build Message Table Key]
The system needs to lookup error message details in the message table → The system should set table ID to 'MS', clear the sequence ID, and construct key by concatenating 'BB' with the first 2 characters of the application error code
[Call Table I/O Function]
The system performs a table lookup operation → The system should call the table I/O function to retrieve the corresponding error message record
[Table Entry Found?]
If the lookup results → If the table entry is found, extract the English error text from the table segment; otherwise, construct an unknown error message using the error code and indicate it's not on the message table
[Release Entry Number Empty?]
The BGM document message number (entry number) is checked for availability → If entry number is empty or spaces, process GCW123 release types, otherwise set standard release information
[GCW123 Auto Release?]
The message ID is GCW123 and the release type is auto release → Set release type to automatic and extract release details from GCW123 comments
[Set Auto Release Info]
The release type is confirmed as auto release → Set release type to 'A', release by to 'AUTO', extract date from GCW123 date field, extract time from GCW123 time field, set release reason from GCW123 comments, and set entry type from GCW123 comments position 26-28
[GCW123 Manual Release?]
The message ID is GCW123 and the release type is manual release → Process the release as manual release type
[Set Manual Release Info]
The release type is confirmed as manual release → Set release type to 'M', create release reason by concatenating 'MANUAL RELEASE' with GCW123 comments, and if comments are empty set release reason to 'MANUAL RELEASE' and release by to ACF2 user ID
[GCW123 SAR Release?]
The message ID is GCW123 and the release type is SAR release → Process the release as SAR autopact traffic release
[Set SAR Auto Release Info]
The release type is confirmed as SAR release → Set release type to 'A', set GCW123 comment type to auto release, set release reason from GCW123 comments or default to 'AUTO RELEASE - AUTOPACT TRAFFIC' if empty, and set release by to 'S.A.R.'
[GCW123 Export Release?]
The message ID is GCW123 and the release type is export → Process the release as export traffic release
[Set Export Release Info]
The release type is confirmed as export → Set release type to 'A', set GCW123 comment type to export, set release reason from GCW123 comments or default to 'AUTO RELEASE - EXPORT TRAFFIC' if empty, set release by to 'EXPORT', and set in-transit status to 'E'
[Set Standard Release Info]
Standard release processing is required → Set release type to 'A', extract release date from DTM date-time positions 3-8, extract release time from DTM date-time positions 9-12, set release by to 'AUTO', and if GCW123 message exists create release reason by concatenating 'CCRA ACQUITTAL:' with GCW123 comments
[Log Release Message]
A release message needs to be logged → If entry number is empty and GCW123 auto release, create message with release type from BGM document message name; if GCW123 manual release, create message with 'MANUAL RELEASE' and comments; if GCW123 SAR release, create message 'AUTO RELEASE - AUTOPACT TRAFFIC'; if GCW123 export, create message 'AUTO RELEASE - EXPORT TRAFFIC'; otherwise create message with entry number, port, and transaction type
[Create US Manifest Release Log]
US manifest release logging is performed → Create log entry with action code for input message, US CCN as train identifier, US cargo type flag, and message containing Canadian CCN release information
[Send Merlin Release Notification]
Notification transmission is initiated → Send release notification to Merlin system with release type flag, and if conveying car exists and carrier index is not '999', update IIS system with release status
[Set Release Type to A, Set Release By to AUTO, Use GCW123 Date/Time, Set Comments as Release Reason, Extract Entry Type from Comments]
The message type is GCW123 and auto release flag is set → Release type is set to A, release by is set to AUTO, release date is extracted from GCW123 date starting at position 3 for 6 characters, release time is set from GCW123 time, release reason is set from GCW123 comments, and entry type is extracted from GCW123 comments starting at position 26 for 3 characters
[Set Release Type to M, Build Manual Release Reason, Use User ID if No Comments]
The message type is GCW123 and manual release flag is set → Release type is set to M, release reason is built by concatenating 'MANUAL RELEASE ' with GCW123 comments, and if GCW123 comments are spaces then release reason is set to 'MANUAL RELEASE' and release by is set to current ACF2 user ID
[Set Release Type to A, Set Release By to S.A.R., Set Auto Release Flag, Set AUTOPACT Traffic Reason]
The message type is GCW123 and SAR release flag is set → Release type is set to A, auto release comment flag is set to true, release reason is set from GCW123 comments or defaults to 'AUTO RELEASE - AUTOPACT TRAFFIC' if comments are spaces, and release by is set to 'S.A.R.'
[Set Release Type to A, Set Release By to EXPORT, Set Export Flag, Set Export Traffic Reason, Set In-Transit Status to E]
The message type is GCW123 and export flag is set → Release type is set to A, export comment flag is set to true, release reason is set from GCW123 comments or defaults to 'AUTO RELEASE - EXPORT TRAFFIC' if comments are spaces, release by is set to 'EXPORT', and in-transit status is set to 'E'
[Set Release Type to A, Use DTM Date/Time, Set Release By to AUTO, Build CCRA Acquittal Reason]
The message type is other than the specific GCW123 variants → Release type is set to A, release date is extracted from DTM date-time starting at position 3 for 6 characters, release time is extracted from DTM date-time starting at position 9 for 4 characters, release by is set to 'AUTO', and if the message is GCW123 type then release reason is built by concatenating 'CCRA ACQUITTAL: ' with GCW123 comments
[Set Auto Release Parameters]
The message type is identified as auto release → The system sets release type to 'A' for automatic, extracts date and time from GCW123 message, sets release by to 'AUTO', extracts entry type from comments position 26-28, and copies comments to release reason
[Set Manual Release Parameters]
The message type is identified as manual release → The system sets release type to 'M' for manual, creates release reason with 'MANUAL RELEASE' prefix and GCW123 comments, and if comments are empty then sets release reason to 'MANUAL RELEASE' and uses ACF2 user ID as release by
[Set AUTOPACT Traffic Settings]
The message type is identified as SAR release → The system sets release type to 'A' for automatic, sets auto release comment indicator, copies GCW123 comments to release reason, sets default reason to 'AUTO RELEASE - AUTOPACT TRAFFIC' if comments are empty, and sets release by to 'S.A.R.'
[Configure Export Traffic Status]
The message type is identified as export release → The system sets release type to 'A' for automatic, sets export comment indicator, copies GCW123 comments to release reason, sets default reason to 'AUTO RELEASE - EXPORT TRAFFIC' if comments are empty, sets release by to 'EXPORT', and sets in-transit status to 'E'
[Apply Default Release Values]
The message type evaluation reaches the default case → The system sets release type to 'A' for automatic, extracts release date from DTM date-time positions 3-8, extracts release time from DTM date-time positions 9-12, sets release by to 'AUTO', and if GCW123 message then creates release reason with 'CCRA ACQUITTAL:' prefix and GCW123 comments
[Set Action Code as Input Message]
Setting the action code for the log entry → Log use input message constant is moved to GCX105 action code field
[Create Release Message for US Cargo]
Creating the release message content → Message 'CDN CCN RLSED: ' concatenated with Canadian CCN key is moved to GCX105 message field
[Call GCCUSIO with GU Function]
Executing the initial US cargo database query → The system should call GCCUSIO with GU function AND set segment type to GCSUSRT AND set index type to CAR-WB AND use greater than or equal operator for the search
[Call GCCUSIO with GN Function]
Continuing the sequential search for additional US cargo records → The system should call GCCUSIO with GN function AND maintain the same segment type GCSUSRT AND use CAR-WB index type AND apply greater than operator for sequential access
[Call GCCUSIO with Parameters]
Executing the database search → GCCUSIO should be called with the configured parameters to retrieve US cargo records
[Receive EXAM Status from CCRA RNS]
The GIS status indicator equals EXAM (examination required) → The system should initiate examination hold processing
[Set Information Message]
Processing examination hold status → The information message should be set to 'CCRA RNS GOODS HELD FOR EXAMINATION'
[Log Cargo Information Message]
Processing cargo examination hold → The system should log the cargo information message
[Prepare Hold Notification for Merlin]
Preparing hold notification → The system should format a hold notification message with cargo details
[Format Hold Notification Message]
Formatting the notification message → The first line should contain 'Cargo on HOLD for inspection by CBSA - CUSRES'
[Include Equipment Details]
Including equipment details → Equipment ID should be included with label 'Equipment : '
[Include Waybill Information]
Including waybill information → Waybill details should include carrier index, origin station number, and waybill number with label 'Waybill : '
[Include CCN Details]
Including CCN details → CCN key should be included with label 'CCN : '
[Include Destination Information]
Including destination information → Destination should include station name and state code with label 'DESTINATION : '
[Include Manifest Information]
Including manifest information → Manifest station name should be included with label 'MANIFEST UPON : '
[Send Hold Notification to CBSA]
Sending notification → The system should send the hold notification as type HOLD to Merlin
[Check GIS Segment for Y51 Release Indicator]
The GIS processing indicator equals Y51 release status → The system should identify this as a Y51 release requirement case
[Set Y51 Release Message]
The system processes the Y51 release status → The cargo information message should be set to 'CCRA RNS Y51 RELEASE DOCS REQUIRED'
[Log Y51 Release Requirement Status]
The system performs cargo information logging → The Y51 release requirement should be logged with current timestamp and cargo identification
[Agriculture Inspection Hold Detected]
The system processes the agriculture examination requirement → The system should set agriculture inspection hold status message and continue processing
[Set Agriculture Inspection Hold Status Message]
The system processes the agriculture hold status → The system should set message to 'CCRA RNS RELEASED BUT REQUIRE AGRICULTURE INSPECTION'
[Log Agriculture Inspection Message]
The system needs to log the agriculture inspection requirement → The system should Execute cargo information message logging
[Check GIS-01 Process Indicator]
If the GIS-01 process indicator value → The system identifies whether the declaration status is accepted or requires other processing
[Set Info Message: 'CCRA RNS: DECLARATION ACCEPTED']
The system processes a declaration that has been accepted → The system sets the information message to 'CCRA RNS: DECLARATION ACCEPTED'
[Append ', AWAIT ARRIVAL' to Message]
The system processes the declaration acceptance → The system appends ', AWAIT ARRIVAL' to the information message
[Log Cargo Information Message]
The system needs to record the cargo status change → The system logs the cargo information message to the audit trail
[Log Acceptance Message]
The cargo record has been updated → An acceptance message 'CCRA RNS: AUTHORIZED TO PROCEED' is logged for the cargo
[Log Non-CSA Rejection]
CSA authorization to deliver message is processed → A rejection message 'NOT ACCEPTED - NON-CSA' is logged and no status changes are made
[Set Info Message: 'CCRA RNS: TRANSACTION AWAITING PROCESSING']
The system processes the awaiting processing status → The system sets the information message to 'CCRA RNS: TRANSACTION AWAITING PROCESSING'
[Log Cargo Information Message]
The system processes the awaiting processing status → The system logs the cargo information message
[Retrieve CM table data using destination station]
CM table lookup is performed using destination station number → Retrieve CM table segment data if available
[Get CPR port code from CM table]
CM table segment contains port code information → Extract CPR port code from CM table for comparison
[Port mismatch exists?]
Port mismatch flag is true and no port match override exists → Prepare broker mismatch message for notification
[Format port mismatch message]
IIS-A6 port code is available and not zero → Format message showing broker port versus CPR IIS-A6 port code
[Format port mismatch message]
IIS-A6 port code is not available or is zero → Format message showing broker port versus manifest transaction code
[Port Mismatch Still Exists?]
If the final port mismatch status → If mismatch still exists, prepare mismatch message; otherwise end validation
[Prepare Broker Mismatch Message]
The system prepares the mismatch notification → Generate message with broker port, CPR port, and appropriate context (IIS-A6 port if applicable, otherwise manifest transaction code)
[Log Port Mismatch Information]
The system logs the mismatch information → Create log entry with detailed port comparison information for cargo tracking
[Extract Port Code from CM Segment]
Processing CM table segment data → Move table segment to CM segment structure and extract CM port code to IIS-A6 port variable
[Clear Return Flags and Segments]
The system prepares the access parameters → All return flags, key values, and segment areas should be cleared to spaces
[Move Table Segment to CM Segment]
The return flag indicates successful retrieval → The retrieved table segment should be moved to the CM segment structure for further processing
[Extract Port Code from CM Segment]
The system needs to extract port information → The port code should be extracted from the CM segment and stored for comparison
[Access CM Table by Station Number]
The system accesses the CM table using the destination station number as the key → Retrieve the corresponding CM table segment containing port code information
[Prepare Port Mismatch Message]
The system prepares the mismatch notification message → Include broker port, CPR port (either IIS-A6 port or manifest transaction code), and format the message for Merlin notification
[Log Port Mismatch Information]
The system logs the mismatch information → Record the port mismatch details in the cargo information log and send Merlin notification
[Set Release Type to 'A' - Auto]
Release information is being set → Release type is set to 'A', release user is set to 'AUTO', release date is extracted from GCW123 date field, release time is extracted from GCW123 time field, comments are set as release reason, and entry type is extracted from comments position 26-28
[Set Release Type to 'M' - Manual]
Release information is being set → Release type is set to 'M', release reason is built with 'MANUAL RELEASE' text and GCW123 comments, and if comments are spaces then release reason is set to 'MANUAL RELEASE' and release user is set to current ACF2 user ID
[Set Release Type to 'A' - Auto SAR]
Release information is being set → Release type is set to 'A', auto release comment indicator is set to true, GCW123 comments are set as release reason, if comments are spaces then release reason is set to 'AUTO RELEASE - AUTOPACT TRAFFIC', and release user is set to 'S.A.R.'
[Set Release Type to 'A' - Auto Export]
Release information is being set → Release type is set to 'A', export comment indicator is set to true, GCW123 comments are set as release reason, if comments are spaces then release reason is set to 'AUTO RELEASE - EXPORT TRAFFIC', release user is set to 'EXPORT', and in-transit status is set to 'E'
[Set Default Auto Release Values]
Release information is being set → Release type is set to 'A', release date is extracted from DTM date-time field positions 3-8, release time is extracted from DTM date-time field positions 9-12, release user is set to 'AUTO', and if message is GCW123 then release reason is built with 'CCRA ACQUITTAL:' text and GCW123 comments
[Extract Release Comments]
The system processes the auto release message → The system extracts entry type from positions 26-28 of comments, entry number from positions 1-15 of comments, and location from positions 19-22 of comments
[Set Release Type as 'A' - Auto]
The system sets release information → The system sets release type to 'A', release by to 'AUTO', release date from GCW123 date positions 3-8, release time from GCW123 time, release reason from GCW123 comments, and entry type from GCW123 comments positions 26-28
[Parse Comments for Entry Type and Location]
The system creates message segments → The system creates LOC segment with identifier 'LOC' and location from GCW123 comments positions 19-22, and increments message entry count
[Configure Auto Release Parameters]
The system creates reference segment → The system sets RFF reference qualifier to 'XC' and RFF reference to GCW123 CCN key, and increments message entry count
[Comments Field Empty?]
The system examines the GCW123 comments field → If comments field is empty or contains only spaces, use default manual release reason, otherwise use the provided comments to build custom release reason
[Build Release Reason with Comments]
The system builds the release reason text → The release reason is constructed by concatenating 'MANUAL RELEASE ' with the GCW123 comments field content
[Use Default Manual Release Reason]
The system assigns the release reason → The release reason is set to the default text 'MANUAL RELEASE' and the release by field is set to the current user ID from CCCOM
[Log Manual Release Message]
The system creates audit log entries → A log message is generated containing manual release information and user comments for tracking purposes
[Set Release Type to 'A' - Automatic]
The system processes the SAR release message → The release type must be set to 'A' indicating automatic release
[Set Auto Release Comment Flag]
The release type is set to automatic → The auto release comment flag must be set to TRUE
[Use Default: 'AUTO RELEASE - AUTOPACT TRAFFIC']
The system needs to assign a release reason → The release reason must be set to 'AUTO RELEASE - AUTOPACT TRAFFIC'
[Use GCW123 Comments as Release Reason]
The system needs to assign a release reason → The release reason must be set to the value from GCW123 comments field
[Set Release By to 'S.A.R.']
The release authority needs to be assigned → The release by field must be set to 'S.A.R.'
[Set Auto Release Comment Flag in BGM]
The BGM segment is initialized → The auto release comment flag must be set to TRUE in the BGM segment
[Add BGM Segment to Message Array]
The message array is being populated → The BGM segment must be added to the message table entry at the current maximum entries position
[Message ID is GCW123 and Export?]
The message ID is GCW123 AND the message type is export release → The system identifies it as an export release message and proceeds with export processing
[Set Default Export Message]
The system processes the export release → The release reason is set to 'AUTO RELEASE - EXPORT TRAFFIC'
[Use Comments as Release Reason]
The system processes the export release → The GCW123 comments content is used as the release reason
[Set Release Type to Auto 'A']
The release type is being set → The release type is set to 'A' for automatic release
[Set Release By to 'EXPORT']
The release authority is being assigned → The release by field is set to 'EXPORT'
[Set In-Transit Status to 'E']
The cargo status is being updated → The in-transit status is set to 'E' for export
[Set Export Flag in Comments]
The comment processing flags are being set → The export comment flag is set to true for proper message handling
[Set BGM Segment for Export]
The BGM segment is being configured → The BGM segment is set with export-specific identifiers and message content
[Set DTM Segment with Date/Time]
The DTM segment is being configured → The DTM segment is populated with current machine date and time or GCW123 date/time if available
[Set GIS Segment with Release Indicator]
The GIS segment is being configured → The GIS segment process indicator is set to '4' for release status
[Set RFF Segment with CCN Reference]
The RFF segment is being configured → The RFF segment is set with reference qualifier 'XC' and the GCW123 CCN key
[Is Cargo CSA Enabled?]
Processing CSA authorization delivery message → Check if cargo has CSA indicator enabled
[Set CSA Delivery Status to Accepted]
Processing CSA authorization delivery message → Set cargo status to CSA delivery accepted and mark CSA authorization as received
[Log CSA Authorization Message]
CSA authorization processing is complete → Log message 'ACCEPTED - CSA' for cargo information tracking
[Set Status to Not Accepted - Non-CSA]
Processing CSA authorization delivery message → Set status to not accepted for non-CSA cargo
[Format Car Release Header Message]
Formatting the car release header message → A formatted string is created containing 'CCRA RELEASE' followed by equipment car, release date, release time, piece count, destination station number, and document message type
[Insert Car Release Line to Merlin Report]
Inserting the car release line to Merlin report → The formatted message is added to the Merlin detail line at the current line position and car release insertion is performed
[Add CCN List Header Message]
Adding the CCN list header → The message 'Below is a list of CCNs for this Car:' is added to the Merlin detail line at the current position
[Format Release Header Message]
Formatting the Merlin release header message → A formatted string is created containing 'CCRA RELEASE' followed by equipment car, hold date, hold time, piece count, destination station number (positions 3-4), and document message type (positions 1-3) delimited by spaces and 'TYPE:' label
[Add CCN List Header Message]
Adding the CCN list header → The message 'Below is a list of CCNs for this Car:' is added to the current line position
[Set Merlin Message Type to RELEASE]
The system prepares the Merlin release notification → The Merlin message type should be set to RELEASE
[Create Log Message with Canadian CCN Released]
The system creates the log message content → Action code is set to log use input message, US CCN key is moved to train or US CCN field, US cargo flag is set to true, and message is constructed with 'CDN CCN RLSED:' followed by the Canadian CCN key
[Spawn Cargo Information Log Entry]
The system submits the log entry → Log entry is spawned using the prepared cargo information structure
[Search for Related Follower Manifests]
The system executes a database search using CIMS with GN function → Retrieve cargo report segments using the specified search criteria and return status code
[Build Message Table Key]
The system needs to retrieve error message text → The system should set table ID to 'MS' and construct key with 'BB' prefix plus the first 2 characters of the application error code
[Call GCCTBIO to Retrieve Message]
The system calls the table lookup service → The system should attempt to retrieve the corresponding English error message text from the message table
[Extract English Text from Table]
The system processes the retrieved message data → The system should extract the English text portion from the table segment for error reporting
[Retrieve English Text from Message Table]
The system processes the retrieved table segment data → The system moves the first 150 characters of the table segment to the message segment structure and extracts the English text for error reporting
[Clear Merlin Detail Line 1]
The error message preparation process begins → The first Merlin detail line should be cleared of any existing content
[Format CCN Message Line]
A Merlin error message is being prepared → The first detail line should be formatted as 'CARGO CONTROL NUMBER : ' followed by the 25-character cargo control number from the RFF reference
[Set Line Count to 4]
The error message preparation is being finalized → The Merlin report line count should be set to 4 lines
[Call Email Send Preparation]
The error message is ready for distribution → The email send preparation process should be invoked to handle message distribution
[Location Found in Message?]
The location segment (LOC) is not found in the message → The port validation process is bypassed and processing continues
[Extract Broker Port from LOC Segment]
Port validation is being performed → The broker port code is extracted from the first 4 characters of the LOC-02-LOCATION field
[Get CPR Port Code from CM Table]
Port validation requires CPR port code → The port code is extracted from the CM table segment
[Prepare Broker Mismatch Message]
Notification processing is required → Merlin message preparation is initiated for broker mismatch notification
[Format Message Line 1 - CCN and Mismatch Info]
Formatting message content → First message line contains 'Broker Entry / Manifest Mismatched for :' followed by the 25-character cargo control number
[Format Message Line 2 - Broker and Transaction Details]
Adding broker information to message → Second message line contains 'Broker is :' followed by broker name and 'Transaction number :' followed by first 15 characters of document message number
[Format Message Line 3 - Port Comparison]
Formatting port information line → Third message line shows 'BROKER SHOWS PORT :' followed by broker port and 'CPR SHOWS PORT :' followed by CPR port
[IIS-A6 Port Available?]
Determining CPR port display value → If IIS-A6 port from CM table is not zero, use CM table port; otherwise use manifest transaction code
[Show Broker vs CPR Port from CM Table]
Formatting port comparison message → Message shows broker port from location segment versus CPR port from CM table
[Show Broker vs CPR Transaction Code]
Formatting port comparison message → Message shows broker port from location segment versus manifest transaction code
[Set Message Type as INFO]
Setting message classification → Message type is set as INFO for informational notification
[Send Merlin Message]
Notification transmission is required → Message is sent through Merlin system for stakeholder notification
[Log Port Mismatch Information]
Audit logging is required → Port mismatch details are logged including broker port, CPR port, and cargo information
[Set Primary Hold Message]
The primary message content is being set → The first message line should contain 'Cargo on HOLD for inspection by CBSA - CUSRES'
[Format Equipment Information Line]
Equipment details are being added to the message → The equipment line should display 'Equipment : ' followed by the equipment ID from the cargo record
[Format Waybill Information Line]
Waybill details are being added to the message → The waybill line should display 'Waybill : ' followed by the carrier index, origin station number index, and waybill number index concatenated together
[Format CCN Information Line]
CCN details are being added to the message → The CCN line should display 'CCN : ' followed by the cargo control number key
[Format Destination Information Line]
Destination details are being added to the message → The destination line should display 'DESTINATION : ' followed by the destination station name, comma, space, and destination station state code
[Format Manifest Station Line]
Manifest station details are being added to the message → The manifest line should display 'MANIFEST UPON : ' followed by the manifest to station name
[Set Message Line Count to 7]
The message structure is being finalized → The message line count should be set to 7 to indicate the total number of formatted lines
[Set Message Type as HOLD]
The message type classification is being set → The message type should be set as HOLD to ensure proper message routing and handling
[Prepare Email Send Process]
The message is ready for distribution → The email preparation process should be initiated to send the hold notification to appropriate recipients
[Is Cargo a Follower Manifest?]
The cargo is identified as a follower manifest → The query processing should be skipped and no query message should be sent
[Manifest Station is IIS-A6 or Spaces?]
The manifest-to-station-name is either 'IIS-A6' or spaces → Use CM table lookup with destination station number, otherwise use MC table lookup with manifest-to-station-name
[Lookup CM Table with Destination Station]
CM table lookup is performed using destination station number as key → Retrieve the port code from CM segment for use in query message
[Lookup MC Table with Manifest Station]
MC table lookup is performed using manifest-to-station-name as key → Retrieve the Canadian customs code (positions 2-4) from MC segment as port code for use in query message
[Spawn GCT1481E Query Transaction]
The query transaction is ready to be sent → Spawn GCT1481E transaction to send the query message and set query error flag to indicate query was processed
[Format Info Message Subject]
The notification type is determined to be an info/mismatch message → The email subject is formatted as 'BROKER/MANIFEST MISMATCH ' followed by the cargo reference number from RFF-02-REFERENCE positions 1-25
[Format Hold Message Subject]
The notification type is determined to be a hold message → The email subject is formatted as 'CBSA CARGO HOLD - ' followed by the cargo reference number from RFF-02-REFERENCE positions 1-25
[Format Release Message Subject]
The notification type is determined to be other than error, info/mismatch, or hold → The email subject is set to the content of MRLN-DTL-LINE(01)
[Set Email Recipients from Admin Configuration]
The AD segment lookup is successful (88-AD-SEGMENT-FOUND is true) → The primary email recipient is set to GCSTBRT-AD-DC-P-MERLIN-1 and secondary recipient is set to GCSTBRT-AD-DC-P-MERLIN-5
[Set Default Recipients if Admin Not Found]
The AD segment lookup is unsuccessful (88-AD-SEGMENT-FOUND is false) → The primary email recipient is set to 'OM01247' and secondary recipient is set to spaces
[Send to IN Destination Only]
The message type flag 88-Z110-MRLN-TYPE-IS-UNKNOWN is true → The destination filename is set to 'UNKNOWN', recipient usercode is cleared, and primary recipient is set to 'OM01247'
[Send to IN Destination Only]
The message type flag 88-Z110-MRLN-TYPE-IS-INFO is true → The destination filename is set to 'IN', recipient usercode is cleared, and primary recipient is set to 'OM01247'
[Send to CAHOLD Destination]
The message type flag 88-Z110-MRLN-TYPE-IS-HOLD is true → The destination filename is set to 'CAHOLD', recipient usercode is cleared, and primary recipient is set to 'OM01247'
[Send to Station-Specific Merlin ID]
The message type flag 88-Z110-MRLN-TYPE-IS-RLSE is true and station Merlin ID is found → The destination filename is set to 'IN' and primary recipient is set to GCSTBRT-MC-MERLIN-ID from the station configuration
[Check Iron Highway Processing]
The message type is release (88-Z110-MRLN-TYPE-IS-RLSE is true) → The system performs Iron Highway check (Z996-IRONHWY-CHECK) to determine if additional Iron Highway processing is needed
[Retrieve Admin Configuration from Database]
Admin table lookup is performed with table ID 'AD' and sequence ID 'ADMINID' → System retrieves admin segment configuration and sets admin segment found flag to true if successful
[Admin Segment Found?]
Admin table lookup return flag equals '0' indicating successful retrieval → System sets admin segment found flag to true and uses admin configuration for email recipients
[Set Recipients from Admin Config]
System processes admin configuration data → System moves admin segment to table segment and extracts primary Merlin recipient from admin configuration
[Configure Primary Recipient]
System configures primary email recipient → System sets primary recipient to GCSTBRT-AD-DC-P-MERLIN-1 from admin configuration
[Configure Secondary Recipient]
System sets secondary email recipient in email preparation logic → System sets secondary recipient to GCSTBRT-AD-DC-P-MERLIN-5 from admin configuration
[Configure Primary Recipient]
System configures primary email recipient with default values → System sets primary recipient to 'OM01247'
[Configure Secondary Recipient]
System configures secondary email recipient with default values → System sets secondary recipient to spaces
[Set Info Message Subject]
The system processes the message type classification → The subject line is set to 'BROKER/MANIFEST MISMATCH' followed by the first 25 characters of the reference number
[Set Hold Message Subject]
The system processes the message type classification → The subject line is set to 'CBSA CARGO HOLD -' followed by the first 25 characters of the reference number
[Set Default Subject]
The system processes the message type classification → The subject line is set to the content of the first Merlin detail line
[Configure Destination Users]
Admin segment information is available → Primary and secondary Merlin user codes are set from admin segment, otherwise default to 'OM01247' for primary and spaces for secondary
[Route to UNKNOWN Destination]
The system routes the notification → The destination filename is set to 'UNKNOWN', user code is cleared, and primary user is set to 'OM01247'
[Route to IN Destination Only]
The system routes the notification → The destination filename is set to 'IN', user code is cleared, and primary user is set to 'OM01247'
[Route to Station-Specific Merlin ID]
The system routes the notification → The destination is set to 'IN', primary user is set to the station Merlin ID, and Iron Highway check is performed
[Route to Hold Notification CAHOLD]
The system routes the notification → The destination filename is set to 'CAHOLD', user code is cleared, and primary user is set to 'OM01247'
[Send Notification to Configured Destinations]
The system executes the notification send process → The EMCSEND2 service is called with configured parameters and the message sequence number is incremented
[Reset Fields for Next Message]
The system completes the notification process → All Merlin report fields are cleared, line counter is reset, subject and keywords are cleared, and sequence number is incremented
[Set Subject Line Based on Message Type]
The message type is ERROR and contains a cargo control number reference → Set subject line to 'CUSTOMS RECEIVED ERR MSG' followed by the cargo control number
[Set Subject Line Based on Message Type]
The message type is INFO and contains a cargo control number reference → Set subject line to 'BROKER/MANIFEST MISMATCH' followed by the cargo control number
[Set Subject Line Based on Message Type]
The message type is HOLD and contains a cargo control number reference → Set subject line to 'CBSA CARGO HOLD - ' followed by the cargo control number
[Set Subject Line Based on Message Type]
The message type is not ERROR, INFO, or HOLD → Set subject line to the content of the first message detail line
[Set Merlin User Codes from Admin Config]
Administrative segment data is found and available → Set primary and secondary Merlin user codes from administrative configuration values
[Set Default User Code OM01247]
Administrative segment data is not found or not available → Set primary user code to 'OM01247' and clear secondary user code
[Set Destination: UNKNOWN, Set User Code: OM01247]
The message type is classified as UNKNOWN → Set destination filename to 'UNKNOWN', clear usercode, and set primary user code to 'OM01247'
[Set Destination: IN, Send to Info Recipients]
The message type is classified as INFO → Set destination filename to 'IN', clear usercode, and set primary user code to 'OM01247'
[Fetch Station Merlin ID]
The message type is RELEASE → Look up Merlin configuration using the manifest destination station name as the key
[Set Destination: IN, Set Station-Specific Merlin ID]
Station-specific Merlin ID is found in the configuration → Set destination filename to 'IN' and set primary user code to the station-specific Merlin ID
[Check Iron Highway Processing]
The message type is RELEASE and Iron Highway processing is required → Invoke Iron Highway integration processing for the released cargo
[Set Destination: CAHOLD, Set User Code: OM01247]
The message type is classified as HOLD → Set destination filename to 'CAHOLD', clear usercode, and set primary user code to 'OM01247'
[Complete Destination Configuration]
Message configuration processing is complete → Reset report fields, clear subject and keywords, increment sequence number, and restore default settings
[Clear Key Values and Flags]
The system initializes the lookup process → All key values, data values, return flags, segment areas, and control flags are cleared to spaces
[Move Table Segment to MC Segment]
The system processes the retrieved data → The table segment data is moved to the MC segment structure for further processing
[Extract Merlin ID from MC Segment]
The system accesses the MC segment data → The Merlin ID is extracted from the MC segment for use in station-specific notifications
[Set MC Segment to Spaces]
The system handles the not found condition → The MC segment is set to spaces to indicate no station information is available
[Clear Message Array Structure]
The system initializes spawned message arrays → The MQS message array is cleared to spaces
[Set SAR Auto Release Comments]
The release type is SAR release → The system sets auto release comment flag and uses 'AUTO RELEASE - AUTOPACT TRAFFIC' as default release reason if comments are empty
[Set Export Release Comments]
The release type is export release → The system sets export comment flag and uses 'AUTO RELEASE - EXPORT TRAFFIC' as default release reason if comments are empty
[Set Message Entry Count to 1]
The message entry count is initialized → The maximum MQS entries is set to 1
[Store BGM Segment in Array]
The BGM segment is stored → The BGM segment is moved to the MQS table entry at the current maximum entries position
[Increment Entry Count]
The LOC segment is ready to be stored → The maximum MQS entries count is incremented by 1
[Store LOC Segment in Array]
The LOC segment is stored → The LOC segment is moved to the MQS table entry at the current maximum entries position
[Increment Entry Count]
The DTM segment is ready to be stored → The maximum MQS entries count is incremented by 1
[Store DTM Segment in Array]
The DTM segment is stored → The DTM segment is moved to the MQS table entry at the current maximum entries position
[Increment Entry Count]
The GIS segment is ready to be stored → The maximum MQS entries count is incremented by 1
[Store GIS Segment in Array]
The GIS segment is stored → The GIS segment is moved to the MQS table entry at the current maximum entries position
[Increment Entry Count]
The ERP segment is ready to be stored → The maximum MQS entries count is incremented by 1
[Store ERP Segment in Array]
The ERP segment is stored → The ERP segment is moved to the MQS table entry at the current maximum entries position
[Increment Entry Count]
The ERC segment is ready to be stored → The maximum MQS entries count is incremented by 1
[Store ERC Segment in Array]
The ERC segment is stored → The ERC segment is moved to the MQS table entry at the current maximum entries position
[Set Reference Qualifier to XC]
The reference qualifier is set → The RFF reference qualifier is set to 'XC '
[Set CCN Key as Reference]
The reference value is set → The RFF reference is set to the GCW123 CCN key
[Increment Entry Count]
The RFF segment is ready to be stored → The maximum MQS entries count is incremented by 1
[Store RFF Segment in Array]
The RFF segment is stored → The RFF segment is moved to the MQS table entry at the current maximum entries position
[Clear Message Array]
The system begins to initialize message segments → The message array is cleared to spaces
[Set SAR Release Comments]
The system processes the SAR release → The release reason is set to 'AUTO RELEASE - AUTOPACT TRAFFIC' if comments are empty
[Set Export Release Comments]
The system processes the export release → The release reason is set to 'AUTO RELEASE - EXPORT TRAFFIC' if comments are empty
[Extract Type and Entry from Comments]
The BGM segment is being populated → The document message name is extracted from positions 26-28 of comments and document number from positions 1-15
[Use Comments as Message Name]
The BGM segment document message name is being set → The entire comments field is used as the document message name
[Set BGM Entry Count]
The BGM segment is ready to be stored → The maximum message entries is set to 1 and BGM segment is stored in the first position of the message array
[Store DTM Segment]
DTM segment is ready to be stored → The message entry count is incremented and DTM segment is stored in the message array
[Set Reject Process Indicator]
GIS process indicator is being set → The process indicator is set to '2 '
[Set Release Process Indicator]
GIS process indicator is being set → The process indicator is set to '4 '
[Store GIS Segment]
GIS segment is ready to be stored → The message entry count is incremented and GIS segment is stored in the message array
[Set SAR Release Comments]
The message comments are empty or contain only spaces, high-values, or low-values → The release reason is set to 'AUTO RELEASE - AUTOPACT TRAFFIC'
[Set Export Release Comments]
The message comments are empty or contain only spaces, high-values, or low-values → The release reason is set to 'AUTO RELEASE - EXPORT TRAFFIC'
[Use Default 'GCT1231E' as Document Message Name]
The GCW123 comments field is empty, contains spaces, high-values, or low-values → The document message name is set to 'GCT1231E'
[Store BGM Segment in Message Array]
The BGM segment is ready for message processing → The BGM segment is stored in the message table entry at the current maximum entry position and the maximum MQS entries counter is set to 1
[Apply Default GCT1231E Value]
GCW123 comments are spaces, high-values, or low-values → The BGM document message name is set to 'GCT1231E'
[Set Auto Release Traffic Message]
The message type is SAR release and comments are empty → The release reason is set to 'AUTO RELEASE - AUTOPACT TRAFFIC'
[Set Export Traffic Message]
The message type is export and comments are empty → The release reason is set to 'AUTO RELEASE - EXPORT TRAFFIC'
[GCW123 Comments Available?]
GCW123 comments are evaluated for content → If comments are spaces, high-values, or low-values, use default processing; otherwise process based on message type
[Message Type?]
The message type is determined from GCW123 flags → Route to SAR release processing, export processing, auto-release processing, or default processing based on the message type
[Set Default Message Name to 'GCT1231E']
GCW123 comments field is empty, contains spaces, high-values, or low-values → The system sets BGM document message name to 'GCT1231E' as the default value
[Extract Entry Number from Position 1-15]
The entry type has been extracted from positions 26-28 → The system extracts characters from position 1-15 of GCW123 comments and sets it as the BGM document message number
[Set Auto Release Comment Flag]
The message type is SAR release → The system sets the auto release comment flag to true
[Set Default SAR Message: 'AUTO RELEASE - AUTOPACT TRAFFIC']
GCW123 comments field is empty → The system sets the release reason to 'AUTO RELEASE - AUTOPACT TRAFFIC'
[Set Export Comment Flag]
The message type is export → The system sets the export comment flag to true
[Set Default Export Message: 'AUTO RELEASE - EXPORT TRAFFIC']
GCW123 comments field is empty → The system sets the release reason to 'AUTO RELEASE - EXPORT TRAFFIC'
[Set DTM Identifier to 'DTM']
The system sets the segment identifier → The DTM identifier field is set to 'DTM' to identify this as a date/time segment
[GCW123 Date Available?]
If GCW123 date availability where GCW123-DATE is populated, HIGH-VALUES, or LOW-VALUES → The system uses GCW123-DATE as the date source, otherwise uses machine date from system
[Use GCW123 Date]
The system selects the date source for DTM segment → GCW123-DATE is used as the date source for DTM-02-DATE-TIME positions 01-08
[Use Machine Date from System]
The system selects the date source for DTM segment → Machine century and date from CCCOM are used as the date source for DTM-02-DATE-TIME positions 01-08
[GCW123 Time Available?]
If GCW123 time availability where GCW123-TIME is populated, HIGH-VALUES, or LOW-VALUES → The system uses GCW123-TIME as the time source, otherwise uses machine time from system
[Use GCW123 Time]
The system selects the time source for DTM segment → GCW123-TIME is used as the time source for DTM-02-DATE-TIME positions 09-12
[Use Machine Time from System]
The system selects the time source for DTM segment → Machine time from CCCOM is used as the time source for DTM-02-DATE-TIME positions 09-12
[Format Date as CCYYMMDD in DTM-02-DATE-TIME positions 01-08]
The system formats the date for DTM segment → The date is formatted as CCYYMMDD and placed in DTM-02-DATE-TIME positions 01-08
[Format Time as HHMM in DTM-02-DATE-TIME positions 09-12]
The system formats the time for DTM segment → The time is formatted as HHMM and placed in DTM-02-DATE-TIME positions 09-12
[Add DTM Segment to Message Array]
The system adds the segment to the message processing array → The DTM segment is stored in the MQS-TABLE-ENTRY at the current WS-MAX-MQS-ENTRIES position
[Increment Message Entry Counter]
The system updates the message entry tracking → WS-MAX-MQS-ENTRIES is incremented by 1 to reflect the new segment count
[Extract Location from GCW123 Comments Position 19-22]
The system builds conditional segments for the message array → A LOC segment is initialized with identifier 'LOC' and location is extracted from GCW123 comments positions 19-22 and added to the message array
[GCW123 Auto Release?]
The system checks if the message is an auto-release type → If auto-release flag is set, proceed to create LOC segment, otherwise skip to reject processing check
[Restore Original Cargo Segment]
The system needs to restore the cargo segment to its original state → The saved cargo segment data is moved back to the active cargo report segment
[Log US Manifest Release Information]
Preparing release information for logging → Move log information, set date from machine century and date, set time from machine time, set action code to log use input message, and set US CCN key from US cargo record
[Create Release Notification Message]
Creating the release notification message → Set cargo type to US cargo and create message text 'CDN CCN RLSED: ' concatenated with the Canadian cargo CCN key
[Spawn Cargo Information Log Transaction]
Submitting the cargo information log transaction → The system performs Z300-SPAWN-GCT1051E to create the cargo information log entry
[Action Type?]
If the GIS process indicator from the original message → If GIS process indicator shows released status, set auto-release action OR if GIS process indicator shows reject status, set reject action
[Set Auto-Release Action]
The system processes each follower manifest → Set the GCW123 message action type to auto-release for the follower manifest
[Set Reject Action]
The system processes each follower manifest → Set the GCW123 message action type to reject for the follower manifest
[Copy Release Details from Original Message]
The system prepares the follower message content → Copy the BGM document message number (first 15 characters) to GCW123 comments (positions 1-15) AND copy the location (first 4 characters) to GCW123 comments (positions 19-22) AND copy the BGM document message name (first 3 characters) to GCW123 comments (positions 26-28)
[Copy Rejection Details from Original Message]
The system prepares the follower message content → Copy the BGM document message name to GCW123 comments (positions 26-28) AND copy the BGM document message number to GCW123 comments (positions 1-15) AND copy the ERC error code value to GCW123 comments (positions 19-20)
[Set Date and Time Information]
The system sets the temporal information for the follower message → Copy the DTM date-time (positions 1-8) to GCW123 date field AND copy the DTM date-time (positions 9-12) to GCW123 time field
[Set CCN Key for Follower]
The system assigns the cargo control number to the follower message → Set the follower manifest's CCN key as the GCW123 CCN key for the message
[Create GCT1231E Transaction]
The system creates the transaction message → Set the GCW123 message ID to indicate GCW123 message type AND copy the GCW123 general information to the GCT1231E message content AND prepare the transaction for queue processing
[Send Message to Queue]
The system sends the message for processing → Change the alternate PCB status for message processing AND write the message to the processing queue using the message code, content, length, and module name AND purge the alternate PCB after successful message transmission
[More Followers?]
The system checks for remaining follower manifests to process → If additional follower manifests exist in the follower manifest array AND the array entry is not spaces or low-values, continue processing the next follower OR if no more follower manifests exist, complete the follower processing
[Is Special Action Required?]
The system checks if the message ID is GCW123 type → If message ID is GCW123, no special action is required and normal processing continues, otherwise special action processing is initiated
[Message Status Check]
If the GIS process indicator status → The system branches to either released status processing or reject status processing based on the GIS indicator value
[Prepare Follower Message Structure]
The system needs to complete the follower message preparation → The system sets 88-GCW123-MSGID-IS-GCW123 to TRUE and moves GCCC-CCN-KEY to GCW123-CCN-KEY
[Is Cargo Follower Manifest?]
The cargo is identified as a follower manifest → The query processing should be skipped and exit immediately
[Extract Train ID from Document Message Number]
The system processes the BGM segment for train information retrieval → The first 25 characters of the document message number are extracted and used as the train identifier key
[Set up Train Record Key]
The system prepares to retrieve train record data → The train identifier is assigned to the B4 key value for database access
[Call IMS Database Access]
The system needs to retrieve train information → An IMS database call is executed using GU function to get the train root segment
[Continue Processing]
The completion code is MQCC-OK and the backout count is less than or equal to 5 → The system sets good message found flag to true
[Document Message Name = 992?]
The document message name equals '992' → The system should set conversion error flag to true
[Extract Train Number from Message]
Processing the BGM segment → The system should extract the first 25 characters of the document message number as the train key value
[Retrieve Train Record by Train Number]
The system performs a train record lookup → The system should query the train database using the B4-KEY-VALUE and execute Z5000-GU-B4-TRAIN procedure
[Train Record Found?]
The status code indicates the train record was not found → The system should prepare an unknown arrival response message and set Merlin report type to unknown
[Set Action Code to ZZZ]
Preparing the arrival acknowledgment message → The system should set the action code to 'ZZZ'
[Set Message Type as CA Train]
Setting up the message parameters → The system should set GCX105-CA-TRAIN flag to true and assign the train number to GCX105-TRAIN-OR-US-CCN
[Create Arrival Acknowledgment Message]
Creating the acknowledgment message → The system should set the message to 'CCRA RNS ACK - ARRIVAL ACK AT BORDER'
[Send Arrival Acknowledgment to System]
Ready to send the acknowledgment → The system should execute Z300-SPAWN-GCT1051E procedure to dispatch the message
[Search for Related Follower Manifests]
The system searches the cargo database using CIMS call with GN function and GCCC-PCB7 → Retrieve cargo records and check if the master manifest CCN matches the reference number from the current message
[Log Arrival Message for Follower]
The system processes the cargo status update → Log the message 'CCRA RNS ACK - ARRIVAL ACK AT BORDER' and store the current CCN key for logging
[Create GCT1231E Transaction]
The system needs to spawn a follower processing transaction → Set the GCW123 message ID flag to true, move the cargo CCN key to the GCW123 structure, and move the general info to the GCT1231E message
[Execute GN Function Call with PCB7]
The system needs to retrieve the next follower manifest record from the database → A Get Next (GN) database operation must be executed using PCB7 with the cargo report segment and B0RT SSA query parameters
[Call CIMS with GN Function]
The GN function is called with CCCOM, GN operation, GCCC-PCB7 database control block, cargo report segment, and CCRT-B0RT-SSAQ query parameters → The system executes the database call to retrieve the next cargo record
[Get Next Cargo Record]
The system retrieves the next cargo record → A database call is made to get the next cargo record using the cargo PCB and segment
[Log Border Acknowledgment]
The system logs the border acknowledgment → Border acknowledgment message is logged with current CCN key and acknowledgment details
[Spawn Processing Message]
The system generates a processing completion message → A processing message is spawned to notify of border acknowledgment completion
[Retrieve Cargo by CCN Key]
The system needs to process border arrival acknowledgment → The system retrieves the cargo record using the CCN key and sets cargo status switches
[Log Border Arrival Acknowledgment Message]
Logging the border acknowledgment activity → Create a log entry with message 'CCRA RNS ACK - ARRIVAL ACK AT BORDER' and current CCN key
[Replace Cargo Record in Database]
Persisting the border acknowledgment changes → Replace the cargo record in the database with the updated information
[Is Release Status and Location Found?]
The cargo has already been released:
location information was not found in the message
→ Port validation processing is skipped and control returns to main processing flow
[Determine Manifest Transaction Code]
The CSA indicator is OFF → The manifest TO transaction code is used for comparison
[Get CM Table Port Code]
The CM table is accessed using the destination station number as the key → The corresponding port code is retrieved from the CM table segment for comparison
[Prepare Broker Mismatch Message]
The port mismatch condition remains true after all validation attempts → A Merlin notification message is prepared with broker and CPR port details
[Create Message with CM Port Code]
The CM table port lookup was successful → The message is formatted showing broker port versus CPR port from CM table
[Create Message with Manifest Port Code]
CM table lookup was unsuccessful or returned no port data → The message is formatted showing broker port versus manifest transaction code
[Log Port Mismatch Information]
The port mismatch information is ready for logging → The mismatch details are logged to the cargo information message system for audit trail
[Is Cargo CSA Enabled?]
The CSA indicator is ON for the cargo → Process CSA authorization and set delivery status, otherwise reject with non-CSA message
[Set CSA Delivery Status]
CSA authorization delivery message is processed → Set cargo status to CSA delivery
[Set Authorization Received Flag]
Processing CSA authorization delivery message → Set the CSA authorization delivery received flag to true
[Log CSA Authorization Message]
CSA authorization processing is completed → Log message 'ACCEPTED - CSA' and create cargo information log entry
[Log Non-CSA Rejection Message]
CSA authorization delivery message is received → Log message 'NOT ACCEPTED - NON-CSA' and create cargo information log entry
[Set release type to 'A', Set release by to 'AUTO', Use GCW123 date/time, Set entry type from comments]
The message type is GCW123 auto release → The release type is set to 'A', release by is set to 'AUTO', release date is set from GCW123 date, release time is set from GCW123 time, release reason is set from GCW123 comments, and entry type is set from GCW123 comments position 26-28
[Set release type to 'M', Set manual release reason, Use current user if no comments]
The message type is GCW123 manual release → The release type is set to 'M', release reason is set to 'MANUAL RELEASE' concatenated with GCW123 comments, and if GCW123 comments are empty then release reason is set to 'MANUAL RELEASE' and release by is set to current ACF2 user ID
[Set release type to 'A', Set release by to 'S.A.R.', Set AUTOPACT traffic reason]
The message type is GCW123 SAR release → The release type is set to 'A', auto release comment indicator is set to true, release reason is set from GCW123 comments or 'AUTO RELEASE - AUTOPACT TRAFFIC' if comments are empty, and release by is set to 'S.A.R.'
[Set release type to 'A', Set release by to 'EXPORT', Set export traffic reason, Set in-transit status to 'E']
The message type is GCW123 export → The release type is set to 'A', export comment indicator is set to true, release reason is set from GCW123 comments or 'AUTO RELEASE - EXPORT TRAFFIC' if comments are empty, release by is set to 'EXPORT', and in-transit status is set to 'E'
[Set release type to 'A', Use DTM segment date/time, Set release by to 'AUTO', Set CCRA acquittal reason]
The message type is other than GCW123 variants → The release type is set to 'A', release date is set from DTM segment date (positions 3-8), release time is set from DTM segment time (positions 9-12), release by is set to 'AUTO', and if the message is GCW123 then release reason is set to 'CCRA ACQUITTAL:' concatenated with GCW123 comments
[Check Message Type]
The system checks the message ID type → The system identifies if it is a GCW123 message type or requires MQ connection
[Skip MQ Connection - Use Internal Message Array]
The system processes the message routing decision → The system skips MQ connection establishment and initializes internal message array processing
[Call MQCONNC to Connect to MQ Manager]
The system initiates MQ connection → The system calls MQCONNC to establish connection to the MQ manager
[Connection Established Successfully]
The system processes the successful connection → The system continues to queue operations for message processing
[Set Queue Object Type to Queue]
The queue configuration is being set up → The queue object type should be set to standard queue type for message operations
[Set Queue Name from Configuration]
The queue name needs to be specified → The queue name should be set from the TMC queue name configuration
[Set Options for Input Operations]
Queue access options need to be defined → The options should be set to input-as-queue-defined to allow message retrieval
[Queue Ready for Message Retrieval]
The completion code indicates success → The queue should be ready for message retrieval operations
[Connect to MQ Manager]
Connection to MQ manager is attempted → System should establish successful connection or abort processing with connection failure message
[Call MQGET to Retrieve Message]
MQGET operation is executed to retrieve message → System should retrieve message data and return completion status with reason codes
[Calculate Message Entry Count]
System processes the message data length → Maximum message entries should be calculated as (data length minus header length) divided by single entry length, with maximum limit of CST-MAX-MQS-ENTRIES
[Backout Count > 5?]
System checks the message backout count → If backout count is greater than 5 then set skip message flag, otherwise set good message found flag
[No Messages Available?]
System checks the reason code for retrieval failure → If reason code equals MQRC-NO-MSG-AVAILABLE then set end of queue flag, otherwise handle as processing error and abort
[Set Message Available Flag]
All validation checks pass and backout count is acceptable → Good message found flag should be set to enable further message processing
[Set Skip Message Flag]
Backout count is greater than 5 → Skip message found flag should be set to bypass message processing
[Set End of Queue Flag]
Reason code indicates no messages available in queue → End of message queue flag should be set to terminate message processing loop
[Format Release Header Message]
The system formats the release header message → A formatted string containing 'CCRA RELEASE', equipment car ID, hold date, hold time, piece count, destination station number (positions 3-4), and document message type (positions 1-3) is created and stored in the Merlin detail line
[Insert Car Release Header Line]
The system inserts the car release information → The car release line is inserted into the Merlin report and the line counter is incremented by 2
[Add CCN List Header Message]
The system adds the CCN list header → The message 'Below is a list of CCNs for this Car:' is added to the Merlin detail line and the line counter is incremented by 1
[Clear Merlin Report Content]
The system needs to reset for the next message → All Merlin report content fields are cleared to spaces
[Increment Machine Sequence Number]
The system prepares for the next message → The machine sequence number is incremented by 1
[Set Merlin User Codes from Admin Config]
The system sets up email notification recipients → Merlin user codes are set from the administrative configuration values
[Set Default User Code 'OM01247']
The system sets up email notification recipients → The default user code 'OM01247' is assigned to the first user code position
[Extract Merlin ID from MC Segment]
The system extracts notification identifiers → The Merlin ID is extracted from the MC segment for use in system notifications
[Set MC Segment to Spaces]
The system handles the failure condition → The MC segment is set to spaces to indicate no station information is available
[Set CCN Key as Train/US CCN]
Setting up log entry structure → Move WS-CURRENT-CCN-KEY to GCX105-TRAIN-OR-US-CCN field
[Set Cargo Type Flag to CA-CARGO]
Setting up log entry structure → Set GCX105-CA-CARGO flag to true
[Set Action Code to Input Message]
Setting up log entry structure → Move LOG-USE-INPUT-MESSAGE to GCX105-ACTION-CODE field
[Move Info Message to Log Message Field]
Creating cargo log entry → Move WS-GCX105-INFO-MSG to GCX105-MESSAGE field
[Move Log Information to Structure]
Initializing log entry → Clear GCX105-INPUT, set GCX105-SECURITY-BYTE to HIGH-VALUE, set GCX105-SENDING-TRANSACTION to 'GCT1231E', and move CC-ACF2-USERID to GCX105-ACF2-ID
[Prepare GCT1051E Transaction]
Writing cargo log entry → Replace spaces with zeroes in GCX105-DATE, replace spaces with '1' in GCX105-TIME, move GCX105-INPUT to GCT1051E-MSG, call CIMS with CHNG and ALT-PCB, call WRITMSGL with message details, and call CIMS with PURG and ALT-PCB
[Use Current Machine Date/Time]
The system needs date/time for logging → The system uses CC-MACHINE-CENTURY, CC-MACHINE-DATE-X, and CC-MACHINE-TIME-X from CCCOM for the log entry
[Set Transaction Details]
The system sets transaction details → Current CCN key is set as TRAIN-OR-US-CCN, cargo type is set to CA-CARGO, action code is set to LOG-USE-INPUT-MESSAGE, and info message content is set in MESSAGE field
[Write Message to Log]
The system writes the message to the log → WRITMSGL is called with CCCOM, alternate PCB, message code, message content, message length, and module name parameters
[Purge Transaction]
The system completes the logging process → PURG operation is called on the alternate PCB to finalize the transaction
[Set Queue Read Parameters]
Queue read parameters are being set → Message ID is set to none, correlation ID is set to none, and buffer length is set to the length of the message structure
[Call MQ Get Message]
The system calls the MQ get message function → The message queue get operation is executed with connection handle, object handle, message descriptor, get message options, buffer length, message buffer, data length, completion code, and reason code
[Calculate Number of Message Entries]
The system calculates the number of message entries → The maximum message entries is computed as the data length minus header length divided by the length of one entry, rounded
[Handle No Message Available]
The completion code indicates no message is available or the reason code is 2033 → The message not available flag is set and appropriate error handling is performed
[Extract CCN from RFF Reference Field]
The system needs to identify the cargo → The first 25 characters of RFF-02-REFERENCE field must be extracted as the CCN key
[Set CCN as Key Value for CCRT and A2RT]
The system prepares database access for cargo segments → The CCN must be set as the key value for both CCRT-SSAQ and A2RT-SSAQ segment access structures
[Call CIMS with GHU Function for Cargo PCB]
The system needs to access the main cargo record → The system must call CIMS with GHU function using GCCC-PCB and GCCC-CARGO-REPORT-SEGMENT with CCRT-SSAQ key structure
[Call CIMS with GHU Function for A2 PCB]
The system needs additional cargo segment data → The system must call CIMS with GHU function using GCA2-PCB and GCSCCS52 segment with A2RT-SSAQ key structure
[Set B4 Key Value from Document Message Number]
The system needs to retrieve train information for processing → The document message number (first 25 characters) is set as the B4 key value for train record lookup
[Call Database to Get Train Record]
The system performs train record retrieval → The system calls the database using GU function to retrieve the train record from GCSB4RT segment
[Train Record Not Found]
The system processes the train record not found condition → The system generates an unknown arrival response message, sets appropriate error details, and prepares Merlin notification for the unknown train
[Train Information Retrieved Successfully]
The system processes the found train record → The system moves log information, sets date and time from machine values, prepares cargo processing messages, and spawns appropriate transaction processing
[Is GCW123 Special Action?]
The system checks if GCW123 special action flag is set to no special action → The system proceeds to evaluate the message status for release or reject processing
[Message Status?]
The GIS segment indicates a released status (GIS-01-RELEASED) → The system sets auto release action and prepares release comment formatting
[Set Auto Release Action]
The system processes the release action configuration → The system sets the GCW123 auto release flag to true
[Format Release Comments with Entry Details]
The system formats the release comments → The system creates a comment string containing the document message number (first 15 characters), forward slash, location (first 4 characters), forward slash, and document message name (first 3 characters)
[Set Message Date and Time]
The system sets the message date and time → The system moves the DTM date-time field positions 1-8 to GCW123 date field AND moves the DTM date-time field positions 9-12 to GCW123 time field
[Write Message to Queue]
The system writes the message to the queue → The system calls WRITMSGL with CCCOM, ALT-PCB, message code, message content, message length, and module name parameters
[Purge Transaction]
The system purges the transaction → The system calls CIMS with PURG function using CCCOM and ALT-PCB parameters
[Create GCT1481E Transaction Message]
The transaction is ready for submission → Create GCT1481E message structure and submit it to the system for processing

Structural Validations

[3:Load and Retrieve Messages]
Message retrieval is completed → If completion code is OK and backout count is 5 or less and message entries are greater than 0, mark as good message found, otherwise handle as skip message, not available, or error condition
[5:Process Business Message Segment]
Document message name is checked → If document message name equals '992', set conversion error flag to true
[21:Process Individual Cargo Release]
System looks up cargo using reference number → If cargo not found and reference starts with '6105', send unknown entry notification, if cargo deleted then exit processing, if cargo found then proceed with cargo processing
[22:Process Cargo Rejection Status]
Rejection is processed → Search message table for error details using ERC application error code, log error message, send Merlin notification if error code is not '01', process log lines, and handle multi-manifests if master manifest
[22:Process Cargo Rejection Status]
Conversion rejection is processed → Look up train information using document message number, if train not found send unknown arrival response notification, otherwise search message table for error details and spawn error report
[Good Message Found?]
If message retrieval results → If good message found, extract message header and continue processing, otherwise end processing with no message
[Clear Conveyance Error Flag]
The system prepares for message processing → Clear conveyance error flag by moving spaces to conveyance error flag field
[Connection Successful?]
Connection completion code != MQCC-OK → System abends with connection failed error message
[Backout Count > 5?]
Message backout count is greater than 5 → Message is flagged to be skipped from processing
[Message Available?]
Maximum message entries is less than 1 → System abends with message too short error
[Document Message Name = 992?]
The document message name is evaluated → If the document message name equals '992', this indicates an error condition requiring conveyance error processing
[Set Conveyance Error Flag]
The error condition is detected → The conveyance error flag must be set to true to trigger error processing workflows
[Log Unknown 6105 Entry Error]
The database status indicates the train was not found → The system creates an error message stating 'UNKNOWN 6105 ENTRY' followed by the train identification and 'THIS CRN WAS NOT FOUND.'
[Is Location Code Valid?]
The system needs to validate the location code in LOC-02-LOCATION field → The system checks if the first 4 characters of LOC-02-LOCATION are not spaces
[Car ID Present?]
The car ID field (EQD-02-CAR-ID) is checked for presence → Processing continues to extract car ID if present, or skips equipment processing if car ID is spaces or empty
[Reference Qualifier = 'XC'?]
The reference qualifier in RFF-01-REFERENCE-QUAL is evaluated → Processing continues only if the reference qualifier equals 'XC ', otherwise RFF conveyance processing is skipped
[Process Conveyance Rejection with ERP Data]
The conveyance rejection processing is invoked → The conveyance rejection is processed using the ERP segment data and other collected segment information
[BGM, RFF, GIS and ERC All Found?]
BGM segment is found AND ERC segment is found AND ERP segment is found AND GIS segment is found AND conversion error flag is set → The system proceeds to process the conversion rejection workflow
[Extract Application Error Code from ERC-01]
The system processes the error information → The system extracts the application error code from the first 3 characters of ERC-01-APPLICATION-ERR field
[Search Message Table for Error Code]
The system needs to retrieve the error description → The system searches the MS table using key 'BB' concatenated with the first 2 characters of the application error code
[Retrieve English Error Text from Table]
The error code is found in the message table (return flag equals '0') → The system retrieves the English error text from the table segment and makes it available for error reporting
[Set Unknown Error Message]
The error code is not found in the message table (return flag not equal to '0') → The system sets the error text to the application error code concatenated with 'UNKNOWN APPLICATION ERROR - NOT ON MESSAGE TABLE'
[Log Error Message to Cargo Information]
The system completes error message processing → The system logs the English error text as cargo information message for tracking and audit purposes
[Prepare Merlin Error Message]
The error code is not '01' → The system prepares a Merlin error notification with cargo control number, error text, and sets the message type to error for external notification
[T2 Segment Found?]
The GCCTBIO return flag is checked → If return flag equals '0', the T2 segment is available for processing, otherwise heartbeat processing is skipped
[Move Log Information to Processing Structure]
The system processes the conveyance rejection for the found train → The system moves log information to the processing structure, sets current machine date and time, and prepares the message type as 'CCRA RNS ERROR REPORT'
[ERC Segment Found?]
If the availability of ERC segment data → If ERC segment is found, the system proceeds to search the message table for error details, otherwise it uses a default unknown error message
[Search Message Table for Error Code]
The system searches the message table using the error code from ERC segment → The system constructs a table key with 'R' prefix and the first 3 characters of the application error code to retrieve the corresponding error message
[Error Code Found in Table?]
If the lookup return status → If the lookup is successful (return flag equals '0'), the system uses the English text from the message table segment, otherwise it creates a default message with the error code and 'UNKNOWN APPLICATION ERROR - NOT ON MESSAGE TABLE'
[Release A6 Manifests]
The system processes the conveyance rejection → If the CCN key does not start with '6105E', the system calls the GCCCCREL program to release the associated manifests, otherwise it continues without release processing
[Create Unknown Entry Error Message]
The system needs to create an error notification → An error message is formatted with 'UNKNOWN 6105 ENTRY' prefix followed by the train reference number
[Set Error Message: 'This CRN was not found']
The system creates an error notification message → The error description is set to 'THIS CRN WAS NOT FOUND.' to indicate the train reference is invalid
[Check Document Message Name]
Checking for document message name → Evaluate if BGM document message name field contains non-space values
[Update Broker Entry Information]
Comparing current broker entry information → If document message number positions 1-15 differ from current broker entry or positions 1-14 differ from customs transaction number, then entry information needs updating
[Update Broker Entry Information]
The document message number (first 15 characters) differs from the current broker entry:
the document message number (first 14 characters) differs from the current customs transaction number
→ The system updates the broker entry with the document message number (first 15 characters), updates the customs transaction number with the document message number (first 14 characters), sets the entry type code, updates broker date and time with machine date and time, sets broker port from location, logs broker entry information, and sets the updated entry flag to true
[Process Cargo Rejection]
The system processes the cargo rejection → The system searches the message table for error details, logs the error message, sends Merlin error notification if error code is not '01', processes log lines, and if the cargo is a master manifest then processes follower manifests
[ERC Segment Found?]
If the presence of ERC segment → If ERC segment is found, proceed with message table lookup, otherwise set unknown error condition message
[Build Message Table Key with 'BB' + Error Code]
The system needs to search the message table for error description → Construct search key by concatenating 'BB' with the first 2 characters of the application error code
[Error Code = '15'?]
The application error code equals '15' → Initiate A6 manifest release processing unless CCN key starts with '6105E'
[Log Error Message to Cargo Info]
Error message logging is required → Log the English error text as cargo information message for tracking and audit purposes
[Set Unknown Error Condition]
ERC segment is not found in the message → Set error message to 'UNKNOWN ERROR CONDITION - ERC SEGMENT NOT FOUND'
[ERC Segment Found?]
The system checks for the presence of an ERC (Error Reporting) segment → The system either proceeds with message table lookup if ERC segment exists or sets a default unknown error condition
[Build Unknown Error Message]
The system needs to provide error information to the user → The system constructs a message indicating the error code is unknown and not found in the message table
[Set Default Unknown Error]
The system needs to report an error condition → The system sets a default message indicating unknown error condition due to missing ERC segment
[Append Application Error Code]
The system builds the message table lookup key → The system creates a key by concatenating 'BB' prefix with the first 2 characters of the application error code from the ERC segment
[Set Unknown Error Message]
No ERC segment is found in the message → The system sets the error message to 'UNKNOWN ERROR CONDITION - ERC SEGMENT NOT FOUND'
[Location Port Not Empty?]
The system checks if location port field contains data → Port validation should continue only if location port is not empty spaces
[T2 Segment Found?]
The table I/O service returns a response → If the return flag equals '0', the T2 segment is found and processing continues; otherwise, heartbeat processing ends
[Entry Type: RNS Error]
The BGM document message name indicates RNS error type → The system sends a query if no query restriction exists and logs 'CCRA RNS ERROR REPORT' message
[Update Broker Entry Information]
The document message number (first 15 characters) != the current broker entry number:
the document message number (first 14 characters) != the current customs transaction number
→ The system updates the broker entry number, customs transaction number, entry type code, broker date, broker time, and broker port, and logs the broker entry message
[Process RNS Error Report Send Query if Applicable]
The BGM document message name matches RNS error criteria → The system performs error query processing if no query conditions are met and sets information message to 'CCRA RNS ERROR REPORT'
[BGM Document Message Name exists?]
The system checks for BGM document message name → The system proceeds with entry type evaluation if BGM document message name is not spaces, otherwise continues processing without entry type classification
[Does ERC Segment Exist?]
The ERC segment is not found in the message → Query processing should be skipped as there is no error condition to query about
[Error Code Found in Query Array?]
The error code from ERC segment is searched against the predefined query error code array → Query processing should only continue if the error code matches one of the predefined query-eligible error codes
[Search Message Table with Error Code]
The system searches the message table using table ID 'MS' and error code prefixed with 'BB' → The system retrieves the English error text from the message table or creates an unknown error message if not found
[Create Unknown Error Message]
The table lookup returns a non-zero return flag → The system creates an error message stating the error code is unknown and not on the message table
[Prepare Merlin Error Message]
The system processes the cargo rejection → The system prepares a Merlin message with cargo control number, error description, and sets error message type
[ERC Segment Found?]
The system checks for the presence of an ERC segment → If ERC segment is found, process the application error code; otherwise, create unknown error condition message
[Error Code ≠ '01'?]
The error code value is evaluated → If the error code is not '01', prepare Merlin error notification; otherwise, skip Merlin notification
[ERC Segment Found?]
The system checks for the presence of an ERC (Error Code) segment → The system should proceed with message table lookup if ERC segment exists, otherwise set a default unknown error condition
[Error Code = '15'?]
The system checks if the error code equals '15' → If the error code is '15', the system should trigger the release of A6 manifests process
[Set Default Unknown Error, Set Default Unknown Error Text]
The system needs to provide error information → The system should set the error message to 'UNKNOWN ERROR CONDITION - ERC SEGMENT NOT FOUND'
[Is Cargo CSA Enabled?]
The system checks the cargo CSA indicator → The system determines if the cargo is CSA-enabled or non-CSA cargo
[Compare Broker Location with CM Port Code]
Comparing broker location with CM table port code → If CM table port equals IIS-A6 port variable, ports match, otherwise ports do not match
[Compare Broker Port vs CPR Port]
The system performs port validation → The broker port code from the location segment should be compared against the CPR port code from the CM table
[Port Codes Match?]
The system compares the first 4 characters of the broker port with the manifest transaction code → Set port mismatch flag if the codes do not match
[Use Default Release Message]
The system processes the message → The system sets BGM document message name to 'GCT1231E' as default identifier
[Set Release Date/Time from Message]
The system processes the date/time fields and GCW123 date is spaces, high-values, or low-values → The system uses machine century and machine date for DTM date/time positions 1-8, and when GCW123 time is spaces, high-values, or low-values, uses machine time for DTM date/time positions 9-12
[Message ID is GCW123 AND Manual Release?]
The system checks the message type and release indicator → Processing continues to manual release logic only if message ID is GCW123 AND manual release flag is set, otherwise manual release processing is skipped
[Comments Field Empty?]
The GCW123 comments field is checked for content → If comments field is spaces, high-values, or low-values, use default export message; otherwise use comments content
[Log Non-CSA Message]
Non-CSA rejection processing is complete → Log message 'NOT ACCEPTED - NON-CSA' for cargo information tracking
[ERC Segment Found?]
The system checks for error segment availability → The system should identify whether ERC segment data is present for error message lookup
[Message Found in Table?]
The system checks the lookup result → The system should determine if the message was found (return flag = '0') or not found (return flag ≠ '0')
[Build Unknown Error Message]
The system needs to provide error information → The system should construct a message containing the error code followed by 'UNKNOWN APPLICATION ERROR - NOT ON MESSAGE TABLE'
[Check for Error Code '15']
The error code is '15' → The system should trigger A6 manifest release processing in addition to standard error message handling
[Search Message Table for Error Code]
The system processes the error code by searching the message table using table ID 'MS' and constructing a key with 'BB' prefix plus the first 2 characters of the application error code → The system retrieves the corresponding message table segment for error text translation
[Error Code Found in Message Table?]
The table search return flag indicates success (value '0') or failure (not '0') → The system either uses the retrieved English text from the message table or generates an unknown error message with the original error code
[Create Unknown Error Message]
The system needs to create an error message for the unknown code → The system generates a message containing the first 2 characters of the application error code followed by the text 'UNKNOWN APPLICATION ERROR - NOT ON MESSAGE TABLE'
[Set Error Message Text]
The system prepares the error message for logging to cargo information → The system sets the error message text in the cargo information message field for subsequent logging operations
[Log Error Message to Cargo Information]
The system performs the cargo information logging operation → The system records the error message to the cargo information log with appropriate timestamp and cargo context information
[Move Error Text to Detail Line 3]
A Merlin error message is being formatted → The English error message text should be placed in the third detail line of the Merlin report
[Set Merlin Type as ERROR]
The message type needs to be specified → The Merlin message type flag should be set to indicate ERROR type
[Broker Port Matches CPR Port?]
Port validation is performed → If broker port matches CPR port, validation passes; otherwise a port mismatch is identified
[Is ERC Segment Found?]
No ERC segment is found in the message → The query processing should be skipped and no query message should be sent
[Error Code Matches Query Criteria?]
The error code value is searched against the query error code table → If the error code matches any entry in the query criteria table, proceed with query processing, otherwise skip query generation
[Format Error Message Subject]
The notification type is determined to be an error message → The email subject is formatted as 'CUSTOMS RECEIVED ERR MSG ' followed by the cargo reference number from RFF-02-REFERENCE positions 1-25
[Send to CAERROR and IN Destinations]
The message type flag 88-Z110-MRLN-TYPE-IS-ERROR is true → The message is sent first to 'CAERROR' destination, then to 'IN' destination with recipient cleared and primary recipient set to 'OM01247'
[Set Error Message Subject]
The system processes the message type classification → The subject line is set to 'CUSTOMS RECEIVED ERR MSG' followed by the first 25 characters of the reference number
[Route to CAERROR and IN Destinations]
The system routes the notification → The message is sent first to 'CAERROR' destination, then to 'IN' destination with user code cleared and primary user set to 'OM01247'
[Set Destination: CAERROR, Send to Error Recipients]
The message type is classified as ERROR → Send to 'CAERROR' destination first, then send to 'IN' destination with user code 'OM01247'
[Use Default GCT1231E Message Name]
The GCW123 comments are spaces, high-values, or low-values → The system sets the BGM document message name to 'GCT1231E'
[Extract Message Details from Comments]
The message is auto release or reject type → The system extracts message name from positions 26-28 of comments and document number from positions 1-15 of comments, otherwise uses entire comments as message name
[Use Machine Date]
The GCW123 date is spaces, high-values, or low-values → The system uses machine century and machine date for positions 1-8 of DTM date time
[Use GCW123 Date]
The GCW123 date contains valid date information → The system uses GCW123 date for positions 1-8 of DTM date time
[Use Machine Time]
The GCW123 time is spaces, high-values, or low-values → The system uses machine time for positions 9-12 of DTM date time
[Use GCW123 Time]
The GCW123 time contains valid time information → The system uses GCW123 time for positions 9-12 of DTM date time
[Set Reject Indicator]
The message type is reject → The GIS process indicator is set to '2 '
[Set Release Indicator]
The message type is not reject → The GIS process indicator is set to '4 '
[Extract Error Code from Comments]
The error code is extracted → The system uses positions 19-20 of GCW123 comments as the ERC code value
[Use Default GCT1231E Name]
The BGM segment document message name is being set → The document message name is set to 'GCT1231E'
[Use Machine Date]
DTM segment date is being set → Machine century and date are used for positions 1-8 of DTM date-time field
[Use GCW123 Date]
DTM segment date is being set → GCW123 date is used for positions 1-8 of DTM date-time field
[Use Machine Time]
DTM segment time is being set → Machine time is used for positions 9-12 of DTM date-time field
[Use GCW123 Time]
DTM segment time is being set → GCW123 time is used for positions 9-12 of DTM date-time field
[Extract Entry Type from Comments Position 26-28]
The message type is auto-release or reject → The document message name is extracted from positions 26-28 of the comments field
[Extract Entry Number from Comments Position 1-15]
The message type is auto-release or reject → The document message number is extracted from positions 1-15 of the comments field
[Use Comments as Document Message Name]
The message type is neither auto-release nor reject → The entire comments field is used as the document message name
[Extract Entry Type from Comments Position 26-28]
The message type is auto-release or reject → The entry type is extracted from positions 26-28 of the GCW123 comments and assigned to BGM document message name
[Extract Entry Number from Comments Position 1-15]
The message type is auto-release or reject → The entry number is extracted from positions 1-15 of the GCW123 comments and assigned to BGM document message number
[Extract Entry Information for Auto Release]
The message type is not auto-release and not reject → The complete GCW123 comments field is assigned to BGM document message name
[Extract Entry Type from Position 26-28]
The action type is auto release or reject → The system extracts characters from position 26-28 of GCW123 comments and sets it as the BGM document message name
[Use GCW123 Comments as Message Name]
The action type is neither auto release nor reject → The system sets the entire GCW123 comments field as the BGM document message name
[Extract Error Code from GCW123 Comments Position 19-20]
The system builds conditional segments for reject processing → An ERP segment is initialized with identifier 'ERP', an ERC segment is initialized with identifier 'ERC', error code is extracted from GCW123 comments positions 19-20 and both segments are added to the message array
[GCW123 Reject Processing?]
The system checks if the message is a reject type → If reject flag is set, proceed to create ERP and ERC segments, otherwise continue with message processing
[Check if Released Status]
The system checks if GIS-01-RELEASED condition is true → If released status is confirmed, the system proceeds to initialize auto-release action, otherwise continues to check for reject status
[Check if Reject Status]
The system checks if GIS-01-REJECT condition is true → If reject status is confirmed, the system proceeds to initialize reject action, otherwise continues with standard processing
[Extract Document Message Name]
The system needs to capture document message name for reject processing → The system moves BGM-04-DOC-MSG-NAME to GCW123-COMMENTS starting at position 26 for 3 characters
[Extract Document Message Number]
The system needs to capture document message number for reject processing → The system moves BGM-05-DOC-MSG-NO to GCW123-COMMENTS starting at position 1 for 15 characters
[Extract Error Code Value]
The system needs to capture error code for reject processing → The system moves ERC-01-CODE-VALUE to GCW123-COMMENTS starting at position 19 for 2 characters
[Is ERC Segment Found?]
The ERC segment is not found in the message → The query processing should be skipped and exit
[Search Query Error Code Table]
The error code is searched against the query error code table → If the error code matches any entry in the query criteria table, mark it as a query error requiring processing
[MQ Connection Error]
The connection completion code is not MQCC-OK → The system formats the error message, sets error status, and performs abnormal termination
[Backout Count > 5?]
The message backout count is greater than 5 → The system sets skip message found flag to true
[Message Too Short]
The maximum MQS entries count is less than 1 → The system sets error message 'GCT1231E: USER ABEND 123 MESSAGE TOO SHORT' and performs abnormal termination
[MQ Get Error]
The completion code is MQCC-FAILED and reason code is MQRC-NO-MSG-AVAILABLE → The system calls GCCMQERR error handler, formats error message with 'OPEN FAILED' text, and performs abnormal termination
[MQ Close Error]
The close completion code is not MQCC-OK → The system calls GCCMQERR error handler, formats error message with 'CLOSE FAILED' text, and performs abnormal termination
[MQ Close Error]
The disconnect completion code is not MQCC-OK → The system calls GCCMQERR error handler, formats error message with 'DISC FAILED' text, and performs abnormal termination
[Date Invalid]
The date conversion parameter indicates an error condition → The system sets error message 'MODULE ISCDATCV SAID CCCOM CONTAIN INVALID DATE' and performs abnormal termination
[Log Unknown Entry Error]
Processing an arrival acknowledgment → The system should create a message stating 'UNKNOWN ARRIVAL RESPONSE' with the train number and indicate 'THIS CRN WAS NOT FOUND' with line count set to 4
[Check CSA Indicator Status]
The system checks the cargo CSA indicator status → The CSA indicator status is determined from the cargo record
[System Error - Invalid Date]
Invalid date error is detected → Error message 'MODULE ISCDATCV SAID CCCOM CONTAIN INVALID DATE' is set and system abend is performed
[Generate Error Message with Reason Code]
The system processes the connection failure → The system generates error message with reason code and calls GCCMQERR for error text formatting
[Set Error Status: CONN FAILED]
The system sets error status information → The system sets transaction set to 'CUS', program error text to 'CONN FAILED', and updates error message
[Generate Error Message]
Error handling is processing the failure → A detailed error message should be generated using the reason code and error text should be formatted with transaction set and program error details
[Terminate Processing with Error]
The error is critical and prevents further processing → The system should terminate processing with the generated error message
[Message Retrieved Successfully?]
System checks the completion code from message retrieval → If completion code equals MQCC-OK then message is successfully retrieved, otherwise handle as retrieval failure
[Validate Message Length]
System validates message length adequacy → If maximum message entries is less than 1 then abort processing with 'MESSAGE TOO SHORT' error, otherwise proceed with message processing
[Handle MQ Error]
System encounters connection, open, or retrieval errors → System should call error message formatter, set appropriate error text, and prepare for processing termination
[Date/Time Valid?]
The DTM-02-DATE-TIME field (positions 1-8) is not numeric → Use current machine date and time from system instead of DTM values
[Create GCT1051E Transaction]
The system checks if GCX105-MESSAGE contains content → If GCX105-MESSAGE is spaces or low-values, the system exits without creating the log entry
[Message Retrieved Successfully?]
The completion code != MQCC-OK → The message retrieval is considered unsuccessful and error handling is triggered
[Message Length Valid?]
The maximum message entries is less than 1 → The message is considered too short and an error condition is triggered
[Set Maximum Entries Limit]
The maximum message entries exceeds the constant maximum limit → The maximum message entries is set to the constant maximum limit value
[Handle Message Too Short Error]
The message length validation fails → An error message 'USER ABEND 123 MESSAGE TOO SHORT' is set and the system abends
[Clear Additional Segment Data]
The system status code equals 'GE' → The GCSCCS52 additional segment data must be cleared to spaces
[Message Status?]
The GIS segment indicates a reject status (GIS-01-REJECT) → The system sets reject action and prepares reject comment formatting with error codes
[Set Reject Action]
The system processes the reject action configuration → The system sets the GCW123 reject flag to true
[Format Reject Comments with Error Code]
The system formats the reject comments → The system places the document message name in comment positions 26-28, the document message number in comment positions 1-15, and the error code value in comment positions 19-20
[Error Code Matches Query Criteria?]
The error code is searched against the query error code table → Query processing should continue only if the error code matches the predefined query criteria, otherwise exit

Module: GCX103 1 Consolidated Epic Story

Epic: GCX103 Complete EDI Specification Extracted from Legacy

Contains 256 distinct extracted legacy rules

EDI Epic Specification

As an EDI Gateway Service,
I want to orchestrate and execute all GCX103 EDI data mapping and validation logic,
So that I can ensure strict compliance with US Customs (P140) automated payload constraints in a single consolidated service.

Prerequisites & Setup

None explicitly identified in logic extraction.

Core Acceptance Criteria

[1:User Security Validation]
The system checks the user's crossing table access permissions → If the user has no access or invalid permissions, deny access and redirect to menu screen, otherwise allow access to crossing table functions
[2:Screen Field Initialization]
The system initializes screen fields → Clear all edit error flags from shipper CHOP, consignee, origin station, destination station, origin SPLC, destination SPLC, and STCC fields by setting them to spaces
[8:Function Code Validation]
The user's crossing table access level is checked → If the user is not an UPDATE-USER or SUPER-USER, deny the operation and display update violation message, otherwise allow the function to proceed
[20:Add Record Processing]
The system checks if a record with the same key already exists → If a record already exists, display invalid add error message and highlight key fields and function; if no record exists, proceed to the update screen for data entry
[21:Modify Record Processing]
The system checks if the record exists in the database → If the record exists, populate the update screen with current data and set function description to modify; if the record does not exist, display invalid change error message and highlight key fields and function
[22:Delete Record Processing]
The system checks if the record exists in the database → If the record exists, populate the update screen with current data, set function description to delete, display confirmation delete message, and protect all update fields; if the record does not exist, display invalid delete error message and highlight key fields and function
[31:Manifest Table Validation]
The manifest codes are checked against the manifest reference table → If the manifest code is not found in the manifest reference table, mark update as invalid, highlight the respective field, and display not on table error message; otherwise accept the manifest code
[32:Broker Table Validation]
The broker names are checked against the broker reference table → First attempt validation with specific port code from destination SPLC; if not found, attempt validation with port code '000'; if still not found, mark update as invalid, highlight the broker name field, and display not on table error message; otherwise accept the broker name
[33:Second Notify Party Validation]
The second notify codes are checked against the SS reference table → If the second notify code is not found in the SS reference table, mark update as invalid, highlight the respective second notify field, and display second notify not authorized error message; otherwise accept the second notify code
[35:Bond Owner Validation]
The bond owner code is checked against the CC reference table → If the bond owner code is not found in the CC reference table or the found record has no IRS number, mark update as invalid, highlight the bond owner field, and display bond owner not authorized error message; otherwise accept the bond owner code
[36:Schedule-D Table Validation]
The bonded TO codes are checked against the Schedule D reference table → If the bonded TO code is not found in the Schedule D reference table, attempt validation against the manifest reference table; if not found in either table, mark update as invalid, highlight the US bonded TO field, and display not on table error message; otherwise accept the bonded TO code
[37:US Border Station Validation]
The border station codes are checked against the manifest reference table → If the border station code is not found in the manifest reference table, mark update as invalid, highlight the US border station field, and display not on table error message; otherwise accept the border station code
[55:Database Record Insertion]
The system attempts to insert the record into the database → If the database insertion is successful, display confirm add message; if the insertion fails, mark update as invalid and display database update error message
[53:Database Record Update]
The system attempts to update the record in the database → If the database update is successful, display confirm change message; if the update fails, mark update as invalid and display database update error message
[54:Database Record Deletion]
The system attempts to delete the record from the database → If the database deletion is successful, display confirm delete message; if the deletion fails, mark update as invalid and display database update error message
[52:Database Record Retrieval]
A database retrieval operation is performed using the crossing table key → If the record is found, populate the display fields with the retrieved data; if no record is found, display appropriate last page or no data message
[56:Next Record Navigation]
The system attempts to retrieve the next sequential record → If more records exist, display the next record; if no more records exist, display last page message and maintain current display
[User = UPDATE-USER or SUPER-USER?]
The system checks if user has UPDATE-USER or SUPER-USER authorization level → Update access is granted only if user equals UPDATE-USER or SUPER-USER, otherwise access violation message is displayed
[Clear Screen Fields and Message Areas]
The display initialization process begins → All screen control fields, key fields, data fields, and message areas are cleared to spaces
[Convert Screen Key Fields to Database Format]
Converting keys for database query → Screen key fields are mapped to corresponding database segment fields and crossing key index is set
[Retrieve First Crossing Table Record]
Executing get unique operation on crossing table → First matching crossing table record is retrieved or no record found status is returned
[Display 'Last Page' Message]
No matching records exist for the search criteria → Last page message is set if no numeric message already exists
[Clear Key Fields for Page Backward]
Page backward navigation is requested → All key fields and crossing table segment data are cleared to spaces
[Clear Screen Control Fields]
Screen needs to be prepared for data display → Control fields, data fields, and message filler are cleared to spaces
[Screen Data Conversion to Database Format]
Database operation needs to be performed → Screen key fields are mapped to database segment including shipper CHOP, consignee, origin/destination stations and SPLC codes, STCC, with spaces for filler and data areas
[Last Record Has Data?]
All key fields (ship chop, consignee, origin station, destination station, origin SPLC, destination SPLC, STCC) in the last record position are empty → Clear all control fields, key fields, message filler, and function code, and set last page message if no numeric message exists
[Last Position Empty?]
System checks the last data line position for emptiness → If all key fields (ship chop, consignee, origin station, destination station, origin SPLC, destination SPLC, STCC) in last position are empty, set last page message if no numeric message exists
[Clear Control Fields]
The system clears the display areas → Control fields, data fields, and message filler areas are set to spaces
[Reset Database Segment]
The system prepares for database access → The crossing table database segment is cleared to spaces
[User Has Update Authority? UPDATE-USER or SUPER-USER]
The user's crossing table access level is not UPDATE-USER and not SUPER-USER → The system sets an update violation error message and highlights the function code field
[Set Authorization Violation Message]
No previous error message has been set for the current transaction → The system assigns the update violation error message to the user message number
[Set Key Combination Invalid]
Any validation rule fails → The key combination invalid flag is set to true and an error message is prepared for display
[Convert Screen Data to Database Format]
The system prepares data for database insertion → Convert key fields to database segment format and convert data fields to database segment format using the MFS-KEY-TO-DB-SEG and MFS-DATA-TO-DB-SEG procedures
[Set Confirmation Message]
The system processes the successful insertion → Set CONFIRM-ADD message to inform user of successful record addition
[Return to Display Screen]
The system completes the add process → Process display request and send display screen to user
[Return to Update Screen]
The system handles the error condition → Send update screen to user with error messages and field highlighting
[Set Confirmation Message]
The database update operation returns successful status → The system sets confirmation change message for user display
[Delete Confirmation Required?]
The delete function is invoked for the first time → The system displays a confirmation message and sets update status to invalid until confirmation is received
[Execute Database Delete]
The system executes the delete operation → The system performs a database delete operation on the crossing table segment
[Delete Successful?]
The delete operation completes successfully with no error status → The system sets a confirmation delete message and returns to display screen
[Validate Manifest Table]
The manifest TO code is looked up in the manifest table → If the code is not found in the table, set validation error, highlight the field, and display 'not on table' error message
[Try Broker with Default Port 000]
The broker name is looked up in the broker table with Canadian flag and default port '000' → If the broker is not found with default port, set validation error, highlight the field, and display 'not on table' error message
[Lookup in Manifest Table]
The system performs a lookup in the Manifest reference table using the US Bonded Station code → If the lookup is successful, validation passes; if unsuccessful, the system marks update as invalid and displays not-on-table error message
[Try Lookup in Manifest Table as Fallback]
The US bonded station code is looked up in the manifest reference table as fallback → If found, validation passes; if not found, set validation error flag, highlight the field, and display 'not on table' error message
[Setup Manifest Table Lookup]
The system performs a manifest table lookup using the CDN-MANI-TO value → If the manifest record is not found in the reference table, the system should set validation error flag, highlight the CDN-MANI-TO field, and display 'not on table' error message
[Setup Manifest Table Lookup for FROM]
The system performs a manifest table lookup using the CDN-MANI-FROM value → If the manifest record is not found in the reference table, the system should set validation error flag, highlight the CDN-MANI-FROM field, and display 'not on table' error message
[Party 1 found in SS table?]
The system looks up party 1 in the SS reference table → If party 1 is not found in the SS table, set validation error with unauthorized second notify message
[Party 2 found in SS table?]
The system looks up party 2 in the SS reference table → If party 2 is not found in the SS table, set validation error with unauthorized second notify message
[Owner Found in CC Table?]
The bond owner code is not found in CC reference table:
the owner is found but has no IRS number
→ The record is marked as invalid with bond owner not authorized error message and field is highlighted
[Call GCCTBIO Utility]
The system executes the reference table lookup → GCCTBIO utility is called with communication area, PCB flag, SSA flag, function code, table literal, key value, data key value, table segment, and return flag
[Database Data Conversion to Screen Format]
The system needs to display the record data on the update screen → All database fields are mapped to their corresponding screen fields including broker name, broker name 2, Canadian manifest from/to, US border station, US bonded to, line release code, bond type code, bond owner, 2nd notify parties, override flag, and PACT arrival flag, and message filler is cleared
[Set Function Description]
The system processes the function selection → The function description field is set to DEL description and a delete confirmation message is displayed to the user
[Clear Screen Data Fields]
The add function is selected → All update screen data fields and message filler are cleared to provide blank entry fields for the new record
[Clear Control and Message Fields]
The system prepares to refresh the display → All control fields, key fields, and message filler areas are cleared to spaces
[Clear Message Fields]
The system maps database fields to update screen fields → The message filler field is cleared to spaces for clean screen display
[Screen Data Conversion to Database Format]
The system needs to prepare data for database operations → All screen key fields are mapped to corresponding database segment fields, key filler and data areas are cleared, and crossing key index is set for database access
[Set Last Page Message]
The database operation indicates no record was found or end of data reached → An appropriate last page or not found message is set for user notification
[Get Unique Record for Display]
The system needs to prepare the screen for user interaction → Control fields, key fields, message filler, and function fields are cleared to reset the screen state
[Convert Screen Key Fields to Database Format]
The system prepares to update the database record → The screen key fields (shipper CHOP, consignee CHOP, origin station, destination station, origin SPLC, destination SPLC, STCC) are converted to database segment format and the crossing key index is set
[Convert Screen Data Fields to Database Format]
The system prepares the data fields for database update → All screen data fields (broker names, manifest information, border stations, bond details, notify information, flags) are converted to database segment format
[Set Confirmation Message - Record Updated]
The database replace operation completes successfully with no errors → The system sets a confirmation message indicating the record was successfully updated
[Delete Key Pressed?]
The delete function is invoked without the delete confirmation key being pressed → The system should display a confirmation message and mark the update as invalid without performing the deletion
[Retrieve Record for Deletion]
The system attempts to retrieve the crossing table record for deletion → The system should convert the screen key fields to database segment format and Execute a get-hold-unique operation to lock the record
[Display Deletion Confirmed]
The database operation returns a successful status → The system should display a deletion confirmation message to the user
[Execute Database Insert Operation]
The system executes the database insert operation → The system calls the database interface with insert function code, crossing table PCB, crossing table segment, and unqualified SSA to insert the record into the database
[Set Confirmation Message - Record Added]
The database insert operation returns a successful status with no error codes → The system sets the user message to confirm record addition

Structural Validations

[8:Function Code Validation]
The function code is validated against allowed values → If the function code is not ADD, MOD, DEL, or EXPAND, display bad function code error message and highlight the function field, otherwise proceed with the requested operation
[9:Key Field Validation]
The field is validated for mandatory data requirements → If the shipper CHOP is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE, display blank/zero error message and highlight the field as invalid, otherwise accept the value
[9:Key Field Validation]
The field is validated for mandatory data requirements → If the consignee is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE, display blank/zero error message and highlight the field as invalid, otherwise accept the value
[23-30:Record Data Validation]
The broker name field is validated for mandatory data → If broker name is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE, mark update as invalid, highlight the broker name field, set edit error flag if applicable, and display blank/zero error message; otherwise accept the broker name value
[23-30:Record Data Validation]
The Canadian manifest TO field is validated for mandatory data → If Canadian manifest TO is ZERO, LOW-VALUE, or HIGH-VALUE, mark update as invalid, highlight the field, set edit error flag if applicable, and display blank/zero error message; if it's SPACES, accept the value; otherwise validate against manifest and broker reference tables
[23-30:Record Data Validation]
The broker name 2 field is validated for business rules → If broker name 2 is not SPACES, mark update as invalid, highlight the broker name 2 field, and display broker 2 should be blank error message; otherwise accept the blank value
[23-30:Record Data Validation]
The override flag field is validated for allowed values → If override flag is SPACES, 'Y', or 'N', accept the value; otherwise mark update as invalid, highlight the override flag field, and display invalid override flag error message
[23-30:Record Data Validation]
The broker name field is validated for business rules → If broker name is not SPACES, mark update as invalid, highlight the broker name field, and display broker should be blank error message; otherwise accept the blank value
[23-30:Record Data Validation]
The Canadian manifest TO field is validated for business rules → If Canadian manifest TO is not SPACES, mark update as invalid, highlight the Canadian manifest TO field, and display manifest TO should be blank error message; otherwise accept the blank value
[23-30:Record Data Validation]
The broker name 2 field is validated for mandatory data → If broker name 2 is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE, mark update as invalid, highlight the broker name 2 field, set edit error flag if applicable, and display blank/zero error message; otherwise validate the broker name 2 against broker reference table
[23-30:Record Data Validation]
The broker name field is validated for mandatory data → If broker name is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE, mark update as invalid, highlight the broker name field, set edit error flag if applicable, and display blank/zero error message; otherwise validate the broker name against broker reference table
[23-30:Record Data Validation]
Broker-related fields are validated for business rules → If broker name, Canadian manifest TO, or broker name 2 are not SPACES, mark update as invalid, highlight the respective fields, and display appropriate 'should be blank' error messages; otherwise accept the blank values
[23-30:Record Data Validation]
Border-related fields are validated for business rules → If Canadian manifest FROM, US border station, US bonded TO, US line release code, bond type code, or bond owner are not SPACES, mark update as invalid, highlight the respective fields, and display appropriate 'should be blank' error messages; otherwise accept the blank values
[23-30:Record Data Validation]
The second notify fields are validated for mandatory data → If both second notify 1 and second notify 2 are SPACES, mark update as invalid, highlight the second notify 1 field, set edit error flag, and display notify 1 or 2 mandatory error message; otherwise validate the notify fields according to second notify business rules
[23-30:Record Data Validation]
All data fields except PACT arrival flag are validated for business rules → If any field other than PACT arrival flag is not SPACES, mark update as invalid, highlight the respective field, and display appropriate 'should be blank' error message; PACT arrival flag must be SPACES, 'Y', or 'N'; otherwise accept the values
[23-30:Record Data Validation]
The Canadian manifest TO field is validated → If Canadian manifest TO is ZERO, HIGH-VALUE, or LOW-VALUE, mark update as invalid, highlight the field, set edit error flag if applicable, and display blank/zero error message; if it's SPACES, accept the value; if it has a value, validate against manifest reference table
[23-30:Record Data Validation]
The Canadian manifest FROM field is validated for mandatory data → If Canadian manifest FROM is SPACE, ZERO, HIGH-VALUE, or LOW-VALUE, mark update as invalid, highlight the field, set edit error flag if applicable, and display blank/zero error message; otherwise validate against manifest reference table
[23-30:Record Data Validation]
The US border station field is validated → If US border station is ZERO, HIGH-VALUE, or LOW-VALUE, mark update as invalid, highlight the field, set edit error flag if applicable, and display blank/zero error message; if it's SPACES, accept the value; if it has a value, validate against manifest reference table
[23-30:Record Data Validation]
The US bonded TO field is validated → If US bonded TO is ZERO, HIGH-VALUE, or LOW-VALUE, mark update as invalid, highlight the field, set edit error flag if applicable, and display blank/zero error message; if it's SPACES, accept the value; if it has a value, validate against Schedule D reference table first, then manifest reference table if not found
[23-30:Record Data Validation]
The bond type code is validated against allowed values → If bond type code is SPACE, 'IT', 'TE', '00', '17', '15', 'IE', 'TR', or '12', accept the value; otherwise mark update as invalid, highlight the bond type code field, and display bond type values error message
[23-30:Record Data Validation]
The relationship between bond type and bonded station is validated → If bond type is SPACE, '00', '15', '12', or '17' and US bonded TO is SPACE, accept the combination; if bond type is not SPACE and US bonded TO is not SPACE, accept the combination; otherwise mark update as invalid, highlight both fields, and display bond and bonded station error message
[23-30:Record Data Validation]
The line release code is validated against bond type restrictions → If bond type is SPACE, '00', or '12', line release code must be SPACE; if bond type is other values and line release code is not SPACE, mark update as invalid, set edit error flag, highlight the line release code field, and display line release should be blank error message
[23-30:Record Data Validation]
The US border station and Canadian manifest FROM are compared → If US border station does not equal Canadian manifest FROM, mark update as invalid, set edit error flag, highlight the US border station field, and display border manifest error message; otherwise accept the values
[23-30:Record Data Validation]
The bond owner field is validated → If bond owner has spaces in positions 1 or 2, mark update as invalid, highlight the bond owner field, and display bond owner has spaces error message; otherwise validate bond owner against CC reference table ensuring it has an IRS number
[23-30:Record Data Validation]
The second notify field format is validated → If second notify 1 or second notify 2 has spaces in any of the 4 character positions, mark update as invalid, highlight the respective field, and display notify has spaces error message; otherwise validate against SS reference table
[23-30:Record Data Validation]
The second notify fields are compared for duplicates → If second notify 1 equals second notify 2, mark update as invalid, highlight both fields, and display duplicate second notify error message; otherwise accept the values
[User = INVALID-USER or SPACE?]
The user's crossing table access level equals INVALID-USER or SPACE → The system sets NO-ACCESS-TO-CROSSING-TABLE message and redirects to GC-MENU-SCREEN
[Clear Ship Chop Field to Space]
The ship chop field contains the edit error flag value → The ship chop field should be cleared to space
[Clear Consignee Field to Space]
The consignee field contains the edit error flag value → The consignee field should be cleared to space
[Clear Origin Station Field to Space]
The origin station field contains the edit error flag value → The origin station field should be cleared to space
[Clear Destination Station Field to Space]
The destination station field contains the edit error flag value → The destination station field should be cleared to space
[Clear Origin SPLC Field to Space]
The origin SPLC field contains the edit error flag value → The origin SPLC field should be cleared to space
[Clear Destination SPLC Field to Space]
The destination SPLC field contains the edit error flag value → The destination SPLC field should be cleared to space
[Clear STCC Field to Space]
The STCC field contains the edit error flag value → The STCC field should be cleared to space
[Clear Update Screen Error Fields]
The message type is crossing table update mode → All update screen fields containing edit error flags should be cleared to space
[Set First Page Message]
User message number is not numeric (no existing message) and page backward was requested → System sets first page message to inform user they are at the beginning of the data
[Set First Page Message]
The system determines the user is at the first page → The user message number is set to the first page message constant
[Function Code Valid? ADD, MOD, DEL, EXPAND]
The function code is not one of ADD-FUNCTION, MOD-FUNCTION, DEL-FUNCTION, or EXPAND-FUNCTION → The system sets an invalid function code error message and highlights the function code field
[Set Invalid Function Error Message]
No previous error message has been set for the current transaction → The system assigns the bad function code error message to the user message number
[Ship Chop Field Check]
The shipper CHOP field is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE → Set error flag on shipper CHOP field, highlight the field, and display blank/zero error message
[Consignee Field Check]
The consignee field is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE → Set error flag on consignee field, highlight the field, and display blank/zero error message
[Validate Numeric Station Code]
The origin station field is ZERO, SPACE, LOW-VALUE, HIGH-VALUE, or non-numeric → Set error flag on origin station field, highlight the field, and display invalid numeric error message
[Validate Numeric Station Code]
The destination station field is ZERO, SPACE, LOW-VALUE, HIGH-VALUE, or non-numeric → Set error flag on destination station field, highlight the field, and display invalid numeric error message
[Validate Numeric SPLC Code]
The origin SPLC field is ZERO, SPACE, LOW-VALUE, HIGH-VALUE, or non-numeric → Set error flag on origin SPLC field, highlight the field, and display invalid numeric error message
[Validate Numeric SPLC Code]
The destination SPLC field is ZERO, SPACE, LOW-VALUE, HIGH-VALUE, or non-numeric → Set error flag on destination SPLC field, highlight the field, and display invalid numeric error message
[Validate Numeric STCC Code]
The STCC field is ZERO, SPACE, LOW-VALUE, HIGH-VALUE, or non-numeric → Set error flag on STCC field, highlight the field, and display invalid numeric error message
[Origin Station Value Check]
The origin station value equals zero → The system sets invalid numeric error message and highlights the origin station field
[Origin Station Value Check]
The origin station value equals space or low-value or high-value → The system sets edit error flag in origin station field, sets invalid numeric error message, and highlights the origin station field
[Set Invalid Numeric Error]
The conversion fails (JSTNUM-RETURN-FLAG not equal to GOOD) → The system sets invalid numeric error message and highlights the origin station field
[Destination Station Value Check]
The destination station value equals zero → The system sets invalid numeric error message and highlights the destination station field
[Destination Station Value Check]
The destination station value equals space or low-value or high-value → The system sets edit error flag in destination station field, sets invalid numeric error message, and highlights the destination station field
[Set Invalid Numeric Error]
The conversion fails (JSTNUM-RETURN-FLAG not equal to GOOD) → The system sets invalid numeric error message and highlights the destination station field
[Zero SPLC invalid - highlight field]
The SPLC code equals zero → Mark the field as invalid, highlight it, and display an invalid numeric error message
[Blank SPLC invalid - highlight field]
The SPLC code is blank, low-value, or high-value → Set the field to edit error flag, highlight it, and display an invalid numeric error message
[Invalid SPLC - highlight field]
The numeric conversion fails → Highlight the field and display an invalid numeric error message
[Display Key Combination Error Message]
The system prepares the error response → The system displays the key combination invalid error message to inform the user of the validation failure
[Station Code is Zero]
The origin station code equals zero → The system sets an invalid numeric error message and highlights the origin station field
[Station Code is Blank/Invalid]
The origin station code is blank, low-value, or high-value → The system sets the field to edit error flag, sets an invalid numeric error message, and highlights the origin station field
[Set Invalid Numeric Error]
The numeric conversion fails → The system sets an invalid numeric error message and highlights the origin station field
[Destination Code is Zero]
The destination station code equals zero → The system sets an invalid numeric error message and highlights the destination station field
[Destination Code is Blank/Invalid]
The destination station code is blank, low-value, or high-value → The system sets the field to edit error flag, sets an invalid numeric error message, and highlights the destination station field
[Set Destination Invalid Error]
The numeric conversion fails → The system sets an invalid numeric error message and highlights the destination station field
[Validate ROAD Pattern]
The system validates the ROAD pattern format → The 3-digit suffix (positions 5-7) must be numeric and greater than zero, otherwise mark as invalid with road/border numeric error message
[Validate BDR Pattern]
The system validates the BDR pattern format → The 4-digit suffix (positions 4-7) must be numeric and greater than zero, otherwise mark as invalid with road/border numeric error message
[Validate Numeric SPLC]
The system validates the numeric SPLC code → If the code is zero, space, low-value, or high-value, mark as invalid with numeric error message. If non-numeric, attempt right-justify conversion and mark as invalid if conversion fails
[Validate Dest ROAD Pattern]
The system validates the destination ROAD pattern format → The 3-digit suffix (positions 5-7) must be numeric and greater than zero, otherwise mark as invalid with road/border numeric error message
[Validate Dest BDR Pattern]
The system validates the destination BDR pattern format → The 4-digit suffix (positions 4-7) must be numeric and greater than zero, otherwise mark as invalid with road/border numeric error message
[Validate Dest Numeric SPLC]
The system validates the numeric destination SPLC code → If the code is zero, space, low-value, or high-value, mark as invalid with numeric error message. If non-numeric, attempt right-justify conversion and mark as invalid if conversion fails
[Set Validation Error]
The system processes the validation failure → Set UPDATE-NOT-VALID flag and maintain current error messages for display to user
[Set Database Error Message]
The system processes the insertion failure → Set UPDATE-NOT-VALID flag and set CST-DB-UPDATE-ERR message if no other message is already set
[Validate CABK Record Data]
The broker name field is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE → The system sets validation error flag and displays blank/zero error message
[Validate CABK Record Data]
Any US-specific field contains data → The system sets validation error flag and displays appropriate blank field error message
[Validate COGD Record Data]
The primary broker name or Canadian manifest destination contains data → The system sets validation error flag and displays broker or manifest should be blank error message
[Validate USBK Record Data]
The Canadian manifest destination or broker name2 contains data → The system sets validation error flag and displays appropriate blank field error message
[Validate SNP Record Data]
Any broker name, broker name2, Canadian manifest destination, or Canadian manifest source contains data → The system sets validation error flag and displays appropriate blank field error message
[Validate PACT Record Data]
Any field other than PACT arrival flag contains data → The system sets validation error flag and displays appropriate blank field error message
[Set Database Error Message]
The database update operation fails → The system sets update not valid flag and displays database update error message
[PF Key = Delete Request?]
The PF key != DELETE-REQUEST → The system sets confirmation delete message, marks update as invalid, and returns to update screen
[Set Database Update Error]
The delete operation fails with an error status → The system marks update as invalid, sets database update error message, and returns to update screen with error
[Broker Name Field Check]
The broker name field is blank, zero, low-value, or high-value → Set validation error flag, highlight the field, and display blank/zero error message
[Canadian Manifest To Field Check]
The Canadian manifest TO field is zero, low-value, or high-value → Set validation error flag, highlight the field, and display blank/zero error message
[Broker Name2 Field Check]
The broker name2 field is not blank → Set validation error, highlight the field, and display 'broker2 should be blank' error message
[Override Flag Check]
The override flag is not blank, 'Y', or 'N' → Set validation error, highlight the field, and display invalid override flag error message
[Check US Fields Must Be Blank]
Any US-specific field (manifest from, border station, bonded to, line release code, bond type code, bond owner, 2nd notify fields) is not blank → Set validation error, highlight the field, and display appropriate 'should be blank' error message for each non-blank US field
[Set Manifest Validation Error]
The system determines the manifest ID is not authorized → The system sets update status to invalid, highlights the manifest field, and displays 'not on table' error message
[Set Broker Validation Error]
The system determines the broker is not authorized → The system sets update status to invalid, highlights the broker name field, and displays 'not on table' error message
[Clear Reference Table Key]
The system performs reference table lookup by clearing the reference table key, setting table ID to manifest table, moving the Canadian Manifest ID to the key field, and performing the lookup → If the manifest ID exists in the reference table, validation passes and processing continues, otherwise the system sets update invalid flag, highlights the manifest field, and displays 'Not on Table' error message
[Set Error Message: Not on Table]
The system handles the validation failure → The user message number is set to 'Not on Table' error message to inform the user that the manifest ID does not exist in the system
[Set Error Message - Not on Table]
The broker is not found in the broker table → The system sets validation error flag, highlights the broker name field, and sets 'Not on Table' error message
[Broker Name Field Check]
The broker name field is SPACE, ZERO, LOW-VALUE, or HIGH-VALUE → Set validation error flag, highlight the broker name field, mark field with error flag if it contains SPACE, LOW-VALUE, or HIGH-VALUE, and display blank/zero error message
[Validate Broker Against Reference Table]
The broker name is looked up in the broker reference table using destination SPLC port information and then with default port '000' → If broker is not found in either lookup, set validation error flag, highlight broker name field, and display 'not on table' error message
[Canadian Manifest To Field Check]
The Canadian manifest TO field is not SPACES → Set validation error flag, highlight the Canadian manifest TO field, and display 'manifest TO should be blank' error message
[Broker Name 2 Field Check]
The broker name 2 field is not SPACES → Set validation error flag, highlight the broker name 2 field, and display 'broker 2 should be blank' error message
[Check US-Specific Fields Must Be Blank]
Any of the US-specific fields (Canadian manifest FROM, US border station, US bonded TO, US line release code, bond type code, bond owner, 2nd notify 1, 2nd notify 2, PACT arrival flag) are not SPACES → Set validation error flag, highlight the respective field, and display appropriate 'field should be blank' error message for each non-blank field
[Broker Validation Successful]
The broker validation process completes successfully → The broker validation is marked as successful AND no error messages are set
[Set Error Message - Not on Table]
The system sets the error message AND no other error message is already set → The user message is set to indicate the broker is not found on the reference table
[Check if Field is Zero/Invalid Values]
The Canadian Manifest To field contains zero, high-value, or low-value → Set validation error indicating blank/zero not allowed, highlight the field with error attribute, and mark the field with edit error flag if it contains low-value or high-value
[Check Canadian Manifest From Field]
The Canadian Manifest From field is space, zero, high-value, or low-value → Set validation error indicating blank/zero not allowed, highlight the field with error attribute, and mark the field with edit error flag if it contains space, low-value, or high-value
[Is CDN-MANI-TO field blank, zero, or invalid values?]
The Canadian Manifest To field is zero, low-value, or high-value → The system sets validation error flag, highlights the field with error display, sets error flag in the field, and displays blank/zero error message
[Lookup successful?]
The system performs a lookup against the manifest reference table using the field value → If the lookup is successful, validation passes; if the lookup fails, the system sets validation error flag, highlights the field, and displays 'not on table' error message
[Is CDN-MANI-FROM field blank, zero, high-value, or low-value?]
The field contains blank spaces, zero, low-value, or high-value → The validation fails with a blank/zero error message and the field is highlighted for correction
[Set field to error flag marker]
Field validation detects these invalid system values → The field is marked with an edit error flag to indicate the specific type of validation failure
[Call reference table validation routine]
The system performs a lookup against the manifest reference table → If the code is not found in the table, validation fails with a 'not on table' error message and the field is highlighted
[US Border Station = ZERO, HIGH-VALUE, or LOW-VALUE?]
The US Border Station equals ZERO or HIGH-VALUE or LOW-VALUE → Set validation as invalid, highlight the field with error attributes, move error flag to the field, and set blank/zero error message
[Table Lookup Successful?]
The table lookup is not successful → Set validation as invalid, highlight the field with error attributes, and set not-on-table error message
[US Bonded Station = ZERO, HIGH-VALUE, or LOW-VALUE?]
The US Bonded Station field contains ZERO, HIGH-VALUE, or LOW-VALUE → The system marks the update as invalid, highlights the field with error attributes, sets error flag in the field, and displays blank/zero error message
[Set Not On Table Error Message]
The US Bonded Station code is not found in both Schedule-D table and Manifest table lookups → The system marks the update as invalid, highlights the field with error attributes, and displays not-on-table error message
[CDN-MANI-TO Field Check]
The Canadian Manifest TO field is ZERO, HIGH-VALUE, or LOW-VALUE → The system should set validation error flag, highlight the field, and display blank/zero error message
[Lookup CDN-MANI-TO in Manifest Table, Lookup CDN-MANI-FROM in Manifest Table]
The system performs a lookup in the manifest reference table → If the code is not found in the table, the system should set validation error flag, highlight the field, and display 'not on table' error message
[CDN-MANI-FROM Field Check]
The Canadian Manifest FROM field is SPACE, ZERO, HIGH-VALUE, or LOW-VALUE → The system should set validation error flag, highlight the field, and display blank/zero error message
[US Border Station Field Empty?]
The US border station field is ZERO or HIGH-VALUE or LOW-VALUE → Set validation error flag, highlight the field, and display blank/zero error message
[Lookup US Border Station in Manifest Table]
The US border station code is looked up in the manifest reference table → If the code is not found in the table, set validation error flag, highlight the field, and display 'not on table' error message
[US Bonded Station Field Empty?]
The US bonded station field is ZERO or HIGH-VALUE or LOW-VALUE → Set validation error flag, highlight the field, and display blank/zero error message
[CDN-MANI-TO = ZERO, HIGH-VALUE, or LOW-VALUE?]
The Canadian Manifest TO field equals ZERO, HIGH-VALUE, or LOW-VALUE → The system should set validation error flag, highlight the CDN-MANI-TO field, and display blank/zero error message
[CDN-MANI-FROM = SPACE, ZERO, HIGH-VALUE, or LOW-VALUE?]
The Canadian Manifest FROM field equals SPACE, ZERO, HIGH-VALUE, or LOW-VALUE → The system should set validation error flag, highlight the CDN-MANI-FROM field, and display blank/zero error message
[US Border Station Error - Cannot be blank/zero]
The US border station field is ZERO or HIGH-VALUE or LOW-VALUE → Set validation error flag, highlight the field, set error message for blank/zero error, and mark update as invalid
[Validate US Border Station against Manifest Table]
The US border station code is looked up in the Manifest reference table → If not found in the table, set validation error flag, highlight the field, set 'not on table' error message, and mark update as invalid
[US Bonded Station Error - Cannot be blank/zero]
The US bonded station field is ZERO or HIGH-VALUE or LOW-VALUE → Set validation error flag, highlight the field, set error message for blank/zero error, and mark update as invalid
[Try Manifest Table for US Bonded Station]
The US bonded station code is looked up in the Manifest reference table as fallback → If found in Manifest table, mark as valid, otherwise set validation error flag, highlight the field, set 'not on table' error message, and mark update as invalid
[Lookup Successful?]
The reference table lookup returns successful status → The system continues processing without setting any error flags or messages
[Set Error Message: Not on Table]
The reference table lookup fails to find the manifest TO code → The system sets update invalid flag, highlights the field with error attribute, and sets 'not on table' error message
[Broker Name Present?]
The broker name field is empty, zero, low-value, or high-value → The system should flag the broker name field as invalid and display a blank/zero error message
[Broker Not Found Error]
The broker validation is performed → The system should flag the broker name field as invalid and display a 'not on table' error message
[Party 1 has embedded spaces?]
The system validates the party 1 field format → If any of the 4 character positions contains spaces, set validation error with message about spaces in notify party 1
[Party 2 equals Party 1?]
The system compares the two party values → If second notify party 2 equals second notify party 1, set validation error with duplicate second notify message
[Party 2 has embedded spaces?]
The system validates the party 2 field format → If any of the 4 character positions contains spaces, set validation error with message about spaces in notify party 2
[Bond Type Code Valid? ' ', 'IT', 'TE', '00', '17', '15', 'IE', 'TR', '12']
The bond type code is not one of the valid values: SPACE, 'IT', 'TE', '00', '17', '15', 'IE', 'TR', '12' → The system should flag the bond type code as invalid and display an error message indicating valid bond type values
[Bond Type Requires Line Release Code to be Blank? ' ', '00', '12']
The US line release code field is not blank → The system should flag the line release code field as invalid and display an error message that it should be blank
[Bond Type Allows Bonded Station? 'IT', 'TE', 'IE', '12', '15', '17', 'TR']
The US bonded station field is not blank → The system should flag the bonded station field as invalid and display an error message that it should be blank
[US Border Station = Canadian Manifest From?]
The US border station does not equal the Canadian manifest from station → The system should flag the US border station field as invalid and display an error message about border manifest mismatch
[Bond Type Requires Bonded Station? 'IT', 'TE', 'TR', 'IE']
The US bonded station field is blank → The system should flag the bonded station field as invalid and display an error message about bond type and station requirements
[Bond Owner Format Valid? 'No embedded spaces']
The bond owner field contains spaces in the first or second character positions → The system should flag the bond owner field as invalid and display an error message about embedded spaces
[Bond Owner Found in CC Table?]
The bond owner is not found in the CC reference table:
is found but does not have an IRS number
→ The system should flag the bond owner field as invalid and display an error message about bond owner authorization
[Bond Type Code Valid? ' ', 'IT', 'TE', '00', '17', '15', 'IE', 'TR', '12']
The bond type code is not one of the approved values: blank space, 'IT', 'TE', '00', '17', '15', 'IE', 'TR', or '12' → The system marks the update as invalid and displays an error message indicating invalid bond type values
[Set Bond Type and Bonded Station Error]
The combination of bond type and bonded station does not meet the valid pairing requirements → The system marks both fields with error flags, sets update as invalid, and displays bond type and bonded station error message
[Line Release Code provided?]
A line release code is provided → The system marks the field with error flag, sets update as invalid, and displays line release should be blank error message
[Bonded Station provided?]
A bonded station is provided → The system marks the field with error flag, sets update as invalid, and displays bonded station should be blank error message
[Border Station matches Manifest From?]
The US border station does not equal the Canadian manifest from location → The system marks the border station field with error flag, sets update as invalid, and displays border manifest error message
[Bonded Station provided?]
No bonded station is provided → The system marks the bonded station field with error flag, sets update as invalid, and displays bond type station requirements error message
[Bond Owner format valid? 'No spaces in positions']
The bond owner contains spaces in the first or second character positions → The system marks the field with error flag, sets update as invalid, and displays bond owner format error message
[Bond Owner authorized in CC table?]
The bond owner is not found in the CC reference table or the CC table entry does not have an IRS number → The system marks the field with error flag, sets update as invalid, and displays bond owner not authorized error message
[Bond Type Code = SPACE, 'IT', 'TE', '00', '17', '15', 'IE', 'TR', or '12'?]
The bond type code is validated against the list of allowed values (SPACE, 'IT', 'TE', '00', '17', '15', 'IE', 'TR', '12') → If the bond type code matches any of the valid values, processing continues; otherwise, the update is marked as invalid, the bond type code field is highlighted, and an error message for invalid bond type values is set
[Set Error Message: Invalid Bond Type Values]
The system processes the bond type code validation error → The user message number is set to indicate invalid bond type values to provide guidance on acceptable values
[Set Update Invalid Flag]
The system detects the invalid bond type code → The update validity flag is set to invalid to prevent the update operation from proceeding
[Bond Type Code Valid? ' ', 'IT', 'TE', '00', '17', '15', 'IE', 'TR', '12']
The bond type code is not one of the valid values: blank space, 'IT', 'TE', '00', '17', '15', 'IE', 'TR', or '12' → The system should flag the bond type code as invalid and display an error message indicating valid bond type values
[Bond Type and Bonded Station Combination Valid?]
The bond type and bonded station combination does not meet the valid pairing requirements → The system should flag both fields as invalid and display an error message about bond type and bonded station relationship
[Bond Type Requires Line Release Code? 'Not ' ', '00', '12']
The bond type is not blank, '00', or '12' and a line release code is present → The system should flag the line release code as invalid and display an error message that line release code should be blank
[Bond Type Requires Bonded Station? 'IT', 'TE', 'IE', '12', '15', '17', 'TR']
The bond type is not 'IT', 'TE', 'IE', '12', '15', '17', or 'TR' and a bonded station is present → The system should flag the bonded station as invalid and display an error message that bonded station should be blank
[Border Station Matches Manifest From? 'For IT, TE, TR, 12, 15, 17, IE']
The US border station does not match the Canadian manifest from field → The system should flag the US border station as invalid and display an error message about border station and manifest mismatch
[Bond Type Requires Bonded Station? 'IT', 'TE', 'TR', 'IE']
The bonded station field is blank → The system should flag the bonded station as invalid and display an error message about bond type and station requirements
[Bond Owner Valid Format? 'No embedded spaces']
The bond owner field contains spaces in the first or second character positions → The system should flag the bond owner as invalid and display an error message about bond owner format with embedded spaces
[Bond Owner Authorized?]
The bond owner is not found in the CC reference table or does not have an IRS number → The system should flag the bond owner as invalid and display an error message that bond owner is not authorized
[Set Error Message: Bond and Bonded Station Mismatch]
An error message needs to be displayed to the user → The system sets the error message indicating bond type and bonded station mismatch
[Check Owner Format]
The bond owner field contains spaces in position 1 or position 2 → The system should flag a format validation error and highlight the bond owner field with error message indicating embedded spaces are not allowed
[Bond Owner Authorization Error]
The bond owner fails CC table lookup or IRS number verification or format validation → The system should set update validation to invalid, highlight the bond owner field with error attributes, and display bond owner authorization error message
[Validate Line Release Code Restrictions - Checks if line release code is allowed based on bond type with business rule enforcement]
The bond type code is blank, '00', or '12' and the line release code field contains a value → The system should flag this as a validation error, highlight the line release code field, set error message indicating line release code should be blank, and mark the update as invalid
[Bond Type Code = ' ' OR '00' OR '12'?]
The bond type code is space, '00', or '12' and the line release code is not spaces → The system should mark the update as invalid, flag the line release code field as error, highlight the field, and display message that line release code should be blank
[Check US Border Station vs CDN Manifest From]
The US border station does not equal the Canadian manifest from station → Set border station error flag, mark update as invalid, highlight the US border station field, and display border manifest error message
[Check US Bonded-To Station Required]
The US bonded-to station field is empty (spaces) → Set bonded-to station error flag, mark update as invalid, highlight the US bonded-to field, and display bond type and stations error message
[Validate Border Station and Manifest From Match]
The bond type is an in-transit type (IT, TE, TR, IE, 12, 15, 17) and the US border station does not equal the Canadian manifest from field → The system sets border station error flag, marks update as invalid, highlights the border station field, and displays border manifest error message
[Set Bond Owner Validation Error]
The bond owner validation fails → The system should set the update as invalid, highlight the bond owner field, and set the error message to indicate the bond owner is not authorized
[Owner Field Has Spaces?]
The bond owner field contains spaces in the first or second character position → The record is marked as invalid with bond owner spaces error message and field is highlighted
[Set Validation Error]
The system processes the validation failure → The update validity flag is set to invalid, the US Bonded-To field is highlighted with error attribute, and 'not on table' error message is set
[US Border Station = ZERO, HIGH-VALUE, or LOW-VALUE?]
The US Border Station field contains ZERO, HIGH-VALUE, or LOW-VALUE → The system marks the update as invalid, highlights the field with error display attributes, sets error flag in the field, and displays a blank/zero error message
[Lookup US Border Station in MANIFEST-TABLE]
The system looks up the US Border Station code in the MANIFEST-TABLE reference table → If the station code is found, validation passes; if not found, the system marks update as invalid, highlights the field with error display attributes, and displays a not-on-table error message
[Field Contains Zero/Invalid Values?]
The field contains zero, high-value, or low-value characters → A validation error is set, the field is highlighted, and a blank/zero error message is displayed
[Lookup Station in Manifest Table]
The system performs a fallback lookup in the manifest reference table → If found in manifest table, validation passes; if not found, a validation error is set with 'not on table' message
[Bond Type IT/TE/TR/IE and Station Empty?]
The US bonded-to station field is empty → A validation error is set with message indicating bond type requires a bonded station
[Override Flag Value?]
The override flag value is not spaces, 'Y', or 'N' → The system marks the update as invalid, highlights the override flag field, and sets an invalid override flag error message
[Set Invalid Flag Message]
No other error message has been set for the current validation → The system sets the user message to indicate invalid PACT arrival flag
[PACT Flag Processing Complete]
The PACT arrival flag contains any value other than spaces → The system marks the update as invalid, highlights the PACT arrival flag field, and sets an error message indicating the field should be blank
[Set Error Flag in Field]
The system processes screen field initialization → The field is cleared to space to remove the error flag
[Set Error Message Number]
The system processes the validation failure → An appropriate error message number is assigned based on the type of validation failure
[Ship/Consignee Code Error]
The system validates the field during update processing → The field is marked with an error flag, highlighted with high intensity display attributes, and an appropriate error message is set
[Station Code Error]
The system validates station codes during update processing → The invalid station field is highlighted with high intensity display attributes and an invalid numeric error message is set
[SPLC Code Error]
The system validates SPLC codes during update processing → The invalid SPLC field is highlighted with high intensity display attributes and an appropriate error message is set based on the validation failure type
[STCC Code Error]
The system validates STCC codes during update processing → The invalid STCC field is highlighted with high intensity display attributes and an invalid numeric error message is set
[Broker Name Error]
The system validates broker name fields during update processing → The invalid broker name field is highlighted with high intensity display attributes and an appropriate error message is set
[Manifest Field Error]
The system validates manifest fields during update processing → The invalid manifest field is highlighted with high intensity display attributes and an appropriate error message is set
[Border Station Error]
The system validates border station fields during update processing → The invalid border station field is highlighted with high intensity display attributes and an appropriate error message is set
[Bond Type Error]
The system validates bond type codes during update processing → The invalid bond type field and related fields are highlighted with high intensity display attributes and an appropriate error message is set
[Second Notify Party Error]
The system validates second notify party fields during update processing → The invalid second notify party field is highlighted with high intensity display attributes and an appropriate error message is set
[Set Error Message Number]
The system processes the navigation request → The system sets the first page message number to indicate user is at the beginning
[Set Error Flag - Database Update Failed]
The database operation fails due to record not found or database update errors → The system sets the update-not-valid flag and displays a database update error message
[Database Update Error]
The database delete operation fails or returns an error status → The system should mark the update as invalid and display a database update error message
[Set Error Flag - Update Not Valid and Set Database Update Error Message]
The database insert operation returns an error status code indicating failure → The system sets the update status to not valid and if no user message is already set then sets the user message to database update error