How to use the connector?

#How to trigger import jobs?

#Where to find import jobs in Magento 2?

Since the 102.0.0 version of the Akeneo Connector for Magento 2, you can find the jobs under:

  1. Magento 2 SYSTEM menu
  2. Then click on Jobs in Akeneo Connector:

Connector job menu

Before the 102.0.0 version of the Akeneo Connector for Magento 2, you can find the jobs under:

  1. Magento 2 SYSTEM menu
  2. Then click on Import in Akeneo Connector:

Connector job menu

#How to manually schedule and trigger each job?

Since the 102.0.0 version of the Akeneo Connector for Magento 2, jobs are now run asynchronously and will be scheduled before being triggered.

To ensure that jobs are run as fast as possible, a new crontask ("akeneo_connector_launch_scheduled_job") has been added to the connector, and will check every minute if a job is ready to be triggered.

When a job is manually scheduled, the job status is changed to "Scheduled", and the Akeneo Connector crontask will trigger it in background under a minute.

In order to manually run the jobs, you can follow these steps:

  1. Make sure that Magento 2 CRON are correctly setup and running (CRON Documentation)
  2. Click on the "Schedule Job" link to schedule one job or select all the jobs you want to schedule and use the action "Schedule Job"
  3. Wait for the Akeneo Connector Cron task to run the job(s) in background

Connector jobs page

When a job is currently running, its status will be switched to "Processing"

If a job execution fails, its status will be switched to "Error", otherwise it will be set to "Success"

You can only schedule a job if its status is: "Pending", "Success" or "Error"

When manually scheduling multiple jobs together, the crontask will manage the correct order of the jobs, and trigger them accordingly:

  1. Category
  2. Family
  3. Attribute
  4. Option
  5. Product

You can reset a job status by using the grid action: "Reset Status". The job status will be set to "Pending".

This action can be used if an independant bug or incident happens during a job execution and that the job is stuck in "Processing" status.

Before the 102.0.0 version of the Akeneo Connector for Magento 2, you can follow this procedure:

  1. Select the job you want to run (import type),
  2. Then click on the Import button to trigger the selected job,
  3. Wait until the process ends.

Connector jobs page

The Job import process is completed when its status changes to Import complete in the console window.

If it fails, you could see a red error in the console window. Please take a screenshot of the console window: you will probably need it to communicate with your technical team or to open a ticket for our Support team via our Helpdesk platform (Akeneo Connector for Magento 2 Enterprise Edition only).

#How to automatically trigger each job?

You can set cron tasks for your Akeneo Connector for Magento 2 through configuration for each import jobs.

Set your cron expression in your crontab according to this example:

0 22 * * * /usr/bin/php /path/to/magento/current/bin/magento akeneo_connector:import --code=import-type >> /path/to/magento/current/var/log/akeneo_connector_import_type.cron.log`
        

You can also launch an import job directly from command line:

php bin/magento akeneo_connector:import --code=import-type
        

Replace import-type with any of these jobs:

  • category
  • family
  • attribute
  • option
  • product

Product model and Family variant jobs has been removed since the 101.0.0 version of the Akeneo Connector for Magento 2 and merged into the Product job

If you are using a version of the connector older than 101.0.0, you can trigger the Product Model and the Family Variant job using these codes : product_model / family_variant

You can also launch multiple imports with command line:

php bin/magento akeneo_connector:import --code=import-type1,import-type2,import-type3
        

Since the 102.0.0 version of the Akeneo Connector for Magento 2, if a job is already scheduled or processing, the command line will return an error and won't process the job execution.

#How to check that all jobs have been executed properly?

  1. Open SYSTEM menu.
  2. Click on Logs in Akeneo Connector:

Connector Logs menu

Since the 102.0.0 version of the Akeneo Connector for Magento 2, you can also click on the "View logs" link in the Jobs grid.

Here, you will find the list of import jobs that have been executed until now. You could check the status of each job while browsing this list.

Connector jobs history page

If you experience an error with one of the connector jobs: click on the red ERROR button in Status column. Then take a screenshot of the console window. You can give it to your technical team for analysis.

Connector console window