Commit 2892f6dc authored by Michael Oehlhof's avatar Michael Oehlhof Committed by Markus Klein
Browse files

[TASK] EXT:Scheduler: Update documentation

Replaced images with new ones from current master.
Adjust the description text where necessary.
Change presentation of the "class not found" group.

Resolves: #72628
Releases: master
Change-Id: Icf6845c72b34afbf0105aa844e321a18878f16dd
Reviewed-on: https://review.typo3.org/55077

Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: default avatarTYPO3com <no-reply@typo3.com>
Reviewed-by: Markus Klein's avatarMarkus Klein <markus.klein@typo3.org>
Tested-by: Markus Klein's avatarMarkus Klein <markus.klein@typo3.org>
parent 14bf99b2
......@@ -19,7 +19,6 @@ The setup check screen
This screen has already been mentioned in the :ref:`Installation chapter <setup-check>`.
It is mostly useful when setting up the Scheduler, as it indicates
whether the necessary "\_cli\_scheduler" BE user exist or not and
whether the CLI script is executable or not. When everything is
running fine, it contains mostly one useful piece of information: when
the last run took place, when it ended and whether it was started
......@@ -62,11 +61,11 @@ information.
Main screen of the Scheduler BE module
Disabled tasks appear in grayed-out text. A disabled task is a
Disabled tasks have a gray label sign near the task name. A disabled task is a
task that will not be run automatically by the command-line script,
but may still be executed from the BE module.
A late task will appear this way:
A late task will appear with an orange label sign near the task name:
.. figure:: ../../Images/LateTask.png
:alt: A late task in the Scheduler main screen
......@@ -74,6 +73,9 @@ A late task will appear this way:
A late task in the main screen of the Scheduler BE module
The task list can be sorted by clicking the column label. With every click it
switches between ascending and descending order of the items of the associated column.
The table at the center of the above screenshot shows the
following:
......@@ -84,39 +86,42 @@ following:
selected tasks" button. Read more in "Manually executing a task"
below.
- The second column contains possible actions, mainly editing or
deleting a task. The actions will be unavailable for a task that is
currently running, as it is unwise to edit or delete it a task in such
a case. Instead a running task will display a "stop" button (see
"Stopping a task" below).
- The third column simply displays the id of the task.
- The second column simply displays the id of the task.
- The fourth column contains the name of the task, the extension it is
- The third column contains the name of the task, the extension it is
coming from and any additional information specific to the task (for
example, the e-mail to which the "test" task will send a message or
the sleep duration of the "sleep" task). It also show a summary of the
task's status with an icon.
- The fifth column shows whether the task is recurring or will run only
- The fourth column shows whether the task is recurring or will run only
a single time.
- The sixth column shows the frequency.
- The fifth column shows the frequency.
- The seventh columns indicates whether parallel executions are allowed
- The sixth columns indicates whether parallel executions are allowed
or not.
- The eighth column shows the last execution time and indicates whether
- The seventh column shows the last execution time and indicates whether
the task was launched manually or was run via the command-line script
(cron).
- The last column shows the planned execution time. If the task is
- The eighth column shows the planned execution time. If the task is
overdue, the time will show up in bold, red numbers. A task may have
no future execution date if it has reached its end date, if it was
meant to run a single time and that execution is done, or if the task
is disabled. The next execution time is also hidden for running tasks,
as this information makes no sense at that point in time.
- The last column contains possible actions, mainly editing, disable or
deleting a task. There are also buttons for running the task on the
next cron job or run it directly.
The actions will be unavailable for a task that is currently running,
as it is unwise to edit or delete it a task in such a case. Instead a
running task will display a "stop" button (see "Stopping a task" below).
Note that all dates and times are displayed in the server's time zone.
The server time appears at the bottom of the screen.
......
......@@ -28,6 +28,12 @@ available by moving the mouse over the field labels):
- The class selector is available only when adding a new task. The class
cannot be changed when editing a task, since there's no sense in that.
.. figure:: ../../Images/TaskConfigurationSelectClass.png
:alt: Select a class
Select the class of the scheduled task
- A task must have a start date. The end date is not mandatory, though.
A task without end date will run forever. Dates and times must be
entered in the server's time zone. The server's time appears at the
......@@ -54,7 +60,13 @@ confirmation message.
.. figure:: ../../Images/InputValidation.png
:alt: Input validation
Input validation when adding a new scheduled task or editing an existing one
Input validation failed when adding a new scheduled task or editing an existing one
.. figure:: ../../Images/InputValidationOk.png
:alt: Input validation OK
Input validation succeeded when adding a new scheduled task or editing an existing one
If an error occurs when validating a cron definition, the
......
......@@ -19,6 +19,7 @@ In case of a high number of different tasks, it may be useful to visually group
Grouping related tasks together
Scheduler task groups are records stored on the root page (pid=0). They may be created, edited and sorted with Web > List:
.. figure:: ../../Images/GroupRecords.png
......@@ -26,7 +27,12 @@ Scheduler task groups are records stored on the root page (pid=0). They may be c
Management of scheduler task groups
Individual tasks may then be edited as usual and associated to a given scheduler task group.
The individual groups can be sorted independent of each other by clicking the column label.
With every click it switches between ascending and descending order of the items of the associated column
in the corresponding group.
.. note::
Tasks inside a hidden group are neither automatically executed nor displayed in the scheduler module.
......@@ -19,3 +19,11 @@ task's run. There's one important thing to note: if the task was
overdue, a new execution date will be calculated. If the task was
**not** overdue, the previously calculated next execution date stays.
A single task can be started by pressing the appropriate button in
the row of the task. Multiple tasks can be started by selecting the
checkboxes on the left side of the task row and then pressing the
appropriate button beneath the task list.
There is one button for directly starting the task and another button
for starting the task with the next cron job.
......@@ -20,7 +20,6 @@ Installation
Installing/Index
SetupCheck/Index
SchedulerUser/Index
SchedulerShellScript/Index
CronJob/Index
BaseTasks/Index
......
......@@ -26,7 +26,7 @@ extension is installed, the following settings are available:
- **Enable logging** : by default, the Scheduler will write an entry in
the BE log every time it starts and ends, and also when it skips a
(denied) parallel execution. This is helpful when setting up a system,
but it may end up cluttering the log in the log run. It's possible to
but it may end up cluttering the log in the long run. It's possible to
turn off all logging by unchecking this option.
- **Enable sample tasks** : the Scheduler provides two sample tasks
......@@ -36,3 +36,10 @@ extension is installed, the following settings are available:
off. If disabled, they won't appear in the list of available tasks
anymore.
.. figure:: ../../Images/ExtensionConfiguration.png
:alt: Extension configuration
Configuring the extension settings
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment