OCMLABS/MODULE-SUPPORT-TICKET · INSTALLATION

Installation

  • Magento
  • Adobe Commerce
  • Hyvä

The Support Tickets module installs as a single Composer package. Magento Open Source and Adobe Commerce each use their own package; pick the one that matches your edition below.

Requirements

MAGENTO
2.4.7 - 2.4.9
PHP
8.3 - 8.4 (Magento 2.4.9 requires PHP 8.4)
THEME
Luma (native) · Hyva via ocmlabs/module-support-ticket-hyva companion package
LICENSE
Composer / Packagist - public, no auth credentials required
NOTE /

Magento 2.4.9 is supported from version 1.0.6. Earlier versions block installation on 2.4.9; run composer require ocmlabs/module-support-ticket:^1.0.6 (or the -commerce package) before upgrading Magento. Magento 2.4.10 and later are blocked until the module has been retested.

Magento 2 Open Source

TERMINAL
$ composer require ocmlabs/module-support-ticket
$ bin/magento module:enable OCMLabs_SupportTicket
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush

Install manually

Copy the module directory to app/code/OCMLabs/SupportTicket, then run the same commands starting from module:enable.

Adobe Commerce

On Adobe Commerce, install the ocmlabs/module-support-ticket-commerce package:

TERMINAL
$ composer require ocmlabs/module-support-ticket-commerce
$ bin/magento module:enable OCMLabs_SupportTicket
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush

Hyva theme

If your store runs the Hyva theme, install the companion module alongside the core Support Tickets module:

TERMINAL
$ composer require ocmlabs/module-support-ticket-hyva
$ bin/magento module:enable Hyva_OCMLabsSupportTicket
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush
NOTE /

The Hyva companion module declares a sequence dependency on OCMLabs_SupportTicket, so install the core module first. Companion 1.0.4 requires core 1.0.7 or later and works with Hyva’s strict Content Security Policy (Alpine CSP) build. It requires the hyva-themes/magento2-compat-module-fallback package and replaces the Luma LESS/jQuery storefront templates with Tailwind CSS and Alpine.js implementations compatible with Hyva’s asset pipeline. Admin management (grid, edit form, configuration) is unchanged; the only difference is the frontend rendering layer for the customer portal and the product page Support button.

Verify the installation

Via CLI:

TERMINAL
$ bin/magento module:status OCMLabs_SupportTicket

The output should show Module is enabled.

Via database:

The install creates two new tables: ocmlabs_support_ticket and ocmlabs_support_ticket_comment. Confirm they exist after running setup:upgrade.

Via admin panel:

Navigate to Stores > Support > Support Tickets. If the menu item is visible and the grid loads, the module installed correctly.

Grant admin access

The module adds a Support section to the role resource tree under System > Permissions > User Roles > Role Resources:

  • Support (OCMLabs_SupportTicket::support) - The parent node. It also controls access to the Support Tickets configuration section, together with Magento’s own Stores > Configuration permission.
    • Support Tickets (OCMLabs_SupportTicket::tickets) - Shows the menu item and the ticket grid
      • Edit / Reply (OCMLabs_SupportTicket::tickets_manage) - Open a ticket, save changes, post replies, and use the Set Status bulk actions
      • Delete (OCMLabs_SupportTicket::tickets_delete) - Delete tickets from the ticket page or with the grid’s bulk Delete action
    • Support Ticket Configuration (OCMLabs_SupportTicket::config) - Listed in the tree, but in 1.0.8 the configuration section checks the parent Support node instead

Without OCMLabs_SupportTicket::tickets, the Stores > Support > Support Tickets menu item does not appear for that user. See System Settings for the configuration path.

Configure the module

How-to: help desk setup and admin role, 1:07
CAUTION /

Before going live, set the Admin Notification Email under Stores > Configuration > OrangeCollar > Support Tickets. This is the address that receives every new-ticket alert and every customer reply notification.

See System Settings for the full configuration reference.

Check the frontend

  1. Log in as a customer account on the storefront.
  2. Go to My Account. A Support Tickets link should appear in the account navigation.
  3. Click it to confirm the My Support Tickets page loads.
  4. Open the page of a product that customer has ordered and confirm the Open a Support Ticket button is visible. On products they have not bought, the button reads Support Ticket (Purchase Required) and is disabled; logged-out visitors see Log in to Open a Support Ticket.
  5. Create a test ticket to verify the full submission flow and confirm notification emails are delivered.

Production deployment

If deploying to a production environment with static content already compiled, run the full static content deploy after setup:upgrade:

TERMINAL
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento setup:static-content:deploy -f
$ bin/magento cache:flush

If your production deploy pipeline uses maintenance mode:

TERMINAL
$ bin/magento maintenance:enable
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento setup:static-content:deploy -f
$ bin/magento cache:flush
$ bin/magento maintenance:disable

See also

Related pages

In this module