Configure a Download Parameter for a Layout

Configure download parameters for a layout from the Download tab of the Layout Designer, then test the results before you publish your integrated workbook.

When a parameter is configured, the add-in appends the search query to the REST endpoint URL of the GET request when the business user clicks the Download Data button.

Please note there is no validation in the editor or at download time. The add-in cannot determine which parameters are useful for search. Likewise, the add-in can't determine the proper syntax for the parameter values. If you enter invalid information, you may get a bad request error. Consult the API documentation for the service you are using to identify whether to use "q" for the parameter name and how to formulate the search expression properly.

The Download Parameters property works in combination with the search and row finder settings where applicable. They are not mutually exclusive. If search or row finder settings have also been configured, the user is prompted to provide values for the configured parameters that will further filter the returned results.

If you configure multiple search options, make sure the service supports that combination. Some combinations may work where others may not.

WARNING:

Some services, such as ADF REST and VBBO services, do not support using more than one "q" parameter in a REST call. If you are using one of these services, configure the add-in to merge all configured "q"-type queries into a single query for download. See Merge Searches for Download.

To add download parameters to your layout:

1. In the Excel ribbon, click Designer.
2. In the Layout Designer's Download tab, click the Add or Edit Download Parameter icon next to the Download Parameters property to open the Download Parameter Editor where you add or edit download parameters.
   
   

   
   Description of the illustration excel-search-parameters.png

   
   
3. Enter a name and value in the parameter properties.

   Note:

   Do not enter URL-encoded values in the parameter properties. The add-in applies URL encoding to the parameter value at download time. The parameter name is not encoded.
4. If you used an expression in the Parameter Value property, select Allow expressions in Parameter Value.
   Selecting this check box ensures the add-in evaluates the value as an expression.
5. Click OK to close the editor.
6. Test the parameter by downloading data and viewing the results.

   Tip:

   To troubleshoot a particular combination of search settings, open the Network Monitor and download data. Then, inspect request details in the Network Monitor's window. This information may help you refine search settings.