Self Help Online Studio - Scheduled Task Management

Last modified on 2022/08/08 16:20

You manage scheduled tasks, i.e. scheduled, delayed or immediate execution tasks, in Self Help using the cron/ task scheduler*./*

  • cron is used to manage all extraction, metadata import and user import tasks.
  • The program enables you to run tasks automatically according to specific dates and times.
  • You can specify the conditions for running these tasks by defining triggers. You define the trigger as a cron expression.

Notes

  • You cannot modify the type of task.
  • Executed tasks cannot be modified.

Caution

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

Best Practice

  • Use CronMaker to specify the trigger conditions for running tasks easily using cron expressions.

Menu access

  • Scheduler status: Online Studio > Platform > Scheduler Status 
  • List of tasks:  Online Studio > Platform > Scheduler List 

Screens description

Scheduler status

         Status.png

Name: Name of the task scheduler.

Status: Current status of the scheduler, i.e. Stopped, Started, Paused.

Running since: Date on which the scheduler was last started.

Number of Tasks Executed: Total number of tasks executed since the start of operation. This includes:

  • Immediate execution tasks
  • Executed tasks whose schedule is active
  • Executed tasks whose schedule is stopped 

Number of Tasks Currently Executed: Number of tasks currently being executed.

Total Number of Tasks: Number of executed tasks whose schedule is active.

Delete tasks icon.png: Used to delete all tasks in progress in the scheduler.

Start scheduler icon.png: Used to start the scheduler.

On hold scheduler icon.png: Used to pause the scheduler. Click the icon again to restart operations.

Stop scheduler icon.png: Used to stop the scheduler.

List of tasks

          Task.png

Name: Name of the task in the scheduler queue.

Type: Type of task, e.g. statistical report, metadata import or user import.

Owner: Name of the user running the task.

Status: Current task status, e.g. Waiting, etc.

Next Execution: Date on which the task will next be run.

Description: Description of the task.

Triggers

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: triggered at midnight on the first, tenth and fifteenth day of each month

Best Practice icon.png  Use CronMaker to specify the trigger conditions for running tasks easily. Open url.png See the procedure

          Task - Triggers.png

History

List of all tasks executed with the processing date and duration.

  • The status indicates if the task was successfully run or if it failed.

Procedure: How to add a trigger to a task

Step 1: Select the task

1. Select Platform > Scheduler List in the Online Studio menu. 

The list of queued tasks will appear.

2. 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.

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  Use CronMaker to specify the trigger conditions for running tasks easily.

  • Click Display popup icon.png.
  • Specify the parameters for scheduling the task in CronMaker, e.g. frequency, day, time, etc.
  • Click Generate.
  • Copy the result displayed in the Cron format field.
  • Go back to the Triggers screen.
  • Paste the expression in the Frequency field.
    The frequency parameters will automatically be specified.
            Task - Cronmaker.png

5. Enter the scheduled start date and time.

6. Click Add.

Tags:
Powered by XWiki © EasyVista 2022