Installation

The initial installation method is to upload the .zip package via FTP and extract. This is the standard WHMCS method.

 

  • Upload the .zip file to whmcsroot/modules/addons
  • Use your host control panel extractor to unpack the files
  • Go to WHMCS administration area Setup > Addon Modules

    install-addon

  • Find CMSE Framework and click Activate
  • Once the activation routine is complete, return to Setup > Addon Modules and click Configure and select the options desired.

    install-configure

 

Configuration Options

  • Auto Configure CMSE Framework
    This will set all the CMSE Framework global configurations to make the extension immediately functional with custom menu, modular template, social sharing buttons, product detail database column insert.

    The settings can be changed as desired by going to Global Configuration when in the CMSE Framework admin scope.


  • Insert Filler Content
    Ideal for new WHMCS sites. This is valid content which creates a privacy page, a product sidebar widget and a blog category. The purpose is to quickly format the display and give the user a better understanding of the extension.

 

Technical Process

CMSE Content Framework will NOT alter any core WHMCS files or database tables*

10 tables are added to the database with the prefix mod_cmse_

A file named cmseContentFramewrok.php is added to the WHMCS root folder. This file handles the Search Engine Friendly (SEF) rewrite rule sent by the .htaccess document. This file is necessary to deliver the proper HTTP response code 200 for pages created by the extension. Otherwise the core WHMCS status code process will return 404 error.

Search Engine Friendly URL Configuration

A backup of an existing .htaccess file is made and stored in modules/addons/cmseframework/_copyfiles/backup and a rewrite condition and rewrite rule is added to the .htaccess. Nothing in the current file will be altered. The original .htaccess file is restored if CMSE Content Framework is deactivated (uninstalled).

Because CMSE Content Framework prefers to deliver SEF pages, a .htaccess document is required in the WHMCS root and SEF enabled and set to Full Friendly URLs in Setup > General > Friendly URLs. If neither is true, CMSE Content Framework will create the .htaccess and *set the value in the table tblconfiguration.

Product Groups And Products Import

All existing product group names and ID and product names and ID which are not hidden or retired will be copied to the table mod_cmse_products to facilitate the associated data output from WHMCS product tables.

Deactivation (uninstall)

If CMSE Content Framework is deactivated (uninstalled), all the associated mod_cmse_ database tables will be deleted, the configuration values set in tbladdonmodules for cmseframework will be removed, all CMSE Content Framework files copied to the system will be deleted, all previous settings will be restored.