The following parameters are built into RTA Reporting and can be used on any report. Their names are reserved and cannot be overridden.
Report Specific Parameters
The following parameters are utilized within reports to gather specific report information.
pageNumber
Description | Display the current page number for HTML, PDF, and RTF on Advanced, Express and Chained Reports. |
Example | =@pageNumber@
|
reportName
Description | Returns the name of the report. |
Example | For a report named Transcripts in a folder named Student Documents =@reportName@ would return Transcripts. |
reportFullName
Description | Returns the name and file path of the report. |
Example | For a report named Transcripts in a folder named Student Documents =@reportFullName@ would return Student Documents/Transcripts. |
User Specific Parameters
The following parameters are often used for user identification when loading user sessions rather than for reporting.
Note: For more in-depth information on the following parameters, please see the User Identification article.
userId
Description | Returns the unique ID of the current user. |
Example | =@userID@ |
companyId
Description | Returns the unique ID of the company (or group) that the user belongs to. |
Example | =@companyID@ |
userEmail
Description | Returns the email address of a specific user. Used to specify an email address for the "Reply To" email field of scheduled reports. |
Example | =@userEmail@ |