Changes

Jump to: navigation, search

Report Variables

835 bytes added, 19:55, 5 April 2022
no edit summary
==Syntax==
:<span style="font -size=3: medium;">@ReportProperty(''reportid'',''property'')@</fontspan>
'''Where:'''
'''Where:'''* ''reportid'' is the system ID for the report (see [[Determining the reportid]]).  The ReportProperty syntax also supports the Report Name, but you must ensure the Report Name does not include any special characters.
* ''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 Custom Export]] settings of the Report ** '''exportrawdata''' - Report data, without any formatting
'''Note:''' :* ''ReportProperty'' is case sensitive. Using ''reportproperty'' 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.<pre>@ReportProperty(reportid,property,distinct(fieldname))@Example: If a report is grouped by the tracking id, then your ReportProperty syntax would be@ReportProperty(reportid,property,distinct(op.opportunityid))@</pre>
You can also pass *:* ''ReportProperty'' is case sensitive. Using 'criteria'reportproperty'' into the ReportProperty call. See [[Including Criteria in ReportProperty]]will not work.
* ==Record Count=Using ReportProperty on reports with a Group By==='''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:* 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)
*:* 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'Examples','': * To generate the number of records property'',distinct(equivalent to the number of rows in the report''fieldname'')) for @ Example: If a report with ID 12345is grouped by the tracking id, then your ReportProperty syntax would be @ReportProperty(12345''reportid'',''property'',recordcountdistinct(opportunityid))@
You can also pass '''criteria''' into the ReportProperty call. See [[Including Criteria in ReportProperty]].
* To display the number of records at a given status in a Portal Icon:==Record Count=='''recordcount''' can be used:[[Image:CMPortal.png]]
Will display *:* In a [[Web Page View]] or asa [[Custom Field Type:Read Only – System Variables|Read Only - System Variable]] to display a record count*:* As part of [[ImageSubmit Logic]] to ensure a certain condition is met prior to submission of a record.*:PIcon.png* Included in the title of a [[Portal]]shortcut to indicate how many records are at a given status (for example)
*
==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 advance export template.:<font size=3>@ReportProperty(''reportid'Examples''',exportdata)@</font>:
** To generate the number of records (equivalent to the number of rows in the report) for report with ID 12345
@ReportProperty(12345,recordcount)@
''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 ** To display the number of records at a given status in a Portal Icon:*: [[Image:CMPortal.png]]* Will display as HTML.:
*: [[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.
:<font size=3>@ReportProperty(''reportid'',csvdata)@</font>
*: <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.''
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 as HTML.  ==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 [[Workflow]] message.'' ==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==
** [[Including Criteria in ReportProperty]]** [[Using Variables in the Report Builder]] 
[[Category:Variables]][[Category:Reports]]
Smartstaff
95
edits

Navigation menu