Difference between revisions of "Report Variables"

From SmartWiki
Jump to: navigation, search
Line 4: Line 4:
  
  
This '''ReportProperty''' [[Variable]] can be used to display:
+
'''Syntax:'''
:* The number of records within a specified report ('''recordcount''')
+
:<font size=3>@ReportProperty(''reportid'',''property'')@</font>
:* 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''')
+
 
 +
'''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  
  
  
Line 14: Line 20:
 
:* 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.
 
:* Included in the title of a [[Portal]] shortcut to indicate how many records are at a given status (for example)
 
:* Included in the title of a [[Portal]] shortcut to indicate how many records are at a given status (for example)
 
'''Syntax:'''
 
:<font size=3>@ReportProperty(''reportid'',recordcount)@</font>
 
  
  
'''Where:'''
 
* ''reportid'' is the system ID for the report (see [[Determining the reportid]])
 
  
  

Revision as of 16:08, 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.


Syntax:

@ReportProperty(reportid,property)@


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


recordcount can be used:



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.