Professional Documents
Culture Documents
Techniques for Leveraging Prompts, Prompt Macros, and Other Techniques in Business Insight
Abstract:
This document provides various examples, techniques, and how-tos to improve the overall amount of dynamic interactivity of Business Insight to meet more of needs and demands of customers
Table of Contents
1
Overview......................................................................................................................................... 3 Example #1 Using Simple Report Prompts in Business Insight....................................................6 Example #2: Using Cascading Prompts........................................................................................10 Example #3 Creating Dynamic Maps.........................................................................................13 Example #4 Using Prompt Macros to Change Measures and Dimensions..................................19 Example #5 Bringing it all together...........................................................................................26 Example #6 Using Prompts for Comparative Analysis................................................................31 Appendix Report Specs...............................................................................................................33
Overview
Business Insight supports the ability to import prompts in addition to report parts directly on the workspace. This provides greater flexibility and options than the native Business Insight toolbox items. Support for a greater variety of prompt types (e.g. tree prompts, radio buttons, cascading prompts, etc.) Greater formatting options, in terms of fonts, background images, borders, colors, etc. Ability to change metadata on the report without needing to launch Business Insight Advanced
This document will describe a few (of the many) different examples of how to leverage prompts within Business Insight.
1. Using Simple Report Studio Prompts Greatly Flexibility and Look-and-Feel with Report Studio Prompts
2. Using Cascading Prompts Provides more dynamic interactions and more navigate-able paths
3.
5.
Different Prompt Types (List, Checkbox, Tree Prompt) Improved Formatting Backgrounds, Font/Colors, Borders Better Control and Linkage to Objects on Dashboard
Step 1: Create the Report Studio Prompts. 1. In Report Studio, create a standard report with multiple charts and lists
2. Create a new prompt page in Report Studio. 3. Within the Prompt Page, add the Appropriate the Prompts and behavior to the Prompt Page (Tree, Value, Text, etc.)
4. Define the appropriate formatting for the prompt page for desired consumption. In this example, predefined sizes, background images, different fonts and colors, and borders were added to improve the overall look-and-feel of the page
Step 2: Add the Prompts to a Business Insight Dashboard 5. Create a New Business Insight Dashboard. In the Content area (where the report was saved) there are two folders
(Page 1 and Prompt Page 1):
Note: You can rename these folder names to more descriptive names, like Select a Report Part and Select a Prompt Filter. 6. Drag-and-drop the Charts and the entire prompt page to the dashboard. You should see the following.
8. From the original prompt report, copy the prompt parameters from the query and paste them into the new report.
On the original report, double-click on the parameter and copy the expression. Go to the new report and create a new detailed filter by drag-and-dropping a data item into the detail filter and copying the new expression in.
Original Report
New Report
Repeat this process for all of the parameters and set the prompt to optional, if desired
9. In Business Insight, drag the new objects (from the new report) on to the dashboard. Change the prompt answers
and youll notice that the new object now leverages these prompt parameters
Step 1: Build the Appropriate Report Objects to Support Business Requirements Similar to the first example, the respective report parts need to be built out.
1. Build out the necessary charts, lists, and crosstab to support your report needs. In this case, since the cascading
prompts will be going to the lowest level, add lower level fields to the objects (e.g. City, Customer, Week, or Product)
Step 2: Build out the Prompt Pages Similar to the first example, the respective prompt pages need to be built to support the interactive needs of the business. To do this, create a new prompt page and add in the following:
10
2. Add a prompt for a high-level field, like Year. Provide the parameter names, as we will be using these parameters again. Choose to select a single value, rather than a multi-select, as this will allow for the auto-submit option. 3. Add another prompt for a more detailed field, like Quarter or Month. Under the cascading option, choose to use the Year parameter to filter this prompt.
4. Within the prompts properties pane, set default selections and assign a default prompt answer.
To get the correct syntax, right-click on a member in the metadata tree and select properties:
5. Repeat this process for other dimensions, like Geography and Products. 6. Apply the necessary tables and formatting for the desired look-and-feel. Refer to the attached report specification for additional details.
11
Step 3: Add the Objects into Business Insight 7. Create a new Business Insight workspace and add these new report objects as well as the prompt page. There will not be any option to select individual prompt objects, so you will need to add the entire prompt page to the workspace.
12
Step 1: Create the Variables in Report Studio This technique uses the render variable option within Report Studio 1. From within Report Studio, select Variables and open the Variables pane.
13
2. Add a new string variable called Map and provide the following expression definition: ParamDisplayValue('vRegion') 3. Within the Values pane, type in values that match your data items. In this example, the Region field has three values:
North America, Europe, and Asia. Therefore, the values are set to be the same names as these regions. Create a blank value and (other) value, in the event that nothing is returned.
Step 2: Add Maps to the Report and Assign the Maps to Variables
4. On the report layout, drag-and-drop a map onto the pane. Select a North America or US map. Add the appropriate
information to it, like States/Provinces and a measure field.
14
5. Repeat these steps for the other maps, like Europe and Asia.
Theres no need to put these maps into tables, as the variables will dynamically display the appropriate map.
6. Click on the Map and within the Properties pane, click on the Render Variable. Under Variable, select the Map
variable and check the appropriate Variable value that applies. Repeat these same steps for the Style Variable (This may not be needed)
15
7.
8. To test that the variables are getting set correctly, highlight the Variables pane and click on North America:
16
Step 3: Build a Prompt or Assign a Parameter to select these Variables The map variable can be set in multiple different ways. If theres a parameter that is already being set by another prompt, that variable can be leveraged within the workspace. 9. Create a new prompt page.
10. Create a prompt for Region and any other prompts that you may wish to set. Ensure that the parameter is identical to
that set in the variable. For example, the variable definition was ParamDisplayValue('vRegion'). This means that the prompt parameter needs to be vRegion. 11. Ensure that only one value can be entered into the prompt and that it is not a multi-select prompt. 12. Assign this prompt to the Region query.
Step 4: Add Additional Charts or List to provide more contextual information 13. Additional crosstabs and charts can be built for additional information or they can be leveraged from other reports.
Step 5: Add Information to Workspace 14. Create a new workspace. Under the reports, drag the entire Page1 onto the workspace along with the prompt.
17
18
Step 1: Create the Prompt Macro Data Items in Report Studio 1. Create a blank chart and crosstab in Report Studio with your desired formatting
2. Go to the Query. Drag a Data Item element from the toolbox to the Query. Type in the following expression:
19
Measures is the parameter name, which will be used later. [Market Analysis].[Market Analysis].[Order Revenue] is the default parameter selection. To get the path of the selections, right click on the measure or object and select properties. Copy the Ref path.
#prompt('Rows','token','[Market Analysis].[Region].[Region].[Region]')#
5. Copy-and-paste the Measures data item and rename to Cols. Copy the following expression:
#prompt('Cols','token','[Market Analysis].[Date].[Year].[Quarter]')#
6. On the Chart or List, add the newly created data items to the object (Measures, Rows, and Cols):
20
Step 2: Create a Prompt Page to Drive the Prompt Macros 7. Identify all of the different Measures, Rows, and Cols to use. Copy their paths to a text editor, like Notepad for future
reference. To do this, right-click on the object in the Metadata Tree and select properties. In this example, we will use the following:
Measures: [Market Analysis].[Market Analysis].[Order Revenue] [Market Analysis].[Market Analysis].[Sales Growth %] [Market Analysis].[Market Analysis].[Win / Loss %] [Market Analysis].[Market Analysis].[Market Share %] [Market Analysis].[Market Analysis].[# Inquiries]
Rows: [Market Analysis].[Region].[Region].[Region] [Market Analysis].[Region].[Region].[Segment] [Market Analysis].[Product (Market Analysis)].[Product].[Product Line]
21
8. Create a new prompt page. Create a Value Prompt for Measures 9. From the toolbox, add a Value Prompt. In the wizard, select to use existing parameter: Measures and uncheck create new query. 10. On the prompt page, click on the value prompt. In the properties pane: Scroll to Static Choices and click to edit. Click on the Add icon Put the path under the Use option and a descriptive name under Display
11. In the properties pane, select Default Selections and add the path to the desired default option ([Market Analysis].
[Market Analysis].[Order Revenue]) 12. Set the Auto Submit option to Yes. This will avoid the need for an Apply or Finish button to be needed.
14. Using the same techniques as above, repeat the same steps for the Rows and Cols prompts. 15. Add a new value prompt from the toolbox menu. 16. Select Rows as the parameter and do not create a new query. 17. In the properties pane, define the Static Choices
18. Define a Default Selection: [Market Analysis].[Region].[Region].[Region] 19. Repeat the same steps for the Cols parameter.
20. Apply any additional prompt options or formatting. In this example, a table and defined sizes to improve the layout.
23
23. On the original report, create a new prompt page. From the toolbox menu, add a text box prompt. 24. Provide a parameter name, like highvalue. Uncheck create a parameterized filter. 25. Add another text box prompt to the report and provide a parameter name, like lowvalue.
26. Add any additional parameters to control the highlighting, if desired.
27. On the Crosstab or List object, click on the measures area within the crosstab/list and select the Conditional Styles
icon.
28. A new dialog will appear. On the bottom left corner, select Advanced Conditional Style. 29. Click on New Advanced Condition and use the following expression
[Query1].[Measures] > string2double(ParamDisplayValue('highvalue)) 30. Create another Advanced Condition and use the following expression: [Query1].[Measures] < string2double(ParamDisplayValue('lowvalue')) 31. Apply the appropriate formatting:
24
25
Filter Prompts to refine result sets Prompt Macros to dynamically change measures and chart values Conditional Formatting to define the KPI thresholds on the dashboard
Users have complete control over the Measures, Rows, Columns, Filters, and Formatting. Infinite number of dashboard combinations
26
Additionally, while all of these prompts can be laid out on the same prompt page, multiple prompt pages were used for Measures, Rows, and Cols to provide more flexibility for the end user. If they do not wish to use all of the objects and prompts, they can choose to ignore them.
to filter by a Time
Apply any formatting to the prompt page to lay the prompts out effectively.
Select a desired conditional format. To define the Up/Down and Stoplights to be dynamic, click on the edit button. Change the font to 1pt with a white background and insert a background image for the stoplights.
28
Apply any additional conditional styles to other lists or crosstabs. Optionally: Conditional Highlighting can be applied to charts. This means that charts can inherit these same properties. Apply any additional formatting to the prompt page:
Drag and drop any combination of charts and prompts to the workspace. Not all of the objects and prompts needed to be added to the dashboard. If a prompt is not added, then the objects will inherit their default prompts answers, defined on the prompt.
29
30
In Business Insight, users can choose to drag over two of the same objects and allow for different behavior. In the example below, the same 2 charts and 2 prompts are dragged into the dashboard. The top two charts are only listening to prompt #1 and the bottom two charts are only listening to prompt #2.
Drag over the same two objects again. Hover over the first chart and select Listen for Widget Events
31
Uncheck the bottom prompts (these will be at the bottom of the list of objects). This means that the top chart will be driven off of the first two prompts, but will ignore the bottom prompts. Repeat this process for the other chart on top. Hover over the bottom chart and select Listen for Widget Events. Uncheck the top prompts. These will be at the top of the list of objects. This means that the bottom charts will be driven from the bottom prompts. Hover over the top prompt and select Listen for Widget Events. Select for the prompt to only listen to the charts and NOT the other similar prompt below. Repeat this for the bottom prompt.
32
Report Spec
Cascading Prompts
Example # - Report Spec.txt 2
Dynamic Maps
Example # - Report Spec.txt 3
Report Builder
Example # - Report Spec.txt 4
33