CHILIconnector - MyDocuments

Introduction

The "mydocuments"-extension for the CHILIconnector is an addon for the "CHILIconnector"-extension for Magento2.x. It supports

  • an advanced management of documents
  • digital outputs
  • advanced renderer possibilities (pdf-, html- and image-rendering support) Important: This is a bundled feature, which is also available separately!

Module

extension-name: enobis/module-chili-my-document
  • Latest stable version

    version: 1.5.8
  • Install & 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:reindex
  • Changelog

    • 1.5.8 optimization - compatibility with new document preview from chili editor, compatibility to support chili preview image type in my drafts and my digital output lists
    • 1.5.7 optimization - small fix when 0 advanced renderers are defined for a product
    • 1.5.6 optimization - replaced the word Image in Preview in the lists.
    • 1.5.5 optimization - translation
    • 1.5.1 - 1.5.4 - different bugfixes and optimizations
    • 1.5.0 feature - function to create different variations of a document based on a) default template b) actual working draft in editor, "my-documents" specific product attributes are moved to separate attribute group for a better overview
    • 1.4.9 optimization - better naming behaviour at document copy event
    • 1.4.8 bugfix -fix: error while compile/deploy
    • 1.4.7 optimization - improvements chili editor compatibility
    • 1.4.6 bugfix fix: edit form not available in my drafts list
    • 1.4.4 bugfix -fix: qty and price visible when selecting configurable option which has chili free digital output enabled
    • 1.4.3 bugfix - fix: qty field visible for simple and virtual products even when chili_free_digital_output is enabled
    • 1.4.2 bugfix - fix: "save" and "create a copy" button available when allowed guest editor
    • 1.4.1 optimization - add messages when save chili document to my drafts / my digital output, change add to cart button in my drafts list to redirect to chili editor, show add to cart button in my drafts list, show delete button in my drafts list for chili bundle too
    • 1.4.0 compatibility - change status based delete in my digital output list to a permanent delete and add a confirmation popup, removed chili status column from my documents and my digital output list, fix: multiple filteres not applicable at once, fix: possible wrong item counts in topmenu
    • 1.3.1 - 1.3.3 bugfixes - several minor bugfixes
    • 1.3.0 feature - support for document types
    • 1.2.0 feature -support for chili variable chili_digital_output_disallowed to toggle finish function
    • 1.1.0 feature - support for image and html-rendering, support for configurable products
    • 1.0.1 - 1.0.28 bugfixes, optimization - several bugfixes and optimizations
    • 1.0.0 Initial Release
  • Roadmap

    • tool for creating variations - creating variations by using the original document template or the actual document version in editor (finished - version 1.5.0)
  • Prerequisites

    Qur 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:

    • enobis/module-chili-advanced-renderer
  • 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.

Feature-Overview

Advanced Document Management

Manage your documents in a separte "my drafts"-list (in addition to the wishlist). Use "document naming", "document comment", "document copy" and "create document variation" to create documents fast and organise them in a better way.

"My Drafts" and "My Digital Output"-Lists

Separate document lists to manage your documents in a better way. Use the "my drafts"-lists to save your documents and separate them from default products on the wishlist. Save documents to the "digital output"-list, render and download documents directly (free of costs). Filter documents with the "document type"-filter option or use the search functionality to find your documents.

Digital Output

Use the "digital output"-feature to create (marketing) self service solutions. Let your customer create and download print-ready documents free of costs. "Digital output"-documents are saved on a separate "digital output"-list in the customer account area. Use the (optional) "advanced rendering feature to create pdf (standard), image- and even html- (experimental) outputs.

Advanced Rendering Support

The "advanced rendering"-extension supports pdf, image and hmtl rendering. Different rendering profiles can be created and attached to the different render locations/areas (like order-frontend, order-backend, emails, pdf-editor, digital output etc.) in Magento.

