The scheduled methods are executed in the client in which they are started. This means that if the client is closed, the scheduled method(s) will not run anymore. SeeBatch Processorsfor information how to continuously run methods in the background, in a client that will not be closed (automatically)
Cache
index
true
refresh
100d
id
doc
showRefresh
true
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes
2100%
height: 30px;
2Supported Clients
sWordListINLINESmartClient
sWordListINLINEWebClient
sWordListINLINENGClient
servoy sSummary
12%30%58%
height: 30px;
3Methods Summary
void
Adds a cron job to the scheduler.
void
Adds a cron job to the scheduler.
void
Adds a cron job to the scheduler.
void
Adds a cron job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
void
Adds a job to the scheduler.
Returns an array with the current jobs.
Returns the last job run from the scheduler.
Removes a job from the scheduler.
functionservoy sDetail
2100%
height:30px
2Methods Details
addCronJob
name
addCronJob(jobname, cronTimings, method)
des
sIndent
Adds a cron job to the scheduler.
{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#addJob]\(jobname, startDate, globalMethod, repeatInterval(ms), repeatCount, endDate, arguments]]/ [arguments)
Adds a
A cron job must have at least one minute between each execution (otherwise it won't execute).
{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getCurrentJobNames]\()
Returns an array with the current jobs.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getLastRunJobName]\()
{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#removeJob]\(jobname)
Removes a job from the scheduler.{td}{tr}{tbody}{table}\\{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=A965BF9A-D70A-49C3-BCEC-8995F13E1BEE}{tr:id=name}{td}h6.addCronJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addCronJob{span}{span:id=iets|style=float: left;}\(jobname, cronTimings, globalMethod, startDate, endDate, arguments){span}{td}{tr}{tr:id=des}{td}{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_des|text=|trigger=button}{sub-section}{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_des|trigger=none|class=sIndent}
A cron job must have at least one minute between each execution (otherwise it won't execute).
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_prs|trigger=none}jobname
cronTimings
globalMethod
\[startDate\]
\[endDate\]
\[arguments\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_ret|text=|trigger=button}{sub-section}{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_see|text=|trigger=button}{sub-section}{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_see|text=|trigger=button}{sub-section}{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_sam|text=|trigger=button}{sub-section}{sub-section:A965BF9A-D70A-49C3-BCEC-8995F13E1BEE_sam|class=sIndent|trigger=none}{code:language=javascript}
// see: http://quartz.sourceforge.net/firstTutorial.html#cronTriggers for more info
// add a job that runs every 20 minutes after the hour (0,20,40)
plugins.scheduler.addCronJob('20mins','0 0/20 * * * ?',globalMethod)
// add a job that runs every day at 23:30 between now and 5 days from now
var dateNow = new Date();
var date5Days = new Date(dateNow.getTime()+5*24*60*60*1000);
plugins.scheduler.addCronJob('23:30','0 30 23 ? * *',globalMethod,dateNow,date5Days)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C5979539-1EB4-4756-B617-58B1F8A88C62}{tr:id=name}{td}h6.addJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}addJob{span}{span:id=iets|style=float: left;}\(jobname, startDate, globalMethod, repeatInterval(ms), repeatCount, endDate, arguments]]/ [arguments){span}{td}{tr}{tr:id=des}{td}{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_des|text=|trigger=button}{sub-section}{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_des|trigger=none|class=sIndent}
A cron job must have at least one minute between each execution (otherwise it won't execute).
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_prs|trigger=none}jobname
startDate
globalMethod
\[repeatInterval(ms)\]
\[repeatCount\]
\[endDate\]
\[arguments]]/ [arguments\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_ret|text=|trigger=button}{sub-section}{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_see|text=|trigger=button}{sub-section}{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_see|text=|trigger=button}{sub-section}{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_sam|text=|trigger=button}{sub-section}{sub-section:C5979539-1EB4-4756-B617-58B1F8A88C62_sam|class=sIndent|trigger=none}{code:language=javascript}
// add a job that runs at the given date (20 seconds in the future)
// and repeats that every 20 seconds for 40 times or the enddate is reached (0 for no repeats = just one call)
var startDate = new Date();
startDate.setTime(startDate.getTime()+20000);
var endDate = new Date(startDate.getTime()+100000);
plugins.scheduler.addJob('in20seconds',startDate,globalMethod,20000,40,endDate)
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C}{tr:id=name}{td}h6.getCurrentJobNames{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getCurrentJobNames{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_des|text=|trigger=button}{sub-section}{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_des|trigger=none|class=sIndent}
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_ret|text=|trigger=button}{sub-section}{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_ret|trigger=none|class=sIndent}[String]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_see|text=|trigger=button}{sub-section}{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_see|text=|trigger=button}{sub-section}{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_sam|text=|trigger=button}{sub-section}{sub-section:8935B6E0-9F3A-44C3-9CBE-9B7B5E67165C_sam|class=sIndent|trigger=none}{code:language=javascript}
// Returns an array of current jobnames
plugins.scheduler.getCurrentJobNames()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=3C5F22DB-68B1-44C1-885B-88EEFB5C626A}{tr:id=name}{td}h6.getLastRunJobName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getLastRunJobName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_des|text=|trigger=button}{sub-section}{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_ret|text=|trigger=button}{sub-section}{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_see|text=|trigger=button}{sub-section}{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_see|text=|trigger=button}{sub-section}{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_sam|text=|trigger=button}{sub-section}{sub-section:3C5F22DB-68B1-44C1-885B-88EEFB5C626A_sam|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=A56D2D42-117D-4816-851F-D79A8EFAAAC0}{tr:id=name}{td}h6.removeJob{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}removeJob{span}{span:id=iets|style=float: left;}\(jobname){span}{td}{tr}{tr:id=des}{td}{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_des|text=|trigger=button}{sub-section}{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_des|trigger=none|class=sIndent}
ret
Returns
sIndent
clients
Supported Clients
sIndentSmartClient,WebClient,NGClient
sam
Sample
sIdent
javascript
lastDetailRow
getLastRunJobName
name
getLastRunJobName()
des
sIndent
Returns the last job run from the scheduler.
ret
Returns
sIndent
clients
Supported Clients
sIndentSmartClient,WebClient,NGClient
sam
Sample
sIdent
javascript
lastDetailRow
removeJob
name
removeJob(jobname)
des
sIndent
Removes a job from the scheduler.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_prs|trigger=none}jobname
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_ret|text=|trigger=button}{sub-section}{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_see|text=|trigger=button}{sub-section}{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_see|text=|trigger=button}{sub-section}{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_sam|text=|trigger=button}{sub-section}{sub-section:A56D2D42-117D-4816-851F-D79A8EFAAAC0_sam|class=sIndent|trigger=none}{code:language=javascript}
// removes a job 'myjob' from the scheduler
plugins.scheduler.removeJob('myjob')
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}