Changes

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

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

This ==Syntax==: <span style="font-size: medium;">@ReportProperty(''reportid'','ReportProperty'property'' [[Variable]] can be used to display the number of records within a specified report.)@</span>

This can be used'''Where:''' :* In a ''reportid'' is the system ID for the report (see [[Web Page ViewDetermining the reportid]] or as a [[Custom Field Type).  The ReportProperty syntax also supports the Report Name, but you must ensure the Report Name does not include any special characters.* ''property'' can be: Read Only – System Variables|Read Only - System Variable]] to display a record count:* As part * '''recordcount''' - Count of [[Submit Logic]] to ensure a certain condition is met prior to submission the number of records within a record.specified report** '''csvdata''' - Report data, with each field separated by commas:* Included * '''exportdata''' - Report data, formatted as defined in the title of a [[PortalExporting Reports|Custom Export]] shortcut to indicate how many records are at a given status (for example)settings of the Report** '''exportrawdata''' - Report data, without any formatting '''Note:'''

*:* '''Syntax:ReportProperty''':<font size=3>@ReportProperty(is case sensitive. Using ''reportidreportproperty'',recordcount)@</font>will not work.

*:* In order to use a ReportProperty on a report which has a group by clause, you need to add a distinct clause to the ReportProperty syntax. * @ReportProperty(''reportid'',''property'',distinct(''fieldname''Where))@ Example:If a report is grouped by the tracking id, then your ReportProperty syntax would be @ReportProperty(''reportid'',''property'',distinct(opportunityid))@ * You can also pass '''criteria''' into the ReportProperty call. See [[Including Criteria in ReportProperty]]. ==Record Count=='''recordcount'reportid'' 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*:* As part of [[Submit Logic]] to ensure a certain condition is met prior to submission of a record.*:* Included in the system ID for the report (see title of a [[Determining the reportidPortal]]shortcut to indicate how many records are at a given status (for example) *

'''Examples''': ** To generate the number of records (equivalent to the number of rows in the report) for report with ID 12345

** To display the number of records at a given status in a Portal Icon:*:[[Image:CMPortal.png]]* Will display as: *: [[Image:PIcon.png]]*   ==CSV Data==When using the '''csvdata''' report variable, the variable will be replaced with data from the specified report, as comma separated values. *: <span style="font-size: medium;">@ReportProperty(''reportid'',csvdata)@</span>*  ''The csvdata variable can be used in a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] custom field, or be included in the body of a [[Workflow]] message.''  '''csvdata''' is most often used within the body of a plain-text workflow e-mail.

Will display When using the '''csvdata''' variable the header and footer defined on the [[Report Export]] page will be used. ==Export Data==When using the Exportdata report variable, the variable will be replaced with data from the specified report, in the format defined by the custom export template. *: <span style="font-size: medium;">@ReportProperty(''reportid'',exportdata)@</span>*  ''The exportdata variable can be used in a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] custom field, or be included in the body of a [[Workflow]] message.''  Most often '''exportdata''' is used with report export settings defined asHTML.  ==Export Raw Data==When using the Exportrawdata report variable, the variable will be replaced with data from the specified report, without any formatting applied. *:<span style="font-size: medium;">@ReportProperty(''reportid'',exportrawdata)@</span>*  ''The exportrawdata variable can be used in a [[Web Page View]] or [[Custom Field Type:Read Only – System Variables|Read Only - System Variables]] custom field, or be included in the body of a [[Image:PIcon.pngWorkflow]]message.'' ==Notes==

=='''Important'''==* * When using any of the ''ReportProperty variables (recordcount'' property does not work if your , exportdata and csvdata) the object ID ([[opportunityid]], [[eventid]], [[Reportuserid]] , etc) will be passed to the report processor. If the specified report includes the variable: '''Group By@''objectid'. It can only '@''', it will be used to count replaced by the object ID of whichever object (Level 1, Level 2, Contact, etc) called the records in a report based on filtered criteriaReportProperty attribute.