# 2. Installation

## Installing the plugin

Install the plugin via the Shopware Store, or upload the ZIP file manually:

1. Go to **Settings → System → Plugins → Upload Plugin**
2. Select the downloaded ZIP file
3. Click **Activate plugin**
4. Clear the cache under **Settings → System → Caches & Indexes → Clear Cache**

## Getting started

After activation, you will find the plugin under **Catalogues → Product Completeness**.

The dashboard will not show any scores yet — they need to be calculated first. Follow these steps:

1. Navigate to **Catalogues → Product Completeness → Rule Sets**
2. Create your first rule set and add conditions (e.g. Name: required, Description: required, Images: count\_min 1)
3. Save the rule set
4. Go to the **Dashboard** and click **Recalculate Scores**
5. Calculation runs asynchronously in the background — scores will appear in the dashboard shortly

## Configuring score thresholds

The color boundaries for "Good" and "Critical" are adjustable under **Settings → System → Configuration → Momo Product Completeness**. Defaults:

* **Good**: score ≥ 70%
* **Critical**: score ≤ 39%

## ACL privileges

The plugin includes dedicated ACL privileges. Assign them to roles under **Settings → System → Users & Permissions**:

| Privilege                   | Actions                      |
| --------------------------- | ---------------------------- |
| `momo_completeness_rule`    | Read, create, update, delete |
| `momo_product_completeness` | Recalculate scores           |

## Notes

* Score calculation runs asynchronously via Symfony Messenger. Make sure workers are running (`messenger:consume async`).
* Scores are automatically recalculated on every product save. Manual recalculation is only needed after major rule set changes.
* The plugin is compatible with Shopware \~6.6.0.