Schedule

Manages scheduled tasks in the BoxLang scheduler.

Component Signature

<bx:schedule action=[string]
task=[string]
scheduler=[string]
group=[string]
URL=[string]
class=[string]
method=[string]
interval=[string]
isDaily=[boolean]
cronTime=[string]
startDate=[string]
startTime=[string]
endDate=[string]
endTime=[string]
repeat=[integer]
exclude=[string]
port=[integer]
username=[string]
password=[string]
proxyServer=[string]
proxyPort=[integer]
proxyUser=[string]
proxyPassword=[string]
publish=[boolean]
path=[string]
file=[string]
overwrite=[boolean]
resolveUrl=[boolean]
retryCount=[integer]
onException=[string]
onComplete=[string]
eventhandler=[string]
cluster=[boolean]
result=[string] />

Attributes

Atrribute	Type	Required	Description	Default
action	string	true
task	string	false
scheduler	string	false		bxschedule
group	string	false
URL	string	false
class	string	false
method	string	false		run
interval	string	false
isDaily	boolean	false		false
cronTime	string	false
startDate	string	false
startTime	string	false
endDate	string	false
endTime	string	false
repeat	integer	false
exclude	string	false
port	integer	false	Optional HTTP port override for the URL. When omitted, the URL's own scheme determines the default port (e.g. 443 for https, 80 for http)
username	string	false
password	string	false
proxyServer	string	false
proxyPort	integer	false
proxyUser	string	false
proxyPassword	string	false
publish	boolean	false		false
path	string	false
file	string	false
overwrite	boolean	false		true
resolveUrl	boolean	false		false
retryCount	integer	false		3
onException	string	false		refire
onComplete	string	false
eventhandler	string	false
cluster	boolean	false		false
result	string	false

Examples

Create a scheduled task

Creates a new task that fires an HTTP GET request against a URL on a recurring interval.

<bx:schedule
    action="create"
    task="dailyReport"
    url="https://example.com/tasks/daily-report.bx"
    interval="daily"
    startTime="08:00"
>

Create a task that runs a BoxLang class

Instead of firing an HTTP request, point a task at a BoxLang class with class (mutually exclusive with url). The class is instantiated once and reused for the life of the task, and its run() method (or the method named by method) is invoked on every fire:

<bx:schedule
    action="create"
    task="dailyReport"
    class="tasks.DailyReport"
    interval="daily"
    startTime="08:00"
>

// tasks/DailyReport.bx
class {

    function run() {
        // do the work
    }

}

The class may optionally define any of before(), after(result), onSuccess(result), and onError(exception) — each is only invoked if defined, following the same convention as a BoxLang scheduler class's life-cycle methods:

// tasks/DailyReport.bx
class {

    function before() {
        logger.info( "About to generate the daily report" );
    }

    function run() {
        // do the work and (optionally) return a result
        return generateReport();
    }

    function onSuccess( result ) {
        logger.info( "Daily report generated: #result#" );
    }

    function onError( exception ) {
        logger.error( "Daily report failed: #exception.message#" );
    }

    function after( result ) {
        logger.info( "Daily report task finished" );
    }

}

A custom method name can be used instead of run():

<bx:schedule
    action="create"
    task="cleanup"
    class="tasks.Cleanup"
    method="purgeOldFiles"
    interval="daily"
>

Create a task with cron expression

<bx:schedule
    action="create"
    task="cleanup"
    url="/tasks/cleanup.bx"
    cronTime="0 0 2 * * ?"
>

Create a task that runs every 5 minutes

<bx:schedule
    action="create"
    task="healthCheck"
    url="/tasks/health.bx"
    interval="300"
>

Update an existing task

<bx:schedule
    action="update"
    task="dailyReport"
    url="/tasks/daily-report-v2.bx"
    interval="daily"
    startTime="09:00"
>

Run a task immediately

<bx:schedule
    action="run"
    task="dailyReport"
>

Pause and resume a task

<bx:schedule action="pause" task="dailyReport">
<bx:schedule action="resume" task="dailyReport">

List all scheduled tasks

<bx:schedule action="list" result="tasks">
<bx:dump var="#tasks#">

List tasks filtered by group

<bx:schedule action="list" group="reports" result="reportTasks">

Pause or resume all tasks

<bx:schedule action="pauseall">
<bx:schedule action="resumeall">

Delete a scheduled task

<bx:schedule action="delete" task="oldTask">