Difference between revisions of "Web Parameters"

(Using Web Parameters Example)
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.
 
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.
  
Web parameters can be added and existing ones managed by using the {{Menu|Add Web Parameter...}} and {{Menu|Manage Web Parameters...}} dialogs respectively: [[File:WebParametersRibbon.png|center]]
+
Web parameters can be added and existing ones managed by using the {{Menu|Add Web Parameter...}} and {{Menu|Manage Web Parameters...}} dialogs respectively: [[File:WebParametersRibbon.png|center|400px]]
  
 
In Excel 2003 and below, these can be found on the {{Menu|XLCubed|Web Parameters}} menu.
 
In Excel 2003 and below, these can be found on the {{Menu|XLCubed|Web Parameters}} menu.
Line 7: Line 7:
 
==Using Web Parameters Example==
 
==Using Web Parameters Example==
 
# Click on the cell where you would like the parameterised value to be, and select the {{Menu|Add Web Parameter...}} ribbon item
 
# Click on the cell where you would like the parameterised value to be, and select the {{Menu|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: [[File:AddWebParameter1.png|center|200px]]
+
# In the dialog, you can give the parameter a name. This name will be used by XLCubed Web Edition to identify the parameter:
# When the report is [[Web Publishing|published]], after first opening it, go to the Web Edition homepage. From here, you can view the defined parameters ([[File:ParametersIcon.png]]): [[File:AddWebParameter2.png|center]]
+
 
# After entering the parameters as required, you can use the '''Get URL''' button to generate a link, which can be used from calling applications: [[File:AddWebParameter3.png|center|400px]]
+
[[File:AddWebParameter1.png|center|200px]]
 +
 
 +
# When the report is [[Web Publishing|published]], after first opening it, go to the Web Edition homepage. From here, you can view the defined parameters ([[File:ParametersIcon.png]]):
 +
 +
[[File:AddWebParameter2.png|center|400px]]
 +
 
 +
# After entering the parameters as required, you can use the '''Get URL''' button to generate a link, which can be used from calling applications:
 +
 
 +
[[File:AddWebParameter3.png|center|400px]]
  
 
==See Also==
 
==See Also==

Revision as of 11:46, 30 August 2012

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.

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.

Using Web Parameters Example

  1. Click on the cell where you would like the parameterised value to be, and select the Add Web Parameter... ribbon item
  2. In the dialog, you can give the parameter a name. This name will be used by XLCubed Web Edition to identify the parameter:
AddWebParameter1.png
  1. When the report is published, after first opening it, go to the Web Edition homepage. From here, you can view the defined parameters (ParametersIcon.png):
AddWebParameter2.png
  1. 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

See Also