Greyne Middleware - Order Processing Documentation

1. System Overview

The Greyne Middleware system is a multi-retailer order processing platform that handles CSV imports from major home improvement retailers and converts them into warehouse-ready order data.

Supported Retailers

• The Home Depot Inc - Standard retail orders
• Lowe's - Standard retail orders
• The Home Depot Special Orders - Custom/special order division

1.1 User Roles & Access Control

The middleware now differentiates between Admin and Developer accounts to scope high-sensitivity tools and reference materials.

• Developer: Full operational access plus documentation viewing. Required to access this page and manage technical configuration.
• Admin: Administrative access across orders, UPCs, carriers, etc. Documentation is intentionally hidden to keep sensitive implementation notes within the engineering team.

UPC Usage & Soft Delete Plan

TODO: The UPCs table maps product codes to UPC numbers. Legacy exports already translate here; re-enable these lookups in the modern middleware.

Where UPCs are referenced

• src/Model/Table/UpcsTable.php::GetUpc() – utility lookup by productcode.
• TODO – Workflow timing: legacy CRS/JET exports fetch UPCs immediately after resolving Fishbowl part numbers and before writing batch CSV rows or FedEx label payloads; port this step to the new flow.
• Legacy v1 flows (reference): v1/src/Controller/CrsController.php reads UPCNumber and calls Upcs->GetUpc() in multiple export paths.
• TODO – Modern controllers: current Cake controllers (under src/Controller) do not yet use UPC translations; wire them into the new export pipeline.
• UI Management: /upcs Tabulator grid for CRUD.

Soft delete considerations

• Add one of: is_deleted TINYINT(1) (preferred) or deleted_at DATETIME.
• Auto-filter enabled: UpcsTable::beforeFind() now excludes soft-deleted rows globally.
• /upcs/api and server CSV export also exclude soft-deleted rows.
• Keep historical rows for audit; hide from active lookups and exports.

Implementation Plan

1. DB migration: add is_deleted to upcs with default 0.
2. Table hook: beforeFind added in UpcsTable to auto-filter is_deleted=0 (or deleted_at IS NULL).
3. Controller: soft-delete endpoint updates is_deleted=1 (already implemented with fallbacks).
4. UI: /upcs delete button calls soft delete; grid reloads.
5. Downstream: ensure GetUpc() and any legacy reads exclude soft-deleted UPCs.
6. QA: verify exports omit soft-deleted UPCs; add tests for lookups.

2. Complete Workflow

Step 1: File Upload & Validation

Step 2: Header Detection & Cleanup

Step 3: Data Extraction

Step 4: Retailer-Specific Processing

Step 5: Batch Number Generation

Step 6: Database Storage

System Modules

This section lists the main application areas for quick reference.

• Orders:
  • Manage Orders — view batches, counts and navigate to line items.
  • Upload Order CSV — import retailer CSV files (mixed supported).
• Carriers & Routes:
  • Carriers — grouped by carrier with rule counts.
  • Routes — full list of routing rules (state → carrier).
• UPCs: UPC Management — edit, search, export with Tabulator grid.
• Users: User Management — manage application users.
• Tags: Tag Management — create and assign tags.

EDI Scope Note (BOL & Advanced Routing)

Examples that were tied to EDI scope:

• Automated BOL generation & submission to trading partners via EDI/SFTP
• Advanced routing logic driven by partner SLAs and EDI acknowledgements
• Auto‑push of files (ASN/labels/manifests) with receipt checks, retries, and error routing

If you want to re‑enable these capabilities, we can re‑estimate and stage them as a separate milestone (keeping current CSV/label exports intact).

3. CSV File Format

Required Header Row

Sample Data Rows

4. Batch Processing

Batch Information Display

Order Hierarchy Creation

5. Database Schema

Orders Table Structure

Related Tables

• tackingfiles: SFTP tracking file metadata
• carrier_details: Shipping carrier assignments by state

6. Retailer-Specific Logic

The Home Depot Inc

Lowe's

The Home Depot Special Orders

7. Export Functions

Available Exports

Detailed Vendor Processing & Address Formatting

Vendor Processing Steps

Vendor-Specific Business Information

Address Formatting Process

// src/Controller/OrdersController.php (downloadorders)
$addressParts = [];
if (!empty($order->ShipToAddress1)) {
    $addressParts[] = $order->ShipToAddress1;
}
if ($order->ShipToAddress2 !== '"N/A"') {
    $addressParts[] = $order->ShipToAddress2;
}
if ($order->ShipToDayPhone !== 'N/A') {
    $phone = $order->ShipToDayPhone;
    $formatted = '(' . substr($phone,0,3) . ') ' . substr($phone,3,3) . '-' . substr($phone,6,4);
    $addressParts[] = $formatted;
}
$mergedAddress = implode(' ', $addressParts);
$mergedAddress = str_replace('"', '', $mergedAddress);
$mergedAddress = '"' . $mergedAddress . '"';

Carrier Assignment System

Supported Carriers

CSV Output Structure

Processing Logic Flow

8. Troubleshooting

Common Error Messages

File Upload Issues

8. Test Data & Templates

Available Test Files

Jet Warehouse Integration Templates

Jet Implementation Status

Testing Workflow

9. ❓ Frequently Asked Questions

Q: Can I upload mixed retailer files?

Q: What happens to the original CSV file?

Q: How are batch numbers generated?

Q: Can I reprocess a batch?

Q: Where are carrier assignments determined?

Q: What's the difference between sequence ID and batch number?