P.S. The "advanced rendering"-extension is an optional (free of costs) extension for the "mydocuments"-extension.

  • Advanced Document Management

    • document naming (mandatory, optional, none) incl. comment
    • edit document - opens document in document editor
    • copy document - copies document and creates a new version incl. custom options and adds "copy" to the document name
    • delete document - deletes document from "my drafts"-list
    • add document to cart
    • "pdf download" - renders document as pdf with pdf-preview-settings
    • edit product (opens product for reconfiguration (not document in editor - e.g. to reconfigure product options or custom option values))
    • preview-image of document (if enabled)
    • create variation (from editor panel) - create variations fast, based on the default template or on the actual working draft
    • sorting of document lists
    • document filtering based on "document types"-attribute (product attribute)
    • document search by document name and document comment
    • Special features for bundled products
      • progress bar based on finished documents of the bundled product
      • details area displays the included products
      • legend with information of document status
  • Advanced Editor Panel

    The editor panels offers additional features for the document management.

    • Create a Copy/ Save As - Saves the document as a copy (with new document id) to the "my drafts"-list. The active document remains as working draft in the browser.
    • Save - Saves the document to the "my drafts"-list via ajax.
    • Create variations - Enables the user to create and add different version of the working draft to cart easily. (Must be enabled first)
      • Add to Cart - adds the working draft (document) to the cart
      • Add Variation to cart  - creates a cart item based the actual working draft
      • Create new based on original - adds the actual working draft to the cart and creates a new document based on the original template (master document)
      • Go to Cart - redirects the user to the cart
  • "My Drafts"

     The "my drafts"-list is available in two layout modes

    • grid-mode
    • list-mode

    Grid-Mode: This is very similar to the wishlist view and offers only basic functionalities.

    List-Mode: The "list-mode" has some advanced and exclusive features. It's the recommended mode for the "my drafts"-feature.

    It offers:

    • document name and comment are displayed and are editable
    • preview-image of document (if enabled)
    • details area shows additional information like custom option values
    • "Add to Cart" - adds the product (incl. document) to the cart
    • "edit" - opens product for reconfiguration (not document in editor - e.g. to reconfigure product options or custom option values)
    • "edit document" - opens document in document editor
    • "copy document" - copies document and creates a new version incl. custom options and adds "copy" to the document name
    • "delete" - deletes document from "my drafts"-list
    • "pdf download" - renders document as pdf with pdf-preview-settings
    • sorting of document list
    • filtering of document list by document type
    • document search by document name and document comment
    • Special features for bundled products (bundle-extension for chili necessary)
      • progress bar based on finished documents of the bundled product
      • details area displays the included products
      • legend with information of document status

  • "My Digital Output"

    The "digital output" is a "self service"-feature for rendering documents without checking them out first. Finished documents are stored on a separate "digital output"-list in the customer account and can be rendered and downloaded by the user "without costs" from there easily.

    Supported features:

    • Document naming incl. comment feature
    • Document preview image (if enabled)
    • Rendering and download of documents (incl. support for advanced rendering (bundled extension feature)
    • document copy
    • document delete
    • sorting of document list
    • filtering of document list by document type
    • document search by document name and document comment

  • Advanced Renderer (bundled extension feature)

    The "advanced renderer"-extension is an optional feature of the CHILIconnector and enhances the default renderer functionalities. By default, the CHILIconnector offers "only" PDF rendering (Highres- / Lowres/Preview). The "advanced renderer"-extension supports the image and html-renderer functionalities of the CHILIpublisher. The "advanced renderer"-extension support also multiple renderer settings and multiple renderer locations (frontend order, digital output, editor panel, backend-order and emails)

    Please note: Please refer to the "advanced renderer"-documentation for further information and configuration parameters.

Configuration-Parameter

Please note: These documentation referes to the latest module version only!

  • Stores->Configuration->CHILI->CHILI-My Document

    OptionTypeDescriptionScope
    EnabledYes, No (Default)Possiblity to enable/ disable the "my documents" featureSystem->Storeview
    Naming rulesDropdown

    Three different "kinds of naming" are supported

    • no naming (default)
    • always and required (naming activated and required before the document can be processed further (like adding to the cart or saving to my drafts)
    • always and optional (naming activated and optional before the document can be processed further (like adding to the cart or saving to my drafts)
    System->Storeview
    My Document in Customer AccountYes (Default), No

    Activates separate "my draft"-area in customer account. It introduces a separate "my documents/ my drafts" list in the customer account. Saved documents are listed as drafts instead of the wishlist. Additionally there is a separate "my drafts"-link in the customer-dropdown-navigation which shows how many drafts are available.

    System->Storeview
    Remove Wishlist Customer Account LinksYes, No (Default)Possibility to hide the default wishlist-link in the customer account. Important: The default wishlist-functionality must be enabled for the "my-documents/ drafts"-feature. This parameter supports hiding the wishlist-link for solutions with only template based products. Shouldn't be enabled in solutions where template-based products and standard products are available!System->Storeview
    My Document List ModeDropdown

    Two different "layouts" are supported

    • List
    • Grid
    System->Storeview
    My Document - Document Type EnabledYes, No (Default)

    Adds the possibility to create document types and add these types to products for filtering in the "my drafts"- and "my digital output"-list.

    Product-Attribute "Chili Document Type"

    System->Storeview

    Edit Chili Name in Customer AccountYes (Default), No

    Allows editing the document name in the "My Drafts" list

    System->Storeview

    Show Chili Name in Mini CartYes (Default), No

    Shows document name in mini cart

    System->Storeview

    Yes (Default), No

    Shows document name in cart

    System->Storeview

    Yes (Default), No

    Shows document name in order confirmation

    System->Storeview

    Yes (Default), No

    Shows document name in my orders

    System->Storeview

    Yes, No (Default)

    Shows document name in wishlist widget in sidebar

    System->Storeview

    Yes, No (Default)

    Disables modal box before adding the document to the cart

    System->Storeview

    Yes (Default), No

    Enables "digital output"-feature

    When this feature is turned on, the behavior of products marked as free digital download will change. The ´Add To Cart´ Button in the Chili Editor is replaced with a ´Finish Digital Download Button´. Finished Digital downloads are collected in an extra list under customer account. Free digital downloads can be created by users without going through the checkout process.

    System->Storeview

    Product->Storeview

    Yes (Default), No

    If enabled, the chili documents will be moved physically to a separate location after finishing them. If disabled, the documents will remain in the temporary folder location.

    System->Storeview

    String

    digitaloutput// -->move location of digital output files.

    • -->aktuelles Datum
    • -->Item_id of chili document

    System->Storeview

    Yes, No (Default)

    Enables automatic generation of chili documents after finishing the document.

    Important: This feature should be enabled only in "on premise"-environments, since it doesn't make sense in on saas-environments! Chili supports no custom save locations in their PDF-Export settings anymore and Magento does not act as a proxy for documents!

    System->Storeview


    Dropdown

    Important for filter functionality in "my drafts" and "my digital output"-lists. Values for filtering can be changed from the product attribute management.

    System->Global

    Chili Variation Add to Cart EnabledYes, No (Default)

    Create variations for the cart easily from the editor panel. If enabled, the "variation"-functionality

    System->Storeview

    If everything is setup correctly, your configuration will be saved and you are now able to access some enviromental data in the other configuration tabs.

^Top Copyright © 2021 - enobis GmbH - All rights reserved.