CXTMS Platform Overview
CXTMS is a low-code platform for building Transportation Management and Supply Chain Management applications. Developers extend the platform by writing YAML configuration — not application code — to define UI screens, business workflows, validations, and integrations.
Most customization falls into two areas:
- App Modules — declarative UI: screens, forms, dialogs, navigation, permissions, localization, and client-side actions
- Workflows — server-side automation: business processes, entity triggers, scheduled jobs, integrations (EDI, FTP, email, webhooks), and validation gates
No compiler, no build step. You commit YAML to a Git repository and the platform consumes it.
Architecture
| Layer | Role |
|---|---|
| Web App | Host for App Modules. Renders YAML-defined screens, forms, and dashboards. Responsive, multi-language. |
| Mobile App | iOS and Android host for App Modules. Offline support, push notifications, camera/GPS for proof of delivery. |
| GraphQL API | Unified query/mutation/subscription interface. Bearer-token auth, role-based access, real-time sync. |
| MCP Server | Model Context Protocol interface for AI agent integration with platform data and operations. |
| Core Services | Business logic, entity validation, audit logging, third-party integration. |
| Workflow Engine | Executes YAML workflows: event-driven triggers, scheduled jobs, async/sync execution, retry and logging. |
| Entity System | 120+ domain entities covering orders, commodities, contacts, accounting, inventory, and more. |
Development Model
All configuration lives in a Git repository with a simple structure:
my-app/
├── app.yaml # App manifest (name, version, repo URL)
├── modules/
│ └── *.yaml # App Module definitions (UI)
└── workflows/
└── *.yaml # Workflow definitions (server-side)
| You want to... | Use |
|---|---|
| Add screens, dialogs, lists, forms, dashboards | App Modules |
| Add button actions, navigation, client-side validation | App Module Actions |
| Automate business processes, approvals, notifications | Workflows |
| Integrate external systems (REST, EDI, FTP, email) | Workflow Tasks |
| Query or mutate data programmatically | GraphQL API |
| Add a new component type or workflow task type | Platform source changes (rare) |
Documentation Map
App Modules
The UI layer. App Modules define screens, forms, navigation, permissions, and client-side behavior — all in YAML.
- Components — 29 built-in UI components (datagrid, form, button, calendar, dashboard, barcode scanner, and more)
- Actions — event handlers for buttons and UI interactions (navigate, query, mutation, workflow execution)
- Routing — URL paths and nested navigation
- Permissions — role-based access to screens and actions
- Variables — client-side expressions and data binding
- Conditional Rendering — show/hide components based on state
- Validation — form and field validation rules
- Localization — multi-language support for labels and text
Workflows
Server-side automation. Workflows execute as a sequence of activities triggered by entity events, schedules, webhooks, or manual invocation.
- Workflow YAML — manifest structure and configuration
- Triggers — entity event triggers (Before/After create, update, delete)
- Activities & Tasks — 40+ task types: entity CRUD, email, EDI, FTP, AI, payment gateways, PDF generation, and more
- Variables & Expressions — runtime data access with
{{ expression }}syntax - Document Templates — generate documents from workflow data
- Webhooks — expose workflows as HTTP endpoints
- Examples — common workflow patterns
Entities
The data model. 120+ business entities define the domain objects the platform operates on:
- Orders & Commodities — shipments, line items, tracking, events, documents, charges
- Contacts & Locations — customers, vendors, carriers, addresses, ports, lanes
- Accounting — transactions, charges, payments, tariffs, discounts, sales tax
- Jobs & Operations — job management, status tracking, warehouse inventory
- System — users, roles, permissions, organizations, custom fields, secrets
- Custom Values — extend entities with organization-specific properties without schema changes
Each entity page documents its fields, relationships, and available operations.
GraphQL API
Programmatic access to all platform data and operations.
- API Credentials — authentication setup and token management
- Attachments — file upload and download via GraphQL
- Notifications — query and manage notifications
- Secrets — secure credential storage
Other Topics
- Security — role-based access control, authentication, and data protection
- Audit — audit logging and change tracking
- Email Notifications — email configuration and templates
- Filtering and Sorting — query syntax for lists and data grids
- Hosting — deployment and infrastructure
- MCP Integration — AI agent integration with the platform
Where to Start
| Your goal | Start here |
|---|---|
| Brand new to CXTMS development | Getting Started — developer onramp with setup steps and examples |
| Understand app repository structure | Building Apps — manifest, modules, and workflows layout |
| Build or modify a UI screen | App Modules then Components |
| Create a workflow or automation | Workflows Overview then Tasks |
| Look up an entity's fields | Entities — browse the 121 entity reference pages |
| Integrate via API | GraphQL API — authentication, queries, mutations |