TCMS Transportation Management System

Route Planning V2 is a wizard-based workflow in the TCMS Booking Web App used to transform delivery orders into optimized truck routes. The process consists of six primary steps:

1. Upload: Load orders via Excel/CSV or Webhook to create a planning session.
2. Locations: Geocode addresses and verify stop pins on the map.
3. Route Setup: Define the depot (start/end point) and planning date.
4. Fleet: Configure trucks, capacities, and shifts.
5. Route Preview: Run optimization via HERE Maps to calculate the best routes.
6. Assignment: Perform a final review and assign routes to the TCMS Planner or export them to third-party systems.

Planning runs are saved as sessions. You can track progress in Usage metrics & history, where statuses like 'Optimized' or 'Planned in TCMS' indicate the current stage of the workflow.

The TCMS Inventory Module provides a set of REST APIs for managing parts, retail stock, purchase orders, and sales. The APIs are divided into three primary functional groups:

• Stock API (/rest/inventory/stock/): Manages categories, stock locations, adjustments, and low-stock alerts.
• Purchase Order API (/rest/inventory/purchaseOrder/): Manages the full purchase order (PO) lifecycle.
• Retail Sale API (/rest/inventory/sale/): Manages sales with automatic stock level updates.

The Inventory module uses a 3-layer architecture to separate concerns between the API, business logic, and data persistence:

1. REST API Layer: Handles JAX-RS endpoints, authentication, and JSON parsing (e.g., StockAPI, RetailSaleAPI).
2. Service Layer: Contains business logic and manages database operations via SafeSqlExecutor (e.g., StockService, InventoryService).
3. Model Layer: Defines JPA @Entity classes that map to MySQL tables (e.g., Item, Warehouse, StockLocation).

Persistence is handled by Hibernate and MySQL 8 using a schema-based multi-tenant approach with HikariCP connection pooling.

The Analytics module provides several data-driven tools:

• Booking Analysis: Includes stats in the Booking Dashboard, Excel download capabilities, and status filters (including 'Awaiting pod' and 'Awaiting cancel').
• Expense and Payment Analysis: Features dynamic filtering upon tab selection, a month graph for expenses, and interactive data points on graphs that display corresponding values when clicked.
• Sales Analysis: Includes a Sales Graph with a 24-hour time format.
• Truck Maintenance: Provides a dedicated UI and API integration for maintenance analysis graphs.

The GenerateInvoiceAPI is a JAX-RS resource used for invoice operations. All endpoints use the POST method and require a raw JSON string body (typically sent with Content-Type: application/json). While the API is declared to produce text/plain, successful responses are JSON strings that should be parsed as JSON.

Key Connection Details:

• Base Path: /rest/generateinvoice
• Full URL Prefix: /rest/generateinvoice/{subpath}
• Authentication: Most methods require a valid userName and authKey. Invalid credentials result in a 401 error with Access-Control-Allow-Origin: *.

Route Planning V2 involves three primary roles with distinct operational tasks:

• Dispatcher: Responsible for the tactical execution of routing, including uploading order files, correcting location data, configuring the fleet, reviewing generated routes, and assigning or exporting them.
• IT / Integration: Handles the technical setup, including webhook configuration, managing secrets, migrations, HERE map keys, and feature flags.
• Operations Manager: Focuses on oversight, monitoring usage metrics, reviewing session history, and managing retries for failed sessions.