Self Help Online Studio - Administration Menu > Scheduler

This menu is used to manage all scheduled, regular or immediate execution tasks, via the cron program, e.g. tasks to generate statistical reports, to import metadata or users.

It is used to stop, start or pause the scheduler. You can also delete all scheduled tasks.


  • The immediate execution of a task may generate performance bottlenecks on the Self Help server.

Description of screens

Status sub-menu

This displays s snapshot of scheduler information at a given time.

  • Current status
  • Operation start date
  • Total number of tasks executed since the start of operation, e.g. immediate execution tasks, executed tasks whose schedule is active, executed tasks whose schedule is stopped
  • Number of tasks currently being executed
  • Total number of executed tasks whose schedule is active

         Administration menu - Scheduler - Status.png

Functionalities available in the toolbar

  • Delete all tasks in progress in the scheduler.
  • Pause and resume the scheduler.
  • Stop the scheduler.

List sub-menu

This displays the list of all pending tasks in the scheduler. The icons below help you identify them easily.

  • Administration menu - Scheduler - Metadata import icon.png: Used to indicate an immediate extraction task for statistical reports. These tasks also appear in the Analytics > Scheduling menu. Also used to indicate a metadata import task.
  • Administration menu - Scheduler - Users import icon.png: User import task.
  • Administration menu - Scheduler - Scheduling icon.png: Scheduled extraction task for statistical reports.
             Administration menu - Scheduler - List.png
  • You can sort the list by clicking one of the column headers.
  • You can group tasks using a specific criterion by clicking the Group By link at the top of the list.
  • You can apply a filter to the names of tasks by clicking the Filter link at the top of the list.
  • Click the name of a task to see its details. A side pane will appear, displaying three tabs, Summary, Triggers and History.
             Administration menu - Scheduler - Task details.png

Task details in the side pane

  • Summary tab: Summarized information on the task.
  • Triggers tab: List of conditions that will trigger task execution.
    • You can define several triggers for a given task.
    • You define the trigger as a cron expression that will specify the execution frequency of the task.

      example  0 0 1,10,15 * *  ==>  Frequency: At midnight on the first, tenth and fifteenth days of each month

    • The CronMaker tool enables you to generate the expression easily when configuring the scheduled task, e.g. frequency, start time, etc.  Open url.png See the procedure.
               Administration menu - Scheduler - Triggers tab.png
  • History tab: This displays all task executions with the processing time and status of the operation (successful or failed).

Functionalities available in the toolbar

  • Add a task.
    Note: The type of task is indicated:
    • Extraction task for statistical reports (immediate or scheduled)
    • Metadata import task
    • User import task
  • Execute one or more tasks immediately.
    Note: Once executed, the tasks will appear:
    • In the Analytics > Extracts menu for statistical report extraction tasks.
    • In the Attributes > Import Attributes menu for metadata import tasks.
    • In the Users > Users import menu for user import tasks.
  • Modify a task.
    • You cannot modify the type of task.
    • Executed tasks cannot be modified.
  • Delete one or more tasks.
    Note: The tasks will also be deleted in the Analytics > Scheduling menu for statistical report extraction tasks.

Procedure: How to add a trigger to a task

Step 1: Select the task.

1. Open the Online Studio.

2. Select Scheduler > List in the menu.

3. Click the name of the task to which you want to add a trigger.
A side pane will appear.

Step 2: Create the trigger.

1. Select the Triggers tab in the side pane.

2. Click Add Trigger.

3. (optional) Enter the name of the trigger and the group to which it belongs (for scheduled group operations). Note: Default values will be used if the information is not specified.

4. Specify the execution frequency of the task using a cron expression.

Best Practice icon.png  Click Frequence CronMaker icon.png to access the CronMaker tool. It enables you to configure the scheduled task and generate the corresponding cron expression easily.

  • Define the schedule configuration.
  • Click Generate Cron Expression.
  • Copy the result displayed in the Cron format field.
  • Return to the Triggers tab and paste the expression in the Cron field.
    The frequency parameters will be automatically completed.
             Frequence CronMaker - Tool.png

5. Enter the scheduled start date and time.

6. Click Add.

Powered by XWiki © EasyVista 2022