CHILI GraFx-Publisher - Document Workflow
Introduction
The "Document Workflow" extension for the "CHILIConnector for Magento 2.x" extends the CHILIConnector with simple document approval workflow functionalities. The document editor acts as "requestor" while a person assigned to him acts as "supervisor".
If a workflow is active, adding a product to the cart is not possible until the document is approved by the supervisor. The people involved are notified by email when a workflow is started or the document status is later updated. In addition, the people involved can view the processing status at any time in the document workflow list in their user account.
After approving the document, the requester can add the document to the shopping cart from the document workflow list.
Module
extension-name: enobis/module-chili-document-workflow
Latest stable version
version: 1.13.2Install & Update
First you need to add our private repo to your composer.json of your magento installation:
composer config repositories.enobis-your-reponame composer https://satis.enobis.de/customers/your-reponame/
Important: All repos are secured by an ip-protection or an user-authentication. Access Credentials are provided by us!
To install the CHILIconnector-extension use composer via ssh:
composer require enobis/extension-name
To update the CHILIconnector-extension use composer via ssh:
composer update enobis/extension-name
Afterwards you have to complete your Magento2.x installation by
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:reindexChangelog
- 1.13.1 - 1.13.2 - fixes for optional and adhoc workflow items
- 1.13.0 - backend grid for document workflow items
- 1.12.7 - 1.12.8 - fixes for table prefixes
- 1.12.0 - 1.12.6 - several bugfixes and optimizations
- 1.11.0 - improved customer chili supervisor select, add "assign chili supervisor" mass action to customer grid, move all "chili document workflow" specific attributes into own "Chili Document Workflow" Attribute Group
- 1.10.0 - PDF Download Links in Customer and Supervisor Lists
- 1.9.1 - 1.9.23 - several bugfixes
- 1.9.1 - add delete/restore functionality for approved/declined documents on customer documents list
- 1.9.1 - add delete/restore functionality for approved/declined documents on customer documents list
- 1.9.0 -"add to cart"-link in document update email
- 1.8 - copy document in workflow list
- 1.7 - supervisor determination priotrity feature
- 1.6 - introduction of approved documents reminder
- 1.1 - 1.5 - multiple bugfixes and features
- 1.0 - inital version
Roadmap
- Support for multiple workflow supervisor
Prerequisites
Our extensions are not available via the magento-marketplace or packagist.org! The extensions are only available via a (private) repository!
In order to get access, a valid license-agreement is required!
If you have no access to our repositories, please contact us!
Addons
The following modules are available as addons:- n/a
Support
If you need help using one of our extensions, please get in touch with us by sending us an email to support@enobis.de.
Features-Overview
Simple approval workflow functionalites
Simple workflow functionalities with three different modes. Activated document workflows disables add to cart for chili documents - this is possible after approval by the responsible person (supervisor).
Different workflow modes
Standard: A document workflow for the Chili document is always started, so that only one document request to the supervisor is possible. It is not possible to add the Chili Document directly to the shopping cart. However, if no supervisor can be determined for the Chili document, the workflow is not activated and a corresponding error message appears. Adding to the shopping cart is not possible in any case.
Optional: A document workflow is only activated if a supervisor can be determined. If a supervisor can be determined, the document workflow is activated. It is not possible to add the Chili document directly to the shopping cart. If no supervisor could be found, no document workflow will be started and direct addition to the shopping cart is possible.
Adhoc: A document workflow can be activated interactively - based on the "document status". If a variable "chili_document_workflow_required" (needs to be created in the document) is not NULL, the document workflow will be activated.
Fully integrated into the storefront of Magento
Requested documents can be managed via the document workflow list - both by the requestor and the supervisor.
Workflow configuration on different levels
Activation on system-, customer and product-level possible (New from version 1.7): configurable supervisor determination rule [system->product->customer (customer wins) [default] or system->customer->product (product wins)]
Comment feature
Comment field(s) allows comments to be entered in the Magento storefront. "Viewer-Only" and "Supervisor" views allow consistent access to the document during the document workflow (requester, editor)
(Email) notification of involved user
The involved persons are informed about status changes via email. A customer can be notified about a new approval after the login.
Reminder functionality
Send automatic reminder (regarding missing approval/disapproval) emails to the supervisor after a given period of time (24h, 48h,72h, 240h).
Bestpractices & Faq
Bestpractice (coming soon)
FAQ (coming soon)
Configuration-Parameter
Please note: These documentation referes to the latest module version only!
Stores->Configuration->CHILI->CHILI-Document-Workflow->General
Option Type Description Scope Enabled Yes, No (Default) Activates the document workflow functionality System->Storeview
System->ProductSupervisor Determination Priority Dropdown How to determine the actual supervisor of this workflow process. There are two possible determination priorities:
Customer->Product->Default Values (supervisor configuration at customer wins)
Product->Customer->Default Values (supervisor configuration at product wins)
System->Storeview
System->Product
System->CustomerChili Workspace Supervisor String Name of Chili environment System->Storeview
System->ProductString Workspace for supervisor System->Storeview
System->ProductString View-preference for supervisor System->Storeview
System->ProductDropdown List with all possible customers, which acts as the default supervisor, if there is no individual supervisor selection at product- or customer level. System->Storeview
System->ProductYes, No (Default) Activates / Disables the comment box for workflow processes. If enabled, the user can add comments to the comment field and send these comments to the supervisor. System->Storeview
Stores->Configuration->CHILI->CHILI-Document-Workflow->Workflow Configuration
Option Type Description Scope Disable Versioning Yes, No (Default) If disabled (Default) a copy of the working draft will be created after the user requests the document again (after disapproval) at the supervisor. So the old version still exist on the ChiliServer. We recommend to "disable versioning".
System->Storeview
Product->StoreviewEnable Re-Request Yes, No (Default) Activates a "Re-request" button in the document approval list and allows the user to request the document again from the supervisor (after previous rejection) System->Storeview
Product->StoreviewEnable save and move to my drafts for AdHoc Workflows Dropdown List of view document constraints (from Environment) System->Storeview
Product->StoreviewStores->Configuration->CHILI->CHILI-Document-Workflow->Email Configuration
Option Type Description Scope Yes, No (Default) Activates email notification for a new document request for the supervisor System->Storeview
Yes, No (Default) Activates direct pdf renderer link in notification email notification (see above) System->Storeview Dropdown Who is the sender of the notification email
System->Storeview Dropdown Selection of email templates for notification email System->Storeview
string comma separated list of additional recepients of notification email System->Storeview
Dropdown Send notification email as a copy to additional recepients by BCC: BlindCarbonCopy or
separated email
System->Storeview
Yes, No (Default) Activates email update notification for an updated document request status.
System->Storeview
Dropdown Who is the sender of the update notification email
System->Storeview
Dropdown Selection of email templates for update notification email
System->Storeview
Yes, No (Default) @Todo
System->Website
Stores->Configuration->CHILI->CHILI-Document-Workflow->Workflow Mode
Option Type Description Scope Yes, No (Default) Activates "optional workflow"-mode System->Storeview
Yes, No (Default) Activates "adhoc workflow"-mode System->Storeview Yes, No (Default) Activates"collaboration workflow"-mode (@Todo)
System->Storeview Yes, No (Default) (@Todo) System->Storeview
Yes (Default), No (@Todo) System->Storeview
Yes, No (Default) (@Todo)
System->Storeview
Yes, No (Default) (@Todo)
System->Storeview
Stores->Configuration->CHILI->CHILI-Document-Workflow->Workflow List
Option Type Description Scope Show product names in the document list Yes, No (Default) Shows productnames in the document workflow list System->Storeview
None (Default), Lowres, Highres Activatespdf render link in the supervisor document workflow list System->Storeview None (Default), Lowres, Highres Activatespdf render link in the customer document workflow list
System->Storeview Yes, No (Default) Shows preview image in the document workflow list @Todo: doesn't workflow actually System->Storeview
multiple select Selection of possible document workflow status - filters documents from the document workflow list System->Website
Yes, No (Default) (@Todo)
System->Storeview
Yes, No (Default) (@Todo)
System->Storeview
Enable Add To Cart In Chili Yes, No (Default) (@Todo)
System->Storeview
Yes, No (Default) (@Todo)
System->Storeview
Yes, No (Default) Activates "delete"-button for supervisor. Deletes the document from the workflow list.
System->Storeview
Yes, No (Default) Activates "copy"-button for customer. Creates a copy of a requested document and opens the editor with it. Gives the possibility to request different documents based on the same original fast.
System->Storeview
Stores->Configuration->CHILI->CHILI-Document-Workflow->Advanced Configuration
Option Type Description Scope Chili Folder Document Workflow Process Yes, No (Default) Save requested documents into a dedicated folder rather to save them to the temp-folder. System->Storeview
String Possible values for folder naming of the requested documents.
{{document_workflow_id}} document workflow ID
{{document_id}} document ID
{{document_workflow_created_at}} document workflow created date (Ymd)
{{document_workflow_status}} document workflow status
{{product_name}} product name
{{customer_name}} customer name
{{date}} current date (Ymd)System->Storeview Enable automatic PDF-Generation on Request/Approved Yes, No (Default) Generates the pdf-document automatically on the server
System->Storeview PDF-Generation Behavior Dropdown Sync (generates PDF directly after creating the document request), Async (generates PDF via async via Cron-Task)
System->Storeview Yes, No (Default) When set to "Yes", customer gets information about rejected workflow documents after log in.
System->Websites
String Message string for customer System->Storeview
Stores->Configuration->CHILI->CHILI-Document-Workflow->Approved Workflow Document Reminder
Option Type Description Scope Enabled Yes, No (Default) Activates the approved document reminder functionality. Sends reminder emails to the supervisor to approve documents asap. System->Storeview
Dropdown List of possible email senders
System->Storeview Send Document Reminder Email Copy To String comma separated list of emails for sending the document reminder email to
System->Storeview Send Document Reminder Email Copy Method Dropdown BCC, Separate Email
System->Storeview Level Grid Time period: 24h, 48h, 72h, 240h
Email template: List of email templates for reminder emailSystem->Storeview Customer Notification Approved Workflow Documents Yes, No (Default) When set to "Yes", customer gets information about approved workflow documents after log in.
System->Websites
String Message string for customer System->Storeview