Contents

cfschedule

Description

Provides a programmatic interface to the ColdFusion scheduling engine. You can run a specified page at scheduled intervals with the option to write out static HTML pages. This lets you offer users access to pages that publish data, such as reports, without forcing users to wait while a database transaction is performed in order to populate the data on the page. ColdFusion scheduled events are registered using the ColdFusion Administrator. Execution of cfschedule can be disabled in the Administrator. Information supplied by the user includes the scheduled ColdFusion page to execute, the time and frequency for executing the page, and whether the output from the task is published. If the output is published, a path and file are specified. The event submission and its success or failure status is written to the cfusion-log-schedule.log file.

Category

Other

Implemented

Usage Syntax

<cfschedule  
	action="String"
	[serverpassword="String"]
	[hidden="Boolean"]
	[readonly="Boolean"]
	[task="String"]
	[operation="String"]
	[file="String"]
	[path="String"]
	[startDate="Any"]
	[startTime="Any"]
	[url="String"]
	[publish="Boolean"]
	[endDate="Any"]
	[endTime="Any"]
	[interval="String"]
	[requestTimeOut="Any"]
	[username="String"]
	[password="String"]
	[proxyServer="String"]
	[proxyUser="String"]
	[proxyPassword="String"]
	[resolveURL="Boolean"]
	[port="Any"]
	[proxyPort="Any"]
	[returnvariable="String"]
 />

[] = Optional attribute

Attributes

Name Type Required Default Description
action String Yes
serverpassword String No allow you to access filesystem, also when access is denied for your context
hidden Boolean No
readonly Boolean No
task String No The name of the task to delete, update, or run.
operation String No The type of operation the scheduler performs when executing this task.
file String No Required with publish ='Yes' A valid filename for the published file.
path String No Required with publish ='Yes' The path location for the published file.
startDate Any No Required when action ='update'. The date when scheduling of the task should start.
startTime Any No Required when creating tasks with action = 'update'. Enter a value in seconds. The time when scheduling of the task starts.
url String No Required when action = 'update'. The URL to be executed.
publish Boolean No Specifies whether the result should be saved to a file.
endDate Any No The date when the scheduled task ends.
endTime Any No The time when the scheduled task ends. Enter a value in seconds.
interval String No Required when creating tasks with action = 'update'. Interval at which task should be scheduled. Can be set in seconds or as Once, Daily, Weekly, and Monthly. The default interval is one hour. The minimum interval is one minute.
requestTimeOut Any No Customizes the requestTimeOut for the task operation. Can be used to extend the default timeout for operations that require more time to execute.
username String No Username if URL is protected.
password String No Password if URL is protected.
proxyServer String No Host name or IP address of a proxy server.
proxyUser String No
proxyPassword String No
resolveURL Boolean No Specifies whether to resolve links in the result page to absolute references.
port Any No The port number on the server from which the task is being scheduled. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.
proxyPort Any No The port number on the proxy server from which the task is being requested. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.
returnvariable String No return variable name of action list

Example Usage