Applicable Versions: 4.05.0075 and above 

This knowledge base describes the two methods to implement dashboards that display information based on a parameter passed from a browser based application. If the dashboard is set to refresh queries when it is opened, you can pass required parameters to the query using the URL. Alternatively, you can use API Parameters to filter the data in a dashboard before it is rendered. Which method you wish to use depends on your data. In general, it will be quicker to use API parameters, as the dashboard already contains the required data, and is simply filtered before it is rendered. However, if the complete dataset is very large, and the filtered dataset is very small, it may be quicker to use the second method, and refresh the filtered query on demand. 



Using API Parameters to filter dashboard content (versions 6.50.013 and above)

The steps are broken down into the following tasks which will be described in detail in the video below;

  1. Create one or more API parameters in your dashboard.
  2. Apply filters to objects in your dashboard using the API parameters.
  3. Publish the dashboard.
  4. Pass the API Parameter values to the dashboard as URL, Form or request header value, name pairs.





Using query parameters to filter content in a dashboard when it is opened (versions 4.05.0075 and above)

The following describes how to filter a query that is refreshed when the dashboard is opened based on values passed in the URL. The steps are broken down into the following tasks which will be described in detail in the video below;

  1. Create a dashboard with at least one required field query parameter. 
  2. Remove the control panel objects that provide the values for the required fields.
  3. Set the query to refresh on open.
  4. Publish the dashboard.
  5. From the Manage Published screen, copy the URL and substitute the parameter and security parameters.
  6. Add a hyperlink or iFrame definition in your web application to open the URL.



Useful Links

HTML iframe tag - useful to include a dashboard, report or query in a page with additional content.

How to embed dashboards with user specific content into a webspeed page.

How can I get the URL for a dashboard, report or query published to DataPA Enterprise so I can use it in my own web application?

Is it possible to specify which connection or connections a query is refreshed against when I open a dashboard using a URL from my application?

Is it possible to control the display of dashboard tabs when embedding a dashboard into my application using DataPA Enterprise?