Mage-Chili-Connector – Document Workflow Plugin

Online-Documentation
Compatible with Magento 2.1.x – 2.2.6. and Chili-Publisher/ UGE 4.x, 5.x
Version: 1.3.5.1

Introduction

The „Approval Workflow Plugin“ introduces an optional approval workflow for chili documents. If the approval workflow is activated for the product, the chili document can´t be ordered (can´t be added to the cart) directly. An approval of the document has to be requested from the supervisor first. After an approval by the superior, the chili document/ chili product can ordered as usual. If a document needs a rework, the supervior is able to reject the document.

2. Prerequisites and Installation

Prerequisites

Magento 1.9.x / Magento 2.1.x
Mage-Chili-Connector V1.x
ChiliPublisher 4.x

Installation

Use the following commands within your ssh-commandline to install the extension.

  1. composer require enobis/module-chili-document-workflow
  2. php bin/magento setup:upgrade
  3. php bin/magento setup:di:compile
  4. php bin/magento setup:static-content:deploy
  5. php bin/magento cache:clean
  6. php bin/magento indexer:reindex

Please note: The extension is not available via the magento-marketplace or packagist.org! The extension is only available via a our private repository! In order to get access, a valid license-agreement is required!

3. Quickstart – Approval Workflow

  • Install the approval workflow plugin – for installation instructions, please follow this guide
  • Login in to your magento-backend
  • Activate the approval workflow in the storefront (stores->configuration->Chili->Chili Editor->document workflow)
  • Setup a product as approval workflow product by enabling the approval workflow for this product (products->catalog->chili->“approval workflow enabled“). Make sure you have assigned a supervisor at customer-level for your test customer (customers->all customers->chili supervisor)
  • Go to the storefront and login with your customer. Open the chili product and press the „edit“-button within your product-view. The CHILIpublisher opens and you can now „request“ the product at your supervisor. Adding the chili document direclty to the cart is disabled!

4. First setup and basic configuration

The configuration of the mage-chili-connector can be found at different configuration areas. There are store-specific configuration parameters and product-specific configuration parameters.

Important: Product-specific configuration parameters overwrite store-specific configuration parameters.

  1. Stores->Configuration->Chili->Chili Editor->Document Workflow
Parameter Example Scope Comment
Enabled Yes, No Storeview Enable Approval Workflow generally
New Document Supervisor Email Enabled Yes, No Storeview Possibility to notify the supervisor by email if an approval workflow is started.
New Document Supervisor Email PDF Link Enabled Yes, No Storeview Enable direct link to the rendered pdf-document for supervisor.
New Document Supervisor Email Sender General Contact, Sales
Representative, …
Storeview Who is the sender of the “new document”-notification-email?
New Document Supervisor Email Template Storeview Email-Template-Selection from Email-Templates
Send New Document Supervisor Email Copy To Email Storeview Possibility to send copies of the notification to additional recipients
Send New Document Supervisor Email Copy Method BCC, Separate Email Storeview How to send the notifaction copies
Document Update Email Enabled Yes, No Storeview Possibility to notify the related persons when the document is updated.
Document Update Email Sender General Contact, Sales
Representative, …
Storeview Who is the sender of the “document update”-notificationemail?
Chili Workspace Supervisor List of Workspaces Storeview Default Workspace for the supervisor
Chili View Preference Supervisor List of View Preferences Storeview Default View Preference for the supervisor
Default Supervisor List of users Storeview Possibility to configure a default supervisor (if no product based or customer based supervisor exist)
Show Product Name In Document List Yes, No Storeview Shows the product name in „my documents“ instead of document_id

5. Product configuration

Some configuration parameters can overwrite the default configuration.

  1. Products->Catalog->Product->Chili Editor
Parameter Example Scope Comment
Chili Document Workflow Yes, No Storeview Enable or disable approval workflow for this product
Chili Workspace Supervisor List of Workspaces Storeview Default Workspace for the supervisor
Chili View Preference Supervisor List of View Preferences Storeview Default View Preference for the supervisor

6. Storefront integration

General workflow: If the approval workflow is activated for the product, the product can´t be ordered. An approval of the document has to be requested from the supervisor first. After an approval by the supervisor, the chili document/ chili product can ordered(added to the cart) as usual. If a document needs a rework, the supervior is able to reject the document.

Types of supervisors: There are three types of supervisors.

  • default supervisor: A default supervisor for the store configured on website or storeview level
  • product specific supervisor: A supervisor for a specific product (product specific superviors replace the default supervisors)
  • customer specific supervisor: A customer specific supervisor replaces a product specific supervisor or the default supervisor

Document status: Documents can have three statuses – „requested“, „rejected“ and „approved“. Every document approval workflows starts with the „requested“ state. Then the supervisor has to approve or reject the document. If the document will be „rejected“, the user has the chance to rework his document and to request it again. One the document is „approved“ by the supervisor, it can be added to the cart and ordered by the user. Both the user and the supervisor will be notified via email about every status change.

document approval

Request an approval for your documents, before you can add it to the cart.

A flexible „workspace“ and „view preferences“ configuration at product level ensures that the supervisor always gets the right permissions for the document approval.

my documents

View the approval state of your documents at your account. Rework documents if needed or add approved documents to the cart directly.

email notification

Be notified of your document approval via email! Both the user and the superior are informed about the status of the request.

Mage-Chili-Connector – Approval Workflow Plugin

7. Changelog

We are permanently optimizing the workflow plugin. Please find below our changelog. If you have any suggestions – please let us know!

Version Name Description
1.0.0 Initial Relase Basic integration of approval workflow
1.2.0 compatibility with magento 2.2 – compatibility with magento 2.2
1.3.0 advanced supervisor functions – introduction of default supervisor for approval workflow
– introduction of product based supervisor
– optimization „my documents“ – shows productname instead of documentid
1.3.1 optimization supervisor comment is now avaiable in the email-template
1.3.2 optimization compatibility with chili-editor 1.3.4
1.3.3 pdf-export via rendering-link, use of product based pdf-export-settings
1.x.x save approval workflow documents to wishlist Saving a chili document product (with activated document workflow) to the wishlist is actually not supported! Because there are some functions within the wishlist (add all to cart, add to cart) which are not compatible with the approval workflow process.

8. Extension Update

Extension-Update via ssh

Update

Use the following commands within your ssh-commandline to update the extension.

  1. composer update
  2. php bin/magento database:upgrade
  3. php bin/magento setup:di:compile
  4. php bin/magento setup:static-content:deploy
  5. php bin/magento cache:clean
  6. php bin/magento indexer:reindex

Please note: The extension is not available via the magento-marketplace or packagist.org! The extension is only available via a our private repository! In order to get access, a valid license-agreement is required!

Contact us!

You need help or more information?
Please fill in the following contact form –
we will contact you as soon as possible!