Difference between revisions of "Including Criteria in ReportProperty"

From SmartWiki
Jump to: navigation, search
(Syntax for dynamic static parameters to a report)
(Syntax for passing multiple parameters to a report)
Line 33: Line 33:
  
 
==Syntax for passing multiple parameters to a report==
 
==Syntax for passing multiple parameters to a report==
:<font size=3>@ReportProperty(12345,exportdata,,”criteria1”::”criteria2”)@</font>
+
:<font size=3>@ReportProperty(12345,exportdata,,"criteria1::criteria2")@</font>
 
or
 
or
:<font size=3>@ReportProperty2(''reportid'',''property'',,@criteria1@::@criteria2@)@</font>
+
:<font size=3>@ReportProperty2(''reportid'',''property'',,"@criteria1@::@criteria2@")@</font>
  
 
'''Example''':  
 
'''Example''':  
 
* The report with reportid 12345 has [[Prompting for Criteria in Reports|criteria]] on a date field of ">=???" and "<=???"
 
* 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:
 
* To generate the number of records in the report with a date range of startdate to enddate:
  @ReportProperty2(12345,exportdata,,"@fullstartdate@"::"@fullenddate@")@
+
  @ReportProperty2(12345,exportdata,,"@fullstartdate@::@fullenddate@")@
 
 
  
 
==Notes==  
 
==Notes==  

Revision as of 12:50, 27 August 2012

This article describes the syntax used with the ReportProperty variable in order to pass parameters to a report to be used as report criteria.


Syntax for passing static parameters to a report

@ReportProperty(reportid,property,,"criteria")@

Where:

  • 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 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 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

@ReportProperty2(reportid,property,,"@criteria@")@


Where:

  • 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 Advanced 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

@ReportProperty(12345,exportdata,,"criteria1::criteria2")@

or

@ReportProperty2(reportid,property,,"@criteria1@::@criteria2@")@

Example:

  • The report with reportid 12345 has 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 not use single quotes to encapsulate criteria.
  • Note that if the ReportProperty variable is used on a web page view, the report will be run every time the web page view is opened. Therefore, use this functionality sparingly or server performance may be impacted.


See Also