Including Criteria in ReportProperty
Revision as of 08:43, 10 August 2012 by Arthur Lathrop (talk | contribs) (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…')
Revision as of 08:43, 10 August 2012 by Arthur Lathrop (talk | contribs) (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 variable in order to pass parameters to a report to be used as report criteria.
Contents
Syntax for passing static parameters to a report
- @ReportProperty(reportid,property,,"criteria")@
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 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
- @ReportProperty2(reportid,property,,"criteria")@
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 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.