Setting parameters through URL

When you set parameters through the URL, you can dynamically add selection options without changing the saved values of the app. It is also easy to share these settings by including them in emails, documents, and so on.

The basic syntax for URL formatting:

http://baseurl/arc/apps/app/id?config.output={setting: value}
baseurl
The ip address of the site, such as 27.0.0.1:8000, or sf.mycompany.org.
id
Unique number of the dashboard or the visual.
output
The output of the parameter or the picklist.
setting
Available option is VALUE.
value
An array of value-label pairs in the format [["value1","label1"],["value2","label2"],["value3","label3"], ...,].

The following steps demonstrate how to use parameters through URLs.

  1. In the Settings modal window, in the Values tab, specify the Title and Output Parameter. In this example, we used test and result, respectively.
  2. [Optional] Specify one or more Value:Label pairs. In this example, we used result1:1.
  3. Click Apply.
  4. In the dashboard, check the possible options for the parameter.
  5. In the test parameter, click the Down Arrow icon, and notice that there are two options: (All), and 1.
  6. Select 1, and hover the pointer over the Filter icon at the top right of the dashboard.
  7. Note that the Current Parameters are set to result: result1 and result.alias: 1.
  8. Save the dashboard.
  9. Switch to View mode.
  10. Copy this the URL. In our example, it is http://127.0.0.1:8000/arc/apps/app/38.
  11. In another browser window, paste the value saved in the previous step, add the code specific to setting parameters through URL, and click enter.

    In this example, we are adding two more pairs: result2:2, and result3:3. The new code is in bold font, starting with '?'.

    http://127.0.0.1:8000/arc/apps/app/38?config.result={values:[["result2","2"],["result3","3"]]}
  12. In the dashboard, check the possible options for the parameter. Note that options 2 and 3 now appear in the selection list.
  13. In the test parameter, click Select , and notice that there are two additional options: 2 and 3.
  14. Select 2, and hover the pointer over the Filter icon at the top right of the dashboard.

    Note that the Current Parameters are set to result: result2 and result.alias: 2.