WRExportType Reserved Word

Trouble seeing the images? Right click on images and open in new tab to enlarge or zoom in on the page (Ctrl + mousewheel).

In this article we discuss how to setup parameters to leverage the @WRExportType reserved word for WebReports.

• Conditional behavior for the "WRExportType" Parameter is as follows:
  • When the report is executed via VDM, the @WRExportType value will be Null. When VDM detects the Default Value has @WRExportType and it is Null, VDM will set the Value to the first item in the Value List; in this example below, the value would be HTML.
  • When the report is executed via WebReports and the SaveFile and ExportType option IS NOT included in the API URL call, the @WRExportType value will be Null. When WebReports detects the Parameter's Default Value has @WRExportType and it is Null, it will set the Value to the first item in the Value List; in this example below, the value would be HTML.
  • When the report is executed via WebReports and the SaveFile and ExportType option IS included in the API URL call, the @WRExportType value will be set to whatever is present in the call; PDF, XLSX, XLS, or RTF. This string will then be assigned to the Value.

Video Tutorial: 

Not Yet Available

Steps to use WRExportType.

1. Open VDM.

2. Open / create a View.

3. Click on parameters.

4. Add a parameter.

5. Name the parameter WRExportType.

6. Add your desired export types to the value / collection list.

NOTE: The first value in the list will be used as the default value if no value is specified. To change the first value use the up/down arrows as needed. 

7. Set the Value property to @WRExportType. This will set the default value to be the reserved word.

8. Set Enabled to False to prevent users from entering anything into the parameter value. This will ensure that the default value / specified value is always used for the parameter value.