Skip to content

Commit

Permalink
Merge pull request #1573 from pczarn2/patch-9
Browse files Browse the repository at this point in the history
Update cfschedule.json
  • Loading branch information
pfreitag authored Oct 20, 2022
2 parents 18c8611 + 828c68e commit af71604
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions data/en/cfschedule.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"description":"Provides a programmatic interface to the CFML scheduling\n engine. Can run a CFML page at scheduled intervals, with the\n option to write the page output to a static HTML page. This\n feature enables you to schedule pages that publish data, such\n as reports, without waiting while a database transaction is\n performed to populate the page.",
"params": [
{"name":"action","description":"delete: deletes the specified task\n update: updates an existing task or creates a new task,\n if one with the name specified by the task attribute\n does not exist\n run: executes the specified task\n pause: Pauses the specified task.\n resume: Continues executing the specified task.\n list: Lists all the scheduled tasks.\n pauseall: CF10+ Pauses all scheduled tasks.\n resumeall: CF10+ Resume all scheduled tasks for a particular application","required":true,"default":"","type":"string","values":["delete","update","run","pause","resume","list","pauseall","resumeall"]},
{"name":"task","description":"Name of the task.","required":true,"default":"","type":"string","values":[]},
{"name":"task","description":"Name of the task. Not required if action attribute is set to list, otherwise it is required","required":false,"default":"","type":"string","values":[]},
{"name":"operation","description":"Operation that the scheduler performs. Must be HTTPRequest.","required":false,"default":"","type":"string","values":[]},
{"name":"file","description":"Name of the file in which to store the published output of\n the scheduled task","required":false,"default":"","type":"string","values":[]},
{"name":"path","description":"Path to the directory in which to put the published file.","required":false,"default":"","type":"string","values":[]},
Expand Down Expand Up @@ -79,6 +79,13 @@
"code": "<cfschedule\r\n action=\"update\"\r\n task=\"myTaskName\"\r\n cronTime=\"0 */2 3-10,21-23 * * ?\" />",
"result": "",
"runnable":false
},
{
"title": "List all scheduled tasks",
"description": "List and dump all scheduled tasks running in ColdFusion instance",
"code": "<cfschedule\r\n action=\"list\"\r\n result=\"scheduledList\"\r\n />\r\n<cfdump var=\"#scheduledList#\" />",
"result": "",
"runnable":false
}
]
}
}

0 comments on commit af71604

Please sign in to comment.