8,849
edits
Changes
Created page with 'This article describes the syntax used with the ReportProperty variable in order to pass parameters to a report to be used as report criteria. ==Sy…'
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 criteria.
==Syntax for passing static parameters to a report==
:<font size=3>@ReportProperty(''reportid'',''property'',,"''criteria''")@</font>
'''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
* ''criteria'' is the
'''Examples''':
* To generate the number of records (equivalent to the number of rows in the report) for report with ID 12345
@ReportProperty(12345,recordcount)@
==Syntax for dynamic static parameters to a report==
:<font size=3>@ReportProperty2(''reportid'',''property'',,"''criteria''")@</font>
'''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
* ''criteria'' is the
==Syntax for passing multiple parameters to a report==
:<font size=3>@ReportProperty(12345,exportdata,,”criteria1”::”criteria2”)@</font>
or
:<font size=3>@ReportProperty2(''reportid'',''property'',,"''criteria''")@</font>
==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==
* [[Using Variables in the Report Builder]]
* [[Reportproperty]]
* [[Passing Values Using Parameters]]
* [[Prompting for Criteria in Reports]]
[[Category:Variables]][[Category:Reports]]
==Syntax for passing static parameters to a report==
:<font size=3>@ReportProperty(''reportid'',''property'',,"''criteria''")@</font>
'''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
* ''criteria'' is the
'''Examples''':
* To generate the number of records (equivalent to the number of rows in the report) for report with ID 12345
@ReportProperty(12345,recordcount)@
==Syntax for dynamic static parameters to a report==
:<font size=3>@ReportProperty2(''reportid'',''property'',,"''criteria''")@</font>
'''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
* ''criteria'' is the
==Syntax for passing multiple parameters to a report==
:<font size=3>@ReportProperty(12345,exportdata,,”criteria1”::”criteria2”)@</font>
or
:<font size=3>@ReportProperty2(''reportid'',''property'',,"''criteria''")@</font>
==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==
* [[Using Variables in the Report Builder]]
* [[Reportproperty]]
* [[Passing Values Using Parameters]]
* [[Prompting for Criteria in Reports]]
[[Category:Variables]][[Category:Reports]]