Difference between revisions of "Web Parameters"

 
Line 1: Line 1:
Web parameters are intended to enable XLCubed Web Edition reports to be invoked from other applications. Using web parameters, it's possible to embed a cell value or an argument for one of the hierarchies into the URL which is generated for the report. This means any calling application can populate this parameter, and open the Web Edition report with the required restriction already in place. In this approach  the cells being used as Web Parameters must also be used as the selection for any XLCubed Grids, Formulae and Charts which should be updated based on the passed parameter.
+
Web parameters are intended to enable XLCubed Web Edition reports to be invoked from other applications. Using web parameters, it's possible to embed a cell value or an argument for one of the hierarchies into the URL which is generated for the report. This means any calling application can populate this parameter, and open the Web Edition report with the required restriction already in place. In this approach  the cells being used as Web Parameters must also be used as the selection for any XLCubed Grids, Formulae and Charts which should be updated based on the passed parameter as shown below.
 
[[File:GridFromRange.png|center|500px]]
 
[[File:GridFromRange.png|center|500px]]
 +
  
 
Web parameters can be added and existing ones managed by using the {{Menu|Add Web Parameter...}} and {{Menu|Manage Web Parameters...}} dialogs respectively.  
 
Web parameters can be added and existing ones managed by using the {{Menu|Add Web Parameter...}} and {{Menu|Manage Web Parameters...}} dialogs respectively.  

Latest revision as of 17:05, 26 September 2018

Web parameters are intended to enable XLCubed Web Edition reports to be invoked from other applications. Using web parameters, it's possible to embed a cell value or an argument for one of the hierarchies into the URL which is generated for the report. This means any calling application can populate this parameter, and open the Web Edition report with the required restriction already in place. In this approach the cells being used as Web Parameters must also be used as the selection for any XLCubed Grids, Formulae and Charts which should be updated based on the passed parameter as shown below.

GridFromRange.png


Web parameters can be added and existing ones managed by using the Add Web Parameter... and Manage Web Parameters... dialogs respectively.

WebParametersRibbon.png


In Excel 2003 and below, these can be found on the XLCubed > Web Parameters menu.

Creating Web Parameters

Web parameters can be defined within the Excel workbook. Select the cell where you would like the parameterised value to be, and select the Add Web Parameter... ribbon item.

In the dialog, you can give the parameter a name. This name will be used by XLCubed Web Edition to identify the parameter.

Selecting Create Named Range will also add the cell as a named range (with the name as defined in the dialog) to the workbook.

AddWebParameter1.png

Opening Web Reports Using Parameters

When the report is published, after first opening it, go to the Web Edition homepage to view recent reports. Hover over the report and click the icon to view the defined parameters (ParametersIcon.png):

AddWebParameter2.png


After entering the parameters as required, you can use the Get URL button to generate a link, which can be used from calling applications:

AddWebParameter3.png

Multiple Parameters

If you select a range when creating your parameter you can pass in multiple values to populate the workbook. One value will go into each cell. To add multiple values you repeat the parameter name for each value. e.g.:

http://myServer/xlcubedweb/WebForm/ShowReport.aspx?rep=MyFolder%MyReport.xml&products=food&products=drink


See Also