eikona-media/akeneo3-1-tessa-connector

Extension to connect TESSA to Akeneo

1.0.2 2020-07-15 08:57 UTC

This package is auto-updated.

Last update: 2024-03-15 17:45:57 UTC


README

TESSA Logo

 

TESSA Connector for Akeneo 3.1

 

With this Connector Bundle you seamlessly connect Akeneo with the Digital Asset Management solution "TESSA" (https://www.tessa-dam.com). This provides you with a professional and fully integrated DAM solution for Akeneo to centrally store, manage and use all additional files for your products (e.g. images, videos, documents, etc.) in all channels.

More informationen is available at our website.

Requirements

Akeneo Version
Akeneo PIM Community Edition ~3.1.0
Akeneo PIM Enterprise Edition ~3.1.0

IMPORTANT! Ensure, that your Akeneo API ist working. Tessa needs an API connection to your Akeneo. In some cases Apache is configured wrong, see https://api.akeneo.com/documentation/troubleshooting.html#apache-strip-the-authentication-header.

Installation

  1. Install the bundle with composer
composer require eikona-media/akeneo3-1-tessa-connector
  1. Then add the following lines at the end of your app/config/routing.yml :
tessa_media:
    resource: "@EikonaTessaConnectorBundle/Resources/config/routing.yml"
  1. Enable the bundle in the app/AppKernel.php file in the registerProjectBundles() method:
protected function registerProjectBundles()
{
    return [
        // ...
        new Eikona\Tessa\ConnectorBundle\EikonaTessaConnectorBundle(),
    ];
}
  1. Run the following commands in your project root:
php bin/console cache:clear --env=prod --no-warmup
php bin/console cache:warmup --env=prod
php bin/console pim:installer:dump-require-paths --env=prod
php bin/console pim:installer:assets --env=prod
yarn run webpack
  1. Update your database schema
php bin/console doctrine:schema:update --dump-sql # Show changes
php bin/console doctrine:schema:update --force # Update database schema
  1. Configure the Tessa Connector in your Akeneo System Settings.

  2. (Optionally) Create a cronjob to synchronize data with TESSA in the background

This is only necessary if you use the option "Sync in background" in the system settings

php bin/console eikona_media:tessa:notification_queue:execute --env=prod

Recommended to run every 5 minutes (*/5 * * * *). If the command is started twice at the same time, the second command exists with a notice.

How to use with reference entities (Enterprise Edition >3.0)

  1. Enable the ReferenceDataAttributeBundle in the app/AppKernel.php file in the registerProjectBundles() method (after the EikonaTessaConnectorBundle):
protected function registerProjectBundles()
{
    return [
        // ...
        new Eikona\Tessa\ConnectorBundle\EikonaTessaConnectorBundle(), // Already registered
        new Eikona\Tessa\ReferenceDataAttributeBundle\EikonaTessaReferenceDataAttributeBundle(), // New
    ];
}
  1. Select TESSA in the type dropdown when you add a new reference entity attribute

How to use with CustomEntityBundle

  1. Make sure you have the CustomEntityBundle installed

  2. Enable the ReferenceDataBundle in the app/AppKernel.php file in the registerProjectBundles() method (after the EikonaTessaConnectorBundle):

protected function registerProjectBundles()
{
    return [
        // ...
        new Eikona\Tessa\ConnectorBundle\EikonaTessaConnectorBundle(), // Already registered
        new Eikona\Tessa\ReferenceDataBundle\EikonaTessaReferenceDataBundle(), // New
    ];
}
  1. Use the module in your edit forms:
    pim-brand-edit-logo:
        module: eikona/tessa/connector/reference-data/form/field # Use this module
        parent: pim-brand-edit-form-properties-common
        targetZone: content
        position: 100
        config:
            fieldName: logo # This field has to be of type "string"
            label: acme_custom.brand.field.label.logo
            customEntityName: brand
            allowedExtensions: ['jpg', 'jpeg', 'png'] # Allowed extensions (default: no restriction)
            maximumCount: 4 # Maximum assets (default: unlimited)
  1. (Optionally) Show thumbnails in the datagrid:
datagrid:
    brand:
        # ...
            columns:
                 # ...
                 logo:
                    label: acme_custom.brand.field.label.logo
                    type: twig
                    frontend_type: html
                    template: EikonaTessaReferenceDataBundle:datagrid:thumbnail.html.twig