Installation

Install the package through the same authenticated SoftwareSilo Composer repository used for your other modules. Composer installs the required Extension Manager package with it.

composer require mageb2b/workflow
php bin/magento module:enable MageB2B_Workflow
php bin/magento setup:upgrade
php bin/magento cache:flush

In production mode, finish with your normal dependency-injection compilation and static-content deployment process.

php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Verify the installation

  1. Sign in to Magento Admin.
  2. Open Content > Workflow > Workflow Definitions.
  3. Confirm that New Workflow is available to a role with workflow management permission.
  4. Open Stores > Configuration > General > Workflow Engine at Default Config scope.
  5. Confirm that Enable Workflow Engine is set to Yes.

The module stores definitions, immutable versions, runs and tasks in Magento. Take a database backup before installing it on an existing store, and deploy the code to every application, cron and queue-worker node before running setup:upgrade.

Runtime prerequisites

The engine dispatches event triggers and run execution through Magento message queues. A successful Admin installation does not prove that live workflows will run. Configure both consumers described in Queues and cron, and make sure Magento cron runs every minute.

Do not publish a business-critical definition until validation, simulation and a controlled end-to-end run have all passed.