Introducing the New OXID eShop Consistency Check Component
Data consistency is essential to keeping your OXID eShop fast, reliable, and easy to maintain. That’s why we’re introducing the new OXID Consistency Check Component which is a flexible tool designed to support a growing range of checks that help identify inconsistencies in your shop.
This new component is part of a broader initiative to improve shop hygiene and long-term performance. While the first available check targets unused image files, future checks will address other areas such as SEO URL structure, data anomalies, and more.
Whether you're managing media files, URLs, or other shop elements, the Consistency Check Component provides a unified way to audit, verify, and clean up your eShop.
Why Consistency Matters
Inconsistent data or leftover system artifacts can degrade shop performance and create friction during maintenance. The Consistency Check Component provides a standardized way to catch these inconsistencies early whether they come from outdated SEO URLs, unused assets, or broken references.
By incorporating small but powerful tools like these, shop owners can proactively manage and clean their systems with confidence.
A Closer Look: Unused Image Check
The first available check in the Consistency Check Component focuses on detecting and managing unused image files. While this is only one use case, it addresses a common pain point in long-running shop’s media files that are no longer linked to products, categories, or manufacturers.
The tool allows you to: - Perform a dry-run to preview affected files - Move unused images to a backup folder - Permanently delete them (if safe) - Log all actions for auditing.
You can find the component on GitHub: https://github.com/OXID-eSales/consistency-check-too
Compatibility
The tool is fully compatible with OXID eShop Compilation version 7.3.0.
Installation
To get started, simply install the tool via Composer:
composer require oxid-esales/consistency-check-tool
Repository: https://github.com/OXID-eSales/consistency-check-tool
Usage: Image Check Commands
Move unused images to a backup directory:
vendor/bin/oe-console oe:consistency_check:move-unused-images --destination=out/pictures/backup/
Tip: The --destination path is relative to your shop root.
Permanently delete unused images:
vendor/bin/oe-console oe:consistency_check:delete-unused-images
Run a dry-run first (recommended):
vendor/bin/oe-console oe:consistency_check:delete-unused-images --dry-run
vendor/bin/oe-console oe:consistency_check:move-unused-images --destination=/path/to/backup --dry-run
Filter by entity (e.g., products only):
vendor/bin/oe-console oe:consistency_check:delete-unused-images --type=product
Verbose output (shows what would be moved or deleted):
vendor/bin/oe-console oe:consistency_check:delete-unused-images --dry-run -v
log/oe_consistency_check.log
Custom Configuration
You can customize log paths or image directories via the configurable_services.yaml file in
/var/configuration/configurable_services.yaml
parameters:
app.log_file_path: '/custom/path/to/oe_consistency_check.log'
Visual Overview (for Current Image Check)
Below is a visual summary of the current image check feature:
Figure 1: The image check helps identify unused image files and optionally move or delete them.
The workflow below shows how consistency checks operate generally:
Figure 2: General process of consistency checks – from scanning to logging.
Looking Ahead
The Consistency Check Component is built to evolve. While image cleanup is the first available feature, future checks will focus on entirely different areas such as SEO URL consistency, data integrity validation, and beyond. Each feature aims to improve long-term performance and maintain a clean system state.
We’d Love to Hear from You!
Have feedback, questions, or ideas for the next consistency check? Let us know! Your input helps us build features that matter.
GitHub Repository: github.com/OXID-eSales/consistency-check-tool
About the Author:
Rahat Hameed is a Software Developer at OXID eSales, building innovative features for the OXID platform.
