[BUGFIX] Drop undesired backslashes from Scheduler base tasks docs
[Packages/TYPO3.CMS.git] / typo3 / sysext / scheduler / Documentation / Installation / BaseTasks / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../Includes.txt
7
8
9 .. _base-tasks:
10
11 The base tasks
12 ^^^^^^^^^^^^^^
13
14 The Scheduler comes by default with several tasks:
15
16 - **Caching framework garbage collection** : some cache backends do not
17   have an automatic garbage collection process. For these it is useful
18   to run this Scheduler task to regularly free some space.
19
20 - **Fileadmin garbage collection** : empties :file:`_recycler_` folders in
21   the fileadmin.
22
23 - **Table garbage collection** : cleans up old records from any table in
24   the database. See related section below for more information on
25   configuration.
26
27
28 .. _table-garbage-collection-task:
29
30 Table garbage collection task
31 """""""""""""""""""""""""""""
32
33 The table garbage collection task can take a more elaborate
34 configuration which is detailed below.
35
36 The task can be registered to clean up a particular table, in which
37 case you simply choose the table and the minimum age of the records to
38 delete from the task configuration screen.
39
40 .. figure:: ../../Images/TableGarbageCollectionTaskConfiguration.png
41    :alt: Table Garbage Collection task configuration
42
43    Configuring the table garbage collection task
44
45
46 It's also possible to clean up all configured table by
47 checking the "Clean all available tables" box. The configuration for
48 the tables to clean up is stored in
49 :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks']['tx_scheduler_TableGarbageCollection']['options']['tables']`.
50 The syntax is the following:
51
52 - option :php:`expireField` can be used to point to a table field
53   containing an expiry timestamp. This timestamp will then be used to
54   decide whether a record has expired or not. If its timestamp is in the
55   past, the record will be deleted.
56
57 - if a table has no expiry field, one can use a combination of a date
58   field and an expiry period to decide which records should be deleted.
59   The corresponding options are :php:`dateField` and :php:`expirePeriod`.
60   The expiry period is expressed in days.
61
62
63 .. _table-garbage-collection-task-example:
64
65 Example
66 ~~~~~~~
67
68 ::
69
70    $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks']['tx_scheduler_TableGarbageCollection']['options']['tables'] = array(
71            'tx_realurl_errorlog' => array(
72                    'dateField' => 'tstamp',
73                    'expirePeriod' => '180'
74            ),
75            'tx_realurl_uniqalias' => array(
76                    'expireField' => 'expire'
77            )
78    );
79
80 The first part of the configuration indicates that records older than
81 180 days should be removed from table :code:`tx_realurl_errorlog` ,
82 based on the timestamp field called "tstamp". The second part
83 indicates that old records should be removed from table
84 :code:`tx_realurl_uniqalias` directly based on the field "expire"
85 which contains expiration dates for each record.
86
87
88 .. _other-tasks:
89
90 Other tasks
91 """""""""""
92
93 More tasks are provided by system extensions, such as the Extension
94 Manager, which defines one for updating the available extensions list.
95
96 The Scheduler also comes with two sample tasks. As explained at the
97 beginning of this chapter, they can be turned off from the extension's
98 configuration options.
99
100 The "test" task just sends a mail to a given e-mail address. The
101 "sleep" task goes to sleep for a given number of seconds. They are not
102 very useful in the everyday running of a web site, but they are nice
103 to have when testing stuff. If you want to make sure that your
104 Scheduler installation is complete, register an instance of the "test"
105 task and wait for the mail to arrive (if it doesn't arrive, check in
106 the Log if the task has indeed run).
107
108 The "sleep" task is mostly useful for testing parallel executions (by
109 creating an instance of the task that goes to sleep for a longer time
110 than the frequency).
111
112 The base tasks are also there to serve as examples for task developers
113 (see "Developer's Guide" below).
114