Studio1® Pimcore Workflow Extend Bundle

This bundles extends Pimcore's workflow engine and workflow designer with additional features.

It adds the possibility to change data during the workflow transition. It also adds a readonly field to place editor of the Pimcore workflow designer to display the state id.

Warning: This bundle is completely untested with the Pimcore community edition and will probably not work. Further work is needed to make it work with the community edition.

Dependencies

Will be automatically installed with composer:

• Pimcore Enterprise Asset Metadata Bundle
• Pimcore Workflow Designer
• Composer Patches

Installation

Preparation

Before you require the bundle via composer, you need to add the following to your composer.json:

  "extra": {
    "enable-patching": true
  }

This will enable the composer patches plugin, for external dependencies.

Composer

composer require studio1/workflow-extend:[version]

During the installation process, the composer patches plugin will automatically apply the needed patches to the pimcore core files.

Please check if the patches were applied correctly. If not, you need to remove the vendor folder and run composer install again.

Enable Bundle

Enable the bundle as with any other Pimcore bundle, add it bundle.php.

Uninstall

composer remove studio1/workflow-extend

Please note that the composer patches plugin will not remove the patches automatically. You need to remove them manually.

Usage / Configuration

Warning: The bundle currently supports data objects and assets only (no documents etc.).

For Pimcore Enterprise Projects, you can configure the workflow transitions in the backend:

In Pimcore Community Edition, you need to populate the data option (implemented by this bundle) in your workflow configuration:

  transitions:
    example-transition:
      options:
        label: 'Example transition'
        # ...
        # data that will be changed during the transition
        data:
          class: Basic
          attribute: Title
          value: test
          languages: 'de,de_DE'
          languagesSetAll: true

Logs

Can be found in var/log/workflow-extend-bundle.log.

Main components

• transitionSettings.js.patch
  • Extends the Pimcore Workflow Designer by additional fields for the transition settings popup
• SetAttributeSubscriber.php
  • Listens to the workflow.transition event and changes the data
• addDiConfiguration.patch
  • Adds the data option to the workflow configuration
  • A patch file is needed, since there is no other way to extend the dependency injection configuration of the workflow bundle
• placeSettings.js.patch
  • Extends the Pimcore Workflow Designer by additional field for the state id
  •