Akeneo Onboarder
#Prerequisites
All the Prerequisites listed below have to be fulfilled before the installation step.
Context | Prerequisites |
---|---|
PIM | Your Akeneo PIM is an enterprise edition |
Your Akeneo PIM version is >= 4.0 | |
Synchronization | The Onboarder parameters are available on your Partner Portal project page |
You are able to launch a daemonized command in your server (a process that needs to be always started) | |
The HTTP traffic must be allowed on port 443 for the google pubsub api pubsub.googleapis.com | |
The HTTP traffic must be allowed on port 443 for the google storage api www.googleapis.com |
#PIM
The Onboarder is compatible with the enterprise edition of the PIM starting 3.0 version.
#Synchronization
#Parameters package
The parameters provided on the Partner Portal must contain:
- A downloadable
serviceAccount.json
file that contains authentication values to be able to use the Google PubSub and Google Cloud Storage services. - Several environments variables values that you will configure in the install process in order to communicate with Google Cloud PubSub instance
ONBOARDER_TOPIC_NAME_FOR_PUBLICATION_TO_MIDDLEWARE
: the topic into wich Akeneo PIM will publish synchronization messages to middlewareONBOARDER_TOPIC_NAME_FOR_PUBLICATION_TO_ONBOARDER
: the topic into wich Akeneo PIM will publish synchronization messages to supplier onboarderONBOARDER_TOPIC_NAME_FOR_CONSUMPTION
: the topic Akeneo PIM will subscribe toONBOARDER_QUEUE_NAME
: the queue Akeneo PIM will consume synchronization messages fromONBOARDER_CLOUD_STORAGE_BUCKET_NAME
: the name of the bucket where the assets will be synchronized
Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!