BIG Pega COE Team
Business Rules to be added in EPICs
Category: GCX105
This report presents the exact business rules dynamically extracted from the legacy system. Rules are formatted in an Agile/BDD Given/When/Then structure, offering a bridge between business requirements and technical implementation constraints. Component rules have been logically grouped into feature sets.
🎯 GCX105 Scope Detected: Extracted 181 rules, Optimally Merged into 36 Feature Scenarios.
📁 File: GCX105.cbl
Select All in File
R-GCX105-cbl-00001 (+21) File: GCX105.cbl Business Rule: Overview Rules
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when user attempts to access the log processing system.
Trigger Criteria:
- Context: A user attempts to access the log processing system
- Applied to: Security Validation
- Action: The security byte is not equal to HIGH-VALUES
Logic Flow:
IF A user attempts to access the log processing system
AND The security byte is not equal to HIGH-VALUES
THEN:
- • The system denies access and terminates processing without performing any log operations
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid authorized request is received.
Trigger Criteria:
- Context: A valid authorized request is received
- Applied to: Determine Processing Type
- Action: The transfer CCN flag is set to true
Logic Flow:
IF A valid authorized request is received
AND The transfer CCN flag is set to true
THEN:
- • The system performs transfer log processing
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid authorized request is received.
Trigger Criteria:
- Context: A valid authorized request is received
- Applied to: Determine Processing Type
- Action: Neither transfer CCN flag nor delete log flag is set to true
Logic Flow:
IF A valid authorized request is received
AND Neither transfer CCN flag nor delete log flag is set to true
THEN:
- • The system performs standard log creation processing
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when valid authorized request is received and transfer ccn flag is not set.
Trigger Criteria:
- Context: A valid authorized request is received and transfer CCN flag is not set
- Applied to: Determine Processing Type
- Action: The delete log flag is set to true
Logic Flow:
IF A valid authorized request is received and transfer CCN flag is not set
AND The delete log flag is set to true
THEN:
- • The system performs delete log processing
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when standard log creation or transfer operation is being performed.
Trigger Criteria:
- Context: Standard log creation or transfer operation is being performed
- Applied to: Format Log Root Segment
- Action: The system needs to create a log root segment
Logic Flow:
IF Standard log creation or transfer operation is being performed
AND The system needs to create a log root segment
THEN:
- • The system formats the segment with train or US CCN as key, current machine date and century as loaded date, and record type code from input
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log root segment has been formatted.
Trigger Criteria:
- Context: A log root segment has been formatted
- Applied to: Insert Log Root Segment
- Action: The system attempts to insert the segment into the database
Logic Flow:
IF A log root segment has been formatted
AND The system attempts to insert the segment into the database
THEN:
- • The system stores the segment and retrieves it if insertion is successful
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when log detail segment needs to be created.
Trigger Criteria:
- Context: A log detail segment needs to be created
- Applied to: Format Log Dependent Segment
- Action: The system processes the input date and time
Logic Flow:
IF A log detail segment needs to be created
AND The system processes the input date and time
THEN:
- • The system computes a new key by subtracting the combined date-time value from nines complement to ensure chronological ordering
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment is being formatted.
Trigger Criteria:
- Context: A log detail segment is being formatted
- Applied to: Process Manual Release Messages
- Action: The action code is 'MMR'
Logic Flow:
IF A log detail segment is being formatted
AND The action code is 'MMR'
THEN:
- • The system formats the message using MMR message structure
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment is being formatted.
Trigger Criteria:
- Context: A log detail segment is being formatted
- Applied to: Process Direct Message Entries
- Action: The action code is 'ZZZ'
Logic Flow:
IF A log detail segment is being formatted
AND The action code is 'ZZZ'
THEN:
- • The system uses the message as-is without additional formatting
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment is being formatted.
Trigger Criteria:
- Context: A log detail segment is being formatted
- Applied to: Process Cargo Train Operations
- Action: The action code is 'CAT', 'CDT', 'CFR', 'CPR', 'CPZ', or 'CTP'
Logic Flow:
IF A log detail segment is being formatted
AND The action code is 'CAT', 'CDT', 'CFR', 'CPR', 'CPZ', or 'CTP'
THEN:
- • The system formats the message using the corresponding message structure for that specific cargo or train operation
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment is being formatted.
Trigger Criteria:
- Context: A log detail segment is being formatted
- Applied to: Process Cargo Renumbering
- Action: The action code is 'RNO' or 'RNN'
Logic Flow:
IF A log detail segment is being formatted
AND The action code is 'RNO' or 'RNN'
THEN:
- • The system formats the message using the corresponding renumbering message structure
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment is being formatted.
Trigger Criteria:
- Context: A log detail segment is being formatted
- Applied to: Process Manual Cargo Changes
- Action: The action code is 'MC' or 'MD'
Logic Flow:
IF A log detail segment is being formatted
AND The action code is 'MC' or 'MD'
THEN:
- • The system formats the message including the reason code and bond type information
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment is being formatted.
Trigger Criteria:
- Context: A log detail segment is being formatted
- Applied to: Process Cargo Transfer Operations
- Action: The action code is 'TFT' or 'TFF'
Logic Flow:
IF A log detail segment is being formatted
AND The action code is 'TFT' or 'TFF'
THEN:
- • The system formats the message using the corresponding transfer message structure
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment is being formatted.
Trigger Criteria:
- Context: A log detail segment is being formatted
- Applied to: Process Equipment Hold Operations
- Action: The action code is 'HNF', 'HID', 'RID', 'SZI', or 'SZR'
Logic Flow:
IF A log detail segment is being formatted
AND The action code is 'HNF', 'HID', 'RID', 'SZI', or 'SZR'
THEN:
- • The system formats the message including the equipment ID information
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment is being formatted.
Trigger Criteria:
- Context: A log detail segment is being formatted
- Applied to: Lookup Unknown Action Codes
- Action: The action code is not one of the predefined codes
Logic Flow:
IF A log detail segment is being formatted
AND The action code is not one of the predefined codes
THEN:
- • The system searches the log table for the action code and uses the corresponding message, or generates an error message if not found
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when log detail segment is being formatted with action code 'ca'.
Trigger Criteria:
- Context: A log detail segment is being formatted with action code 'CA'
- Applied to: Lookup Unknown Action Codes
- Action: The bond type field is not empty
Logic Flow:
IF A log detail segment is being formatted with action code 'CA'
AND The bond type field is not empty
THEN:
- • The system formats the message as 'CARGO CREATED AUTOMATICALLY TP:' concatenated with the bond type
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail segment has been formatted.
Trigger Criteria:
- Context: A log detail segment has been formatted
- Applied to: Insert Log Dependent Segment
- Action: The system attempts to insert the segment and encounters a duplicate key
Logic Flow:
IF A log detail segment has been formatted
AND The system attempts to insert the segment and encounters a duplicate key
THEN:
- • The system automatically decrements the key value and retries insertion up to 50 times
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when standard log creation has been completed successfully.
Trigger Criteria:
- Context: Standard log creation has been completed successfully
- Applied to: Spawn Vista GUI Transaction
- Action: The record type code is 'CC' or 'UC' and both log root and detail insertions were successful
Logic Flow:
IF Standard log creation has been completed successfully
AND The record type code is 'CC' or 'UC' and both log root and detail insertions were successful
THEN:
- • The system spawns the GCT1511E transaction with the formatted log segments
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when transfer or delete operation is being performed.
Trigger Criteria:
- Context: A transfer or delete operation is being performed
- Applied to: Find Existing Log Root
- Action: The system searches for an existing log root using the provided CCN
Logic Flow:
IF A transfer or delete operation is being performed
AND The system searches for an existing log root using the provided CCN
THEN:
- • The system determines if the log root exists and sets the appropriate status flag
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when transfer operation is being performed and the old log root exists.
Trigger Criteria:
- Context: A transfer operation is being performed and the old log root exists
- Applied to: Retrieve Log Dependent Segments
- Action: The system retrieves associated detail records
Logic Flow:
IF A transfer operation is being performed and the old log root exists
AND The system retrieves associated detail records
THEN:
- • The system collects up to 100 detail records associated with the old log root
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when transfer operation has successfully created new log entries or a delete operation is requested.
Trigger Criteria:
- Context: A transfer operation has successfully created new log entries or a delete operation is requested
- Applied to: Delete Old Log Entries
- Action: The old log root exists in the system
Logic Flow:
IF A transfer operation has successfully created new log entries or a delete operation is requested
AND The old log root exists in the system
THEN:
- • The system deletes the old log root and all associated detail records
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when delete log operation is requested.
Trigger Criteria:
- Context: A delete log operation is requested
- Applied to: Delete Log Processing
- Action: The system locates the log root using the provided CCN
Logic Flow:
IF A delete log operation is requested
AND The system locates the log root using the provided CCN
THEN:
- • The system deletes the entire log structure if found
R-GCX105-cbl-00023 (+1) File: GCX105.cbl Business Rule: Read Input Message
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when transaction message exists in the message queue. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A transaction message exists in the message queue
- Applied to: Call Message Queue Reader
- Action: The system calls the message queue reader
Logic Flow:
IF A transaction message exists in the message queue
AND The system calls the message queue reader
THEN:
- • The message is retrieved from the queue for processing
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when message has been retrieved from the queue with a specific length.
Trigger Criteria:
- Context: A message has been retrieved from the queue with a specific length
- Applied to: Move Message Content to Input Structure
- Action: The system processes the message content
Logic Flow:
IF A message has been retrieved from the queue with a specific length
AND The system processes the message content
THEN:
- • The message content is moved to the input structure using the determined message length
R-GCX105-cbl-00025 (+2) File: GCX105.cbl Business Rule: Security Validation
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when user attempts to access the log processing system with a security byte value.
Trigger Criteria:
- Context: A user attempts to access the log processing system with a security byte value
- Applied to: Security Byte = HIGH-VALUES?
- Action: The system checks if the security byte equals HIGH-VALUES
Logic Flow:
IF A user attempts to access the log processing system with a security byte value
AND The system checks if the security byte equals HIGH-VALUES
THEN:
- • Access is granted if security byte is HIGH-VALUES,
otherwise access is denied and processing terminates
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when security validation has passed successfully.
Trigger Criteria:
- Context: Security validation has passed successfully
- Applied to: Access Authorized - Continue Processing
- Action: The security byte equals HIGH-VALUES
Logic Flow:
IF Security validation has passed successfully
AND The security byte equals HIGH-VALUES
THEN:
- • The system continues to execute the main processing logic for log operations
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when user attempts to access the system with invalid security credentials.
Trigger Criteria:
- Context: A user attempts to access the system with invalid security credentials
- Applied to: Access Denied - Exit Program
- Action: The security byte does not equal HIGH-VALUES
Logic Flow:
IF A user attempts to access the system with invalid security credentials
AND The security byte does not equal HIGH-VALUES
THEN:
- • The system denies access and terminates the program without performing any log operations
R-GCX105-cbl-00028 (+2) File: GCX105.cbl Business Rule: Determine Processing Type
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when transaction message has been received and validated.
Trigger Criteria:
- Context: A transaction message has been received and validated
- Applied to: Check GCX105-TRANSFER-CCN Flag
- Action: The system checks the GCX105-TRANSFER-CCN flag in the input message
Logic Flow:
IF A transaction message has been received and validated
AND The system checks the GCX105-TRANSFER-CCN flag in the input message
THEN:
- • If the transfer flag is set, route the transaction to transfer log processing workflow
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when transaction message has been received and validated.
Trigger Criteria:
- Context: A transaction message has been received and validated
- Applied to: Route to Standard Log Update Processing
- Action: Both the GCX105-TRANSFER-CCN flag and GCX105-DELETE-LOG flag are not set
Logic Flow:
IF A transaction message has been received and validated
AND Both the GCX105-TRANSFER-CCN flag and GCX105-DELETE-LOG flag are not set
THEN:
- • Route the transaction to standard log update processing workflow to create new log entries
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when transaction message has been received and the transfer flag is not set.
Trigger Criteria:
- Context: A transaction message has been received and the transfer flag is not set
- Applied to: Check GCX105-DELETE-LOG Flag
- Action: The system checks the GCX105-DELETE-LOG flag in the input message
Logic Flow:
IF A transaction message has been received and the transfer flag is not set
AND The system checks the GCX105-DELETE-LOG flag in the input message
THEN:
- • If the delete flag is set, route the transaction to delete log processing workflow
R-GCX105-cbl-00031 (+14) File: GCX105.cbl Business Rule: Transfer Log Processing
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when transfer request is received with an old ccn.
Trigger Criteria:
- Context: A transfer request is received with an old CCN
- Applied to: Find Old Log Root by Old CCN
- Action: The system searches for the existing log root using the old CCN
Logic Flow:
IF A transfer request is received with an old CCN
AND The system searches for the existing log root using the old CCN
THEN:
- • The system determines whether the old log root exists and sets the appropriate status flag
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when system has searched for an old log root record.
Trigger Criteria:
- Context: The system has searched for an old log root record
- Applied to: Old Log Root Found?
- Action: The search operation completes
Logic Flow:
IF The system has searched for an old log root record
AND The search operation completes
THEN:
- • If old log root is found, proceed with transfer initialization,
otherwise terminate transfer process
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when old log root has been found for transfer.
Trigger Criteria:
- Context: An old log root has been found for transfer
- Applied to: Initialize Transfer Variables
- Action: The system begins transfer processing
Logic Flow:
IF An old log root has been found for transfer
AND The system begins transfer processing
THEN:
- • Set dependent segment found flag to true, initialize key value to zero, initialize counter to zero, and clear dependent segment storage area
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when transfer variables are initialized and old log root exists.
Trigger Criteria:
- Context: Transfer variables are initialized and old log root exists
- Applied to: Retrieve First Dependent Segment
- Action: The system retrieves dependent segments using get next parent operation
Logic Flow:
IF Transfer variables are initialized and old log root exists
AND The system retrieves dependent segments using get next parent operation
THEN:
- • If segment is found, increment counter and store segment in memory array,
otherwise set dependent segment not found flag
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when dependent segment retrieval operation has completed.
Trigger Criteria:
- Context: A dependent segment retrieval operation has completed
- Applied to: More Segments Available?
- Action: The system checks the operation status and counter limits
Logic Flow:
IF A dependent segment retrieval operation has completed
AND The system checks the operation status and counter limits
THEN:
- • If status indicates success and counter is less than 100, continue retrieval,
otherwise proceed to new log creation
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when dependent segment has been successfully retrieved.
Trigger Criteria:
- Context: A dependent segment has been successfully retrieved
- Applied to: Store Segment in Memory
- Action: The segment data is available
Logic Flow:
IF A dependent segment has been successfully retrieved
AND The segment data is available
THEN:
- • Increment the storage counter and move the segment data to the corresponding position in the memory array
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when all dependent segments have been retrieved and stored.
Trigger Criteria:
- Context: All dependent segments have been retrieved and stored
- Applied to: Create New Log Root with New CCN
- Action: The system creates the new log structure
Logic Flow:
IF All dependent segments have been retrieved and stored
AND The system creates the new log structure
THEN:
- • Format new log root with current CCN as key, current machine date, and record type code from input
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when new log root record has been formatted with current ccn.
Trigger Criteria:
- Context: A new log root record has been formatted with current CCN
- Applied to: Insert New Log Root
- Action: The system performs the insert operation
Logic Flow:
IF A new log root record has been formatted with current CCN
AND The system performs the insert operation
THEN:
- • Insert the log root record and if successful, retrieve it to establish database positioning
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when new log root has been successfully inserted and dependent segments are stored in memory.
Trigger Criteria:
- Context: New log root has been successfully inserted and dependent segments are stored in memory
- Applied to: Process Each Stored Segment
- Action: The system processes stored segments using a loop from 1 to 100
Logic Flow:
IF New log root has been successfully inserted and dependent segments are stored in memory
AND The system processes stored segments using a loop from 1 to 100
THEN:
- • For each non-empty segment, initialize segment structure and move stored data to working segment
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when dependent segment is being processed for transfer.
Trigger Criteria:
- Context: A dependent segment is being processed for transfer
- Applied to: Update Segment Key
- Action: The segment data is moved to working storage
Logic Flow:
IF A dependent segment is being processed for transfer
AND The segment data is moved to working storage
THEN:
- • Extract the dependent key from the segment and move it to the new key field for insertion
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when dependent segment has been prepared with updated key.
Trigger Criteria:
- Context: A dependent segment has been prepared with updated key
- Applied to: Insert Segment to New Log
- Action: The system performs the insert operation
Logic Flow:
IF A dependent segment has been prepared with updated key
AND The system performs the insert operation
THEN:
- • Insert the dependent segment as a child of the new log root record
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when dependent segment has been inserted into the new log structure.
Trigger Criteria:
- Context: A dependent segment has been inserted into the new log structure
- Applied to: More Segments to Transfer?
- Action: The system checks the loop counter and segment availability
Logic Flow:
IF A dependent segment has been inserted into the new log structure
AND The system checks the loop counter and segment availability
THEN:
- • If counter is less than or equal to 100 and segment is not empty, continue processing,
otherwise proceed to cleanup
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when all dependent segments have been successfully transferred to new log structure.
Trigger Criteria:
- Context: All dependent segments have been successfully transferred to new log structure
- Applied to: Position to Old Log Root
- Action: The system prepares to delete the old log structure
Logic Flow:
IF All dependent segments have been successfully transferred to new log structure
AND The system prepares to delete the old log structure
THEN:
- • Use get hold unique operation to position on the old log root using the old CCN
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has positioned to the old log root location.
Trigger Criteria:
- Context: The system has positioned to the old log root location
- Applied to: Old Log Root Still Exists?
- Action: The positioning operation completes
Logic Flow:
IF The system has positioned to the old log root location
AND The positioning operation completes
THEN:
- • If status indicates successful positioning, proceed with deletion,
otherwise complete transfer process
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when old log root has been located and transfer is complete.
Trigger Criteria:
- Context: The old log root has been located and transfer is complete
- Applied to: Delete Old Log Root and All Segments
- Action: The system performs the delete operation
Logic Flow:
IF The old log root has been located and transfer is complete
AND The system performs the delete operation
THEN:
- • Delete the old log root record which cascades to remove all associated dependent segments
R-GCX105-cbl-00046 (+4) File: GCX105.cbl Business Rule: Delete Log Processing
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when delete log request is being processed.
Trigger Criteria:
- Context: A delete log request is being processed
- Applied to: Set CCN as Search Key
- Action: The system prepares to search for existing log entries
Logic Flow:
IF A delete log request is being processed
AND The system prepares to search for existing log entries
THEN:
- • The Train or US CCN from input is set as the search key for log root lookup
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn search key has been set.
Trigger Criteria:
- Context: The CCN search key has been set
- Applied to: Search for Existing Log Root Entry
- Action: The system searches for the log root entry in the database
Logic Flow:
IF The CCN search key has been set
AND The system searches for the log root entry in the database
THEN:
- • The system retrieves the log root entry if it exists or determines it is not found
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when search for log root entry has been completed.
Trigger Criteria:
- Context: A search for log root entry has been completed
- Applied to: Log Root Entry Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search for log root entry has been completed
AND The system evaluates the search results
THEN:
- • If log root entry is found, proceed with deletion;
otherwise, no action is required
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log root entry exists for the specified ccn.
Trigger Criteria:
- Context: A log root entry exists for the specified CCN
- Applied to: Delete Complete Log Structure
- Action: The system processes the delete request
Logic Flow:
IF A log root entry exists for the specified CCN
AND The system processes the delete request
THEN:
- • The complete log structure including root and all detail records is deleted from the database
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when no log root entry exists for the specified ccn.
Trigger Criteria:
- Context: No log root entry exists for the specified CCN
- Applied to: No Action Required - Log Not Found
- Action: The system processes the delete request
Logic Flow:
IF No log root entry exists for the specified CCN
AND The system processes the delete request
THEN:
- • No deletion action is performed and processing continues normally
R-GCX105-cbl-00051 (+5) File: GCX105.cbl Business Rule: Format Log Root Segment
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log root segment structure exists in memory.
Trigger Criteria:
- Context: A log root segment structure exists in memory
- Applied to: Initialize Root Segment Structure
- Action: The format log root process begins
Logic Flow:
IF A log root segment structure exists in memory
AND The format log root process begins
THEN:
- • The log root segment structure is initialized to empty values and the input message structure is cleared
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when input message contains a train or us ccn number.
Trigger Criteria:
- Context: An input message contains a train or US CCN number
- Applied to: Set Train/CCN as Primary Key & Set Train/CCN as Key Value
- Action: Formatting the log root segment
Logic Flow:
IF An input message contains a train or US CCN number
AND Formatting the log root segment
THEN:
- • The train or US CCN number from the input message is assigned as the primary key in the log root segment
- • The train or US CCN number from the input message is assigned as the key value in the log root segment
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has access to the current machine date.
Trigger Criteria:
- Context: The system has access to the current machine date
- Applied to: Set Current Load Date
- Action: Formatting the log root segment
Logic Flow:
IF The system has access to the current machine date
AND Formatting the log root segment
THEN:
- • The current machine date in YYMMDD format is assigned to the loaded date field in the log root segment
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when system has access to the current machine century.
Trigger Criteria:
- Context: The system has access to the current machine century
- Applied to: Set Current Load Century
- Action: Formatting the log root segment
Logic Flow:
IF The system has access to the current machine century
AND Formatting the log root segment
THEN:
- • The current machine century is assigned to the loaded date century field in the log root segment
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when input message contains a record type code.
Trigger Criteria:
- Context: An input message contains a record type code
- Applied to: Set Record Type Code
- Action: Formatting the log root segment
Logic Flow:
IF An input message contains a record type code
AND Formatting the log root segment
THEN:
- • The record type code from the input message is assigned to the record type field in the log root segment
R-GCX105-cbl-00057 (+3) File: GCX105.cbl Business Rule: Insert Log Root Segment
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when formatted log root segment is ready for insertion into the log database.
Trigger Criteria:
- Context: A formatted log root segment is ready for insertion into the log database
- Applied to: Insert root segment into log database with duplicate handling
- Action: The system attempts to insert the log root segment
Logic Flow:
IF A formatted log root segment is ready for insertion into the log database
AND The system attempts to insert the log root segment
THEN:
- • If insertion succeeds, the operation completes successfully, but if insertion fails due to duplicate key, the system retrieves the existing segment to maintain data consistency
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when system is preparing to insert a log root segment.
Trigger Criteria:
- Context: The system is preparing to insert a log root segment
- Applied to: Set Accept Status for Insert
- Action: The insert operation is initiated
Logic Flow:
IF The system is preparing to insert a log root segment
AND The insert operation is initiated
THEN:
- • The accept status must be set to 'II' to indicate an insert operation
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log root segment insertion has been attempted and resulted in duplicate key status 'ii'.
Trigger Criteria:
- Context: A log root segment insertion has been attempted and resulted in duplicate key status 'II'
- Applied to: Insert Successful?
- Action: The system detects the duplicate key condition
Logic Flow:
IF A log root segment insertion has been attempted and resulted in duplicate key status 'II'
AND The system detects the duplicate key condition
THEN:
- • The system must perform a retrieval operation to get the existing segment using the same key
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when log root segment insert operation has been completed (either successful insert or duplicate key handling).
Trigger Criteria:
- Context: A log root segment insert operation has been completed (either successful insert or duplicate key handling)
- Applied to: Record Insert Status
- Action: The operation finishes
Logic Flow:
IF A log root segment insert operation has been completed (either successful insert or duplicate key handling)
AND The operation finishes
THEN:
- • The final status code must be recorded in the working storage indicator for the log root operation
R-GCX105-cbl-00061 (+25) File: GCX105.cbl Business Rule: Format Log Dependent Segment
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log dependent segment needs to be created.
Trigger Criteria:
- Context: A log dependent segment needs to be created
- Applied to: Initialize Dependent Segment
- Action: The format log dependent process begins
Logic Flow:
IF A log dependent segment needs to be created
AND The format log dependent process begins
THEN:
- • The dependent segment structure is initialized to clear any previous data
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when input contains date and time information.
Trigger Criteria:
- Context: Input contains date and time information
- Applied to: Set Date and Time Information
- Action: Formatting the log dependent segment
Logic Flow:
IF Input contains date and time information
AND Formatting the log dependent segment
THEN:
- • The date is moved to the dependent segment date field and time is moved to the dependent segment time field
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when date and time information is available.
Trigger Criteria:
- Context: Date and time information is available
- Applied to: Generate Unique Key from Date/Time
- Action: Creating a log dependent segment
Logic Flow:
IF Date and time information is available
AND Creating a log dependent segment
THEN:
- • A unique key is computed as nines complement minus the combined date-time value and assigned to the dependent segment key
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when input contains action code, user id, and sending transaction information.
Trigger Criteria:
- Context: Input contains action code, user ID, and sending transaction information
- Applied to: Set Action Code and User Information
- Action: Formatting the log dependent segment
Logic Flow:
IF Input contains action code, user ID, and sending transaction information
AND Formatting the log dependent segment
THEN:
- • The action code is moved to dependent segment action code field, ACF2 ID is moved to user code field, and sending transaction is moved to transaction field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'mmr'.
Trigger Criteria:
- Context: Action code is 'MMR'
- Applied to: Format Manual Release Message - MMR
- Action: Processing a manual release action
Logic Flow:
IF Action code is 'MMR'
AND Processing a manual release action
THEN:
- • The input message is moved to MMR message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'zzz'.
Trigger Criteria:
- Context: Action code is 'ZZZ'
- Applied to: Format Direct Message - ZZZ
- Action: Processing a direct message action
Logic Flow:
IF Action code is 'ZZZ'
AND Processing a direct message action
THEN:
- • The input message is moved directly to the dependent segment message field without additional formatting
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'cat'.
Trigger Criteria:
- Context: Action code is 'CAT'
- Applied to: Format Cargo Added to Train - CAT
- Action: Processing a cargo added to train action
Logic Flow:
IF Action code is 'CAT'
AND Processing a cargo added to train action
THEN:
- • The input message is moved to CAT message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'cdt'.
Trigger Criteria:
- Context: Action code is 'CDT'
- Applied to: Format Cargo Deleted from Train - CDT
- Action: Processing a cargo deleted from train action
Logic Flow:
IF Action code is 'CDT'
AND Processing a cargo deleted from train action
THEN:
- • The input message is moved to CDT message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'cfr'.
Trigger Criteria:
- Context: Action code is 'CFR'
- Applied to: Format Cargo Print Faxing - CFR
- Action: Processing a cargo print faxing action
Logic Flow:
IF Action code is 'CFR'
AND Processing a cargo print faxing action
THEN:
- • The input message is moved to CFR message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'cpr'.
Trigger Criteria:
- Context: Action code is 'CPR'
- Applied to: Format Cargo Print Merlin ID - CPR
- Action: Processing a cargo print Merlin ID action
Logic Flow:
IF Action code is 'CPR'
AND Processing a cargo print Merlin ID action
THEN:
- • The input message is moved to CPR message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'cpz'.
Trigger Criteria:
- Context: Action code is 'CPZ'
- Applied to: Format Cargo Print Zebra - CPZ
- Action: Processing a cargo print Zebra action
Logic Flow:
IF Action code is 'CPZ'
AND Processing a cargo print Zebra action
THEN:
- • The input message is moved to CPZ message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'ctp'.
Trigger Criteria:
- Context: Action code is 'CTP'
- Applied to: Format Cargo Transfer Print - CTP
- Action: Processing a cargo transfer print action
Logic Flow:
IF Action code is 'CTP'
AND Processing a cargo transfer print action
THEN:
- • The input message is moved to CTP message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'rno'.
Trigger Criteria:
- Context: Action code is 'RNO'
- Applied to: Format Cargo Renumber Old - RNO
- Action: Processing a cargo renumber old action
Logic Flow:
IF Action code is 'RNO'
AND Processing a cargo renumber old action
THEN:
- • The input message is moved to RNO message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'rnn'.
Trigger Criteria:
- Context: Action code is 'RNN'
- Applied to: Format Cargo Renumber New - RNN
- Action: Processing a cargo renumber new action
Logic Flow:
IF Action code is 'RNN'
AND Processing a cargo renumber new action
THEN:
- • The input message is moved to RNN message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when action code is 'mc'.
Trigger Criteria:
- Context: Action code is 'MC'
- Applied to: Format Manual Cargo Change - MC
- Action: Processing a manual cargo change action
Logic Flow:
IF Action code is 'MC'
AND Processing a manual cargo change action
THEN:
- • The input message is moved to MC reason code field, bond type is moved to MC bond type field, and the complete MC message is moved to dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'tff'.
Trigger Criteria:
- Context: Action code is 'TFF'
- Applied to: Format Transfer From - TFF
- Action: Processing a transfer from action
Logic Flow:
IF Action code is 'TFF'
AND Processing a transfer from action
THEN:
- • The input message is moved to TFF message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'tft'.
Trigger Criteria:
- Context: Action code is 'TFT'
- Applied to: Format Transfer To - TFT
- Action: Processing a transfer to action
Logic Flow:
IF Action code is 'TFT'
AND Processing a transfer to action
THEN:
- • The input message is moved to TFT message info structure and
then to the dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when action code is 'md'.
Trigger Criteria:
- Context: Action code is 'MD'
- Applied to: Format Manual Cargo Delete - MD
- Action: Processing a manual cargo delete action
Logic Flow:
IF Action code is 'MD'
AND Processing a manual cargo delete action
THEN:
- • The input message is moved to MD reason code field, bond type is moved to MD bond type field, and the complete MD message is moved to dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'hnf'.
Trigger Criteria:
- Context: Action code is 'HNF'
- Applied to: Format Equipment Hold Not Found - HNF
- Action: Processing an equipment hold not found action
Logic Flow:
IF Action code is 'HNF'
AND Processing an equipment hold not found action
THEN:
- • The input message is moved to HNF message equipment ID field and the complete HNF message is moved to dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'hid'.
Trigger Criteria:
- Context: Action code is 'HID'
- Applied to: Format Equipment Hold ID - HID
- Action: Processing an equipment hold ID action
Logic Flow:
IF Action code is 'HID'
AND Processing an equipment hold ID action
THEN:
- • The input message is moved to HID message equipment ID field and the complete HID message is moved to dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'rid'.
Trigger Criteria:
- Context: Action code is 'RID'
- Applied to: Format Equipment Release ID - RID
- Action: Processing an equipment release ID action
Logic Flow:
IF Action code is 'RID'
AND Processing an equipment release ID action
THEN:
- • The input message is moved to RID message equipment ID field and the complete RID message is moved to dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'szi'.
Trigger Criteria:
- Context: Action code is 'SZI'
- Applied to: Format Equipment Seize ID - SZI
- Action: Processing an equipment seize ID action
Logic Flow:
IF Action code is 'SZI'
AND Processing an equipment seize ID action
THEN:
- • The input message is moved to SZI message equipment ID field and the complete SZI message is moved to dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code is 'szr'.
Trigger Criteria:
- Context: Action code is 'SZR'
- Applied to: Format Equipment Seize Release - SZR
- Action: Processing an equipment seize release action
Logic Flow:
IF Action code is 'SZR'
AND Processing an equipment seize release action
THEN:
- • The input message is moved to SZR message equipment ID field and the complete SZR message is moved to dependent segment message field
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when action code does not match any predefined codes.
Trigger Criteria:
- Context: Action code does not match any predefined codes
- Applied to: Lookup Unknown Action Code in Table
- Action: Processing an unknown action code
Logic Flow:
IF Action code does not match any predefined codes
AND Processing an unknown action code
THEN:
- • The system searches the log table for the action code and uses the corresponding message, or generates an error message with the unknown action code if not found
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when action code is 'ca' and bond type is not spaces.
Trigger Criteria:
- Context: Action code is 'CA' and bond type is not spaces
- Applied to: Lookup Unknown Action Code in Table
- Action: Processing a cargo created automatically action with bond type
Logic Flow:
IF Action code is 'CA' and bond type is not spaces
AND Processing a cargo created automatically action with bond type
THEN:
- • The message is formatted as 'CARGO CREATED AUTOMATICALLY TP:' concatenated with the bond type
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when log dependent segment is being formatted.
Trigger Criteria:
- Context: A log dependent segment is being formatted
- Applied to: Set Load Date and Time
- Action: Completing the dependent segment formatting
Logic Flow:
IF A log dependent segment is being formatted
AND Completing the dependent segment formatting
THEN:
- • The current machine date is moved to load date field and current machine time is moved to load time field
R-GCX105-cbl-00087 (+1) File: GCX105.cbl Business Rule: Process Manual Release Messages
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log entry is being processed with an action code.
Trigger Criteria:
- Context: A log entry is being processed with an action code
- Applied to: Check Action Code = 'MMR'
- Action: The action code equals 'MMR'
Logic Flow:
IF A log entry is being processed with an action code
AND The action code equals 'MMR'
THEN:
- • The system should extract the message information and format it as a manual release message structure
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when action code has been identified as 'mmr'.
Trigger Criteria:
- Context: An action code has been identified as 'MMR'
- Applied to: Format MMR Message
- Action: The message needs to be formatted
Logic Flow:
IF An action code has been identified as 'MMR'
AND The message needs to be formatted
THEN:
- • The system should move the input message to MMR-MESSAGE-INFO structure and
then move the formatted MMR-MESSAGE to the log detail message field
R-GCX105-cbl-00089 File: GCX105.cbl Business Rule: Process Direct Message Entries
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log detail record is being formatted for insertion.
Trigger Criteria:
- Context: A log detail record is being formatted for insertion
- Applied to: Move Input Message Directly to Log Message
- Action: The action code from the input message equals 'ZZZ'
Logic Flow:
IF A log detail record is being formatted for insertion
AND The action code from the input message equals 'ZZZ'
THEN:
- • The input message is moved directly to the log detail message field without any formatting applied
R-GCX105-cbl-00090 (+1) File: GCX105.cbl Business Rule: Process Cargo Train Operations
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when input message contains cargo train operation data with action code 'cat'.
Trigger Criteria:
- Context: An input message contains cargo train operation data with action code 'CAT'
- Applied to: Process Cargo Added to Train - CAT
- Action: The system processes the cargo added to train operation
Logic Flow:
IF An input message contains cargo train operation data with action code 'CAT'
AND The system processes the cargo added to train operation
THEN:
- • The system extracts cargo information from the input message, formats it as a CAT message, and stores the formatted message for the log entry
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when input message contains cargo train operation data with action code 'cdt'.
Trigger Criteria:
- Context: An input message contains cargo train operation data with action code 'CDT'
- Applied to: Process Cargo Deleted from Train - CDT
- Action: The system processes the cargo deleted from train operation
Logic Flow:
IF An input message contains cargo train operation data with action code 'CDT'
AND The system processes the cargo deleted from train operation
THEN:
- • The system extracts cargo information from the input message, formats it as a CDT message, and stores the formatted message for the log entry
R-GCX105-cbl-00092 (+1) File: GCX105.cbl Business Rule: Process Cargo Print Operations
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail record is being processed.
Trigger Criteria:
- Context: A log detail record is being processed
- Applied to: Extract Cargo Fax Print Information
- Action: The action code is 'CFR' (Cargo Fax Print)
Logic Flow:
IF A log detail record is being processed
AND The action code is 'CFR' (Cargo Fax Print)
THEN:
- • The system extracts the message as CFR message information and formats it as a CFR message for fax printing
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail record is being processed.
Trigger Criteria:
- Context: A log detail record is being processed
- Applied to: Extract Cargo Print Information
- Action: The action code is 'CPR' (Cargo Print)
Logic Flow:
IF A log detail record is being processed
AND The action code is 'CPR' (Cargo Print)
THEN:
- • The system extracts the message as CPR message information and formats it as a CPR message for Merlin ID printing
R-GCX105-cbl-00094 (+2) File: GCX105.cbl Business Rule: Process Cargo Renumbering
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when cargo log entry is being processed.
Trigger Criteria:
- Context: A cargo log entry is being processed
- Applied to: Process RNO - Renumber From Operation
- Action: The action code is 'RNO' (Renumber From Operation)
Logic Flow:
IF A cargo log entry is being processed
AND The action code is 'RNO' (Renumber From Operation)
THEN:
- • The system should extract the original cargo information from the input message and format it as an RNO message structure for logging
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when cargo log entry is being processed.
Trigger Criteria:
- Context: A cargo log entry is being processed
- Applied to: Process RNN - Renumber To Operation
- Action: The action code is 'RNN' (Renumber To Operation)
Logic Flow:
IF A cargo log entry is being processed
AND The action code is 'RNN' (Renumber To Operation)
THEN:
- • The system should extract the new cargo information from the input message and format it as an RNN message structure for logging
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when cargo renumbering message has been formatted (either rno or rnn).
Trigger Criteria:
- Context: A cargo renumbering message has been formatted (either RNO or RNN)
- Applied to: Store Formatted Message for Log
- Action: The message formatting is complete
Logic Flow:
IF A cargo renumbering message has been formatted (either RNO or RNN)
AND The message formatting is complete
THEN:
- • The formatted message should be moved to the log detail message field for storage
R-GCX105-cbl-00097 (+1) File: GCX105.cbl Business Rule: Process Cargo Transfer Operations
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when log detail record is being processed for message formatting.
Trigger Criteria:
- Context: A log detail record is being processed for message formatting
- Applied to: Extract Transfer To Message Info
- Action: The action code is 'TFT' indicating a transfer-to operation
Logic Flow:
IF A log detail record is being processed for message formatting
AND The action code is 'TFT' indicating a transfer-to operation
THEN:
- • The system extracts the message information as TFT message format and assigns it to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log detail record is being processed for message formatting and the action code is not 'tft'.
Trigger Criteria:
- Context: A log detail record is being processed for message formatting and the action code is not 'TFT'
- Applied to: Extract Transfer From Message Info
- Action: The action code is 'TFF' indicating a transfer-from operation
Logic Flow:
IF A log detail record is being processed for message formatting and the action code is not 'TFT'
AND The action code is 'TFF' indicating a transfer-from operation
THEN:
- • The system extracts the message information as TFF message format and assigns it to the log detail message field
R-GCX105-cbl-00099 (+1) File: GCX105.cbl Business Rule: Process Manual Cargo Changes
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail record is being processed with action code 'mc'.
Trigger Criteria:
- Context: A log detail record is being processed with action code 'MC'
- Applied to: Check Action Code
- Action: The system processes the manual cargo change action
Logic Flow:
IF A log detail record is being processed with action code 'MC'
AND The system processes the manual cargo change action
THEN:
- • The system extracts the reason code from the input message, extracts the bond type from the input, and formats a manual cargo change message with both pieces of information
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail record is being processed with action code 'md'.
Trigger Criteria:
- Context: A log detail record is being processed with action code 'MD'
- Applied to: Check Action Code
- Action: The system processes the manual cargo deletion action
Logic Flow:
IF A log detail record is being processed with action code 'MD'
AND The system processes the manual cargo deletion action
THEN:
- • The system extracts the reason code from the input message, extracts the bond type from the input, and formats a manual cargo deletion message with both pieces of information
R-GCX105-cbl-00101 (+4) File: GCX105.cbl Business Rule: Process Equipment Hold Operations
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when input message with action code 'hnf' and equipment information in the message field.
Trigger Criteria:
- Context: An input message with action code 'HNF' and equipment information in the message field
- Applied to: HNF - Equipment Not Found
- Action: The system processes the equipment not found operation
Logic Flow:
IF An input message with action code 'HNF' and equipment information in the message field
AND The system processes the equipment not found operation
THEN:
- • The equipment ID is extracted from the input message and formatted into the HNF message structure, which is
then stored as the log detail message
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when input message with action code 'hid' and equipment information in the message field.
Trigger Criteria:
- Context: An input message with action code 'HID' and equipment information in the message field
- Applied to: HID - Equipment Hold
- Action: The system processes the equipment hold operation
Logic Flow:
IF An input message with action code 'HID' and equipment information in the message field
AND The system processes the equipment hold operation
THEN:
- • The equipment ID is extracted from the input message and formatted into the HID message structure, which is
then stored as the log detail message
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when input message with action code 'rid' and equipment information in the message field.
Trigger Criteria:
- Context: An input message with action code 'RID' and equipment information in the message field
- Applied to: RID - Equipment Release
- Action: The system processes the equipment release operation
Logic Flow:
IF An input message with action code 'RID' and equipment information in the message field
AND The system processes the equipment release operation
THEN:
- • The equipment ID is extracted from the input message and formatted into the RID message structure, which is
then stored as the log detail message
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when input message with action code 'szi' and equipment information in the message field.
Trigger Criteria:
- Context: An input message with action code 'SZI' and equipment information in the message field
- Applied to: SZI - Equipment Seize
- Action: The system processes the equipment seize operation
Logic Flow:
IF An input message with action code 'SZI' and equipment information in the message field
AND The system processes the equipment seize operation
THEN:
- • The equipment ID is extracted from the input message and formatted into the SZI message structure, which is
then stored as the log detail message
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when input message with action code 'szr' and equipment information in the message field.
Trigger Criteria:
- Context: An input message with action code 'SZR' and equipment information in the message field
- Applied to: SZR - Equipment Seize Release
- Action: The system processes the equipment seize release operation
Logic Flow:
IF An input message with action code 'SZR' and equipment information in the message field
AND The system processes the equipment seize release operation
THEN:
- • The equipment ID is extracted from the input message and formatted into the SZR message structure, which is
then stored as the log detail message
R-GCX105-cbl-00106 (+4) File: GCX105.cbl Business Rule: Process Equipment Not Found
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log entry request is received with action code 'hnf'.
Trigger Criteria:
- Context: A log entry request is received with action code 'HNF'
- Applied to: Format Equipment Not Found Message
- Action: The system processes the message formatting for the log detail record
Logic Flow:
IF A log entry request is received with action code 'HNF'
AND The system processes the message formatting for the log detail record
THEN:
- • The equipment ID from the input message is moved to the HNF message format and the formatted HNF message is assigned to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log entry request is received with action code 'hid'.
Trigger Criteria:
- Context: A log entry request is received with action code 'HID'
- Applied to: Format Equipment Not Found Message
- Action: The system processes the message formatting for the log detail record
Logic Flow:
IF A log entry request is received with action code 'HID'
AND The system processes the message formatting for the log detail record
THEN:
- • The equipment ID from the input message is moved to the HID message format and the formatted HID message is assigned to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log entry request is received with action code 'rid'.
Trigger Criteria:
- Context: A log entry request is received with action code 'RID'
- Applied to: Format Equipment Not Found Message
- Action: The system processes the message formatting for the log detail record
Logic Flow:
IF A log entry request is received with action code 'RID'
AND The system processes the message formatting for the log detail record
THEN:
- • The equipment ID from the input message is moved to the RID message format and the formatted RID message is assigned to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log entry request is received with action code 'szi'.
Trigger Criteria:
- Context: A log entry request is received with action code 'SZI'
- Applied to: Format Equipment Not Found Message
- Action: The system processes the message formatting for the log detail record
Logic Flow:
IF A log entry request is received with action code 'SZI'
AND The system processes the message formatting for the log detail record
THEN:
- • The equipment ID from the input message is moved to the SZI message format and the formatted SZI message is assigned to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log entry request is received with action code 'szr'.
Trigger Criteria:
- Context: A log entry request is received with action code 'SZR'
- Applied to: Format Equipment Not Found Message
- Action: The system processes the message formatting for the log detail record
Logic Flow:
IF A log entry request is received with action code 'SZR'
AND The system processes the message formatting for the log detail record
THEN:
- • The equipment ID from the input message is moved to the SZR message format and the formatted SZR message is assigned to the log detail message field
R-GCX105-cbl-00111 (+3) File: GCX105.cbl Business Rule: Lookup Unknown Action Codes
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when action code that needs message lookup and a log table with predefined action codes and messages.
Trigger Criteria:
- Context: An action code that needs message lookup and a log table with predefined action codes and messages
- Applied to: Search Log Table for Action Code
- Action: The system searches the log table for the action code
Logic Flow:
IF An action code that needs message lookup and a log table with predefined action codes and messages
AND The system searches the log table for the action code
THEN:
- • If the action code is found in the table, the corresponding table message is used; if not found, the system continues to error handling
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when action code that was not found in the log table during search.
Trigger Criteria:
- Context: An action code that was not found in the log table during search
- Applied to: Move Action Code to Error Message
- Action: The table search completes without finding a match
Logic Flow:
IF An action code that was not found in the log table during search
AND The table search completes without finding a match
THEN:
- • The unknown action code is moved to an error message field and the error message is used as the log message
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when action code that exists in the log table with a corresponding message.
Trigger Criteria:
- Context: An action code that exists in the log table with a corresponding message
- Applied to: Move Table Message to Log Message
- Action: The table search finds a matching action code entry
Logic Flow:
IF An action code that exists in the log table with a corresponding message
AND The table search finds a matching action code entry
THEN:
- • The predefined message from the table entry is moved to the log message field
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when action code of 'ca' and a bond type field that is not empty.
Trigger Criteria:
- Context: An action code of 'CA' and a bond type field that is not empty
- Applied to: Format Special Cargo Message with Bond Type
- Action: The system processes the cargo creation action
Logic Flow:
IF An action code of 'CA' and a bond type field that is not empty
AND The system processes the cargo creation action
THEN:
- • A formatted message is created containing 'CARGO CREATED AUTOMATICALLY TP:' followed by the bond type value
R-GCX105-cbl-00115 (+3) File: GCX105.cbl Business Rule: Insert Log Dependent Segment
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log dependent segment is ready for insertion into the database.
Trigger Criteria:
- Context: A log dependent segment is ready for insertion into the database
- Applied to: Insert Log Dependent Segment
- Action: The insert operation is attempted
Logic Flow:
IF A log dependent segment is ready for insertion into the database
AND The insert operation is attempted
THEN:
- • The segment should be successfully inserted into the log database
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log dependent segment insertion fails due to duplicate key error (status code 'ii').
Trigger Criteria:
- Context: A log dependent segment insertion fails due to duplicate key error (status code 'II')
- Applied to: Handle Key Conflicts - Retry with Decremented Key
- Action: The duplicate key conflict is detected
Logic Flow:
IF A log dependent segment insertion fails due to duplicate key error (status code 'II')
AND The duplicate key conflict is detected
THEN:
- • The system should perform retry logic up to 50 times with decremented key values
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when duplicate key error has occurred during insert operation.
Trigger Criteria:
- Context: A duplicate key error has occurred during insert operation
- Applied to: Decrement Key Value by 1
- Action: The retry logic is executed
Logic Flow:
IF A duplicate key error has occurred during insert operation
AND The retry logic is executed
THEN:
- • The key value should be decremented by 1 and used for the next insert attempt
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when multiple duplicate key conflicts occur during log dependent segment insertion.
Trigger Criteria:
- Context: Multiple duplicate key conflicts occur during log dependent segment insertion
- Applied to: Maximum Retries Reached
- Action: The retry operation is performed 50 times
Logic Flow:
IF Multiple duplicate key conflicts occur during log dependent segment insertion
AND The retry operation is performed 50 times
THEN:
- • The system should stop retrying and complete the operation
R-GCX105-cbl-00119 (+3) File: GCX105.cbl Business Rule: Handle Key Conflicts
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when log detail record is being inserted into the database.
Trigger Criteria:
- Context: A log detail record is being inserted into the database
- Applied to: Duplicate Key Detected?
- Action: The insertion fails due to a duplicate key conflict (status code 'II')
Logic Flow:
IF A log detail record is being inserted into the database
AND The insertion fails due to a duplicate key conflict (status code 'II')
THEN:
- • The system decrements the key value by 1 and retries the insertion operation
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when duplicate key conflict occurs during log detail insertion.
Trigger Criteria:
- Context: A duplicate key conflict occurs during log detail insertion
- Applied to: Retry Count < 50?
- Action: The system has already attempted to resolve the conflict multiple times
Logic Flow:
IF A duplicate key conflict occurs during log detail insertion
AND The system has already attempted to resolve the conflict multiple times
THEN:
- • The system performs up to 50 retry attempts before stopping the resolution process
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when duplicate key conflict exists for a log detail record.
Trigger Criteria:
- Context: A duplicate key conflict exists for a log detail record
- Applied to: Decrement Key Value by 1
- Action: The system needs to resolve the key conflict
Logic Flow:
IF A duplicate key conflict exists for a log detail record
AND The system needs to resolve the key conflict
THEN:
- • The system computes a new key by subtracting 1 from the current key value and updates the log detail segment key
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when log detail record key has been decremented to resolve a duplicate key conflict.
Trigger Criteria:
- Context: A log detail record key has been decremented to resolve a duplicate key conflict
- Applied to: Retry Insert Operation
- Action: The system is ready to retry the insertion
Logic Flow:
IF A log detail record key has been decremented to resolve a duplicate key conflict
AND The system is ready to retry the insertion
THEN:
- • The system attempts to insert the log detail record using the modified key value
R-GCX105-cbl-00123 (+4) File: GCX105.cbl Business Rule: Spawn Vista GUI Transaction
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when log record has been processed with a specific record type code and processing status indicators.
Trigger Criteria:
- Context: A log record has been processed with a specific record type code and processing status indicators
- Applied to: Start Vista GUI Transaction
- Action: The record type code is 'CC' (Canadian Cargo) or 'UC' (US Cargo) and both log root insertion and log dependent insertion were successful
Logic Flow:
IF A log record has been processed with a specific record type code and processing status indicators
AND The record type code is 'CC' (Canadian Cargo) or 'UC' (US Cargo) and both log root insertion and log dependent insertion were successful
THEN:
- • The system should initiate Vista GUI transaction processing
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log root segment and log dependent segment have been successfully created and are available in memory.
Trigger Criteria:
- Context: Log root segment and log dependent segment have been successfully created and are available in memory
- Applied to: Prepare Log Message for Vista
- Action: Vista GUI transaction processing is initiated
Logic Flow:
IF Log root segment and log dependent segment have been successfully created and are available in memory
AND Vista GUI transaction processing is initiated
THEN:
- • The system should move the log root segment to Vista GUI log root segment field and move the log dependent segment to Vista GUI log dependent segment field
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when vista gui message data has been prepared with log segments.
Trigger Criteria:
- Context: Vista GUI message data has been prepared with log segments
- Applied to: Initialize Vista Transaction
- Action: Vista transaction initialization is requested
Logic Flow:
IF Vista GUI message data has been prepared with log segments
AND Vista transaction initialization is requested
THEN:
- • The system should move the Vista input message to the Vista transaction message structure and clear the communication status to prepare for message transmission
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when vista transaction has been initialized with prepared message data.
Trigger Criteria:
- Context: Vista transaction has been initialized with prepared message data
- Applied to: Send Log Message to Vista GUI
- Action: Message transmission to Vista GUI is requested
Logic Flow:
IF Vista transaction has been initialized with prepared message data
AND Message transmission to Vista GUI is requested
THEN:
- • The system should change the alternate PCB to prepare for message transmission and write the message to Vista GUI using the message code, message content, message length, and module name
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log message has been successfully transmitted to vista gui system.
Trigger Criteria:
- Context: Log message has been successfully transmitted to Vista GUI system
- Applied to: Complete Vista Transaction
- Action: Vista transaction completion is requested
Logic Flow:
IF Log message has been successfully transmitted to Vista GUI system
AND Vista transaction completion is requested
THEN:
- • The system should purge the alternate PCB to complete the message transmission and finalize the Vista GUI transaction
R-GCX105-cbl-00128 (+4) File: GCX105.cbl Business Rule: Find Existing Log Root
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when transfer log operation is being performed.
Trigger Criteria:
- Context: A transfer log operation is being performed
- Applied to: Set Search Key to Old CCN
- Action: The system needs to find an existing log root entry
Logic Flow:
IF A transfer log operation is being performed
AND The system needs to find an existing log root entry
THEN:
- • The search key is set to the old CCN value from the input message
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when search key has been set to the old ccn. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The search key has been set to the old CCN
- Applied to: Search Log Database for Root Entry
- Action: The system executes the database search operation
Logic Flow:
IF The search key has been set to the old CCN
AND The system executes the database search operation
THEN:
- • A database call is made to retrieve the log root segment using the search criteria
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when database search for log root entry has been executed.
Trigger Criteria:
- Context: A database search for log root entry has been executed
- Applied to: Root Entry Found?
- Action: The system evaluates the search results
Logic Flow:
IF A database search for log root entry has been executed
AND The system evaluates the search results
THEN:
- • If the database status code is blank spaces, the log root is considered found,
otherwise it is considered not found
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when database search returned a successful result with blank status code.
Trigger Criteria:
- Context: The database search returned a successful result with blank status code
- Applied to: Old Log Root Found
- Action: The system processes the successful search result
Logic Flow:
IF The database search returned a successful result with blank status code
AND The system processes the successful search result
THEN:
- • The old log root found indicator is set to true
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when database search returned a non-successful result with non-blank status code.
Trigger Criteria:
- Context: The database search returned a non-successful result with non-blank status code
- Applied to: Old Log Root Not Found
- Action: The system processes the unsuccessful search result
Logic Flow:
IF The database search returned a non-successful result with non-blank status code
AND The system processes the unsuccessful search result
THEN:
- • The old log root not found indicator is set to true
R-GCX105-cbl-00133 (+7) File: GCX105.cbl Business Rule: Retrieve Log Dependent Segments
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when transfer log operation is being performed.
Trigger Criteria:
- Context: A transfer log operation is being performed
- Applied to: Initialize Segment Counter to Zero
- Action: The system begins retrieving dependent segments from the old log
Logic Flow:
IF A transfer log operation is being performed
AND The system begins retrieving dependent segments from the old log
THEN:
- • The segment counter is set to zero and dependent segment storage area is cleared
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when old log root has been found and dependent segments need to be retrieved.
Trigger Criteria:
- Context: An old log root has been found and dependent segments need to be retrieved
- Applied to: Get Next Log Dependent Segment
- Action: The system requests the next dependent segment in sequence
Logic Flow:
IF An old log root has been found and dependent segments need to be retrieved
AND The system requests the next dependent segment in sequence
THEN:
- • The system performs a get-next-parent operation to retrieve the next log dependent segment
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when get-next-parent operation has been performed on log dependent segments.
Trigger Criteria:
- Context: A get-next-parent operation has been performed on log dependent segments
- Applied to: Segment Found?
- Action: The system checks the operation status
Logic Flow:
IF A get-next-parent operation has been performed on log dependent segments
AND The system checks the operation status
THEN:
- • If the status is successful (space), increment counter and store segment;
otherwise set not-found flag
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log dependent segment has been successfully retrieved.
Trigger Criteria:
- Context: A log dependent segment has been successfully retrieved
- Applied to: Increment Counter
- Action: The segment needs to be processed and stored
Logic Flow:
IF A log dependent segment has been successfully retrieved
AND The segment needs to be processed and stored
THEN:
- • The working storage subscript counter is incremented by 1
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when log dependent segment has been successfully retrieved and counter incremented.
Trigger Criteria:
- Context: A log dependent segment has been successfully retrieved and counter incremented
- Applied to: Store Segment in Memory Array
- Action: The segment needs to be preserved for transfer operation
Logic Flow:
IF A log dependent segment has been successfully retrieved and counter incremented
AND The segment needs to be preserved for transfer operation
THEN:
- • The entire log dependent segment is moved to the corresponding position in the working storage segment array
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when log dependent segments are being retrieved for transfer.
Trigger Criteria:
- Context: Log dependent segments are being retrieved for transfer
- Applied to: Counter < 100?
- Action: The system checks if more segments can be processed
Logic Flow:
IF Log dependent segments are being retrieved for transfer
AND The system checks if more segments can be processed
THEN:
- • If the counter is less than 100, continue retrieving;
otherwise stop the retrieval process
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when system is retrieving log dependent segments.
Trigger Criteria:
- Context: The system is retrieving log dependent segments
- Applied to: End - All Segments Retrieved
- Action: No more dependent segments are found in the database
Logic Flow:
IF The system is retrieving log dependent segments
AND No more dependent segments are found in the database
THEN:
- • The retrieval process ends and control returns to the calling procedure
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when system is retrieving log dependent segments for transfer.
Trigger Criteria:
- Context: The system is retrieving log dependent segments for transfer
- Applied to: End - Maximum Limit Reached
- Action: The segment counter reaches 100
Logic Flow:
IF The system is retrieving log dependent segments for transfer
AND The segment counter reaches 100
THEN:
- • The retrieval process stops even if more segments exist in the database
R-GCX105-cbl-00141 (+1) File: GCX105.cbl Business Rule: Delete Old Log Entries
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when log root segment exists in the database for the old ccn and the transfer operation has been completed.
Trigger Criteria:
- Context: A log root segment exists in the database for the old CCN and the transfer operation has been completed
- Applied to: Remove Log Root Segment from Database
- Action: The system initiates deletion of the old log root segment
Logic Flow:
IF A log root segment exists in the database for the old CCN and the transfer operation has been completed
AND The system initiates deletion of the old log root segment
THEN:
- • The log root segment is permanently removed from the GCSLGRT database
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when deletion operation is about to be performed.
Trigger Criteria:
- Context: A deletion operation is about to be performed
- Applied to: Initialize Status Codes
- Action: The system prepares for the deletion process
Logic Flow:
IF A deletion operation is about to be performed
AND The system prepares for the deletion process
THEN:
- • All status codes and accept status indicators are cleared to initial state
R-GCX105-cbl-00143 (+4) File: GCX105.cbl Business Rule: Format Manual Release Messages
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when log entry is being processed.
Trigger Criteria:
- Context: A log entry is being processed
- Applied to: Receive MMR Action Code
- Action: The action code equals 'MMR'
Logic Flow:
IF A log entry is being processed
AND The action code equals 'MMR'
THEN:
- • The system identifies this as an MMR message type requiring special formatting
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when mmr action code has been identified.
Trigger Criteria:
- Context: An MMR action code has been identified
- Applied to: Extract Message from Input
- Action: The message content needs to be processed
Logic Flow:
IF An MMR action code has been identified
AND The message content needs to be processed
THEN:
- • The system extracts the message from the GCX105 input structure
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been extracted from the input for mmr processing.
Trigger Criteria:
- Context: A message has been extracted from the input for MMR processing
- Applied to: Move Message to MMR Message Info Structure
- Action: The message needs to be structured for MMR format
Logic Flow:
IF A message has been extracted from the input for MMR processing
AND The message needs to be structured for MMR format
THEN:
- • The system moves the message content to the MMR message info structure
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when message has been placed in the mmr message info structure.
Trigger Criteria:
- Context: A message has been placed in the MMR message info structure
- Applied to: Format MMR Message
- Action: The message needs to be formatted according to MMR standards
Logic Flow:
IF A message has been placed in the MMR message info structure
AND The message needs to be formatted according to MMR standards
THEN:
- • The system formats the message content into the standardized MMR message format
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when mmr message has been properly formatted.
Trigger Criteria:
- Context: An MMR message has been properly formatted
- Applied to: Store Formatted Message in Log Segment
- Action: The formatted message needs to be persisted
Logic Flow:
IF An MMR message has been properly formatted
AND The formatted message needs to be persisted
THEN:
- • The system stores the formatted MMR message in the log detail segment message field
R-GCX105-cbl-00148 (+1) File: GCX105.cbl Business Rule: Format Direct Message Entries
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log entry is being processed with action code 'zzz'.
Trigger Criteria:
- Context: A log entry is being processed with action code 'ZZZ'
- Applied to: Check Action Code = 'ZZZ'
- Action: The system formats the log detail message
Logic Flow:
IF A log entry is being processed with action code 'ZZZ'
AND The system formats the log detail message
THEN:
- • The input message should be moved directly to the log message field without any formatting or transformation applied
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code has been identified as 'zzz'.
Trigger Criteria:
- Context: The action code has been identified as 'ZZZ'
- Applied to: Move Input Message Directly to Log Message
- Action: The message content needs to be stored in the log detail
Logic Flow:
IF The action code has been identified as 'ZZZ'
AND The message content needs to be stored in the log detail
THEN:
- • The original input message should be copied directly to the log detail message field without modification
R-GCX105-cbl-00150 (+2) File: GCX105.cbl Business Rule: Format Cargo Train Operations
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo train operation with action code 'cat' is being processed.
Trigger Criteria:
- Context: A cargo train operation with action code 'CAT' is being processed
- Applied to: Process CAT - Cargo Added to Train
- Action: The system encounters action code 'CAT' during message formatting
Logic Flow:
IF A cargo train operation with action code 'CAT' is being processed
AND The system encounters action code 'CAT' during message formatting
THEN:
- • The input message is moved to CAT message format structure and
then formatted into the log message field
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo train operation with action code 'cdt' is being processed.
Trigger Criteria:
- Context: A cargo train operation with action code 'CDT' is being processed
- Applied to: Process CDT - Cargo Deleted from Train
- Action: The system encounters action code 'CDT' during message formatting
Logic Flow:
IF A cargo train operation with action code 'CDT' is being processed
AND The system encounters action code 'CDT' during message formatting
THEN:
- • The input message is moved to CDT message format structure and
then formatted into the log message field
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo train operation is being processed for message formatting.
Trigger Criteria:
- Context: A cargo train operation is being processed for message formatting
- Applied to: Action Code?
- Action: The system checks the action code value
Logic Flow:
IF A cargo train operation is being processed for message formatting
AND The system checks the action code value
THEN:
- • If action code is 'CAT'
then process as cargo added to train,
else if action code is 'CDT'
then process as cargo deleted from train
R-GCX105-cbl-00153 (+3) File: GCX105.cbl Business Rule: Format Cargo Print Operations
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log detail record is being processed.
Trigger Criteria:
- Context: A log detail record is being processed
- Applied to: CFR - Cargo Print Faxing
- Action: The action code is 'CFR'
Logic Flow:
IF A log detail record is being processed
AND The action code is 'CFR'
THEN:
- • The system extracts message information into CFR format and moves the formatted CFR message to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log detail record is being processed.
Trigger Criteria:
- Context: A log detail record is being processed
- Applied to: CPR - Cargo Print Operations
- Action: The action code is 'CPR'
Logic Flow:
IF A log detail record is being processed
AND The action code is 'CPR'
THEN:
- • The system extracts message information into CPR format and moves the formatted CPR message to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log detail record is being processed.
Trigger Criteria:
- Context: A log detail record is being processed
- Applied to: CPZ - Merlin ID Printing
- Action: The action code is 'CPZ'
Logic Flow:
IF A log detail record is being processed
AND The action code is 'CPZ'
THEN:
- • The system extracts message information into CPZ format and moves the formatted CPZ message to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when log detail record is being processed.
Trigger Criteria:
- Context: A log detail record is being processed
- Applied to: CTP - Cargo Train Print
- Action: The action code is 'CTP'
Logic Flow:
IF A log detail record is being processed
AND The action code is 'CTP'
THEN:
- • The system extracts message information into CTP format and moves the formatted CTP message to the log detail message field
R-GCX105-cbl-00157 (+3) File: GCX105.cbl Business Rule: Format Cargo Renumbering Operations
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo renumbering request is received with action code 'rno'.
Trigger Criteria:
- Context: A cargo renumbering request is received with action code 'RNO'
- Applied to: Process RNO - Renumber Old Cargo
- Action: The system processes the renumbering operation
Logic Flow:
IF A cargo renumbering request is received with action code 'RNO'
AND The system processes the renumbering operation
THEN:
- • The message is formatted using RNO message structure and stored in the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo renumbering request is received with action code 'rnn'.
Trigger Criteria:
- Context: A cargo renumbering request is received with action code 'RNN'
- Applied to: Process RNN - Renumber New Cargo
- Action: The system processes the renumbering operation
Logic Flow:
IF A cargo renumbering request is received with action code 'RNN'
AND The system processes the renumbering operation
THEN:
- • The message is formatted using RNN message structure and stored in the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when action code is 'rno' and renumbering information exists in the input message.
Trigger Criteria:
- Context: The action code is 'RNO' and renumbering information exists in the input message
- Applied to: Format RNO Message with Old Cargo Details
- Action: The system formats the message for logging
Logic Flow:
IF The action code is 'RNO' and renumbering information exists in the input message
AND The system formats the message for logging
THEN:
- • The input message is moved to RNO message info structure and
then to the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when action code is 'rnn' and renumbering information exists in the input message.
Trigger Criteria:
- Context: The action code is 'RNN' and renumbering information exists in the input message
- Applied to: Format RNN Message with New Cargo Details
- Action: The system formats the message for logging
Logic Flow:
IF The action code is 'RNN' and renumbering information exists in the input message
AND The system formats the message for logging
THEN:
- • The input message is moved to RNN message info structure and
then to the log detail message field
R-GCX105-cbl-00161 (+1) File: GCX105.cbl Business Rule: Format Cargo Transfer Operations
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when log detail record is being processed and the action code is 'tft'.
Trigger Criteria:
- Context: A log detail record is being processed and the action code is 'TFT'
- Applied to: Format TFT Transfer To Message
- Action: The system processes the message formatting for the log entry
Logic Flow:
IF A log detail record is being processed and the action code is 'TFT'
AND The system processes the message formatting for the log entry
THEN:
- • The input message is moved to TFT message format structure and the formatted TFT message is stored in the log detail message field
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when log detail record is being processed and the action code is 'tff'.
Trigger Criteria:
- Context: A log detail record is being processed and the action code is 'TFF'
- Applied to: Format TFF Transfer From Message
- Action: The system processes the message formatting for the log entry
Logic Flow:
IF A log detail record is being processed and the action code is 'TFF'
AND The system processes the message formatting for the log entry
THEN:
- • The input message is moved to TFF message format structure and the formatted TFF message is stored in the log detail message field
R-GCX105-cbl-00163 (+1) File: GCX105.cbl Business Rule: Format Manual Cargo Changes
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail record is being formatted and the action code is 'mc'.
Trigger Criteria:
- Context: A log detail record is being formatted AND the action code is 'MC'
- Applied to: Process MC - Manual Cargo Change
- Action: The system processes the manual cargo change action
Logic Flow:
IF A log detail record is being formatted AND the action code is 'MC'
AND The system processes the manual cargo change action
THEN:
- • The system extracts the reason code from the message field AND extracts the bond type from the input AND formats the MC message with both reason code and bond type AND stores the formatted message in the log dependent segment
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail record is being formatted and the action code is 'md'.
Trigger Criteria:
- Context: A log detail record is being formatted AND the action code is 'MD'
- Applied to: Process MD - Manual Cargo Deletion
- Action: The system processes the manual cargo deletion action
Logic Flow:
IF A log detail record is being formatted AND the action code is 'MD'
AND The system processes the manual cargo deletion action
THEN:
- • The system extracts the reason code from the message field AND extracts the bond type from the input AND formats the MD message with both reason code and bond type AND stores the formatted message in the log dependent segment
R-GCX105-cbl-00165 (+4) File: GCX105.cbl Business Rule: Format Equipment Hold Operations
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment hold operation is being processed.
Trigger Criteria:
- Context: An equipment hold operation is being processed
- Applied to: HNF - Equipment Not Found
- Action: The action code is 'HNF'
Logic Flow:
IF An equipment hold operation is being processed
AND The action code is 'HNF'
THEN:
- • The system extracts the equipment ID from the input message and formats it as an equipment not found message for the log dependent segment
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment hold operation is being processed.
Trigger Criteria:
- Context: An equipment hold operation is being processed
- Applied to: HID - Equipment Hold
- Action: The action code is 'HID'
Logic Flow:
IF An equipment hold operation is being processed
AND The action code is 'HID'
THEN:
- • The system extracts the equipment ID from the input message and formats it as an equipment held message for the log dependent segment
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment hold operation is being processed.
Trigger Criteria:
- Context: An equipment hold operation is being processed
- Applied to: RID - Equipment Release
- Action: The action code is 'RID'
Logic Flow:
IF An equipment hold operation is being processed
AND The action code is 'RID'
THEN:
- • The system extracts the equipment ID from the input message and formats it as an equipment released message for the log dependent segment
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment hold operation is being processed.
Trigger Criteria:
- Context: An equipment hold operation is being processed
- Applied to: SZI - Equipment Seize
- Action: The action code is 'SZI'
Logic Flow:
IF An equipment hold operation is being processed
AND The action code is 'SZI'
THEN:
- • The system extracts the equipment ID from the input message and formats it as an equipment seized message for the log dependent segment
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment hold operation is being processed.
Trigger Criteria:
- Context: An equipment hold operation is being processed
- Applied to: SZR - Equipment Seize Release
- Action: The action code is 'SZR'
Logic Flow:
IF An equipment hold operation is being processed
AND The action code is 'SZR'
THEN:
- • The system extracts the equipment ID from the input message and formats it as an equipment seize released message for the log dependent segment
R-GCX105-cbl-00170 (+4) File: GCX105.cbl Business Rule: Lookup Unknown Action Code in Table
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when action code needs to be processed and a log table with action code entries exists.
Trigger Criteria:
- Context: An action code needs to be processed and a log table with action code entries exists
- Applied to: Search Log Table for Action Code
- Action: The system searches the log table for the matching action code
Logic Flow:
IF An action code needs to be processed and a log table with action code entries exists
AND The system searches the log table for the matching action code
THEN:
- • The system either finds the action code entry or reaches the end of the table without finding a match
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when action code has been searched in the log table.
Trigger Criteria:
- Context: An action code has been searched in the log table
- Applied to: Create Error Message with Unknown Action Code
- Action: The action code is not found in any table entry
Logic Flow:
IF An action code has been searched in the log table
AND The action code is not found in any table entry
THEN:
- • The system creates an error message containing the unknown action code
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when action code has been searched in the log table.
Trigger Criteria:
- Context: An action code has been searched in the log table
- Applied to: Retrieve Message from Table Entry
- Action: The action code matches an entry in the table
Logic Flow:
IF An action code has been searched in the log table
AND The action code matches an entry in the table
THEN:
- • The system retrieves the corresponding message text from that table entry
Rule Belongs to : GCX105.cbl
Business Justification: Dictates the expected operational logic and validation steps when action code is 'ca' and bond type field contains data.
Trigger Criteria:
- Context: The action code is 'CA' and bond type field contains data
- Applied to: Format Special Cargo Auto-Creation Message with Bond Type
- Action: The system processes the message formatting
Logic Flow:
IF The action code is 'CA' and bond type field contains data
AND The system processes the message formatting
THEN:
- • The system creates a formatted message 'CARGO CREATED AUTOMATICALLY TP:' concatenated with the bond type value
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when action code lookup process needs to be performed.
Trigger Criteria:
- Context: An action code lookup process needs to be performed
- Applied to: Set Search Index to First Entry
- Action: The system begins the lookup process
Logic Flow:
IF An action code lookup process needs to be performed
AND The system begins the lookup process
THEN:
- • The system sets the log table index to position 1 to start searching from the first entry
R-GCX105-cbl-00175 (+2) File: GCX105.cbl Business Rule: Retry Insert with Decremented Key
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when log detail record is being inserted into the database.
Trigger Criteria:
- Context: A log detail record is being inserted into the database
- Applied to: Duplicate Key Error?
- Action: The insert operation returns a duplicate key status code 'II'
Logic Flow:
IF A log detail record is being inserted into the database
AND The insert operation returns a duplicate key status code 'II'
THEN:
- • The system should check for duplicate key error condition
Rule Belongs to : GCX105.cbl
Business Justification: Ensures correct system behavior and process compliance when duplicate key error has been detected during log detail insertion.
Trigger Criteria:
- Context: A duplicate key error has been detected during log detail insertion
- Applied to: Decrement Key Value by 1
- Action: The system needs to generate a new unique key for retry
Logic Flow:
IF A duplicate key error has been detected during log detail insertion
AND The system needs to generate a new unique key for retry
THEN:
- • The key value should be decremented by 1 from the current value
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when new unique key has been generated after a duplicate key error.
Trigger Criteria:
- Context: A new unique key has been generated after a duplicate key error
- Applied to: Attempt Insert with New Key
- Action: The system retries the log detail insertion
Logic Flow:
IF A new unique key has been generated after a duplicate key error
AND The system retries the log detail insertion
THEN:
- • The insert operation should be attempted using the new decremented key value
R-GCX105-cbl-00178 (+3) File: GCX105.cbl Business Rule: Search Log Table for Action Code
Rule Belongs to : GCX105.cbl
Business Justification: Defines the strict business conditions required to proceed when action code that is not handled by the predefined message formatting cases.
Trigger Criteria:
- Context: An action code that is not handled by the predefined message formatting cases
- Applied to: Search Log Table for Matching Action Code
- Action: The system searches the log table for the action code
Logic Flow:
IF An action code that is not handled by the predefined message formatting cases
AND The system searches the log table for the action code
THEN:
- • The system uses the corresponding message from the table if found
Rule Belongs to : GCX105.cbl
Business Justification: Governs the functional prerequisites and system routing when action code that does not exist in the log table.
Trigger Criteria:
- Context: An action code that does not exist in the log table
- Applied to: Generate Error Message with Unknown Action Code
- Action: The table search completes without finding a match
Logic Flow:
IF An action code that does not exist in the log table
AND The table search completes without finding a match
THEN:
- • The system creates an error message containing the unknown action code
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when action code of 'ca' and a non-blank bond type value.
Trigger Criteria:
- Context: An action code of 'CA' and a non-blank bond type value
- Applied to: Create Special Cargo Auto-Creation Message with Bond Type
- Action: The message formatting process executes
Logic Flow:
IF An action code of 'CA' and a non-blank bond type value
AND The message formatting process executes
THEN:
- • The system creates a message with text 'CARGO CREATED AUTOMATICALLY TP:' followed by the bond type
Rule Belongs to : GCX105.cbl
Business Justification: Establishes the required business protocol to be followed when need to search the log table for an action code.
Trigger Criteria:
- Context: A need to search the log table for an action code
- Applied to: Set Search Index to 1
- Action: The lookup process begins
Logic Flow:
IF A need to search the log table for an action code
AND The lookup process begins
THEN:
- • The search index is set to position 1