Difference between revisions of "Report Variables"

From SmartWiki
Jump to: navigation, search
Line 4: Line 4:
  
  
This '''ReportProperty''' [[Variable]] can be used to display the number of records within a specified report.
+
This '''ReportProperty''' [[Variable]] can be used to display:
 +
:* The number of records within a specified report ('''recordcount''')
 +
:* Unformatted data contained within a report, separated by commas ('''csvdata''')
 +
:* Report data, formatted as defined in the [[Exporting Reports|Advanced Export]] settings of the Report ('''exportdata''')
  
This can be used:
+
 
 +
'''recordcount''' can be used:
 
:* In a [[Web Page View]] or as a [[Custom Field Type: Read Only – System Variables|Read Only - System Variable]] to display a record count
 
:* In a [[Web Page View]] or as a [[Custom Field Type: Read Only – System Variables|Read Only - System Variable]] to display a record count
 
:* As part of [[Submit Logic]] to ensure a certain condition is met prior to submission of a record.
 
:* As part of [[Submit Logic]] to ensure a certain condition is met prior to submission of a record.

Revision as of 16:05, 18 May 2010

This article describes the Variables that can be used to display Reports, or properties of reports.

For details on Variables that can be used when creating reports see Using Variables in the Report Builder.


This ReportProperty Variable can be used to display:

  • The number of records within a specified report (recordcount)
  • Unformatted data contained within a report, separated by commas (csvdata)
  • Report data, formatted as defined in the Advanced Export settings of the Report (exportdata)


recordcount can be used:

Syntax:

@ReportProperty(reportid,recordcount)@


Where:


Examples:

  • To generate the number of records (equivalent to the number of rows in the report) for report with ID 12345
@ReportProperty(12345,recordcount)@


  • To display the number of records at a given status in a Portal Icon:
CMPortal.png

Will display as:

PIcon.png

Important

  • the recordcount property does not work if your Report includes Group By. It can only be used to count the records in a report based on filtered criteria.