Smartstaff
95
edits
Changes
no edit summary
==Syntax==
:<span style="font -size=3: medium;">@ReportProperty(''reportid'',''property'')@</fontspan>
'''Where:'''
* ''property'' can be:
'''Note:'''
* ===Using ReportProperty on reports with a Group By=== *:* 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''))@
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''' 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)
*
'''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:*:[[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.''
==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.''
==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]]
