Search Knowledge Base Articles

Trade Promotion Management — How to Install

← Back to Trade Promotion Management overview

How to Install — Trade Promotion Management

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

Trade promotion planning, execution and tracking for Perfex CRM

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 trade_promotion_management.

Step-by-step installation

  1. Upload the trade_promotion_management 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 Trade Promotion Management 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 Trade Promotion Management → Settings and save defaults.

Install notes from README

Installation

  1. Upload the trade_promotion_management folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Trade Promotion Management.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open Trade Promo → Settings and configure prefixes, approvals, API, and integrations.

No core CRM files are modified. Schema version tpm_db_version is set to 100 for v1.0.0.

Uninstall

Deactivate the module, then click Uninstall. This removes:

  • All tpm_* database tables
  • All tpm_* options / settings
  • Uploaded files under uploads/trade_promotion_management/

Core Perfex CRM files are not modified.

After activation — configuration checklist

  1. Go to Setup → Modules and activate Trade Promotion Management.
  2. Reload admin once if menus do not appear — schema version tpm_db_version is set to 100 for v1.0.0.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open the module menu and configure settings.
  5. Perfex CRM 2.3+ (3.x recommended)
  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 trade_promotion_management folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Trade Promotion Management.
  3. Reload admin once if menus do not appear — schema version tpm_db_version is set to 100 for v1.0.0.
  4. Assign permissions under Setup → Staff → Roles.
  5. Open the module menu and configure settings.

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

Requirements

  • Perfex CRM 2.3+ (3.x recommended)
  • 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
TPM Dashboard
tpm_dashboard		view
Promotions
tpm_promotions		view, create, edit, delete, approve
Promotion Types
tpm_types		view, create, edit, delete
Accruals
tpm_accruals		view, create, edit, delete, post
Claims
tpm_claims		view, create, edit, delete, validate, pay
Deduction Codes
tpm_deduction_codes		view, create, edit, delete
Sell-Out Data
tpm_sell_out		view, create, edit, delete, import
Execution Checklists
tpm_execution		view, create, edit, delete, verify
Reports
tpm_reports		view, export
Settings
tpm_settings		view, edit
Integrations
tpm_integrations		view
API Keys
tpm_api_keys		view, create, edit, delete
Webhooks
tpm_webhooks		view, create, edit, delete

Verify installation (checklist)

  1. Setup → Modules shows Trade Promotion Management as Active.
  2. Admin sidebar shows the Trade Promotion Management menu for an admin user.
  3. Setup → Staff → Roles lists this module's permission groups.
  4. Opening Trade Promotion Management → 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