TYPO3/Install Aimeos/Configure scheduler tasks

From Aimeos documentation

TYPO3 | Install Aimeos
Other languages:
English 100% • ‎русский 37%


2018.x+ version

The Scheduler extension has to be installed in TYPO3, before any tasks can be configured.

Setup scheduler user

Before the TYPO3 scheduler can be triggered by a cronjob (which has to be created separately and executing the scheduler every minute), a user for the scheduler has to be created:

  1. Admin Tools::Scheduler:
    • switch to submodule Setup check
  2. submodule Setup check, section TYPO3 Scheduler back end user:
    • click Create the user now in red box to create user "_cli_scheduler" for the Scheduler

Create Aimeos tasks

After installing the Aimeos TYPO3 extension, a new scheduler task named "Aimeos scheduler" is available. It's capable of executing one or more Aimeos jobs for one or more sites. Normally, you will need to add the Aimeos scheduler task several times with different jobs. To add a new task, click on the icon with the plus symbol (green one in the upper left corner / above the list of configured tasks). When all Aimeos tasks are configured it should look like this:

Aimeos-typo3-scheduler-tasks.png

Create scheduler tasks

Configure a task for them by

  1. click on the plus sign above the list of configured tasks
  2. new window Scheduled tasks opens:
    • Select "Aimeos Shop advanced scheduler"
    • set selection box Type to value "Recurring"
    • enter e.g. "* * * * *" in field Frequency to run the task every minute
    • select the jobs (see below for details)
    • select the sites for which the jobs will be executed (at least "default")
    • configure at least the sender e-mail address in the TypoScript field if you are not using the specialized Aimeos shop e-mail scheduler task
    • configure the content URL and the catalog detail page ID to reference the product images and product detail page in the e-mails correctly
    • click Save and close.
Aimeos-typo3-scheduler-minute.png

Every minute

Some Aimeos jobs should run very often, like the job for sending order confirmation e-mails after an order was placed successfully. This task can also be used for other jobs that should also run frequently:

  • Order export CSV (export of orders marked in the admin interface)
  • Order delivery related e-mails (customer notification e-mails on delivery status changes)
  • Order payment related e-mails (customer notification e-mails on payment status changes and order confirmation e-mails)
  • Order voucher e-mails (e-mails to customers containing the code for the voucher they bought)
  • Process order delivery services (send paid orders to ERP systems or logistic partners)
  • Subscription export CSV (export of subscriptions marked in the admin interface)

Every hour

The same must be done for jobs that have to be executed every hour (or at least several times a day):

  • Product notification e-mails (customer notification for price and stock updates)
  • Removes unfinished orders (unblock product stock and coupon codes)
  • Batch update of payment/delivery status (asynchronous updates via uploaded files)
  • Capture authorized payments (if payments are first authorized and captured later)

Once a day

These jobs should be executed once a day (best at times of low traffic):

  • Cache cleanup (remove old cache entries)
  • Catalog import (import categories from CSV files)
  • Log cleanup (remove old log entries)
  • Removes unpaid orders (delete orders without payment)
  • Product import (import products from CSV files)
  • Products bought together (automatically generated product suggestions)
  • Index rebuild (re-create the product index)
  • Index optimize (optimizes the index for fastest query execution)
  • Product sitemap (generate product sitemaps for search engines)
  • Subscription process start (start subscription period and add permissions if applicable)
  • Subscription process renew (renew subscriptions on next date)
  • Subscription process end (finish subscriptions and revoke permissions if applicable)

Create the catalog index task

The catalog index is a separate product index optimized for searching products. It should be recreated once a day after midnight to update the products if start and end times are used for products, texts, etc.

Rebuilding the catalog index may last from several minutes up to an hour depending on the amount products per site in the database. Also, it's very resource consuming and should run only in time frames with low activity on the shop pages.

Aimeos-typo3-scheduler-rebuild.png
  1. click on the plus sign above the list of configured tasks
  2. new window Scheduled tasks opens:
    • Select "Aimeos Shop scheduler"
    • set selection box Type to value "Recurring"
    • enter "15 0 * * *" in field Frequency to run the task 15 minutes after midnight
    • select the job "Catalog index rebuild"
    • select the sites for which the jobs will be executed (at least "default")
    • click Save and close.


Create the optimize task

To speed up the shop front-end even more, you can run a job to optimize the database tables and load the data into memory if possible. This job should run after the index is rebuild to get the best result and therefore configured separately, so it runs only once for all sites:

Aimeos-typo3-scheduler-optimize.png
  1. click on the plus sign above the list of configured tasks
  2. new window Scheduled tasks opens:
    • Select "Aimeos Shop scheduler"
    • set selection box Type to value "Recurring"
    • enter "15 1 * * *" in field Frequency to run the task 15 minutes after one o'clock (change this to your own needs)
    • select the job "Catalog index optimize"
    • select the sites for which the jobs will be executed (normally only "default" as the optimization is globally done)
    • click Save and close.


<< Previous: Configure TYPO3