Installation
Before installing the extension, please make sure to Backup your web directory and store database
You will require to install MageDelight Base Extension first. If it is not installed then please download it from https://www.magedelight.com/pub/extensions/magedelight-base.zip and unzip the package file into the root folder of your Magento 2 installation.
Root Directory is - "app/code/magedelight/#YourExtensionName#"
- Unzip the extension package file into the root folder of your Magento 2 installation.
- Connect to SSH console of your server:
- Navigate to the root folder of your Magento 2 setup
Run command as per below sequence,
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:clean
- log out from the backend and log in again
If you are using Magento 2.3 or later then you do not need to activate license. Extension will be activated with silent activation mechanism and does not require activation keys to be entered manually.
Installation with Composer
Composer repository using this command:
composer config repositories.magedelight-repo composer https://packages.magedelight.com/
Replace repo public key and private key with your public and private key
composer config http-basic.gitlab.magedelight.com $PUBLIC_KEY $PRIVATE_KEY
composer require mage_delight/backend-reindex_module
To obtain your public and private keys, please navigate to the "My Account" section. In the "Download Extension Packages" tab, you will find the keys available for your access.
Backend Configuration (Admin side)
| Field | Description |
|---|---|
| Enable Module | Enables or disables the entire Backend Reindex module. When disabled, all related reindex and cache flush features provided by the extension remain unavailable in the admin panel. |
| Enable Backend Reindexing | Controls whether reindex actions can be performed directly from the Magento backend. When enabled, administrators can trigger reindex processes without using command-line operations. |
| Enable Backend Cache Flush | Controls whether the cache flush functionality is available from the admin panel. When enabled, administrators can clear cache directly from the backend for faster maintenance. |
| Enable Floating Sidebar Menu | Enables a floating sidebar menu in the admin area for quick access to module actions. This helps administrators perform key maintenance tasks more conveniently from anywhere in the backend. |
| Show Reindex Button in Sidebar | Displays the Reindex All button inside the floating sidebar menu. This allows administrators to quickly trigger the reindex process from the sidebar. |
| Show Cache Flush Button in Sidebar | Displays the Flush Cache button inside the floating sidebar menu. This allows administrators to quickly clear cache directly from the sidebar. |
Backend Functionality
Index Management
| Field | Description |
|---|---|
| Actions | Allows administrators to perform bulk operations on selected indexers from the dropdown menu. |
| Indexer | Displays the name of the index process available in the grid. Each indexer is responsible for updating a specific type of store data. |
| Description | Provides a short explanation of what data the selected indexer manages or rebuilds. |
| Mode | Shows the current indexing mode applied to the indexer, such as updating data automatically by schedule. |
| Status | Indicates the current state of the indexer, helping administrators identify whether it is ready, processing, or requires attention. |
| Action | Provides a direct action button for the selected indexer, such as resetting the index when needed. |
| Schedule Status | Displays the current cron-based execution status of the indexer, including whether it is idle or has pending items in the backlog. |
| Updated | Shows the date and time when the indexer was last updated or processed. |
| Selection Checkbox | Allows administrators to select one or more indexers for applying bulk actions. |
Reindex Selected Indexers
- To reindex selected data from the Index Management grid, administrators can mark the required indexers using the selection checkboxes and then choose the reindex action from the Actions dropdown. This makes it easy to process only specific indexers instead of running a full reindex for all records. After selecting the required action, the chosen indexers can be submitted for reindexing directly from the grid.
| Field | Description |
|---|---|
| Selection Checkbox | Allows administrators to select one or more indexers for bulk processing. |
| Actions | Displays the list of bulk actions that can be applied to the selected indexers. |
| Update on Save | Sets the selected indexers to update immediately whenever related data is changed. |
| Update by Schedule | Sets the selected indexers to run automatically based on the configured schedule. |
| Invalidate Index | Marks the selected indexers as invalid so they can be rebuilt later. |
| Reindex Data | Triggers reindexing for the selected indexers directly from the admin grid. |
| Records Found | Displays the total number of indexer records available in the grid and highlights how many are currently selected. |
- After selecting the required indexers and choosing the Reindex Data action from the Actions dropdown, click the Submit button to start the reindex process for the selected records. This executes the chosen action directly from the grid and begins updating the selected index data.
Thank you for choosing MageDelight!