DAM Scheduler task

Copyright © by Michael Feinbier, Joerg Kummer <typo3@no spam pleasefeinbier.net>
Published under the Open Content License available from http://www.opencontent.org/opl.shtml

Table Of Contents

• 1. EXT: DAM Scheduler task
  • 1.1. Extension Key: dam_scheduler
  • 1.2. Language: en
  • 1.3. Keywords: forAdmins, forIntermediates, dam, cron, index
  • 1.4. Copyright 2010, Michael Feinbier, Jörg Kummer, <typo3 at feinbier dot net>
  • 1.5. Read online
  • 1.6. This document is published under the Open Content License
  • 1.7. available from http://www.opencontent.org/opl.shtml
  • 1.8. Read online
  • 1.9. The content of this document is related to TYPO3
  • 1.10. - a GNU/GPL CMS/Framework available from www.typo3.org
  • 1.11. Read online
  • 1.12. Introduction
    • What does it do?
  • 1.13. The DAM Scheduler is designed to manage several different tasks for automatically indexing of DAM records, using the TYPO3 integrated scheduler (former gabriel).
    • Screenshots
  • 1.14. This is a view of the BE module's Scheduler including DAM indexing tasks.
  • 1.15. Read online
    • Depends
  • 1.16. You must running TYPO3 version 4.3 or higher which includes Extension scheduler. The scheduler needs at least his own crontab. Read more about TYPO3 integrated scheduler in its documentation.
  • 1.17. Overview
    • Why using scheduling tool?
  • 1.18. To index your DAM automaticly you could use some command-line scripts meant to be run regularly using cron jobs. When using several scripts, all they need their separate entry in the server's crontab, maintenance complexity increases, as well as the cost of migration. The TYPO3 integrated Scheduler aims to address this issue. The DAM Scheduler task is designed to Scheduler.
  • 1.19. Installation
    • Installing the extension
  • 1.20. The process is pretty simple: just install the extension in the Extension Manager.
    • The Scheduler user
  • 1.21. When tasks are launched manually from the BE module, they are executed using the current BE user. When they are run from the command line, however, there needs to be a specific user, called “_cli_scheduler”. Read more about at schedulers documentation.
  • 1.22. For DAM indexing the BE user use TCEmain. Therfor you must give additional rights to the “cli_scheduler” user. The BE user needs privilegs, which only can be added to the “cli_scheduler” using BE usergroup with at least following 3 settings:
  • 1.23. - Include Accesslist
  • 1.24. - Tables (modify): define database table 'tx_dam' (Media) is allowed to modify
  • 1.25. - Allowed excludefields: detail the permissions granted to table 'tx_dam' (Media: ...)
  • 1.26. - DB Mounts: access to DAM's default Media folder
  • 1.27. Read online
  • 1.28. Read online
  • 1.29. Administration
    • Setting up the indexing
  • 1.30. Before you can run a valid task in the scheduler, you need to define and save a setup for the auto indexing. This is simply done by using DAM's module 'Tools' → 'Indexing setup'. Read more at DAM's documentation.
  • 1.31. Open BE modul Scheduler, and choose 'Scheduled task' or 'Information' in the selectbox to add a new task.
  • 1.32. Read online
  • 1.33. Fill out the form to setup the new task.
  • 1.34. Read online
  • 1.35. For DAM's indexing you got two special fields:
  • 1.36. Title (optional):
  • 1.37. Define a setup title. Just name your setup definition, so you remember if you should have several tasks for DAM.
  • 1.38. SetupFile:
  • 1.39. Define a path of the location for an existing indexing setup xml file (You should have done steps for indexing setup in DAM: Tools->Indexing Setup->'define and save a setup for the auto indexing feature'..). The path must be relative to 'fileadmin/'.
  • 1.40. Known problems
  • 1.41. Read online
  • 1.42. Read online
  • 1.43. To-Do list
  • 1.44. Here are a few ideas for possible evolutions:
  • 1.45. ChangeLog
  • 1.46. Read online
  • 1.47. Read online

This document is related to version 0.1.1 of the extension dam_scheduler.