Synchronization¶

Push catalog structure to the middleware¶

To work, the middleware needs some data from the PIM and you will have to push them once your installation will be done.

Data synchronized are: attribute groups, attributes, attribute option, and families.

$ php bin/console akeneo:synchronization:push-catalog-to-onboarder --env=prod

Warning

Please not that the synchronization can take time.

Note

You will have to run this command only once. Once the extension is correctly installed, all data mentioned above will be synchronized automatically when they will be saved.

Launch the message worker¶

The synchronization of the catalog structure and the catalog data is handled in a asynchronous way using the Google Cloud PubSub service.
The messages that are part of the synchronization process are queued.
The queue is consumed by a command line process called worker.

The worker has to always be launched as it polls the queue waiting for new messages to handle.

You want a supervised worker¶

Warning

This process is only for “On premise” PIMs. If you are using the Flexibility mode of Akeneo Cloud Edition, please follow this documentation instead.

You can use supervisor to run the worker as a daemonized process, supervisor will monitor this process and according to the configuration you’ll define it will be autostarted and autorestarted.

[program:pim-onboarder-worker]
command=bin/console akeneo:synchronization:message:consumer --env=prod
directory=/path/to/your/pim
user=www-data
autostart=true
autorestart=true

Warning

By default the environment variable of the shell that is running the supervisord process will not propagate the environment variables to the process it monitor. You have to configure the mandatory environment variables that the akeneo/pim-onboarder bundle requires in the /etc/supervisor.conf file.

[supervisord]
environment=ONBOARDER_GOOGLE_APPLICATION_CREDENTIALS="/srv/pim/onboarderServiceAccount.json",ONBOARDER_TOPIC_NAME_FOR_PUBLICATION_TO_MIDDLEWARE="middleware-topic-name",...

Note

Supervisor documentation: https://github.com/Supervisor/supervisor#documentation

You want an infinite worker¶

Launch the following command line:

bin/console akeneo:synchronization:message:consumer --ttl=-1 --env=prod

Warning

This command does not ensure that the worker command line is always started

Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!