Smartstaff
95
edits
Changes
no edit summary
This article describes the syntax used with the [[ReportProperty ]] [[Variables|variable]] in order to pass [[Parameter|parameters]] to a report to be used as report [[:Category:Criteria|criteria]].
==Syntax for passing static parameters to a report==
:<span style="font -size=3: medium;">@ReportProperty(''reportid'',''property'',,"''criteria''")@</fontspan>'''Where:'''
* ''property'' can be:
* ''criteria'' is the answer to the ??? in the report referenced by the reportid
'''Example''':
* The report with reportid 12345 has a [[Prompting for Criteria in Reports|criteria]] on a date field of "=???"
* To generate the number of records in the report with a date of 2009-10-26:
@ReportProperty(12345,recordcount,,"2009-10-26")@
==Syntax for dynamic parameters to a report==
:<span style="font -size=3: medium;">@ReportProperty2(''reportid'',''property'',,"''@criteria@''")@</fontspan>
'''Where:'''
* ''reportid'' is the system ID for the report (see [[Determining the reportid]])
* ''property'' can be:
* ''criteria'' is the variable that returns the answer to the ??? in the report referenced by the reportid
==Syntax for passing multiple parameters to a report==
:<span style="font -size=3>@ReportProperty(12345,exportdata,,"criteria1::criteria2medium;")@</font>or:<font size=3>@ReportProperty2(''reportid'',''property'',,"@''criteria1''@::@''criteria2''@")@</fontspan>'''Where:''' * ''reportid'' is the system ID for the report (see [[Determining the reportid]])* ''property'' can be:** '''recordcount''' - Count of the number of records within a specified report** '''csvdata''' - Report data, with each field separated by commas** '''exportdata'''- Report data, formatted as defined in the [[Exporting Reports|Advanced Export]] settings of the Report* ''criteria1'', ''criteria2'', etc. are the variable that returns the answer to the ??? prompts in the report referenced by the reportid. ''Criteria1'' is matched against the first instance of the ??? prompt in the [[Report Builder]], ''criteria2'' is matched against the second instance, etc., working from left to right. '''Example''':
* The report with reportid 12345 has [[Prompting for Criteria in Reports|criteria]] on a date field of ">=???" and "<=???"
* To generate the number of records in the report with a date range of startdate to enddate:
@ReportProperty2(12345,exportdata,,"@fullstartdate@::@fullenddate@")@
==Notes== * Do Use double quotes, not use single quotes , to encapsulate criteria.* Note that if the ReportProperty variable is used on in a web page view, Custom Field the report will be run every time the web page view record is opened. Therefore, use this functionality sparingly or server performance may be impacted. Consider putting the ReportProperty onto a [[Custom Field Type: Display Only – Web Page View|web page view]] on the record, so it can be executed/viewed on-demand.* [[Read Only - System Variable|Read Only]] fields with ReportProperty should '''never''' be included in [[List View]]s. (All Read Only fields should be avoided when creating [[List Views]])
* [[Prompting for Criteria in Reports]]
[[Category:Variables]][[Category:Reports]][[Category:Criteria]]
