Plugin Settings Tools Reference

This Reference page covers the Tools tab in Plugin Settings. It is a manual draft for the full option Reference, not a standalone public release of the whole Reference set.

Tools can change saved configuration, rebuild data, or reset statistics. Use danger actions carefully and verify backups before changing destructive settings.

Maintenance Tools

Debug Mode

• Public label: Debug Mode
• Location: Plugin Settings > Tools > Maintenance Tools
• Type: Toggle
• Default value: Off
• Shown when: Always.
• Availability: Free
• What it does: Enables additional debugging output or diagnostic behavior.
• When to use: Use it while troubleshooting filter behavior with support or during development.
• Side effects / performance notes: Debug output can expose implementation details or add overhead, so turn it off after troubleshooting.
• Related options: Exclude from JS Optimization, Theme Compatibility Mode, Export Settings.

Export Settings

• Public label: Export Settings
• Location: Plugin Settings > Tools > Maintenance Tools
• Type: Button
• Default value: None
• Shown when: Always.
• Availability: Free
• What it does: Exports plugin settings for backup, migration, or support review.
• When to use: Use it before major changes, site migrations, imports, or troubleshooting sessions.
• Side effects / performance notes: Exported settings may include site-specific selectors and should be handled carefully.
• Related options: Import Settings, Reset All Settings, Debug Mode.

Import Settings

• Public label: Import Settings
• Location: Plugin Settings > Tools > Maintenance Tools
• Type: File upload with button
• Default value: None
• Shown when: Always.
• Availability: Free
• What it does: Imports plugin settings from a saved settings file.
• When to use: Use it to restore a backup or move configuration between sites.
• Side effects / performance notes: Imported settings can overwrite current configuration and may contain selectors that do not match the current theme.
• Related options: Export Settings, Reset All Settings, Theme Compatibility Mode.

Reset All Settings

• Public label: Reset All Settings
• Location: Plugin Settings > Tools > Maintenance Tools
• Type: Danger button
• Default value: None
• Shown when: Always.
• Availability: Free
• What it does: Resets plugin settings back to defaults.
• When to use: Use it only when you intentionally want to discard existing plugin configuration.
• Side effects / performance notes: This is destructive for configuration; export settings first if you may need to restore them.
• Related options: Export Settings, Import Settings, Remove Data on Uninstall.

Rebuild Index

• Public label: Rebuild Index
• Location: Plugin Settings > Tools > Maintenance Tools
• Type: Button
• Default value: None
• Shown when: Always.
• Availability: Free
• What it does: Rebuilds plugin index data used for filtering and counts.
• When to use: Use it after major catalog, attribute, variation, grouped product, or bundled product changes.
• Side effects / performance notes: Rebuilds can take time on large catalogs and may temporarily increase server load.
• Related options: Enable Index Tables, Rebuild Scope, Index Grouped & Bundle.

Remove Data on Uninstall

• Public label: Remove Data on Uninstall
• Location: Plugin Settings > Tools > Maintenance Tools
• Type: Toggle
• Default value: Off
• Shown when: Always.
• Availability: Free
• What it does: Removes plugin data when the plugin is uninstalled.
• When to use: Enable it only when you want uninstall to clean stored plugin data.
• Side effects / performance notes: This can remove configuration or generated data during uninstall, so keep backups when needed.
• Related options: Reset All Settings, Export Settings, Cache Filter Results.

Rebuild Scope

• Public label: Rebuild Scope
• Location: Plugin Settings > Tools > Maintenance Tools
• Type: Select
• Default value: Everything / Products / Categories / Attributes
• Shown when: Rebuild Index is used.
• Availability: Pro
• What it does: Chooses which part of the index data should be rebuilt.
• When to use: Use a narrower scope when only one catalog area changed and a full rebuild is unnecessary.
• Side effects / performance notes: Narrow rebuilds can be faster, but choosing too narrow a scope may leave stale index data elsewhere.
• Related options: Rebuild Index, Enable Index Tables, Index Grouped Products.

Analytics

Enable Filter Analytics

• Public label: Enable Filter Analytics
• Location: Plugin Settings > Tools > Analytics
• Type: Toggle
• Default value: Off
• Shown when: Always.
• Availability: Free
• What it does: Enables collection of filter usage analytics.
• When to use: Use it when the site team wants to understand which filters shoppers use.
• Side effects / performance notes: Analytics collection should be reviewed against privacy and retention policies.
• Related options: Send Usage Statistics, Data Retention Period, Reset All Statistics.

Data Retention Period

• Public label: Data Retention Period
• Location: Plugin Settings > Tools > Analytics
• Type: Select
• Default value: 7 / 30 / 90 Days
• Shown when: Enable Filter Analytics is on.
• Availability: Free
• What it does: Sets how long filter analytics data is retained.
• When to use: Choose a period that matches reporting needs and privacy expectations.
• Side effects / performance notes: Longer retention keeps more data and may require more storage.
• Related options: Enable Filter Analytics, Reset All Statistics, Send Usage Statistics.

Reset All Statistics

• Public label: Reset All Statistics
• Location: Plugin Settings > Tools > Analytics
• Type: Danger button
• Default value: None
• Shown when: Enable Filter Analytics is on.
• Availability: Free
• What it does: Clears collected filter analytics statistics.
• When to use: Use it when starting a new measurement period or removing old analytics data.
• Side effects / performance notes: This is destructive for analytics history and cannot be treated as a temporary filter.
• Related options: Enable Filter Analytics, Data Retention Period, Debug Mode.