Changes

Jump to: navigation, search

Report Variables

1,317 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.
 
*
===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)
*:* 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]]
*: [[Image: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.
==CSV Data==
When using the '''csvdata''' report variable, the variable will be replaced with data from the specified report, as comma separated values.
==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.*:<span style="font -size=3: medium;">@ReportProperty(''reportid'',exportdatacsvdata)@</fontspan>*
''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.''
''The exportdata variable can be 'csvdata''' is most often used in a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] custom field, or be included in within the body of a [[Workflow]] messageplain-text workflow e-mail.''
Most often When using the '''exportdatacsvdata''' is variable the header and footer defined on the [[Report Export]] page will be used with report export settings defined as HTML.
==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>
*
==CSV Data==When using the '''csvdata''' report The exportdata variablecan be used in a [[Web Page View]] or [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] custom field, the variable will or be replaced with data from included in the specified report, as comma separated valuesbody of a [[Workflow]] message.:<font size=3>@ReportProperty(''reportid'',csvdata)@</font>
Most often '''exportdata''' is used with report export settings defined as HTML.
''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 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'csvdata''' is most often used within the body of a plain-text workflow e-mail.,exportrawdata)@</span>*
When using the '''csvdata''' 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 header and footer defined on the body of a [[Report ExportWorkflow]] page will be usedmessage.''
==Notes==
==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]]
Dan Eardley
Smartstaff
95
edits
Retrieved from ‘https://wiki.smartsimple.com/wiki/Special:MobileDiff/9918...39626’

Navigation menu