MyDocuments

Introduction

The "my-documents"-extension for the CHILIconnector is an addon for CHILIconnector. It supports

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

Feature-Overview

  • Advanced Document Management

    • separated "my drafts"-list for managing your documents (instead of Magento wishlist)
    • two layouts (grid and list-mode) for "my drafts" list
    • "document types"-attribute (product attribute) for document filtering in "my drafts"-list
    • document naming - give documents a name (optional/ or mandatory) incl. possibility to save drafts with a name
    • document copy function
    • "create variation"-function - create variations fast, based on the default template or on the actual working draft
  • "My Drafts"

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

    • grid-mode
    • list-mode

    The "my-drafts"-list supports several different features:

    • 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
    • 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

  • 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.

    It supports (like the my drafts list) the "document naming" and "document-type"-features. Copying documents enables you to create variations of your documents easily.

  • Advanced Renderer (bundled extension feature)

    The "Advanced Renderer" extends the rendering capabilities of the CHILIconnector. By default, the CHILIconnector offers "only" PDF rendering (Highres- / Lowres/Preview). With the "Advanced Renderer" it is possible to add separate render settings (besides Highres- / Lowres/Preview) and also supports image and HTML rendering.

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

Module

extension-name: enobis/module-chili-my-document

Latest stable version

version: 1.5.4

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 & Roadmap

  • 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)
  • Changelog

    • 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

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/{{date}}/{{item_id}} -->move location of digital output files.

    • {{date}} -->aktuelles Datum
    • {{item_id}} -->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

    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.

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

enobis/module-chili-advanced-renderer - Advanced Renderer/ Output Support (Image, HTML) for CHILIconnector (bundled with "my-document"-extension)

Support

If you need help using the CHILIconnector, please get in touch with us by sending an email to support@enobis.de.

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