Document-Workflow-Extension
[für Mage-Chili-Connector]

Compatible with Magento 2.1.x – 2.3.x. and Chili-Publisher/ UGE 4.x, 5.x
Requirement: Mage-Chili-Connector
Latest Version: 1.4.3

Die „Dokument-Workflow“-Erweiterung für den „CHILI-Connector für Magento“ erweitert den ChILI-Connector um einfache Dokumenten-Workflow-Funktionalitäten.

Die Basis der Extension ermöglicht es Ihnen einen einfachen Freigabe-Workflow für Chili-Dokumente zu aktivieren. Dabei agiert der Dokumenten-Bearbeiter als „Anfrager“ und eine Ihm zugeordnete Person als „Bearbeiter“. Der „Bearbeiter“ gilt dann als „Supervisor“ und wird und wird über folgende Logik im System ermittelt.

  • gibt es im System einen allgemeinen Supervisor für Chili-Workflow-Dokumente?
  • gibt es am Produkt einen Chili-Workflow Supervisor? Diese Konfiguration überschreibt dabei die allgemeine Systemkonfiguration.
  • gibt es für den aktuellen User  („Anfrager“) einen Chili-Workflow-Supervisor? Diese Konfiguration überschreibt dabei die Konfiguration am Produkt.

Bei einem aktivierten Dokumenten-Workflow ermöglichen verschiedene Workflow-Modi unterschiedliche Szenarien abzubilden:

  • Standard: Ein Dokumenten-Workflow für das Chili-Dokument wird immer gestartet, so dass ausschließlich eine Dokumentenanfrage beim Supervisor möglich ist. Das direkte Hinzufügen des Chili-Dokuments zum Warenkorb ist nicht möglich. Kann allerdings kein Supervisor für das Chili-Dokument ermittelt werden, wird der Workflow nicht aktiviert und es erscheint eine entsprechende Fehlermeldung. Das Hinzufügen zum Warenkorb ist in jedem Fall nicht möglich.
  • Optional: Ein Dokumenten-Workflow wird nur dann aktiviert, wenn ein Supervisor ermittelt werden kann. Konnte ein Supervisor ermittelt werden, so wird der Dokumenten-Workflow aktiviert. Das direkte Hinzufügen des Chili-Dokuments zum Warenkorb ist nicht möglich. Konnte kein Supervisor ermittelt werden, so kann kein Dokumenten-Workflow gestartet werden und das direkte Hinzufügen zum Warenkorb ist möglich.
  • Adhoc: Ein Dokumenten-Workflow kann anhand des „Dokumentenzustands“ aktiviert werden. D.h. ob ein Workflow aktiviert wird oder ein direktes Hinzufügen zum Warenkorb möglich ist, hängt vom Zustand der Dokumentenbearbeitung ab.

Wird nun ein Dokumenten-Workflow aktiviert, so muss zunächst das Chili-Dokument vom „Supervisor“ freigegeben werden, bevor der „Anfrager“ das Dokument in den Warenkorb legen kann. Über die Aktivierung eines Workflows und einer späteren Aktualisierung des Workflow-Status werden die beteiligten Personen via Email benachrichtigt. Zudem können die beteiligten Personen den Bearbeitungszustand jederzeit im Benutzerkonto einsehen.

Name

Document-Workflow-Extension
[für Mage-Chili-Connector]

Version

Version: 1.4.3

Requirements

Mage-Chili-Connector
Compatible with Magento 2.1.x – 2.3.x. and
Chili-Publisher/ UGE 4.x, 5.x

Key-Features

  • einfache Workflow-Funktionalitäten mit drei verschiedenen Konfigurationen (Standard, Optional, Adhoc)
  • Allgemeine Aktivierung je Produkt/ Dokument möglich
  • Aktivierte Dokumenten-Workflows unterdrücken ein direktes Hinzufügen des Chili-Dokuments zum Warenkorb – dies ist er nach Freigabe durch den zuständigen Bearbeiter (Supervisor) möglich
  • (optionale) Möglichkeit zur Nachbearbeitung nach Ablehnung eines Dokuments
  • Beteiligte Personen (Anfrage, Bearbeiter) werden durch Emails über den aktuellen Zustand des Workflows informiert
  • Beteiligte Personen haben über alle Workflow-Vorgänge eine Bearbeitungsliste (angefragte Dokumente und freizugebene Dokumente)
  • Kommentarfeld(er) ermöglicht die magentoseitige Angabe von Kommentaren
  • Optionale Unterstützung für Preflight-Check (Chili) und direktem PDF-Download (eigenständige PDF-Render-Settings)

Aktivierter Dokumenten Workflow im Editor Panel

Bei einem aktivierten Freigabe-Workflow muss der User zunächst eine Freigabe für sein Dokument erhalten, bevor er dieses in den Warenkorb legen kann. Bis zur Freigabe wird so die  Standard-Funktion „Add to Cart“ durch die Workflow-Funktion „Request“ ersetzt. Der zugeordnete „Bearbeiter“ (Supervisor) wird über den gestarteten Dokumenten-Workflow per Email informiert.

„Viewer Only“ bzw. Freigabe-Ansichten für den „Bearbeiter“ (Supervisor)

Die spezielle „View-Only“-Ansicht stellt den eindeutigen Bearbeitungszustand des Dokuments sicher. Sobald eine Anfrage getätigt wurde, erhält der „Anfrager“ nur noch im „Viewer-Only“-Modus den Zugriff auf das Dokument. In diesem Zustand kann nichts mehr am Dokument geändert werden. Gleichzeitig erhält der „Bearbeiter“ (Supervisor) Zugriff auf das Dokument. Dabei können die Zugriffsmöglichkeiten des „Bearbeiters“ über eine eigene Workspace-Definition frei definiert werden – diese können somit vom „Viewer-Only“-Modus bis hin zum „Vollzugriff“-Modus reichen.

