# Installation and Configuration

Detailed guide on installing, activating, configuring, updating, and deactivating the PUQ Product Analytics addon module for WHMCS.

# WHMCS Module Installation and Update

### PUQ Product Analytics module **[WHMCS](https://puqcloud.com/link.php?id=77)**
##### [Order now](https://puqcloud.com/store/whmcs-addon-modules) | [Download](https://download.puqcloud.com/WHMCS/addons/PUQ_WHMCS-Product-Analytics/) | [Community](https://community.puqcloud.com/)

## System Requirements

| Requirement | Minimum          |
|-------------|------------------|
| WHMCS       | 8.x or higher |
| PHP         | 8.1 or 8.2 |
| ionCube Loader | v13 or newer  |

> **Note:** The module is encrypted with ionCube. Ensure that the correct ionCube Loader version is active on your web server.

---

## Download

The module is distributed as a single ZIP archive. A separate build is published for each supported PHP major version.

All versions and historical builds are available in the index:
- [https://download.puqcloud.com/WHMCS/addons/PUQ_WHMCS-Product-Analytics/](https://download.puqcloud.com/WHMCS/addons/PUQ_WHMCS-Product-Analytics/)

### Direct "latest" downloads

#### PHP 8.2
```bash
wget https://download.puqcloud.com/WHMCS/addons/PUQ_WHMCS-Product-Analytics/php82/PUQ_WHMCS-Product-Analytics-latest.zip
```

#### PHP 8.1
```bash
wget https://download.puqcloud.com/WHMCS/addons/PUQ_WHMCS-Product-Analytics/php81/PUQ_WHMCS-Product-Analytics-latest.zip
```

> Not sure which PHP version your WHMCS runs on? Check **Utilities > System > PHP Info** in the WHMCS admin area.

---

## Installation

### Step 1: Unzip the Archive
On your WHMCS server (or locally):
```bash
unzip PUQ_WHMCS-Product-Analytics-latest.zip
```

### Step 2: Copy the Module Files
Copy the extracted module directory directly to your WHMCS directory:

```bash
cp -r PUQ_WHMCS-Product-Analytics/puq_product_analytics /var/www/html/whmcs/modules/addons/
```

### Step 3: Activate and Configure the Addon Module
1. Log in to the WHMCS admin area.
2. Navigate to **System Settings > Addon Modules** (or **Setup > Addon Modules**).
3. Find **PUQ Product Analytics** in the list and click **Activate**.
4. Click **Configure**, enter your **License Key**, and select the admin groups allowed to access the module.
5. Click **Save Changes**.

---

## File Structure

Structure of files after a successful installation:
```
whmcs/
└── modules/
    └── addons/
        └── puq_product_analytics/   # Addon files
```

---

## Update Procedure

To update the module to a newer version:
1. **Deactivate** the addon module in **Setup > Addon Modules**.
2. Make a backup of your WHMCS files and database.
3. Download the latest version for your PHP version.
4. Extract the ZIP and overwrite the existing files in the `modules/` directories.
5. **Reactivate** the addon module in **Setup > Addon Modules** (this will trigger database migrations). All settings and client data are safe during this process.


<!-- sync:e5e6253a6937cf39 -->

# Initial Setup and Access Control

### Product Analytics addon **[WHMCS](https://puqcloud.com/link.php?id=77)**
##### [Order now](https://puqcloud.com/store/whmcs-addon-modules) | [Download](https://download.puqcloud.com/WHMCS/addons/PUQ_WHMCS-Product-Analytics/) | [Community](https://community.puqcloud.com/)

After uploading the module files, you need to activate the module and configure roles and permissions inside WHMCS.

---

## 1. Activate the Addon

1. Log in to your WHMCS admin area.
2. Navigate to **System Settings > Addon Modules** (or **Setup > Addon Modules** in older versions).
3. Find **PUQ Product Analytics** in the list.
4. Click **Activate**.

---

## 2. Configure Settings & Permissions

1. Click **Configure** next to PUQ Product Analytics.
2. Enter your license key in the **License key** field.
3. In **Access Control**, check the administrator role groups that are allowed to access and view the analytics (e.g., Full Administrator, Sales Operator, Support Operator, test).
4. Click **Save Changes**.

---

## 3. Verify Activation

Once settings are saved, the license validation status will display directly below the license key field:
- **Success status** (e.g., `success: 2027-02-15T19:41:07+01:00`) indicates that the module successfully validated its license and is ready.

![PUQ Product Analytics Activation and Access Control Configuration](https://doc.puq.info/uploads/images/gallery/2026-07/embedded-image-ifabal7w.png)
*01-addon-config-license.png*


<!-- sync:564f9e2928fcccfc -->