Creating a Dashboard Prompt

Transcription

1 Creating a Dashboard Prompt This guide will cover: How to create a dashboard prompt which can be used for developing flexible dashboards for users to utilize when viewing an analysis on a dashboard. Step One Click or hover over the New icon in the Global Header and select Dashboard Prompt. Step Two Select a subject from the Select Subject Area menu. It is important to note that prompts work best when used with analyses from the same subject area. Caution must be taken when attempting to use a prompt from a different subject area than the analysis is using. Step Three Click on the green (+) sign and select the Column Prompt... option. Locate and select a column then click OK. 11/10/2016 1

2 Step Four The New Prompt dialog box will appear. Here you can change the text of the prompt, add a description for the prompt and change the way the prompt functions. Click on the Options plus box. This area can be used to adjust many options for the prompts. Use the Choice List Values to select specific values that will be available in the prompt. It is often best to require user input on at least one of the prompts as well as indicating a default selection to prevent system latency or errors. Once the prompt for this column has been configured click OK. Repeat steps 3 and 4 as necessary. If you have multiple prompts, this will limit the available options the user sees in the prompt based on the values selected by a previous prompt. In this example, when a user chooses one of the available Academic Programs (e.g. UCBA Associate) the Academic Plan prompt will only display majors and minors associated with that Academic Program. It can be tempting to choose the All Prompts option here, but doing so regularly will cause performance problems and can cause irregular behavior within your prompts. It is recommended that you only limit prompt values by prompts that are directly related (for example, Academic Year and Term, or Academic Program and Academic Plan). 11/10/2016 2

3 Step Five Click the Save icon to save the dashboard prompt into a folder. Please note, if this will be included on a shareable dashboard it must be saved within your assigned Shared folder. Please review the Understanding Shared Folders and How to Share Dashboards and Analyses documentation if necessary. Step Six A dashboard prompt will not have any impact on an analysis filter unless the filter is set to "is prompted" or the filter looks at a variable that is being set by the prompt. Use the Catalog to navigate to the analysis (or analyses) that the prompt will be impacting. Step Seven Within the Criteria Tab, create a new filter using the same column selected in step 3 or locate an already created filter in the Filters section. (Reference the Creating Basic Filters document for more information on how to create filters) If editing an existing filter, hover over the filter and click the Edit icon. In the Edit Filter dialog box, change the Operator to "is prompted" then click OK. Repeat this step as necessary. 11/10/2016 3

4 Step Eight Click Save to save your analysis then navigate to the dashboard which will contain the analysis and newly created dashboard prompt. If creating a new dashboard, click or hover over the New icon in the Global Header and select Dashboard. (Reference Creating a New Dashboard document) Step Nine To insert the dashboard prompt into the dashboard, locate it within the Catalog Pane under the folder in which it was saved. Once found, drag and drop it to the right side of the dashboard editor window. 11/10/2016 4

5 Step Ten If the dashboard contains multiple pages, be sure to select the appropriate scope which will control whether the filter applies to all pages or a single page. To select a scope, hover over the dashboard prompt object and click on the Properties icon. Hover over Scope and make one of the following selections: Dashboard filter will apply to the entire dashboard (default option) Page filter will only apply to the current page that contains the prompt Step Eleven Click Save then Run to view the dashboard and see how the prompt affects the analysis that is included on the dashboard. 11/10/2016 5

6 Unlike analysis prompts, the dashboard prompt will remain static which will allow a user to change the filter selections without the need to refresh the web browser. You have now completed the steps for creating dashboard prompts. 11/10/2016 6