From f4f0abf2f181448e13a1f0f94c7b8ce5ff9fe318 Mon Sep 17 00:00:00 2001
From: Pawel Czarnota <114521677+pczarn2@users.noreply.github.com>
Date: Thu, 13 Oct 2022 07:51:27 -0500
Subject: [PATCH 1/2] Update cfschedule.json
Clarified when the task name attribute is required. Added example of using the list attribute.
---
data/en/cfschedule.json | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/data/en/cfschedule.json b/data/en/cfschedule.json
index f62954812..cf505b280 100644
--- a/data/en/cfschedule.json
+++ b/data/en/cfschedule.json
@@ -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. Note: Not required if action attribute is set to list","required":true,"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":[]},
@@ -79,6 +79,13 @@
"code": "",
"result": "",
"runnable":false
+ },
+ {
+ "title": "List all scheduled tasks",
+ "description": "List and dump all scheduled tasks running in ColdFusion instance",
+ "code": "\r\n",
+ "result": "",
+ "runnable":false
}
]
-}
\ No newline at end of file
+}
From 828c68ea41b43ab791906083889bab63b578b457 Mon Sep 17 00:00:00 2001
From: Pawel Czarnota <114521677+pczarn2@users.noreply.github.com>
Date: Thu, 20 Oct 2022 06:44:37 -0500
Subject: [PATCH 2/2] Update cfschedule.json
Made a change to the description of the task attribute per Pete Freitag
---
data/en/cfschedule.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/data/en/cfschedule.json b/data/en/cfschedule.json
index cf505b280..fb705e683 100644
--- a/data/en/cfschedule.json
+++ b/data/en/cfschedule.json
@@ -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. Note: Not required if action attribute is set to list","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":[]},