Query String Parameter Reference
Logi products use a number of reserved words to identify tokens and special query string parameters. This topic presents the query string parameters available for use in Logi Info and Logi Report.
If you're looking for information about tokens, see Token Reference.
Query string parameters are useful for passing data between web applications and use the familiar syntax:
http://<URL>?<Parameter>=<Value>
http://<URL>?<Parameter1>=<Value1>&<Parameter2>=<Value2>
In Logi reports, @Request tokens are used to retrieve the data POSTed by an HTML form and the values from parts of the query string used to call reports. The following special @Request token identifiers are also reserved words and have special meanings in Logi reports:
| Parameter | Description | Product |
|---|---|---|
| rdAcRefreshData | For use with the Analysis Chart element. Refreshes the chart's data from the data source while maintaining any chart customizations the user has made during this session. To refresh data, call report with this parameter set to True. | Info, Report |
| rdAcReset | For use with the Analysis Chart element. Users' settings are automatically maintained during the session; clear these settings by calling the report with the rdAcReset parameter set to True. | Info |
| rdAgLoadSaved | For use with the Analysis Grid element. Users' runtime customizations of the grid can be saved between sessions and Logi Info developers can implement this using the process task Procedure.Save Analysis Grid. A saved Analysis Grid can be reloaded using the rdAgLoadSaved parameter: rdAgLoadSaved=myFileName.xml | Info |
| rdAgRefreshData | For use with the Analysis Grid element. Refreshes the grid's data from the data source while maintaining any grid customizations the user has made during this session. To refresh data, call report with this parameter set to True. | Info |
| rdAgReset | For use with the Analysis Grid element. Users' settings are automatically maintained during the session; clear these settings by calling the report with the rdAgReset parameter set to True. | Info |
rdDebugPdf | When set to True, runs the PDF report and returns the HTML rather than generating a PDF from the HTML. | Info, Report |
| rdDgLoadSaved | For use with the Dimension Grid element. Users' runtime customizations of the grid can be saved between sessions and Logi Info developers can implement this using the process task Procedure.Save Dimension Grid. A saved Dimension Grid can be reloaded using the rdDgLoadSaved parameter: rdDgLoadSaved=myFileName.xml | Info |
| rdDgRefreshData | For use with the Dimension Grid element. Refreshes the grid's data from the data source while maintaining any grid customizations the user has made during this session. To refresh data, call report with this parameter set to True. | Info |
| rdDgReset | For use with the Dimension Grid element. Users' settings are automatically maintained during the session; clear these settings by calling the report with the rdDgReset parameter set to True. | Info |
rdFormLogon | Set to True when using custom logon forms. | Info |
rdLogoffRedirect | Logs the current user off and redirects the browser to the specified URL. | Info |
| rdMobile | Set to True to indicate that the report definition specified in the rdReport parameter is a Mobile Reports definition. | Info |
| rdOgLoadSaved | For use with the OLAP Grid element. Users' runtime customizations of the grid can be saved between sessions and Logi Info developers can implement this using the process task Procedure.SaveOlapGrid. A saved OLAP Grid can be reloaded using the rdAOLoadSaved parameter: rdOgLoadSaved=myFileName.xml | Info |
| rdOgRefreshData | For use with the OLAP Grid element. Refreshes the grid's data from the data source while maintaining any grid customizations the user has made during this session. To refresh data, call report with this parameter set to True. | Info |
| rdOgReset | For use with the OLAP Grid element. Users' settings are automatically maintained during the session; clear these settings by calling the report with the rdOgReset parameter set to True. | Info |
rdPaging | Specify either Interactive, Printable or NoPaging. | Info, Report |
| rdPassword | The password value used during login when using security. | Info |
rdProcess | Specifies the file name (without a file extension) of a process definition that contains a task to execute. | Info |
rdPrompt | When set to True, a page listing all @Request tokens referenced in the definition file is displayed. The user can display default values for each parameter by specifying rdPromptxxxxx at the prompt, where xxxxx is the name of the request parameter. | Info, Report |
rdReport | Specifies a report definition to run. | Info, Report |
rdReportFormat | Specify any of the following formats: PDF, NativeExcel, NativeWord, CSV, HtmlExport, HtmlEmail, Excel, Word, XML, or GoogleSpreadsheet | Info, Report |
rdShowModes | Specifies ShowModes defined for display in the current report. | Info, Report |
| rdSort | Indicates the column and direction of a DataTable sort. | Info, Report |
rdTaskID | Specifies a Task ID to execute. | Info |
rdTaskLogFilename | Returns the name of the logfile created by Task Manager for a specific job. This token is used within the Process definition that creates the job. | Info |
| <TabsElementID> | When a page containing a Tabs element is submitted, a request variable is automatically generated named for the ID of the Tabs element and assigned the value of the ID of the currently selected Tab Panel. | Info |
| rdTemplate | Specify the template definition to run. | Info, Report |
| rdUserName | The User Name value used during login when using security. | Info |