Search Knowledge Base Articles

EDI / B2B Integration Hub — How to Install

← Back to EDI / B2B Integration Hub overview

How to Install — EDI / B2B Integration Hub

Module folder: modules/edi_b2b_hub/   Version: v1.0.0

Enterprise EDI and B2B integration hub for Perfex CRM — trading partners, connections, document exchange, and message tracking

Before you begin

  • Backup your database (Setup → Backup or your host backup tool).
  • Use a staff account with Modules / Settings access.
  • PHP version and Perfex CRM version should match the module README requirements when listed.
  • Keep the module folder name exactly edi_b2b_hub.

Step-by-step installation

  1. Upload the edi_b2b_hub folder into your CRM modules/ directory (FTP, cPanel, or Setup → Modules → Upload when available).
  2. Log in to Admin.
  3. Go to Setup → Modules.
  4. Find EDI / B2B Integration Hub and click Activate (or Upgrade if already installed).
  5. Wait for migrations/tables to finish — do not refresh mid-activation.
  6. Go to Setup → Staff → Roles and assign permissions for this module.
  7. Open EDI / B2B Integration Hub → Settings and save defaults.

Install notes from README

Installation

  1. Module files are in modules/edi_b2b_hub/
  2. Go to Setup → Modules in Perfex CRM admin
  3. Click Activate on EDI / B2B Integration Hub
  4. Assign permissions under Setup → Staff → Permissions
  5. Full database schema (revision 104) is applied on activation
  6. Enable REST API, webhooks, and partner portal in EDI Hub → Settings

Uninstall: From Setup → Modules, uninstall removes all ebh_* tables, all ebh_* options, and uploads/edi_b2b_hub/. Export data first — this is irreversible.

After activation — configuration checklist

  1. Go to Setup → Modules and activate EDI / B2B Integration Hub.
  2. Reload admin once if needed — database schema is applied on activation.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open EDI Hub → Settings and configure company ISA/GS IDs, paths, transport, API, and webhooks.
  5. Perfex CRM 3.0+
  6. PHP 7.4+ (8.1+ recommended)
  7. MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  8. PHP extensions: mysqli, json, mbstring, curl, fileinfo

Official documentation — Installation

Installation

  1. Upload the edi_b2b_hub folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate EDI / B2B Integration Hub.
  3. Reload admin once if needed — database schema is applied on activation.
  4. Assign permissions under Setup → Staff → Roles.
  5. Open EDI Hub → Settings and configure company ISA/GS IDs, paths, transport, API, and webhooks.

No core CRM files are modified. All tables, options, and upload folders are created on activation.

Requirements

  • Perfex CRM 3.0+
  • PHP 7.4+ (8.1+ recommended)
  • MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  • PHP extensions: mysqli, json, mbstring, curl, fileinfo

Staff permissions (from module)

Assign under Setup → Staff → Roles. Each feature can expose different actions:

FeatureActions
Integration Dashboard
ebh_dashboard		view
Trading Partners
ebh_trading_partners		view, create, edit, delete
Connections
ebh_connections		view, create, edit, delete
Messages
ebh_messages		view, create, edit, delete, reprocess
Field Mappings
ebh_field_mappings		view, create, edit, delete
Settings
ebh_settings		view, edit
API Keys
ebh_api		view, create, delete
Webhooks
ebh_webhooks		view, create, edit, delete
Bulk Import
ebh_import		view, create

Verify installation (checklist)

  1. Setup → Modules shows EDI / B2B Integration Hub as Active.
  2. Admin sidebar shows the EDI / B2B Integration Hub menu for an admin user.
  3. Setup → Staff → Roles lists this module's permission groups.
  4. Opening EDI / B2B Integration Hub → Settings loads without PHP errors.
  5. Creating one sample record succeeds and appears in the list/table.
  6. (If used) Cron-dependent features have Perfex CRM cron enabled on the server.

After install — first actions

  1. Create master data required by this module.
  2. Create one sample record and walk it through approve/complete if applicable.
  3. Train staff using the Quick Start Guide.

Related: Features · Quick Start · FAQ · Version & Changelog

Did you find this article useful?

Related Articles