This is archived documentation for Magento v2.2 and is no longer supported. Go to the latest documentation.
Magento Commerce only

Magento_CatalogRuleStaging module

The Magento_CatalogRuleStaging module is a part of the staging functionality in Magento Commerce. It enables you to add the catalog rule updates to existing store campaigns. In other words, you can add and/or remove catalog rules for some period of time. These updates are shown on the campaign dashboard.

Implementation details

The Magento_CatalogRuleStaging module changes a catalog rule creation page and the catalog rule related database tables to make them compatible with the Magento Staging Framework. This module depends on the Magento_CatalogRule module and extends its functionality. It changes the database structure of the Magento_CatalogRule module and the way in which catalog rules are managed. The Magento_CatalogRule module must be enabled.

The Magento_CatalogRuleStaging module enables you to stage the following catalog rule attributes:

  • Rule Name
  • Description
  • Websites
  • Customer Groups
  • Priority
  • Product Apply
  • Product Discount Amount
  • Subproduct Discounts
  • Subproduct Apply
  • Subproduct Discount Amount
  • Discard Subsequent Rules

These attributes cannot be modified and are a part of the static Magento Catalog Rule form.

Installation details

The Magento_CatalogRuleStaging module makes irreversible changes in a database during installation. You cannot uninstall this module.


You can find the list of modules that have dependencies on the Magento_CatalogRuleStaging module in the require section of the composer.json file. The file is located in the root directory of the module.

Extension points

Extension points enable extension developers to interact with the Magento_CatalogRuleStaging module. You can interact with the Magento_CatalogRuleStaging module using the Magento extension mechanism, see Magento plug-ins.

The Magento dependency injection mechanism enables you to override the functionality of the Magento_CatalogRuleStaging module.


You can extend and override layouts in the app/code/Magento/CatalogRuleStaging/view/adminhtml/layout directory. For more information about layouts, see the Layout documentation.

Additional Information

You can track backward incompatible changes made in a Magento Commerce mainline after the Magento 2.0 release.