Statuslisten im Benutzerkonto

Die Statuslisten im Benutzer-Konto (jeweils separat für User und Bearbeiter) bieten einen Überblick über die gerade aktiven Dokumenten-Workflows. Nur freigebene Dokumente können über die Funktion „Add to Cart“ später dem Warenkorb hinzugefügt werden.

Backend

Zahlreiche Konfigurationsmöglichkeiten zum Dokumenten-Workflow sind über das Magento-Backend auf System- und Produktebene möglich.

Frontend-Features

  • einfache Workflow-Funktionalitäten mit drei verschiedenen Konfigurationen (Standard, Optional, Adhoc)
  • Allgemeine Aktivierung je Produkt/ Dokument möglich
  • Aktivierte Dokumenten-Workflows unterdrücken ein direktes Hinzufügen des Chili-Dokuments zum Warenkorb – dies ist er nach Freigabe durch den zuständigen Bearbeiter (Supervisor) möglich
  • (optionale) Möglichkeit zur Nachbearbeitung nach Ablehnung eines Dokuments
  • Beteiligte Personen (Anfrage, Bearbeiter) werden durch Emails über den aktuellen Zustand des Workflows informiert
  • Beteiligte Personen haben über alle Workflow-Vorgänge eine Bearbeitungsliste (angefragte Dokumente und freizugebene Dokumente)
  • Kommentarfeld(er) ermöglicht die magentoseitige Angabe von Kommentaren
  • „Viewer-Only“- und „Supervisor“-Ansicht ermöglichen den konsistenten Zugriff auf das Dokument während des Dokumenten-Workflows (Anfrager, Bearbeiter)
  • Optionale Unterstützung für Preflight-Check (Chili) und direktem PDF-Download (eigenständige PDF-Render-Settings)

Backend-Features

  • Aktivierung / Deaktivierung des systemweiten Dokumenten-Workflows
  • Aktivierung/ Deaktivierung Emailbenachrichtigung des Bearbeiters (Supervisor)
  • Aktivierung/ Deaktivierung PDF-Download-Link innerhalb Emailbenachrichtigung des Bearbeiters (Supervisor)
  • Auswahl Email Template für Emailbenachrichtigung des Bearbeiters (Supervisor)
  • Möglichkeit zur Versendung der Emailbenachrichtigung des Bearbeiters (Supervisor) an weitere Emailadressen (BCC, CC)
  • Aktivierung/ Deaktivierung ReRequest (Möglichkeit zur wiederholten Anfrage nach Ablehnung)
  • Aktivierung / Deaktivierung der Workflow-Versionierung – bei aktivierter Versionierung wird bei einer zweiten Anfrage (ReRequest) eine Kopie vom Original für den Dokumenten-Workflow angelegt. (Der ReRequest läuft also in einem separaten Workflow-Prozess)
  • Konfiguration des Default-Bearbeiters (Supervisor)
  • Konfiguration des Default-Workspace und Viewpreference für den Bearbeiter (Supervisor)
  • Konfiguration des Workspaces im View-Only-Mode (gilt für User und Bearbeiter während des Workflows (sofern sie gerade passiv sind)
  • Konfiguration „Bearbeiter kann Dokument-Workflow-Item“ löschen
  • Konfiguration „Chili Folder Document Workflow Process“ –>Möglichkeit zur Konfiguration der Dokumentenablage eines Dokument-Workflow-Items
  • Konfiguration „Enable automatic PDF-Generation on Request/Approved“ –>Möglichkeit zur Aktivierung der automatischen PDF-Generierung nach Dokument-Workflow-Anfrage
  • Aktivierung weiterer Workflow-Modi „Optional“, „Adhoc“ und „Collaboration“

Installation

  • To install the extension we recommend to use “composer”. Please use the following commands within your ssh-commandline to install the extension.
    composer require enobis/chili-document-workflow
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy
    php bin/magento cache:clean
    php bin/magento indexer:reindex
    Please note: The extension is not available via the magento-marketplace or packagist.org!
  • Bereitstellung der Extension mittels privatem (Satis-)Repository
  • Zugriff auf aktuellste Version der Extension durch automatische Aktualisierung des Repositories (gültige Maintenance-Vereinbarung vorausgesetzt)

Changelog

Version Typ Inhalt Bemerkung
1.0.0 Initial Release Basic integration of document-workflow
1.1.0 – 1.3.6 bugfix and optimizations
1.3.7 optimizations – Customer Account – „my requested documents“ and „my releaseable documents“  will only be shown if items are available
– suppress Static Chili Attributes injection while in both active workflow views (customer + supervisor) #10434
1.3.7.2 bugfix and optimizations – add „Save Document“ Button to save possible document changes
– fix: automatic static data injection not working in order workflow impersonation mode
1.3.7.3 optimizations auto „go back“ after „Save + Close“ click
1.3.8 optimizations – added missing translations
– minor bugfixes
1.4.0 optimizations – add document_workflow_id column in workflow list
– protect request button against multiple clicks
– add „Chili Folder Document Workflow Process“ system config
– add „cdw_pdf_export_settings“ product attribute
– processs document on request and release
1.4.1 features – add comment for document request
– show comment in rework
– wrap supervisor approve buttons to possible hide them
– support for php7.2
1.4.2 features – provide basic functions for external integrations
– api to change status from external systems
1.4.3 features – additional workflow modes: optional, adhoc and collaboration