tracker issue : CF-3194049

select a category, or use search below
(searches all categories and all time range)
Title:

documentation of cfschedule's result attribute and result struct

| View in Tracker

Status/Resolution/Reason: Closed/Fixed/

Reporter/Name(from Bugbase): Aaron Neff / Aaron Neff (Aaron Neff)

Created: 05/18/2012

Components: Documentation

Versions: 10.0

Failure Type:

Found In Build/Fixed In Build: Final /

Priority/Frequency: Minor / Some users will encounter

Locale/System: English / Win All

Vote Count: 0

Listed in the version 2016.0.0.297996 Issues Fixed doc
Verification notes: verified_fixed on September 28, 2015 using build 11.0.06.295053
1) Currently, cfschedule's result attribute is undocumented. Suggested wording:

-----------
Req/Opt: Required for the list action. (once Bug #3194048 is fixed)
Description: Name for the query in which cfschedule returns the result variables.
-----------

2) Currently, cfschedule's result struct is undocumented. Suggested wording (using cfquery's result struct doc as a reference):

-----------
The cfschedule tag also returns the following result variables in a query. You can access these variables with a prefix of the name you specified in the result attribute. For example, if you assign the name myResult to the result attribute, you would retrieve the status of the second retrieved task by accessing #myResult.status[2]#. The result attribute provides a way for functions or CFCs that are called from multiple pages, possibly at the same time, to avoid overwriting results of one call with another.

Variable name    |    Description
---------------------------------------------------------------------
result_name.chained_task | {description here}
result_name.clustered | {description here}
result_name.crontime | {description here}
result_name.enddate | {description here}
result_name.endtime | {description here}
result_name.eventhandler | {description here}
result_name.exclude | {description here}
result_name.file | {description here}
result_name.group | {description here}
result_name.interval | {description here}
result_name.last_fire | {description here}
result_name.mode | {description here}
result_name.oncomplete | {description here}
result_name.onexception | {description here}
result_name.onmisfire | {description here}
result_name.overwrite | {description here}
result_name.path | {description here}
result_name.priority | {description here}
result_name.proxy_port | {description here}
result_name.proxy_server | {description here}
result_name.proxy_user | {description here}
result_name.publish | {description here}
result_name.remaining_count | {description here}
result_name.repeat | {description here}
result_name.resolve_url | {description here}
result_name.retry_count | {description here}
result_name.startdate | {description here}
result_name.starttime | {description here}
result_name.status | {description here}
result_name.task | {description here}
result_name.timeout | {description here}
result_name.url | {description here}
result_name.username | {description here}

Of course, hopefully the underscores are removed first (per Bug #3194042).

----------------------------- Additional Watson Details -----------------------------

Watson Bug ID:	3194049

External Customer Info:
External Company:  
External Customer Name: itisdesign
External Customer Email:  
External Test Config: My Hardware and Environment details:

Attachments:

Comments:

Assigning to Prabhuram
Comment by Suhas Y.
19391 | October 15, 2012 12:25:42 AM GMT
The first part (result) is documented in the Wiki. But unsure on the second part as where it needs to be documented is not clear. (Comment added from ex-user id:ramachan)
Comment by Adobe D.
19392 | March 14, 2013 11:26:20 PM GMT
Hi Prabhuram, Regarding: "where it needs to be documented is not clear"? The <cfschedule> doc page. The result struct needs documented on the <cfschedule> doc page. I see this ticket is marked Closed/Fixed. It can't be "Fixed" if the 2nd part isn't done. Thanks!, -Aaron
Comment by External U.
19393 | September 28, 2015 02:50:54 AM GMT
I just realized Prabhuram's comment was from over 2 years ago. However, this ticket was just -now- marked Closed/Fixed. Adobe: Were both parts (1 & 2) fixed? Thanks!, -Aaron
Comment by External U.
19394 | September 28, 2015 02:51:50 AM GMT
Verified both parts (1 & 2) were fixed. Once CF-3194042 is completely fixed, then the underscores will need removed from the variable names. Thanks!, -Aaron
Comment by External U.
19395 | September 29, 2015 12:29:32 AM GMT