Module: EDI / B2B Integration Hub v1.4.0
Enterprise EDI and B2B integration hub for BIXCRM — trading partners, connections, document exchange, and message tracking
Screen-by-screen guides (each tab explained)
Click a menu item below for step-by-step instructions on that EDI / B2B Integration Hub screen:
- Integration Dashboard
- Trading Partners
- Connections
- Messages
- Ebh Field Mappings
- API Keys
- Webhooks
- Bulk Import
- Settings
How to use in BIXCRM (daily operations)
- Sign in to the admin area with a role that includes EDI / B2B Integration Hub permissions.
- Open Edi B2b Hub (sidebar) or search for EDI / B2B Integration Hub in the admin menu.
- Start on the Dashboard (if available) to see open tasks, pending approvals, and KPIs.
- Review Settings after upgrades — new options may need defaults for your company.
- Create or import master data first; most modules block transactions until masters exist.
- Run the main business flow (create → submit → approve → post/complete) using the screens listed in Admin menu below.
- Use Reports / Analytics screens to reconcile stock, finance, compliance, or SLA metrics.
- For integrations (API, EDI, gateways, tax), confirm credentials in Settings and monitor logs or webhook delivery screens.
- Train staff with role-based access — give approvers approve permissions only, operators create/edit on their area.
- If something fails overnight, check BIXCRM cron ran and open the module log / failed queue screen if present.
Admin menu — where to work
Open the EDI / B2B Integration Hub section in the admin sidebar. Screens your staff may use (depending on role):
- API Keys
- Bulk Import
- Connections
- Ebh Field Mappings
- EDI Hub
- EDI Messages
- Integration Dashboard
- Messages
- Settings
- Trading Partners
- Webhooks
- When invoice is paid
- When invoice is sent (unpaid)
Detailed guide — features, workflows, API & FAQ
Phase 1 — Foundation ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| Trading Partners | CRUD with ISA/GS IDs, CRM client linking |
| Connections | SFTP, AS2, REST API, Email, FTP, Local folder profiles |
| Document Types | Pre-seeded X12 types (850, 810, 856, 997, etc.) |
| Message Log | Track inbound/outbound EDI messages with status workflow |
| Dashboard | Stats, charts, recent messages |
| Settings | Hub enable, default standard, retention, file paths |
Phase 2 — Parsing & Mapping ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| X12 Parser | Segment/element parsing, 850/810/856 structure extraction |
| EDIFACT Parser | Basic UNB/UNH envelope support |
| Field Mappings | Partner + document type → CRM field mapping UI |
| Inbound Processor | Auto-process on save + BIXCRM cron batch |
| Reprocess | Re-parse failed or updated messages |
| Parse Preview | Test raw EDI before saving |
| Validation Rules | Required envelope segments (ISA, GS, ST, SE, GE, IEA) |
Phase 3 — Outbound & CRM Integration ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| X12 Generator | Build 810, 850, 856, 997 transaction sets |
| Invoice → 810 | Auto-generate when invoice is sent or paid |
| PO → 850 | Cron sync for approved purchase orders |
| Shipment → 856 | Auto-generate on WMS shipment completion |
| 997 Auto-Ack | Functional acknowledgment for processed inbound docs |
| Entity Linking | Messages linked to invoice, PO, shipment, or client |
| Outbound Files | Written to configured outbound path |
Phase 4 — Transport Connectors ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| SFTP | Inbound poll, outbound upload, connection test |
| FTP | Inbound poll, outbound upload, passive mode |
| Local Folder | Watch folder inbound, outbound drop |
| AS2 | HTTPS delivery with optional signing, MDN capture |
| Transport Cron | Poll inbound + push outbound on BIXCRM cron |
| Connection Test | Live test button on connection form |
| Transport Status | pending / sent / failed per outbound message |
Phase 5 — API & Enterprise ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| REST API | List partners/messages, submit documents (/edi_b2b_hub/api) |
| API Keys | Admin-managed tokens with read/write scopes and rate limits |
| Webhooks | HMAC-signed callbacks: message.received, message.processed, message.failed |
| Partner Portal | Client-area EDI message status for linked trading partners |
| Bulk Import | CSV upload (partner_code, raw_payload, optional direction/doc code) |
Database Tables
| Table | Purpose |
|---|---|
| ------- | --------- |
ebh_trading_partners | B2B partner master |
ebh_connections | Transport/protocol configuration |
ebh_document_types | EDI document catalog |
ebh_messages | Message/transaction log |
ebh_field_mappings | Segment → CRM field maps |
ebh_validation_rules | Parse validation rules |
ebh_activity_logs | Audit trail |
ebh_api_keys | REST API authentication tokens |
ebh_webhooks | Outbound webhook subscriptions |
ebh_webhook_deliveries | Webhook delivery log and retry queue |
ebh_import_batches | Bulk CSV import history |
Permissions
| Feature | Capabilities |
|---|---|
| --------- | ------------- |
ebh_dashboard | view |
ebh_trading_partners | view, create, edit, delete |
ebh_connections | view, create, edit, delete |
ebh_messages | view, create, edit, delete, reprocess |
ebh_field_mappings | view, create, edit, delete |
ebh_settings | view, edit |
ebh_api | view, create, delete |
ebh_webhooks | view, create, edit, delete |
ebh_import | view, create |
Processing Flow
- Create inbound message with raw X12/EDIFACT payload
- Processor parses → validates → applies field mappings
parsed_payloadJSON stores structure + mapped CRM fields- Cron processes pending queue when Auto-process Inbound is enabled
Roadmap
All planned phases (1–5) are complete. See [docs/ROADMAP.md](docs/ROADMAP.md) for details.
Version
- Module: 1.4.0
- DB version: 104 (option
ebh_db_version)
Features
Enterprise EDI and B2B integration hub for BIXCRM — trading partners, connections, document exchange, and message tracking
- Module: **1.4.0**
- DB version: **104** (option `ebh_db_version`)
Permissions
Granular staff capabilities are registered on activation. Assign them under Setup → Staff → Roles for the EDI / B2B Integration Hub capability group.
Typical capabilities include view, create, edit, delete, plus module-specific actions (approve, export, settings, API access).
Cron Jobs
Background tasks (if enabled) run through BIXCRM's main cron. Example crontab (every 5 minutes):
* * * * * php /path/to/bixcrm/index.php cron/index > /dev/null 2>&1
Check module settings for scheduled jobs (alerts, sync, reports, retention).
After activation — configuration checklist
- Go to Setup → Modules and activate EDI / B2B Integration Hub.
- If prompted, click Upgrade Database or reload admin — migrations run automatically.
- Assign permissions under Setup → Staff → Roles.
- Open the module menu and configure settings.
- BIXCRM 3.0+
- PHP 7.4+ (8.1+ recommended)
- MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
- PHP extensions: mysqli, json, mbstring, curl, fileinfo
One-time setup (first time only)
- Setup → Modules → activate EDI / B2B Integration Hub.
- Setup → Staff → Roles → assign EDI / B2B Integration Hub permissions (view, create, edit, delete, approve, export, settings as needed).
- Open EDI / B2B Integration Hub → Settings and complete company defaults, prefixes, integrations, and notification options.
- Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
- Enable BIXCRM cron (
php /path/to/bixcrm/index.php cron/index) for sync, retries, alerts, and scheduled jobs. - Optionally enable REST API / webhooks in module settings if you integrate external systems.
BIXCRM Knowledge Base — usage guide generated from module README and documentation.