Properties
Name | Access | Type | Description |
---|---|---|---|
IsCancellationRequested | Read | Boolean | Returns whether a cancellation of the scheduled file execution has been requested. Cancellation can be requested by the job server, by disconnection of the initiating user if the file was scheduled with a 'Durable' option of 'false', or by re-scheduling with the same 'ProgressKey' option. |
Methods
End
Halts execution of a scheduled file, logs an exception, and sends a 'scheduledFile.error' client message to the initiating user
Velocity
$context_v2_scheduledFile.End($errorMessage)
JavaScript
context_v2_scheduledFile.End(errorMessage);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
errorMessage | String | Message to log as an exception | Required |
Returns
NothingReport
Sends a scheduled file execution progress report as a 'scheduledFile.progress' client message to the initiating user to render within a progress indicator.
Velocity
$context_v2_scheduledFile.Report("%{ Message = $messageArg, PercentComplete = $percentCompleteArg }")
JavaScript
context_v2_scheduledFile.Report({ Message: messageArg, PercentComplete: percentCompleteArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
Message | String | Optional status message | Optional | ||
PercentComplete | Single | Completion percentage, between 0 and 1 | Optional |