first commit
This commit is contained in:
salam committed
commit
1218dd1517
12716 files changed
+989233
No files matched your search
@@ -0,0 +1,147 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
.. _backend-module:
|
||||
|
||||
The backend module
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
.. _setup-check-screen:
|
||||
|
||||
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 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
|
||||
manually (i.e. from the BE module) or automatically (i.e. from the
|
||||
command line).
|
||||
|
||||
|
||||
.. _information-screen:
|
||||
|
||||
The information screen
|
||||
""""""""""""""""""""""
|
||||
|
||||
This screen shows a list of all available tasks in the current TYPO3
|
||||
installation. When the Scheduler has just been installed, this will be
|
||||
limited to the two base tasks provided by the extension. The screen
|
||||
shows the name and description of the task. Clicking on the "Add" icon
|
||||
on the right side of each row will open up the new task registration
|
||||
screen, with the task class already predefined.
|
||||
|
||||
.. figure:: ../../Images/InformationScreen.png
|
||||
:alt: Scheduler information screen
|
||||
|
||||
List of available tasks in the Scheduler's information screen
|
||||
|
||||
|
||||
.. _scheduled-tasks-screen:
|
||||
|
||||
The scheduled tasks screen
|
||||
""""""""""""""""""""""""""
|
||||
|
||||
This is the main screen when administering tasks. At first it will be
|
||||
empty and just offer a link to add a new task. When such registered
|
||||
tasks exists, this screen will show a list with various pieces of
|
||||
information.
|
||||
|
||||
|
||||
.. figure:: ../../Images/BackendModuleMainView.png
|
||||
:alt: Scheduler main screen
|
||||
|
||||
Main screen of the Scheduler BE module
|
||||
|
||||
|
||||
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 with an orange label sign near the task name:
|
||||
|
||||
.. figure:: ../../Images/LateTask.png
|
||||
:alt: A late task in the Scheduler main screen
|
||||
|
||||
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:
|
||||
|
||||
- The first column contains checkboxes. Clicking on a checkbox will
|
||||
select that particular scheduled task for immediate execution.
|
||||
Clicking on the icon at the top of the column will toggle all
|
||||
checkboxes. To execute the selected tasks, click on the "Execute
|
||||
selected tasks" button. Read more in "Manually executing a task"
|
||||
below.
|
||||
|
||||
- The second column simply displays the id of the task.
|
||||
|
||||
- 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 fourth column shows whether the task is recurring or will run only
|
||||
a single time.
|
||||
|
||||
- The fifth column shows the frequency.
|
||||
|
||||
- The sixth columns indicates whether parallel executions are allowed
|
||||
or not.
|
||||
|
||||
- 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 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.
|
||||
|
||||
At the top of the screen is a link to add a new task.
|
||||
If there are a lot of tasks that appear late,
|
||||
consider changing the frequency at which the cron job is running (see
|
||||
"Choosing a frequency" above).
|
||||
|
||||
Occasionally the following display may appear:
|
||||
|
||||
.. figure:: ../../Images/MissingTaskClass.png
|
||||
:alt: A broken task
|
||||
|
||||
A scheduled task missing its corresponding class
|
||||
|
||||
|
||||
This will typically happen when a task provided by some
|
||||
extension was registered, then the extension was uninstalled, but the
|
||||
task was not deleted beforehand. In such a case, this task stays but
|
||||
the Scheduler doesn't know how to handle it anymore. The solution is
|
||||
either to install the related extension again or delete the registered
|
||||
task.
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
|
||||
.. _deleting-a-task:
|
||||
|
||||
Deleting a task
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
When choosing to delete a task, a pop-up window will appear requesting
|
||||
confirmation. If confirmed, the deletion is final. There is no
|
||||
"deleted" flag in the Scheduler's table, deleted task registrations
|
||||
cannot be recovered.
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
.. _adding-editing-task:
|
||||
|
||||
Adding or editing a task
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When adding or editing a task, the following form will show up:
|
||||
|
||||
.. figure:: ../../Images/AddingATask.png
|
||||
:alt: Add task form
|
||||
|
||||
Adding a new scheduled task
|
||||
|
||||
|
||||
Some fields require additional explanations (inline help is
|
||||
available by moving the mouse over the field labels):
|
||||
|
||||
- A disabled task will be skipped by the command-line script. It may
|
||||
still be launched manually, as described above.
|
||||
|
||||
- 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
|
||||
bottom of the form.
|
||||
|
||||
- The frequency needs be entered only for recurring tasks. It can be
|
||||
either a number of seconds or a cron-like command. Since TYPO3 4.5 the
|
||||
Scheduler supports the full cron syntax, including ranges, steps and
|
||||
keywords like :code:`@weekly` . For more information on cron syntax,
|
||||
see http://en.wikipedia.org/wiki/CRON\_expression.
|
||||
|
||||
- Parallel executions are denied by default (see "Tasks execution"
|
||||
above). They must be allowed explicitly.
|
||||
|
||||
- At the bottom of the form (highlighted area) there may be one or more
|
||||
additional fields. Those fields are specific to each task and will
|
||||
change when a different class is selected.
|
||||
|
||||
If there are some input errors, the form will reload upon submission
|
||||
and display the relevant error messages. When the input is finished
|
||||
and correct, the view switches back to the list view and displays a
|
||||
confirmation message.
|
||||
|
||||
.. figure:: ../../Images/InputValidation.png
|
||||
:alt: Input validation
|
||||
|
||||
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
|
||||
Scheduler's built-in cron parser tries to provide an explanation about
|
||||
what's wrong.
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
|
||||
.. _executing-a-task-on-next-cronjob:
|
||||
|
||||
Executing a task on next cron job
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
It is possible to manually set the next execution time of one or more
|
||||
registered tasks from the BE module to the current time.
|
||||
The selected tasks will then be running on the next cron job.
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
|
||||
.. _grouping-tasks:
|
||||
|
||||
Grouping tasks together
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
In case of a high number of different tasks, it may be useful to visually group similar tasks together:
|
||||
|
||||
.. figure:: ../../Images/GroupedTasks.png
|
||||
:alt: Overview of tasks with grouped
|
||||
|
||||
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
|
||||
:alt: Task group records
|
||||
|
||||
Management of scheduler task groups
|
||||
|
||||
|
||||
It is also possible to create a new task group from within the edit task form whith clicking on the `+` icon next to the
|
||||
task group select box.
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,33 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../Includes.txt
|
||||
|
||||
|
||||
|
||||
.. _administration:
|
||||
|
||||
======================
|
||||
Backend administration
|
||||
======================
|
||||
|
||||
The Scheduler provides a BE module to manage tasks. It provides three
|
||||
screens: a setup check, an information screen and the main (default)
|
||||
one for actually managing the tasks.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
BackendModule/Index
|
||||
EditTask/Index
|
||||
DeleteTask/Index
|
||||
GroupTask/Index
|
||||
StopTask/Index
|
||||
ManualExecution/Index
|
||||
ExecuteNextCronjob/Index
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
|
||||
.. _manually-executing-a-task:
|
||||
|
||||
Manually executing a task
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
As mentioned above, it is possible to manually execute one or more
|
||||
registered tasks from the BE module. When the selected tasks have
|
||||
finished running, feedback is given about success or failure of each
|
||||
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.
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
.. _stopping-a-task:
|
||||
|
||||
Stopping a task
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
As was explained above, a task is marked as being executed while it is
|
||||
running. If the process running the task crashes or is killed for some
|
||||
reason, the task will stay marked as being executed. This will be
|
||||
cleaned up automatically according to the maximum lifetime parameter
|
||||
(also described previously), but this may be inconvenient in some
|
||||
circumstances.
|
||||
|
||||
.. figure:: ../../Images/StoppingATask.png
|
||||
:alt: Stopping a task
|
||||
|
||||
Stopping a running task from the main screen
|
||||
|
||||
|
||||
In such cases it is possible to use the "stop" button to
|
||||
clean up marked executions for the given task. This will make it
|
||||
possible to run this task again. However please note that this will
|
||||
**not** kill a corresponding still running or continuously hanging
|
||||
process.
|
||||
|
||||
Reference in new issue
Block a user