Advanced Renderer

Introduction

The "advanced renderer"-extension for the CHILIconnector is an optional enhancement of the CHILIconnector feature set. It supports additional renderer possibities on top of the standard renderer features. By default the CHILIconnector supports "only" one highres- and one lowres/preview renderer setting. The "advanced renderer"-extension adds

  • multiple renderer settings per area. The following areas are supported 
    • storefront - my orders (incl. order confirmation email)
    • backend - orders
    • digital output
  • support for image and html-rendering

Feature-Overview

  • multiple renderer settings

    By default the CHILIconnector supports "only" one highres- and one lowres/preview renderer setting. You can add multiple renderer support by adding additional settings in the system-configuration settings of Magento.

    You can define for each renderer (pdf, image, html) several renderer settings, which each relies on the render-settings of your chili-server. Each rendersettings can be activated per display area. Display areas are "storefront - my orders incl. order confirmation email", "backend - orders" and "digital output" (optional "mydocuments"-extensions necessary!). A Label describes the download link in the frontend.

    advanced renderer with my orders


    advanced renderer in order backend



    advanced renderer with digital-output

    Each settings can be overwritten per product too.

  • image and html renderer support

    The "advanced renderer" supports image and html rendering.

    • Image Rendering

    For rendering images you need an "image conversion profile" in your chili server first. An "image conversion profile" defines output parameters for the image output. The image output will downloaded in the defined image-format. If multiple images are rendered, a zip-file with all images will be provided for download.

    • HTML Rendering

    For rendering html output you need need at least a pdf- and an image conversion profile. With basic settings it will export plain html like the CHILIpublisher will do. In addition to that, it's possible to export html in combination with an html-block from Magento. By the use of placeholders it's possible to use variable data from the CHILIpublisher too.

Module

Extension-Name: enobis/module-chili-advanced-renderer

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!

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

To update the CHILIconnector-extension use composer via ssh:

composer update enobis/module-chili-advanced-renderer

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

Configuration-Parameter

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

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

    OptionTypeDescriptionScope
    Expert settingsYes, No (Default)Enable these Expert-Settings will activated Advanced Renderer FeatureSystem->Storeview
    PDF Renderer SettingsMulti-Config-Box

    Configuration includes

    • Label: Label for Renderer in Display area
    • CHILI renderer: PDF-Renderer Setting from Chili Server
    • display area: order frontend (incl. order confirmation email), order backend, digital output (optional mydocuments-extension necessary)
    System->Storeview
    Image Renderer SettingsMulti-Config-Box

    Configuration includes

    • Label: Label for Renderer in Display area
    • Image Renderer: Image Conversion Profile Setting from Chili Server
    • CHILI renderer: PDF-Renderer Setting from Chili server
    • display area: order frontend (incl. order confirmation email), order backend, digital output (optional mydocuments-extension necessary)

    Important: For image rendering a separate image conversion profile is necessary!

    System->Storeview
    HTML Renderer SettingsMulti-Config-Box

    Configuration includes

    • Label: Label for Renderer in Display area
    • Image Renderer: Image Conversion Profile Setting from Chili Server
    • CHILI renderer: PDF-Renderer Setting from Chili server
    • display area: order frontend (incl. order confirmation email), order backend, digital output (optional mydocuments-extension necessary)

    Important: For html rendering it's possible to use internal magento blocks for an advanced html-rendering!

    The Block Id column is optional. If not filled, a standard HTML export archive is generated.

    Alternatively, if a Magento BlockId is specified as base template, the Magento Block Template can be populated with the variables from the Chili Document and with rendered Html Layer fragments from the Chili Html export.

    The syntax for these block placeholders is

    #chili_variable_VARNAME#,
    #chili_layer_LAYERNAME# and
    #base_url#.

    If the BlockID is specified, the images, fonts, and css files of the HTML export are published in a dedicated public folder below the Magento Pub/Media directory. The url of this directory is available in the #base_url# variable.

    System->Storeview

Changelog & Roadmap

  • Changelog

    • 1.1.9 optimization - configuration moved to separate section
    • 1.1.1 - 1.1.18 bugfixes, optimizations - several bugfixes and optimizations
    • 1.1.1 feature - support for image export
    • 1.1.0 feature - support for html export
    • 1.0.21 - 1.0.22 optimization - support for statistics
    • 1.0.1 - 1.0.20 bugfixes, optimizations - several bugfixes and optimizations
    • 1.0.0 Initial Release
  • Roadmap

    • nothing planned

Addons

Not enough features? Then get in touch with our [addons]

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.