Difference between revisions of "Including Criteria in ReportProperty"

From SmartWiki
Jump to: navigation, search
Line 12: Line 12:
 
:* '''csvdata''' - Report data, with each field separated by commas
 
:* '''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  
 
:* '''exportdata'''- Report data, formatted as defined in the [[Exporting Reports|Advanced Export]] settings of the Report  
* ''criteria'' is the  
+
* ''criteria'' is the answer to the ??? in the report referenced by the reportid
  
  
  
 
'''Examples''':  
 
'''Examples''':  
* To generate the number of records (equivalent to the number of rows in the report) for report with ID 12345
+
* The report with reportid 12345 has a [[Prompting for Criteria in Reports|criteria]] on a date field of "=???"
  @ReportProperty(12345,recordcount)@
+
* To generate the number of records in the report with a date of 2009-10-26:
 +
  @ReportProperty(12345,recordcount,,"2009-10-26")@
  
  

Revision as of 16:15, 10 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


Examples:

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


Syntax for passing multiple parameters to a report

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

or

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


Notes

  • When using any of the ReportProperty variables (recordcount, exportdata and csvdata) the object ID (opportunityid, eventid, userid, etc) will be passed to the report processor. If the specified report includes the variable: @objectid@, it will be replaced by the object ID of whichever object (Level 1, Level 2, Contact, etc) called the ReportProperty attribute.


See Also