Difference between revisions of "Report Variables"
From SmartWiki
| Line 16: | Line 16: | ||
| + | ==Record Count== | ||
'''recordcount''' can be used: | '''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 | :* 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. | :* 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) | ||
| − | |||
| − | |||
| Line 35: | Line 34: | ||
:[[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. | |
| + | |||
| + | |||
| + | ==Export Data== | ||
| + | * '''Exportdata''': 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'',exportdata)@</font> | ||
| + | |||
| + | |||
| + | ''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. | ||
| + | |||
| + | '''Example''': To display the exported report for the report with ID 12345 | ||
| + | @ReportProperty(12345,exportdata)@ | ||
| + | |||
| + | |||
| + | ==CSV Data== | ||
| + | * '''Csvdata''': 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> | ||
| + | |||
| + | |||
| + | ''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. | ||
| + | |||
| + | When using the '''csvdata''' variable the header and footer defined on the [[Report Export]] page will be used. | ||
| + | |||
| + | |||
| + | ==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. | ||
[[Category:Variables]][[Category:Reports]] | [[Category:Variables]][[Category:Reports]] | ||
Revision as of 15:24, 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:
- 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 Advanced Export settings of the Report
Contents
Record Count
recordcount can be used:
- In a Web Page View or as a 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:
Will display as:
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.
Export Data
- Exportdata: 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.
- @ReportProperty(reportid,exportdata)@
The exportdata variable can be used in a Web Page View or 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.
Example: To display the exported report for the report with ID 12345
@ReportProperty(12345,exportdata)@
CSV Data
- Csvdata: when using the Csvdata report variable, the variable will be replaced with data from the specified report, as comma separated values.
- @ReportProperty(reportid,csvdata)@
The csvdata variable can be used in a Web Page View or 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.
When using the csvdata variable the header and footer defined on the Report Export page will be used.
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.
