User Guide

302 Chapter 2: ColdFusion Tags
Attributes
Attribute Req/Opt Default Description
action Required • delete: deletes the specified task
• update: updates an existing task or creates a
new task, if one with the name specified by the
task attribute does not exist
• run: executes the specified task
task Required Name of the task.
operation Required if
action =
"update"
Operation that the scheduler performs. Must be
HTTPRequest.
file Required if publish
= "Yes"
Name of the file in which to store the published
output of the scheuled task.
path Required if
publish
= "Yes"
Path to the directory in which to put the published
file.
startDate Required if
action =
"update"
Date on which to first run the scheuled task.
startTime Required if
action =
"update"
Time at which to run the scheduled of task starts.
url Required if
action =
"update"
URL of the page to execute.
port Optional 80 Port to use on the server that is specified by the
url parameter. If resolveURL = "yes", retrieved
document URLs that specify a port number are
automatically resolved, to preserve links in the
retrieved document. A port value in the
url
attribute overrides this value.
publish Optional No • Yes: save the result to a file
• No
endDate Optional Date when scheduled task ends.
endTime Optional Time when scheduled task ends (seconds).
interval Required if
action =
"update"
One hour Interval at which task is scheduled.
• number of seconds (minimum is 60)
• once
• daily
• weekly
• monthly
requestTimeOut Optional Can be used to extend the default timeout period.
username Optional Username, if URL is protected.
password Optional Password, if URL is protected.
proxyServer Optional Host name or IP address of a proxy server.
proxyPort Optional 80 Port number to use on the proxy server.
proxyUser Opt User name to provide to the proxy server.