Loading...
 
Skip to main content

History: Scheduler Handler

Source of version: 4 (current)

Copy to clipboard
            This is a ((handler)) to create schedulers.

{CODE(caption=>YAML)}
preferences:
 feature_scheduler: y
objects:
  -
    type: scheduler
    ref: my_scheduler
    data:
      name: New Scheduler
      task: ConsoleCommandTask
      params:
        console_command: index:rebuild
      run_time: "0 6 * * *"
      status: active
{CODE}

! Scheduler Object
||__Name__|__Mandatory__|__Value__
name|yes|Scheduler name
description| |A brief description of the scheduled task
task|yes|Check task options section bellow
params| |Check task params options bellow
run_time|yes|A CRON time format. Eg. every 5 minutes: "*/5 * * * *"
status|yes|active or inactive
re_run| |A bool flag (true/false) if scheduler should re-run on the next minute if last run failed ||

! Task Options
||__Task Name__|__Description__
ConsoleCommandTask|Execute a Tiki console command
ShellCommandTask|Execute a shell command
HTTPGetCommandTask|Perform a HTTP Get request and save the output
TikiCheckerCommandTask|Check for Tiki updates||

!ConsoleCommandTask Params
||__Name__|__Mandatory__|__Value__
console_command|yes|The console command to execute. Eg. index:rebuild||

!ShellCommandTask Params
||__Name__|__Mandatory__|__Value__
shell_command|yes|The shell command to execute. Eg. index:rebuild
timeout| |The max execution time in seconds to run the command||

!HTTPGetCommandTask Params
||__Name__|__Mandatory__|__Value__
url|yes|The URL to call
output_file|yes|The file path where the output should be saved
additional_http_headers| |Eg: "Accept-Language: en-us,en;\nAccept-Charset: ISO-8859-1,utf-8;"
basic_auth_username| |If requested URL required basic authentication
basic_auth_password| |If requested URL required basic authentication||

!!TikiCheckerCommandTask Params
No params