Changes

Jump to: navigation, search

Including Criteria in ReportProperty

195 bytes added, 19:55, 5 April 2022
no edit summary
==Syntax for passing static parameters to a report==
:<span style="font -size=3: medium;">@ReportProperty(''reportid'',''property'',,"''criteria''")@</fontspan>'''Where:'''
'''Where:'''* ''reportid'' is the system ID for the report (see [[Determining the reportid]]). The ReportProperty syntax also supports the Report Name, but you must ensure the Report Name does not include any special characters.
* ''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
* ''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:'''
'''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|Custom Export]] settings of the Report
* ''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: medium;">@ReportProperty2(''reportid'',''property'',,"@''criteria1''@::@''criteria2''@")@</fontspan>'''Where:'''
'''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==  
* Use double quotes, not single quotes, to encapsulate criteria.
* Note that if the ReportProperty variable is used in a Custom Field the report will be run every time the 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]])
 
Dan Eardley
Smartstaff
95
edits
Retrieved from ‘https://wiki.smartsimple.com/wiki/Special:MobileDiff/39627’

Navigation menu