Home

Using the DeepSee Dashboard Designer

1. 9 3 Manually Creating Dashboards to Display source Data To manually create dashboards to display source data do the following in either order e Create the primary dashboard which includes a suitably configured frame e Create the secondary dashboard which displays one or more source data fields as default values within controls The following figure sketches the basic requirements Primary dashboard Secondary dashboard Frame Load as Detail Listing Subject Area option MySubjectArea Subject Area option MySubjectArea Detail Listing option MyDetailListing Detail Listing option MyDefaiilListing Optional fiter Text box or other control Default Value specific source field Because the primary dashboard refers to the secondary dashboard you may find it simpler to create the secondary dashboard first so that you do not need to reopen and re edit the primary dashboard The following sections provide the details 9 3 1 Creating the Secondary Dashboard The secondary dashboard displays one or more listing fields typically with labels and typically arranged in a row like the following example OrderID Ship Date Customer To create the second dashboard 1 Create a new blank dashboard as described in Editing a Dashboard earlier in this book 84 Using the DeepSee Dashboard Designer Manually Creating Dashboards to Display Source Data Tip You may find it useful to follow a naming
2. could select 20 and then the pivot table would display the top 20 sales regions This works because the combo box uses the user s selection to update a system variable that is used by the pivot table You can also use the same mechanism to set your own variables For example you could use a combo box to set the variable VVCOUNTRY or some other name you choose and you could have a label that displays the value of that variable by using the VAR function see Function Calls in the appendix To use a control to set a variable 1 Configure the control as follows a For Store In Variable either type the variable name or click the browse button and then select a system variable Note For check boxes the properties dialog box does not include a browse button for variables so type the variable instead b Click OK The dialog box is closed and the variable is displayed in Store In Variable 2 Specify the control as the refresh trigger To do so right click the control and then click Set as Refresh Trigger 3 Specify the data element as the refresh target To do so right click the data element and then click Set as Refresh Target When you do so a gray line is drawn between the control and the data element Tip To delete links to an object right click it and then click Delete all links to object 5 11 1 Example 1 Controlling the Ranking of a Pivot Table In this example we create a combo box with which the user
3. e Appearance Specifies whether this speedometer is shown as a half circle or as a circle The following shows examples of each note that both these speedometers have exactly the same width E 4 S54 JE 7 e Outer Layout Type Controls the appearance of the outer region of the speedometer which can be displayed either as a solid color as in the preceding examples or as a gradient Select None Gradient vertical or Gradient round radial gradient The following examples show the vertical gradient and the radial gradient A 4 0J S 5 41015 7 6 4 0 S 5 4 5 7 The radial gradient option is more suitable with a round speedometer rather than a half circle For example 36 Using the DeepSee Dashboard Designer Speedometer Display Properties SEAE e Outer Layout left Color Specifies the main color of the outer region of the speedometer By default this is dark blue e Outer Layout right Color Specifies the secondary color of the outer region of the speedometer if you are using one of the gradient options By default this is not specified If you select one of the gradient options be sure to use different colors for Outer Layout left Color and Outer Layout right Color Inner Layout Specifies the color of the inner region of the speedometer This area is white by default This option has no effect if you use the Outer Scale option e Background Color Specifies the color of t
4. 1 1 Purpose of the DeepSee Dashboard Designer You use the DeepSee Dashboard Designer during an implementation process whose overall goal is to embed pivot tables in existing or new applications Pivot tables provide real time business intelligence Using the DeepSee Dashboard Designer 3 Introduction to the Dashboard Designer BI interactive tables and graphs with which your users can explore the data used in or generated by their applications The purpose of the Dashboard Designer is to create dashboards that display pivot tables speedometers and detail listings Dashboards can include buttons drop down list controls and other elements with which the user can control the display 1 2 Required Preparation Before you can use the Dashboard Designer you or someone else must create the following elements e Pivot tables e KPIs e Detail listings For information on creating pivot tables and KPIs see Using the DeepSee Analyzer For information on creating detail listings see Using the DeepSee Architect 1 3 Summary of Dashboard Options This section summarizes what you can do in dashboards 1 3 1 Available Elements You can include any of the following elements in a dashboard 4 Using the DeepSee Dashboard Designer Summary of Dashboard Options Label A string which can be the result of a Cach ObjectScript function call Image E An image which can be interactive Picture box A An i
5. 3 1 Creating a New Dashboard To create a new dashboard 1 The way to start depends on your current location e Ifyou are currently viewing a dashboard in view mode right click and then click New Dashboard gt Blank e Ifyou are currently viewing a DeepSee module click Main gt Open Dashboard Then click the New button Using the DeepSee Dashboard Designer 19 Creating Dashboards DeepSee displays a dialog box where you specify the basic properties of the new dashboard 2 For Board Name type the name of this dashboard 3 For Folder click the browse button and select a folder to contain this dashboard 4 Optionally specify the following properties e Remarks Specifies a description or comments for this dashboard for internal use e Back Color Specifies the background color for this dashboard as well as the initial back ground color for any elements you add to it To use this option click it choose a color and then click OK e Width Specifies the width of this dashboard In practice this specifies the maximum pos sible width of any background graphic e Height Specifies the height of this dashboard In practice this specifies the maximum possible height of any background graphic e Scrollable Dashboard Specifies whether this dashboard includes scroll bars when the browser window or the containing dashboard frame is too small to display all the contents of the dashboard Select thi
6. earlier in this book 2 Click the add button icon MEE DeepSee displays a dialog box in which you specify the details 3 Type the text of the button into Normal Display Or type a Cach ObjectScript expression that refers to a user defined function function starting with see Function Calls in the appendix You can use the KPI or VAR function which are also described in that section 4 Optionally specify the following e Font Click this and then specify the typeface font style and font size You can also choose underline or strike through properties Ignore the color options and alignment which have no effect e Fore Color Click this and then select the color of the text e Back Color Click this and then select the color of the background of the label e Back Style Transparent Click this to make this background transparent If you do the background color is ignored 5 Click OK You might need to resize the dialog box in order to see this button The button is added in the upper left corner of the dashboard Note For information on DashboardID see Configuring an Image Button or Picture Button to Control a Frame later in this book Ignore the 3D Appearance option 70 Using the DeepSee Dashboard Designer Adding a Picture Button 7 9 Adding a Picture Button A picture button is a button that includes both an image and a caption You specify the position of both of these el
7. interactive Picture box a An image tiled repeatedly to fill Using the DeepSee Dashboard Designer 25 Creating Dashboards Timer A timer that can refresh one or more data elements Timer control A control with which the user can start and stop a timer See Adding Refresh Timers Pivot table A pivot table Speedometer A KPI displayed within a speedometer Detail listing A detail listing See Overview of Data Elements Venn diagram A Venn diagram See Adding Venn Diagrams Frame A frame that contains a dashboard See Adding Frames Combo box A drop down list from which the user can select one item List box 7 ABDEO EDD A list from which the user can select one or maybe more item Shown in a box Text box A box into which the user can type a value Date picker E A control into which the user can type a date or can click a button to choose a date Check box E A check box that the user can select or clear Search box A control into which the user can type a value or can click a button to search for a value in a list See Overview of Data Controls Dashboard library object An element that has been copied to the dashboard library See Using the Dashboard Library 26 Using the DeepSee Dashboard Designer Editing an Elem
8. 4 For Folder click the browse button and select a folder to contain this new dashboard 5 Click OK 24 Using the DeepSee Dashboard Designer Adding an Element DeepSee makes this copy from the original dashboard as saved That is if you open a dashboard in edit mode make changes but do not save them and then use the copy option the new dashboard reflects the original dashboard as it was before you made changes 3 5 Adding an Element 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this chapter 2 Click the icon corresponding to the type of element you want to add See the following subsection for a quick summary The system displays a dialog box in which you specify properties for the new element The details depend upon the element and how you plan to use it 3 Click OK You might need to resize the dialog box in order to see this button The new element is added in the upper left corner of the dashboard 4 Drag and drop the element to the desired location 5 Resize the element as needed 3 5 1 Overview of the Dashboard Elements The following table lists the elements you can add to a dashboard Label A string See Overview of Text and Graphic Elements Image An image which can be interactive the element Button A button that displays a string Can be interactive Picture button A button that displays a string and an image Can be
9. a EJ Click the add label icon RAG b For Normal Display type a suitable string such as Shipper c Click OK You might need to resize the dialog box in order to see this button The button is added in the upper left corner of the dashboard d Drag and drop the label to the desired location 6 Rearrange the other dashboard elements if needed Click the save dashboard icon E Then click OK 8 Click the close button X in the upper right DeepSee displays the new dashboard in view mode 9 Refresh the browser window Now your dashboard might look like this Using the DeepSee Dashboard Designer 15 Tutorial BIS se Shipper v Country amp shipper by year Level o of O Federal Shipping Argentina Speedy Express United Package Federal Shipping Austria Speedy Express United Package Federal Shipping v Page i of2 gt gt l When you choose an item from the combo box the pivot table and the speedometer should both be automatically filtered and refreshed 2 3 Tutorial Part 3 In this part of the tutorial we create a slightly more complex dashboard that contains multiple combo boxes Instead of including refresh links between these combo boxes and the pivot table we add a button and use that as the refresh trigger 1 Right click and then click New Dashboard gt Blank 2 In the dialog box specify the following basic information e For Board Name type the name of this dashboard
10. as described in Editing a Dashboard earlier in this book 2 Click the add detail listing table button DeepSee displays a dialog box in which you specify the details 3 In the List Of Detail Listing section expand folders as needed and click the detail listing that you want to add 4 Specify how to display the detail listing To do so click one of the following options for Display e Grid page Displays the rows one page at a time e Grid List All Displays all rows in a single scrolling window 5 Optionally specify the following 40 Using the DeepSee Dashboard Designer Adding a Detail Listing e Name Specifies a caption for the detail listing By default the detail listing uses the title specified in the Architect e Row Height Specifies the row height if you want to adjust the default row height e Auto load If you select this option the detail listing table automatically retrieves and displays the data clear the Auto load check box Otherwise it does not do so You would clear this option only if you added another element to the dashboard to act as a refresh trigger for the detail listing e Filter Specifies an additional filter to apply to the data shown in the detail listing Type a filter expression For example Ship Country Australia See the appendix Filter Expressions 6 Click OK You might need to resize the dialog box in order to see this button The detail lis
11. 7 Filter Expression That Uses Session Data cciisccc s iti sesiesstsesesscticessensopscesaensssccteos 111 A2 Punco Coals since E E E E ears A EE EA 112 A 2 1 KPI Function s seseseesessssssseseststererereseseststsrsrereresesesestsesrerererestsesesrsesrerereseseseseseseete 112 A2 2 SEVAR PUNehON eraciren erie A EEEE AERA 113 3 Cache Object Seri pt IX pres SiO cieri oe eae eoe E REE E EERE 113 AA Cache ObjectSeript SCriptss cisetiieciseciiviecsdl ave vasattps cubes E a EE RE 113 INdeX OE EEE E EAA A 115 vi Using the DeepSee Dashboard Designer About This Book This book describes how to create DeepSee dashboards and embed them in your applications This book contains the following sections e Introduction to the Dashboard Designer e Tutorial e Creating Dashboards e Adding Data Elements e Adding Data Controls e Adding Refresh Timers e Adding Text and Graphics e Adding Frames e Displaying Listing Fields and Other Source Data e Adding Venn Diagrams e Adding Post Actions e Using the Dashboard Library e Using Query Variables e Adding Dashboards to Your Applications e Expressions and Scripts in the Dashboard Designer For a detailed outline see the table of contents For more information see the following books e Introduction to InterSystems DeepSee an introductory guide for all users e Using the DeepSee Analyzer a guide for implementers and advanced users who want to create pivot tables to embed in applic
12. Click the add frame button I y DeepSee displays a dialog box in which you specify the details Optionally do some or all of the following For Default Dashboard click the browse button and then click the name of a dashboard e For Bottom Margin type a number that specifies the bottom margin of this frame relative to the window For example use 0 to make the frame flush with the bottom of the browser window e For Right Margin type a number that specifies the right margin of this frame relative to the window For example use 0 to make the frame flush with the right edge of the browser win dow If you do not specify Bottom Margin and Right Margin the frame is not resized automatically when the browser window is resized Instead the frame keeps the dimensions to which you resize it manually in the Dashboard Designer Click OK You might need to resize the dialog box in order to see this button The frame is added in the upper left corner of the dashboard For information on the other frame options see the next topic 76 Using the DeepSee Dashboard Designer Configuring an Image Button or Picture Button to Control a Frame 8 3 Configuring an Image Button or Picture Button to Control a Frame In general to configure an image button or picture button to control a frame 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Double click the image button
13. Dashboard Displays a dashboard possibly in a new window e Web Page Displays a Web page in another browser window e Scripts Executes one or more line of Cach ObjectScript e KPI Drill Down Displays a small child window that displays the value of a KPI Ignore Detail Listing and Workflow The bottom part of the dialog box then displays fields that are appropriate for your selection Specify the details as appropriate for the post action you chose See the following section Click Add This adds an entry to the table at the top of the dialog box To add more items click Clearand then repeat the preceding steps a SN Uw B Click OK to close the dialog box 11 3 Details for Different Types of Post Actions This section describes the details you provide for the different types of post actions Ignore the post action of type Workflow this type is not supported in DeepSee 11 3 1 Options for Displaying Another Dashboard If you choose Dashboard specify the details as follows e Dashboard Specify the dashboard to display To do so click the browse button select the dashboard and click OK 96 Using the DeepSee Dashboard Designer Deleting a Post Action e Open in New Window Select this to display the dashboard in a new browser window Or clear this to reuse the current browser window e Full Screen Select this to maximize the browser window Or clear this to leave the browser wind
14. Dashboard To remove a background image to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book Click the dashboard properties button fal 66 Using the DeepSee Dashboard Designer Adding a Label DeepSee displays a dialog box in which you specify the details Do one of the following e To remove the pointer to a stored image click Clr e To remove an image that was loaded from a file click Clear Click OK You might need to resize the dialog box in order to see this button The image is displayed in the specified position 7 5 Adding a Label To add a label to a dashboard l 2 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book Click the add label button Gin DeepSee displays a dialog box in which you specify the details Type the text of the label into Normal Display Or type a Cach ObjectScript expression that refers to a user defined function function starting with see Function Calls in the appendix You can use the KPI or VAR function which are also described in that section The label can have multiple lines Optionally specify the following e Font Click this and then specify the typeface font style and font size You can also choose underline or strike through effects Ignore the color options and alignment which have no effect e Fore Color Click this and then s
15. For Namespace type the name of the namespace you want to work in 4 Click Logon to DeepSee This displays a login page 5 Log in as usual 1 7 Exiting the Dashboard Designer To exit the Dashboard Designer click the close button X in the upper right DeepSee closes the child browser window Important DeepSee does not prompt you to save any changes Any unsaved changes are discarded 10 Using the DeepSee Dashboard Designer Tutorial This chapter presents a tutorial in three parts 1 The first part describes how to create a simple dashboard with a dashboard and a drop down list 2 The second part adds a speedometer and a label 3 The third part describes a more complex variation You can use this tutorial with any data It assumes that you have created at least one DeepSee pivot table and one KPI For information on creating pivot tables and KPIs see Using the DeepSee Analyzer 2 1 Tutorial Part 1 In the first part of the tutorial we create a simple dashboard that contains a pivot table and a drop down list called a combo box that filters it 1 Log into DeepSee as described earlier in this chapter 2 Now do one of the following e Ifyou are viewing a DeepSee module click Main gt Open Dashboard and then click New e Ifyou are viewing a dashboard right click and then click New Dashboard gt Blank DeepSee displays a dialog box where you specify the basic properties of the new dashboard 3 In this dialo
16. SCASE session Data CurrRole rolel North Region role2 South Region role3 West Region East Region A 2 Function Calls In a couple of places you can use a function call Specifically you can write a Cach ObjectScript expression of the following form functionname argl arg2 The function name must start with You can use function calls in labels button captions and speedometer captions DeepSee provides a couple of convenient functions e KPI Refers to the value of a KPI You can use this in labels and button captions e VAR Refers to the value of a variable set within the same dashboard You can use this in labels button captions and speedometer captions A 2 1 KPI Function To refer to the value of a KPI use the KPI function SSKPI kpiid filterexpr This function takes the following arguments kpiid ID of another KPI as shown in KPI List and elsewhere in DeepSee filterexpr Optional Quoted filter expression You cannot use this function in speedometer captions For example the following expression returns the value of KPI 10005 divided by KPI 10001 KPI 10005 KPI 10001 Suppose that KPI 10005 is based on the Freight measure and KPI 10001 is based on count The previous expression then returns the average freight cost per order for the entire subject area Consider the following variation SSKPI 10005 Ship Country USA SS KPI 10001 Ship Coun
17. abe E T 91 10 3 Adding a Venn Diagram to a Dashboard nccesser 92 11 Configuring Post ACtions sssssssssssssssssssssssssessssessssssssessssesessesessessesessesessessssessssessesesssorses 95 UY IO iverview of Post ACHONS iii ccacivese cecest2 cabin sascaesdhste a a iE EEEE EES 95 N2 Addins a Post PUMA sran ieia er Ei aee aaa ERORE EERS 96 11 3 Details for Different Types of Post ACHONS oeseri nesas eisini 96 11 3 1 Options for Displaying Another Dashboard 6 cscccsccscsseseeccestsssssossebesenssonstedvonee 96 11 3 2 Options for Executing Cach ObjectScript 2 42 0 5 scescseesseegecteeieseescteiptensecenevbadesocae 97 11 3 3 Options fof Displaying a Web Page iis ccc cts tins aise ititeiiiiicaai ei 97 11 34 Options for Displaying KPI Drlldowik eissis ssoi isisosseiisseerprisaconieronsinas teoses 97 11 4 Deleting a Post ACHR ss sacs er n eE EEE E Y 97 12 Using the Dashboard Library scssccsssessssssessesssssssssessscenscsssscsenssensosenssescossscvsssevasseasseeens 99 12 1 Adding an Element to the Dashboard Qibrary cscsccsccssscesesccsestssabessescopseuseesdanstaaiedenceys 99 122 Using a Library Object ma Dashboard scierie noirin 100 12 3 Deleting Objects from the Dashboatd Library u c s scccccccsessiscesceseantteasesaieevnescestsnnncsvigsees 100 13 Using Query Variables scccccaccccecsisacosssecvensevesersenvoeussessontsessondssesdesseosesaceesiscscasened sesendsecdevacensssases 103 13 1 introduction to Q
18. can type a value or can click a button to search for a value in a list The following sections show examples of each of these data controls in its default state Note that none of the data controls include a label this enables you to add labels at any position You can use any of the data controls in either of the following ways or even in a combination of both ways e To filter a data element or another data control in the same dashboard For example a user chooses a country and that updates a pivot table e To set variables used by data elements in the same dashboard For example a user types a number and a pivot table that shows the top ranked countries is updated to show that many of the top countries Both techniques are described at the end of the chapter 5 2 Adding a Data Control In general to add a data control to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Click the button for the type of control you want to add See Overview of Controls DeepSee displays a dialog box in which you specify the details 3 Configure the control as needed by setting its properties as described in the following sections 44 Using the DeepSee Dashboard Designer Using Combo Boxes Click OK You might need to resize the dialog box in order to see this button The control is added in the upper left corner of the dashboard Drag and
19. dashboard that displays listing fields e How to manually create a dashboard to display listing fields or other source data Also see the section Adding a Detail Listing earlier in this book 9 1 Overview of Displaying Source Data on Dashboards You can create dashboards that display listing fields or other source data For example Using the DeepSee Dashboard Designer 81 Displaying Listing Fields and Other Source Data DEE PSEE Dashboard with detail listing Shipper Ship Country Ship Date Year z al 3 OrderID 10248 Ship Date 16 Jul 2005 Customer wilman Kala OrderID 10249 Ship Date 10 Jul 2005 Customer Tradi o Hipermerce OrderID 10250 Ship Date 12 Jul 2005 Customer Hanari Carnes OrderID 10251 Ship Date 15 Jul 2005 Customer victuailles en stock OrderID 19252 Ship Date 11 Jul 2005 Customer Supr mes d lices This dashboard initially displays data for the entire subject area this is configurable The user selects dimension members from any or all of the combo boxes and then clicks Search The dashboard then filters the display appropriately The bottom of the dashboard not shown displays buttons with which the user can page ahead and back if there are too many items to display on one page DeepSee provides a wizard to help you display source data like this or you can create the dashboards manually See the following sections Using the Detail Listing Dashboard Wizard and Manually Creating Dash
20. drop the control to the desired location Resize the control as needed 5 3 Using Combo Boxes A combo box is a drop down list as follows The user clicks the arrow on the right and then clicks a list member To configure a combo box specify its properties as follows l Optionally type a name into Name This name is not visible in the dashboard itself but is useful when you edit the dashboard Create the list that this combo box uses To do so do one of the following e Create a list of dimension members as described in the following subsection If you are using the user s selection as a filter you must create the list this way e Manually create a list as described in the subsection after that Optionally do some or all of the following e Specify a default list member To do so click the browse button next to Default Value Then type a Cach ObjectScript expression into Cach Scripts Typically you type a string or a number For example Federal Shipping The expression must evaluate to one of the items in the list you created otherwise it is not shown Then click OK e Specify whether the list is populated when the dashboard is accessed To disable the default population clear the Load records Onload check box Using the DeepSee Dashboard Designer 45 Adding Data Controls You would do this only if you included another control that used this control as its refresh target For example
21. effect e Specify a filter to apply to the list of dimension members To do so type a filter expression into Filter For example Ship Date Year 2005 See the appendix Filter Expressions For example if the list of dimension members is the set of ship countries and you specify the preceding filter the user sees only the ship countries that received orders in 2005 Note This option does not apply to search boxes 5 3 2 Create a List Manually For combo boxes as well as list boxes and search boxes both discussed later you can manually create the list of items that the control uses To do so 1 Type a list item into the box beneath Condition Using the DeepSee Dashboard Designer 47 Adding Data Controls Control Value General 2 Click the gt gt button The value you typed is then copied to the unlabeled box beneath Sort Order 3 Repeat these steps as necessary until you have added all list elements Sort Order 4 Optionally specify whether the list includes the special first line By default the first line in the combo box or a list box is a blank line and this line corresponds to all members no filtering To remove this first line clear the First Line Display check box To specify a title for the first line type a value into the unlabeled box to the right of First Line Display Note This option does not apply to search boxes 48 Using the DeepSee Dashboard
22. end tools b Create a DeepSee user that uses that role For details on creating DeepSee users and roles see the DeepSee Site Configuration and Mainte nance Guide Within your application add a link that uses a URL of the following form http localhost 57772 csp sys bi speedLogin csp NAMESPACE NS amp usr username amp pwd password amp role rolename amp dbId 10026 Where e 57772 is the port number for which your Cach or Ensemble server is configured e NS is the namespace in which you defined the dashboard e username is a DeepSee user name Using the DeepSee Dashboard Designer 105 Adding Dashboards to Your Applications e password is the corresponding password e rolename is the DeepSee role to use e 10026 is the ID of the dashboard When the dashboard is displayed the URL shown in the browser address bar does not include the namespace name or the login details Note Depending upon your application you might need to use amp 38 or amp amp rather than amp in order for your application to compile For example http localhost 57775 csp sys bi speedLogin csp NAMESPACE ENSEMBLE amp amp usr demo amp amp pwd demo amp role demo amp dbId 10026 14 2 Passing Parameters to Dashboards First it is useful to summarize how a dashboard and its contents can use parameters e A filter expression can include a Cach ObjectScript expression that refers to a query variable For example you can have a fil
23. in the same way as any other dimensions including using them in filters However when you filter by date you often want the filter to consider a complete date rather than just an isolated segment of it For example you might want to filter a subject area to show only the data that falls within a particular ten year span of time To do so you can use the date dimension name without any of the automatically generated suffixes For example Birth Date gt 01 01 1980 AND Birth Date lt 01 01 1990 The dates must be in the form dd mm yyyy or dd mm yy A 1 5 Filter Expression with Embedded Cach ObjectScript A filter expression can include an embedded Cach ObjectScript expression The syntax is as follows DimensionName COS expression An extremely simple example is as follows Ship Country Den _ mark A 1 6 Filter Expression That Uses a Query Variable In a filter expression use the following syntax to refer to a DeepSee query variable DimensionName query_variable_name A 1 7 Filter Expression That Uses Session Data In a Cach ObjectScript expression in DeepSee you can refer to the current DeepSee username or the current DeepSee user role as follows Ssession Data CurrUser Ssession Data CurrRole For example you could use the current DeepSee role to specify a filter Using the DeepSee Dashboard Designer 111 Expressions and Scripts in the Dashboard Designer Region Name
24. must be no space between the left square bracket and the dimension name e There must be no space between the right string and the right square bracket e You can combine filter expressions by using the logical operators NOT AND and OR For example Ship Country Canada OR Ship Country Mexico OR Ship Country USA Use brackets to control the precedence e Filter expressions use the internal names of dimensions and members By default the external name of a dimension is the same as the internal name similarly the external name of a member is the same as the internal name This means that if you have renamed dimensions or members the filter editor still shows the original names A 1 3 Filter Expression Using IN You can also create a filter expression with the following syntax DimensionName IN Stringl String2 String3 For example Ship Country IN Canada Mexico USA 110 Using the DeepSee Dashboard Designer Filter Expressions A 1 4 Filter Expression with a Full Date When you create a dimension based on a date DeepSee creates a set of dimension variants which you can use separately or in combination For example if you create a date dimension called Order Date DeepSee creates the variants Order Date Year Order Date Quarter Order Date Month and soon The Order Date Year variant uses only the year part of the date Order Date Quarter uses only the quarter number and so on You can use these
25. of post actions and how to configure them It contains the following topics e An overview of the post actions you can configure e How to add a post action in general e Details for the different types of post actions e How to delete a post action 11 1 Overview of Post Actions You can configure a dashboard element so that when a user clicks the element DeepSee performs one or more post actions of the following types e Dashboard Displays a dashboard possibly in a new window e Web Page Displays a Web page in another browser window e KPI Drill Down Displays a small child window that displays the value of a KPI e Scripts Executes one or more line of Cach ObjectScript Post actions occur after any filter and trigger actions You can configure post actions for any of the following dashboard elements labels images buttons picture buttons and text boxes Using the DeepSee Dashboard Designer 95 Configuring Post Actions 11 2 Adding a Post Action To add a post action to a dashboard element 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Right click the element and then click Post Action DeepSee displays a dialog box in which you specify the details The top area displays a table of the post actions that have been configured for this element if any Use the bottom area to add new ones or delete existing ones 3 Click one of the following e
26. or picture button object in the dashboard DeepSee displays a dialog box in which you specify the details For Dashboard Id click the browse button and then click the name of a dashboard Click OK You might need to resize the dialog box in order to see this button Right click the object that you just edited or added and select Set as Refresh Trigger nw e W Right click the frame and select Set as Refresh Target When you do so a gray line is drawn between the frame and the object you just edited 7 Optionally save the dashboard Tip To delete links to an object right click it and then click Delete all links to object 8 4 Adding a Drop down Menu to Control a Frame You can add drop down menus to dashboards Drop down menus use DeepSee shortcuts which are discussed in the DeepSee Site Configuration and Maintenance Guide There are several types of shortcuts e A link to a DeepSee module e A link to a dashboard e A link to a dashboard function such as the Edit Dashboard option e A group of other shortcuts When you add a drop down menu to a dashboards you choose a shortcut of this type In general to add a drop down menu and configure it to control a frame Using the DeepSee Dashboard Designer 77 Adding Frames 1 If necessary create the individual shortcuts to include in the drop down menu See the DeepSee Site Configuration and Maintenance Guide If necessary create a shortcut that
27. selects a number The same dashboard includes a pivot table that uses ranking Depending on which number the user selects the pivot table is updated to show a different number of top ranked elements To set up a dashboard with these elements assuming that you have a suitable data model 1 Create a pivot table that uses ranking See Using the DeepSee Analyzer For example this pivot table could display the top ten ship countries 2 Create a new empty dashboard 3 Add the pivot table to the dashboard 4 Add a combo box to the dashboard For this combo box e Manually define the list members as 5 10 15 and 20 Using the DeepSee Dashboard Designer 57 Adding Data Controls 5 e For Store In Variable select the variable zzRANKCNT Connect the combo box and the pivot table Use the combo box as the refresh trigger and use the pivot table as the refresh target See the previous section in this chapter 5 11 2 Example 2 Controlling a Label In this example we create a combo box with which the user selects a ship country This combo box acts as a filter and refresh trigger for a pivot table it also controls a label on the dashboard To set up a dashboard with these elements assuming that you have a suitable data model 1 Create a new empty dashboard 2 Add a pivot table to the dashboard 3 Adda combo box to the dashboard For this combo box e Select the Orders subject area and then select the Ship Country
28. C hef Anton s Gumbo Mix hocolade te de Blaye The user then clicks a list item and clicks Accept to select it To configure a search box specify its properties as follows 1 Optionally type a name into Name This name is not visible in the dashboard itself but is useful when you edit the dashboard 2 Create the list that this search box uses To do so do one of the following 54 Using the DeepSee Dashboard Designer Specifying Default Values e Create a list of dimension members as described in Creating a List of Dimension Members earlier in this chapter If you are using the user s selection as a filter you must create the list this way e Manually create a list as described in Creating a List Manually earlier in this chapter Optionally specify the default list element To do so click the browse button next to Default Value Then type a Cach ObjectScript expression into Cach Scripts Typically you type a string or a number For example p This expression would select all list items that start with F Then click OK If you are using the user s selection to set a variable enter the name of that variable into Store In Variable See Using a Control to Set a Variable later in this chapter Click OK You might need to resize the dialog box in order to see this button If you are using the user s selection as a filter link the search box to the element that it filters
29. Designer Using List Boxes 5 4 Using List Boxes A list box is a box that contains a list of items as follows Argentina Austria Belgium Brazil Canada Denmark The box automatically includes scroll bars if necessary List boxes are quite similar to combo boxes To configure a list box specify its properties in the same way as for a combo box with two differences e For a list box the only comparison operator you can use is the equals operator so no choice is given e Fora list box you can enable the user to select multiple list elements at once To do so click Allow Multi Select 5 5 Using Text Boxes A text box is a plain box into which a user can type a value as follows To configure a text box specify its properties as follows 1 Optionally type a name into Name This name is not visible in the dashboard itself but is useful when you edit the dashboard 2 If you are using the user s entry as a filter select the dimension to which the filter refers To do so a For Subject Area select a subject area and click OK The dimensions in the subject area are then displayed within Dimensions b For Dimensions double click a dimension Using the DeepSee Dashboard Designer 49 Adding Data Controls When you do so the system puts your subject area and dimension name into Schema and Dimension on the right 3 If you are using the user s entry as a filter optionally choose a comparison
30. For Folder click the browse button and select a folder to contain this dashboard 16 Using the DeepSee Dashboard Designer Tutorial Part 3 10 11 Click OK You might need to resize the dialog box in order to see this button DeepSee then displays the dashboard in edit mode Add a pivot table to this dashboard as you did in the previous part of the tutorial Add a combo box to this dashboard as you did in the previous part of the tutorial Use different dimensions in the two combo boxes To add a second combo box a Right click the first combo box and then click Duplicate The copy is placed directly on top of the original b Drag and drop the copy c Double click the copy which displays a dialog box of its properties d In this dialog box double click a different dimension e Click OK For each combo box add a filter link between that combo box and the pivot table as follows a Right click the combo box and then click Set as Filter b Right click the pivot table and then click Apply Filter to this object When you do so a blue line is drawn between the two elements Add a button to this dashboard as follows a Click the add button icon MEEI b For Normal Display type Find c Click OK You might need to resize the dialog box in order to see this button The button is added in the upper left corner of the dashboard d Drag and drop the button to the desired location Create a refresh li
31. Grouping Grouping Images and Picture Buttons Default Value Set Value 3D Ignore these options Appearance and Border 7 7 Adding a Picture Box A picture box displays an image which is tiled repeatedly to fill the area of the picture box To add a picture box to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Click the add picture box button a DeepSee displays a dialog box in which you specify the details 3 Do one of the following e Select a DeepSee image file To do so either type the image ID into Image List or click the button next to that field and then select an image e Select an external image file To do so click Browse navigate to the file and click OK This action loads the file into the database and uses it as this dashboard element The dialog box displays a preview of the image 4 Optionally select Auto Resize If you do so the image object is resized to fit the image as soon as you click OK 5 Click OK You might need to resize the dialog box in order to see this button Using the DeepSee Dashboard Designer 69 Adding Text and Graphics The picture box is added in the upper left corner of the dashboard Note Ignore the Default Value DashboardID 3D Appearance and Border options 7 8 Adding a Button To add a button to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard
32. InterSystems J Using the DeepSee Dashboard Designer Version 2009 1 30 June 2009 InterSystems Corporation 1 Memorial Drive Cambridge MA 02142 www intersystems com Using the DeepSee Dashboard Designer Cach Version 2009 1 30 June 2009 Copyright 2009 InterSystems Corporation All rights reserved This book was assembled and formatted in Adobe Page Description Format PDF using tools and information from the following sources Sun Microsystems RenderX Inc Adobe Systems and the World Wide Web Consortium at www wsc org The primary document development tools were special purpose XML processing applications built by InterSystems using Cach and Java InterSystems gt nterSystems CACHE ENSEMBLE Cach WEBLINK Distributed Cache Protocol M SQL M NET and M PACT are registered trademarks of InterSystems Corporation InterSystems InterSystems InterSystems INTERSYSTEMS HEALTHSHARE DEEPSEE RAKCARE InterSystems Jalapefo Technology Enterprise Cache Protocol ECP and InterSystems Zen are trademarks of InterSystems Corporation All other brand or product names used herein are trademarks or registered trademarks of their respective companies or organizations This document contains trade secret and confidential information which is the property of InterSystems Corporation One Memorial Drive Cambridge MA 02142 or its affiliates and is furnished for the sole purpose of the operation and maintenance of the product
33. See Using a Control to Filter a Dashboard Element later in this chapter Note Ignore the Custom and Post Loading Scripts options 5 9 Specifying Default Values For data controls you can specify a default value as noted in the earlier sections of this chapter You do this when you add or edit the data control in the dashboard Click the browse button next to Default Value Then you can specify Default Value Type and the corresponding details Quick Script is the default type If you use this enter a Cach ObjectScript expression into Cach Scripts Typically you type a string or a number For example Federal Shipping Data Object refers to the value of a source field in the database For information on using this type see the chapter Displaying Listing Fields and Other Source Data later in this book Listing fields refers to the value of a detail listing field See the chapter Displaying Listing Fields and Other Source Data later in this book Using the DeepSee Dashboard Designer 55 Adding Data Controls Do not use the type Cach Script Object 5 10 Using a Control to Filter Another Dashboard Element You can use any of the controls to filter any number of data elements or other controls in the same dashboard Note that filters do not affect frames except for frames that are loaded as detail lists see the chapter Displaying Listing Fields and Other Source Data To use a cont
34. ables Then it substitutes the definition of the query variable and evaluates it 13 2 Defining Query Variables To define a query variable 1 First e Ifyou are currently viewing a DeepSee module click Controls gt Query Variable e Ifyou are currently viewing a dashboard right click and then click Go To gt Controls gt Query Variable 2 For Query Variable Type click Query Variable DeepSee displays all the existing query variables 3 Right click in the Query Variable tab and click Add Line Using the DeepSee Dashboard Designer 103 Using Query Variables 4 In the new empty line type the name of the query variable into Variable Name 5 Optionally type a comment or description into Description 6 Type a valid Cach ObjectScript expression into Value Formula 7 Click Save 13 3 Referring to a Query Variable In a filter expression use the following syntax to refer to a DeepSee query variable DimensionName query_variable_name 104 Using the DeepSee Dashboard Designer 14 Adding Dashboards to Your Applications This chapter discusses the basics of adding dashboards to your applications 14 1 Adding Dashboards to Your Applications To add DeepSee dashboards to your applications do the following l Create a DeepSee user with suitable permissions To do this you would typically a Create a DeepSee role that has permission to display dashboards and detail listings and no other back
35. ake sure that Encrypted is selected this check box is selected by default 4 Click OK You might need to resize the dialog box in order to see this button 3 3 3 Restricting a Dashboard by Roles or Users You can specify the roles as well as the users that are permitted to use a dashboard To do so 1 Open the dashboard in edit mode as described in the previous section i A Click the dashboard properties icon U 3 Click the more button in the Security section DeepSee displays a dialog box like the following Using the DeepSee Dashboard Designer 23 Creating Dashboards demo Line Manager Shift Supervisor The lists on the right show all the DeepSee roles and the DeepSee users To restrict this dashboard to specific roles double click those roles in the right hand roles list The roles are then copied to the Selected Roles list To restrict this dashboard to specific users double click those users in the right hand users list The users are then copied to the Selected Users list Click OK You might need to resize the dialog box in order to see this button 3 4 Copying a Dashboard To copy a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this chapter ia Click the duplicate dashboard icon L DeepSee displays a dialog box that prompts you for information about the copy 3 For New Board Name type the name of this new dashboard
36. ard you created in the previous section This step is not technically required because you could instead use images buttons or picture buttons to control which dashboard the frame displays See the chapter Adding Frames earlier in this book e Load as detail listing Select this option 86 Using the DeepSee Dashboard Designer Manually Creating Dashboards to Display Source Data e Number of rows The secondary dashboard is shown repeatedly as rows within the frame Specify the number of rows to show at a time the primary dashboard includes buttons to page through all the rows e Row height Specify the height for each row e Subject Area Click the browse button and then click a subject area This selection controls your choices for the detail listing e Detail Listing Click the browse button and then click the detail listing for this frame to use e Filter Optionally specify a filter to control which source data this frame accesses To do so specify a filter expression for example Ship Country Australia See the appendix Filter Expressions If you do not specify a filter the frame accesses all records in the subject area 4 Optionally add controls to act as additional filters for the frame See Using a Control to Filter Another Dashboard Element earlier in this book 5 Add labels as needed 6 Save the dashboard The result might be something like the followi
37. arlier in this book 2 Click the add pivot table button BL DeepSee displays a dialog box in which you specify the details 3 In the List Of Pivot section expand folders as needed and click the pivot table that you want to add 4 Optionally specify the following properties e Normal Display Specifies a new title for the pivot table By default the pivot table uses the title specified in the Analyzer e Display Controls how this pivot table is initially displayed By default the pivot table is initially displayed in tabular format To use graph format initially click the Chart option The user can change the display format e Auto load If this option is selected the pivot table automatically retrieves and displays the data You would clear this option only if you added another element to the dashboard to act as a refresh trigger for the pivot table e Filter Specifies an additional filter to apply to the data shown in the pivot table Type a filter expression For example Ship Country Australia See the appendix Filter Expressions 5 Click OK You might need to resize the dialog box in order to see this button The pivot table is added in the upper left corner of the dashboard 34 Using the DeepSee Dashboard Designer Adding a Speedometer 4 3 Adding a Speedometer A speedometer displays a KPI Note that you can also display a KPI by using a label element and the VAR function See Adding a Label late
38. ase the timer is displayed as follows Using the DeepSee Dashboard Designer 59 Adding Refresh Timers 10 11 Tip Refresh Interval for Pivot Table Next Trigger In 95T When the remaining time is five seconds or less the timer displays the remaining time in red font Click OK You might need to resize the dialog box in order to see this button The timer is added in the upper left corner of the dashboard Drag and drop the timer to the desired location Resize the timer as needed Right click the timer and then click Set as Refresh Trigger Specify a data element as the refresh target To do so right click the data element and then click Set as Refresh Target When you do so a gray line is drawn between the timer and the data element To delete links to an object right click it and then click Delete all links to object 6 2 Adding a Timer Control A timer control is a button with which the user can start and stop a timer Note that a timer control can affect multiple timers as you choose To add a timer control to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Click the add timer control button E DeepSee displays a dialog box in which you specify the details 3 Optionally do some or all of the following e Edit the value in Start Timer Caption which is the caption of the button to start the timer The default is Start Timer e E
39. at dashboard To edit another dashboard or to create a new one you must first exit the editor by clicking the X in the upper right 3 3 Enabling Security Options for a Dashboard This section discusses how to enable the security options for a dashboard 3 3 1 Adding a Password You can require the user to enter a password in order to display a given dashboard When the user tries to open the dashboard DeepSee displays a dialog box like the following Please type the password for this dashboard If the user does not enter the correct password DeepSee displays the Dashboard List dialog box to prompt the user to open a different dashboard To add a password to a given dashboard 1 Open the dashboard in edit mode as described in the previous section i A Click the dashboard properties icon LIL4 3 To require a password specify both of the following properties e Prompt text specifies prompt text to display when a user first accesses of this dashboard 22 Using the DeepSee Dashboard Designer Enabling Security Options for a Dashboard e Password specifies the password needed to display this dashboard 4 Click OK You might need to resize the dialog box in order to see this button 3 3 2 Encrypting a Dashboard You can encrypt a dashboard To do so 1 Open the dashboard in edit mode as described in the previous section i A Click the dashboard properties icon U 3 To encrypt the dashboard m
40. ata Controls ssccccccsstesseviscessssvaccssesssesscedscssecssoussesssessonvossesendansecssvacsdeenctecevasesbensseensedsousoes 43 JL Overview Or Data CONtrolS siniori secu neii a E EER EE REEE 43 52 Addins a Data Contoh anieri e e E E VR E EE 44 I Usine Combo BORGE ers eaei oreina teno oe e En EEEIEE EE EPE EEEE EE E EE EE 45 5 3 1 Creating a List of Dimension MembeTS ossessi eeii isisisi siess 46 Ioa Create a List Manually scocciu n ER REEE EOR EEE REE 47 SA Using List BOXES scce ie sens erore eenen Ee a EEE E RE A E E EERE E aE Se TETEE EE EEEE EEE 49 39 Using TORI BORGS oreco aeree ena aeina EAT EEE ETa E E E EE EA E 49 5 6 Using Date Pickers cscssiciecieciiicconreer scere i e i i er E a E E ERE PEE e E EERE E Ee EEEa 51 5 7 Usine Check BOXES srece oerien riar re reae eE EEEE E TNE E ETSE 52 5 8 Ubing Search BOXES scisscccsesccsucsioasvenes aschesasseascheaiedvesswsetepaanvabaatapieeracntenesa shoe EEEE EEE E ESE EES E 54 39 Speciiyine Default Valts srineconriosroesre nirien eT E o a SEET EEEN EEEE EEE SA 55 5 10 Using a Control to Filter Another Dashboard Element sscsosscsssseesoseseeesseveess 56 511 Using a Control to Set a Variable x5 sss ievstcscelicsaegsceusssid sacnsiveasctace aias eip ien eia 56 5 11 1 Example 1 Controlling the Ranking of a Pivot Table ote eeseeeeeecneeeeeeenecneee 57 5 112 Example 2 Controlling a Label srini iene a ESG S 58 6 Adding Refresh Timer ccsccsscsssssssscscccsscssccssssscs
41. ations or who simply want to explore their data e Using the DeepSee Architect a guide for implementers who are setting up a DeepSee model e Using the DeepSee Connector a guide for implementers who are using the DeepSee Connector to access externally stored data Note The DeepSee Connector is available only with Ensemble Using the DeepSee Dashboard Designer 1 About This Book e DeepSee Site Configuration and Maintenance Guide a guide for implementers and system administrators This book describes how to configure and maintain a DeepSee site It also includes a chapter on troubleshooting e DeepSee User Guide a user manual for your end users This book describes how to work with deployed dashboards and pivot tables For general information see the nterSystems Documentation Guide 2 Using the DeepSee Dashboard Designer Introduction to the Dashboard Designer This chapter introduces the DeepSee Dashboard Designer which you use to create dashboards that you can embed in your applications This chapter discusses the following topics Purpose of the Dashboard Designer Required preparation before you can use the Dashboard Designer Summary of dashboard options How to log into DeepSee How to access the Dashboard Designer from anywhere within DeepSee How to switch to another namespace How to exit the Dashboard Designer Be sure to consult InterSystems Supported Platforms for information on system requirements
42. boards to Display Source Data 9 2 Using the Detail Listing Dashboard Wizard The Detail Listing Dashboard wizard helps you quickly create a dashboard that displays detail listing fields The wizard creates two dashboards one of which is used within the other one The primary dashboard with the secondary dashboard embedded looks like the example shown in the previous section To use the Detail Listing Dashboard wizard and create a dashboard like this 1 Display any dashboard in view mode 2 Right click and then click New Dashboard gt By Wizard DeepSee displays a dialog box where you choose the kind of dashboard to create 3 Click Detail Listing Dashboard DeepSee then displays the first page of the wizard 4 On the first page of the wizard specify the following details e For Board Name type the name of the primary dashboard 82 Using the DeepSee Dashboard Designer Using the Detail Listing Dashboard Wizard 10 11 The name of the secondary dashboard will be the same as the primary one with Detail added to the end e For Dashboard Title type the title to display on the primary dashboard This title is added as a label element e For Folder click the browse button and select a folder to contain the two dashboards e For Remarks type an optional description or comments for internal use e For Subject Area click the browse button and then click a subject area This selection controls your ch
43. ce type the name of the namespace you want to work in and then click Logon to DeepSee The system then displays the DeepSee login page Using the DeepSee Dashboard Designer 7 Introduction to the Dashboard Designer 4 On the DeepSee login page enter a DeepSee username and password For example you can use the username demo with the password demo 5 For Role select demo 6 Click Login DeepSee displays the home page which depends upon the user ID you used to log in In general the home page is either a DeepSee module or a dashboard If the page is a DeepSee module it has a row of buttons at the top as follows a eee Data Modeler Administrator If the page is a dashboard the right click menu provides access to all the same options provided by these buttons in addition to options that apply to dashboards Edit Dashboard New Dashboard Open Dashboard Recent Dashboard Save Parameter Reload Save Parameter Dashboard Management a Go To Home Refresh Main Log Out Data Modeler Controls Administrator 1 5 Accessing the Dashboard Designer In general you can access the Dashboard Designer either via an existing dashboard or by creating a new dashboard This section describes the following e How to display a dashboard from anywhere within DeepSee e How to edit the dashboard you are viewing e How to exit the Dashboard Designer For information on creating new dashboards see the
44. ck Add 7 3 Adding a Background Image to a Dashboard To add a background image to a dashboard 1 2 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book Click the dashboard properties button E DeepSee displays a dialog box in which you specify the details Do one of the following Using the DeepSee Dashboard Designer 65 Adding Text and Graphics e Select a DeepSee image file To do so either type the image ID into Image List or click the button next to that field and then select an image This action inserts a pointer on this dashboard to that stored image e Select an external image file To do so click Browse navigate to the file and click OK This action loads the file into the database and uses it on this dashboard 4 Optionally choose a value for Picture Position one of the following Left Top the default e Left Center e Left Bottom e Center Top e Center Center e Center Bottom e Right Top e Right Center e Right Bottom e Tile Ignore the Stretch and Zoom options 5 Click OK You might need to resize the dialog box in order to see this button The image is displayed in the specified position Note that unlike the other objects in the dashboard you cannot manipulate this one directly To move the image you must edit the dashboard properties To resize the image you must edit the image file itself 7 4 Removing a Background Image from a
45. convention For example the name of a given secondary dashboard could be the same as the primary dashboard with Detail appended to it This is the convention followed by the DeepSee dashboard wizard discussed earlier in this chapter 2 For the new dashboard specify the detail listing for this dashboard to use e For Subject Area click the browse button and then click a subject area This selection controls your choices for the detail listing e For Detail Listing click the browse button and then click the detail listing 3 Add an object that displays the value of a listing field You use a label or any of the data controls a Click the button for the type of object you want to add See Overview of Controls Or use a label object fe td DeepSee then displays a dialog box on which you configure this object b Click Default Value or Default depending on which object you are adding DeepSee displays a dialog box c Now do one of the following e To display a listing field click Listing fields The dialog box displays a drop down list of all the listing fields in the detail listing that this dashboard uses Default Value Type Quick Script Cache Script Object Data Object Listing fields Select one of the listing field to be loaded into this control ID OrderID Customer Shipper Choose a listing field and then click OK e To display some other source field click Data Object Th
46. cribed in Editing a Dashboard earlier in this book 2 en Click the add Venn diagram button DeepSee displays a dialog box in which you specify the details 3 In List of Venn Diagrams navigate to and click the desired Venn diagram 92 Using the DeepSee Dashboard Designer Adding a Venn Diagram to a Dashboard 4 Optionally specify the following additional details e Normal Display Specify a caption to use when the Venn diagram is shown in table format The default is to use the name contained in the definition of the Venn diagram see previous section e Display Click Table or Diagram to specify the initial appearance of this Venn diagram on this dashboard e Color Schema Click the browse button and either select an existing chart theme or create and select a new one For information see the section Defining and Using Chart Themes in Using the DeepSee Analyzer The default is to use the color scheme contained in the definition of the Venn diagram see previous section 5 Click OK You might need to resize the dialog box in order to see this button The Venn diagram is added in the upper left corner of the dashboard Using the DeepSee Dashboard Designer 93 11 Configuring Post Actions You can configure a dashboard element so that when a user clicks the element DeepSee performs one or more post actions which generally display additional windows of data This chapter describes the types
47. ct Disable for all options NET Framework reliant components Select Disable for all options ActiveX controls and plug ins Select Enable for the following options Allow Scriptlets Binary and script behaviors Run ActiveX controls and plug ins Select Disable for the others Downloads Select Disable for all options Enable NET Framework Setup Select Disable Microsoft VM Select Disable for all options Miscellaneous Select Enable for the following options Allow script initiated windows without size or position constraints Use Phishing Filter Use Pop up Blocker Select Prompt for the following options Display mixed content Drag and drop or copy and paste files Launching programs and files in an IFRAME Submit non encrypted form data Select High safety for Software channel permissions Select Disable for the others Scripting Select Enable for the following options Active scripting Using the DeepSee Dashboard Designer 107 Adding Dashboards to Your Applications Scripting of Java applets Select Disable for the others e User Authentication gt Logon Select Prompt for user name and password Your settings might need to be different depending on your environment 108 Using the DeepSee Dashboard Designer Expressions and Scripts in the Dashboard Designer The Dashboard Designer uses expressions and scripts of varying types This appendix summar
48. d drop and resize it by dragging its handles In addition you can display and edit the size and placement as follows Using the DeepSee Dashboard Designer 29 Creating Dashboards 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this chapter 2 Click the show object properties icon E DeepSee then displays a child window as follows Object Properties Position Hort 215 ro a4 Size Width 100 Height 30 3 Move this window to a convenient location where it does not cover any elements 4 Click an element on the dashboard The Object Properties window then displays details for that element Here e X Indicates the position of the top edge of this element e Y Indicates the position of the left edge of this element e Width Indicates the width of this element e Height Indicates the height of this element 5 Optionally edit a value and then move the cursor to another field in the Object Properties window When you do so the change is applied immediately When you no longer need the Object Properties window click the hide object properties icon el You can also select multiple elements so that you can move them To select them left click and hold while dragging the selected elements are highlighted in orange Then left click and drag the elements to a new location 3 10 4 Moving Elements Backward and Forward If you arrange dashboard ele
49. diagram if any Click Clear to ensure that the right area is cleared Specify the following basic details for the new Venn diagram e Name Specify a name e Schema Click a subject area from this drop down list e Folder Click the browse button and select a folder to contain the Venn diagram e Color Schema Click this and either select an existing chart theme or create and select a new one For information see the section Defining and Using Chart Themes in Using the DeepSee Analyzer Using the DeepSee Dashboard Designer 91 Adding Venn Diagrams 4 6 In the table below the basic details specify the name and definition of each of the three main groups in this Venn diagram In each row specify the following e Query Caption Specify a name for this group e Query Specify a filter expression that defines this group For example Ship Country Australia See the appendix Filter Expressions Optionally View to preview this Venn diagram If you do the preview is shown in the bottom area of the page For example Denmark Federal Shipping Denmark 18 Federal Shipping 255 Denmark AND Federal Shipping z 2005 143 Denmark AND 2005 z Federal Shipping AND 2005 51 Denmark AND Federal Shipping AND 2005 2 2005 Click Add to add this Venn diagram 10 3 Adding a Venn Diagram to a Dashboard To add a Venn diagram to a dashboard 1 Open the dashboard in edit mode as des
50. dimension e For Store In Variable type a variable name such as MyVar 4 Connect the combo box and the pivot table Use the combo box as the refresh trigger and filter and use the pivot table as the refresh target and filtered object See the previous section in this chapter 5 Add a label to the dashboard For this label e Specify Normal Display as SVAR MyVar e Specify Default as All Countries 6 Connect the combo box and the label Use the combo box as the refresh trigger and use the label as the refresh target See the previous section in this chapter 58 Using the DeepSee Dashboard Designer Adding Refresh Timers You can add timers to a dashboard typically you do this to refresh reload data at periodic intervals You can include timer controls which allow the users to stop and start the timers This chapter discusses the following e How to add a timer to a dashboard e How to add a timer control to a dashboard 6 1 Adding a Timer To add a timer to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book D Click the add timer button oN DeepSee displays a dialog box in which you specify the details 3 Optionally type a name into Name 4 Optionally type a description into Description This is not visible in the dashboard itself 5 For Interval type the refresh interval in seconds 6 If you want to display this timer click Display Timer Information In this c
51. dit the value in Stop Timer Caption which is the caption of the button to stop the timer The default is Stop Timer 60 Using the DeepSee Dashboard Designer Adding a Timer Control e Click Font and then select a different font for the start stop button e Click Fore Color and then select a different color of font for the start stop button e Click Back Color and then select a different background color for the start stop button 4 Click OK You might need to resize the dialog box in order to see this button The timer control is added in the upper left corner of the dashboard Drag and drop the timer control to the desired location Resize the timer control as needed Right click the timer control and then click Set as Timer Control ann ww Right click a timer and then click Apply Timer Control When you do so a gray line is drawn between the timer control and the timer The following shows an example of a timer and a timer control Start Timer Sample Timer Next Trigger In 0 06 Tip To delete links to an object right click it and then click Delete all links to object Using the DeepSee Dashboard Designer 61 Adding Text and Graphics This chapter describes how to add text and graphics to a dashboard It discusses the following topics An overview of text and graphic elements How to load images into the DeepSee library for use in dashboards How to add a background image to a dashboard How to remove a backgr
52. e Dashboard Elements o cccscscecsscescesscvssgsutesstesecvastaneuses sacesseeecssteesavee 25 36 Editing an Blemenl i ccseccesiel ciccceves cians EE RE Woranenedennetin EEO SEE 27 Deh Copying an SMV IL ierra niao eoni coed E ca AE R ERO ERLE ERS Ea ER RE 27 3 8 Deleting an Element 3 15 55 ccsssces sii ccssceesdessestiehesavedasasdeauecabeadaecctuacsssaasoisesasbensdeeseubebaverssnsoiaiedige 27 3 9 Deleting a Dashboard scccrectenirerrieen neno onal Eneee EE OEE EE REE ESE 28 3 10 Adjusting Positions and Sizes of Elements ssicicissriesiiersrssrsrossieiers restesse ensien 28 J10 1 Di splayina he G soosse hesr ee T R E EEN EE EE A E E 28 310 2 Adjusting All Elements ssec csr iiare na eeni a sn E a rara EEE iai 29 Using the DeepSee Dashboard Designer iii 3103 Adjusting Orne Plemenit 2st acest keen ni eee a Aiea 29 3 10 4 Moving Elements Backward and Forward s ssscsssessessssssessrsensenevsnssserses 30 4 Adding Data Elements scsssscssssssccsssscscsscesecesscsssesscssscsscesscessssssscsssessesscessossscsseesscesessnceees 33 A1 Oyerview of Data Blames sessioissa nuoriso aeiae n aeei Aaa 33 AD Addme a Pivot Table vrsio enea R A EEE E E EAEE EE EE 34 4 3 Adding a Speedometer 3 cic2sciscieccciticeises Gicd uackek na a E a E EE 35 44 Speedometer Display Properties srs siiioie srecen itoe e e upeina eoi oiai erei koeee araia 35 45 Addmng a Detal LISUNT iieii riseire shoes ea E EEEE EE E a EE Ea aA 40 5 Adding D
53. elect the color of the text e Back Color Click this and then select the color of the background of the label Or select Back Style Transparent to make this background transparent e Default Click this and then type a default value This is useful when you use a function call within Normal Display e Alignment Click an option in the drop down list to specify how the text is aligned within the label e Scrollbar Select this to add a vertical scroll bar to the right side of the label Using the DeepSee Dashboard Designer 67 Adding Text and Graphics 3 Click OK You might need to resize the dialog box in order to see this button The label is added in the upper left corner of the dashboard Other options are discussed later in this book as follows Default Displaying Listing Fields and Other Source Data KPI Override Setting and KPI Filter Using KPI Display Rules to Override Text or Graphics 3D Appearance Border Store In Ignore these options Variable and DashboardID 7 6 Adding an Image To add an image to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Click the add image button Ei DeepSee displays a dialog box in which you specify the details 3 Do one of the following e Select a DeepSee image file To do so either type the image ID into Image List or click the button next to that field and the
54. element that can be used this way that element can participate in multiple links It is quite common for example for a given drop down list to control multiple data elements 1 3 3 Programmatic Connections Among Elements In some cases you can use one element to set the value of a system variable or a custom variable that affects another element which you connect as a refresh target For example a user might select a number from a list and that could control the number of top ranked members displayed in a pivot table For another example the default value of a label could use the VAR function to display your custom variable The value of this variable could be set by another element which refreshes the label 1 3 4 Post Actions You can configure a dashboard element so that when a user clicks the element DeepSee performs one or more post actions after any filter and refresh actions A post action does one of the following e Displays a dashboard possibly in a new window e Displays a Web page in another browser window e Displays a small child window that displays the value of a KPI 1 4 Logging Into DeepSee To log into DeepSee 1 Click the InterSystems Launcher When you do so the system displays a menu 2 Click DeepSee If you have not yet specified a namespace the system displays a page that prompts you for a namespace Otherwise the system displays the DeepSee login page 3 If you are prompted for a namespa
55. ements To add a picture button to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Click the add picture button icon amp DeepSee displays a dialog box in which you specify the details 3 Type the caption of the button into Caption 4 Specify the main image used on the picture button To do so click the Normal Display tab and then do one of the following e Select a DeepSee image file To do so either type the image ID into Image List or click the button next to that field and then select an image e Select an external image file To do so click Browse navigate to the file and click OK This action loads the file into the database and uses it as this dashboard element The Normal Display tab displays a preview of the image 5 Optionally specify the following e Upon Clicked Specifies the image to display when the user clicks the picture button Click the tab and choose a image as described previously The tab shows a preview of the image If you use this option make sure that the image has the same dimensions as the main image e Mouse Over Specifies the image to display when the user hovers the cursor over the picture button Click the tab and choose a image as described previously The tab shows a preview of the image If you use this option make sure that the image has the same dimensions as the main image e Font Specifies the typeface fo
56. en click the browse button The dialog box displays the hierarchy of source data fields in this subject area Navigate to and click the desired field and then click OK d Click OK to close the dialog box for the object Using the DeepSee Dashboard Designer 85 Displaying Listing Fields and Other Source Data e Reposition the new object and resize it f If needed add a suitable label object and place it appropriately nearby 4 Repeat the preceding step as needed Tip Because this dashboard is displayed repeatedly as rows in a frame it is a good idea to arrange the dashboard elements in short wide rectangle 5 Save the dashboard The result might be something like the following which uses text boxes to display the source data 1 2 3 4 5 6 fi oen od OOOO Or the following which uses labels to display the source data 9 3 2 Creating the Primary Dashboard The primary dashboard contains a frame that displays the secondary dashboard It can and usually does also contain controls that filter the contents of the secondary dashboard To create the primary dashboard 1 Create a new blank dashboard as described in Editing a Dashboard earlier in this book l Add a frame S to the dashboard as described in Adding a Frame earlier in this book 3 When you add the frame specify the following details e Default Dashboard Optionally choose a dashboard such as the secondary dashbo
57. ent 3 6 Editing an Element 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this chapter 2 Now either e Double click the element e Right click the element and then click Edit The system displays a dialog box in which you specify properties for the new element The details depend upon the element and how you plan to use it 3 Click OK You might need to resize the dialog box in order to see this button 3 7 Copying an Element 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this chapter 2 Right click the element and then click Duplicate 3 The system immediately copies the element and places the copy directly in front of its original 4 Drag and drop the copied element to the desired location If the original element is a refresh target or as a filtered object those links are copied If the original element is a refresh trigger or as a filter those links are not copied If the original element includes post actions those are copied You can also copy elements to the dashboard library and reuse them on other dashboards see the chapter Using the Dashboard Library 3 8 Deleting an Element 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this chapter 2 Now either e Click the element and then press Delete e Right click the element and then click Delete Using the DeepSee Dashboard De
58. epSee Dashboard Designer Speedometer Display Properties If the KPI used in the speedometer has a set of ranges with display rules those rules override the color you choose for the scale For example a se e Label Color Specifies the color of the numbers of the scale itself not the numbers in the meter The default is black e Arrow Color and Arrow Circle Color Control the color of the arrow and the circle shown at its center respectively By default the arrow is red and the circle is purple The following shows a variation with green and white lella L IoNSI4 L SIZ Scale Type Controls the placement of the scale Select Inner Scale the default or Outer Scale The following shows examples of each with the default version on the left B4LISE4L 57 BAWSE4N82 If you use Outer Scale the speedometer does not have an inner area and the color specified by Inner Layout is ignored e Lighting Effect If you select this option the speedometer looks as if a light is shining on it as follows Using the DeepSee Dashboard Designer 39 Adding Data Elements Font Click this to specify the typeface font style and font size of the caption which is shown above the speedometer For example Caption J BELEBKLErN J i ii Ignore the other options which have no effect 4 5 Adding a Detail Listing To add a detail listing to a dashboard 1 Open the dashboard in edit mode
59. es of Elements Ea The grid is currently hidden Click this icon to display the grid H The grid is currently shown Click this icon to hide the grid 3 10 2 Adjusting All Elements The dashboard management tool lets you easily adjust the position and size of every element on a dashboard This is particularly useful when you want to make sure elements are lined up precisely with each other To use this tool 1 2 Open the dashboard in view mode Right click and then click Dashboard Management DeepSee then displays a dialog box with a table of all the elements on this dashboard showing their names and their types For any element edit any of the following options e Top The position of the top edge of this element e Left The position of the left edge of this element e Width The width of this element e Height The height of this element e Auto Resize A check box that is enabled for graphic elements Ignore the Security Enable option Optionally to delete an element click the table row corresponding to that element and then click Delete Line DeepSee prompts you for confirmation Click Save and then click OK DeepSee then saves your changes and refreshes the dashboard so that you can check your work When you are done click the close button X in the upper right 3 10 3 Adjusting One Element When you are creating or modifying a dashboard you can move an element by drag an
60. esses 75 8 1 Overview of Frames Frame Controls and Drop down Menus eeeesseesseceeeeeeeeeeeeeee 75 3 2 Adding a Frae escenes UovsetstsazasstesasavRcasdsasanbeasnsdedusbanuecsgsespsetapootena e E EREA E EREE EE 76 8 3 Configuring an Image Button or Picture Button to Control a Frame 0 0 0 eee eterno 77 4 Adding a Drop down Menu to Control a Framie sccsc scsesscsessessctevenssests senate ss ctonanencobiasnssass 77 6 3 Displaying a Web Pape ina Fiame 2 332165 iene lock cadeas ts ee En TEE E SEEE E 79 9 Displaying Listing Fields and Other Source Data sesesesosoeseoseososssosoesesososousesosososoesosesesoeossesesoe 81 9 1 Overview of Displaying Source Data on Dashboards ssesssssessessessesresseesseressrsssereesrerrereess 81 9 2 Using the Detail Listing Dashboard Wizard 0 cicccdcamaaniiii can aoisecuereeveniineees 82 9 3 Manually Creating Dashboards to Display Source Data 0 eee cseeseteeceeeneeeseeeneees 84 9 3 1 Creating the Secondary Dashboard oscccsicicsccssncveckivsascis scevecssonstonioas anconauersancvndecnsaseaaes 84 9 3 2 Creating the Primary Dashboard 2 3 0 s sessessestansessvecseastesuscaarsgaiesoaacteaiissintennsoeene 86 10 Adding Venn Diagrams cccccesccscsscosarsacesssessiscosssenscncectaceascossoascsscnssenseseactasntsoedsensessdeassenssonsensees 89 10 1 Overview of Venn Diagramb cerceii onee a a EE E R EE S 89 10 2 Defining Yenn Dia prams oenciseieitosreria iniaeeaa aes eke EEE RE
61. eview is shown in the right pane 4 Click OK You might need to resize the dialog box in order to see this button The object is added in the upper left corner of the dashboard 12 3 Deleting Objects from the Dashboard Library Frame 15 Frame 15 Button 10 Combo box 8 Unmapped Type 25 Label 5 Picture box 7 Click the add library object button amp sample 7 Sample 5 Sample 5 Sample 5 Venn test sample 3 sample 3 To delete an object from the dashboard library 1 Open any dashboard in edit mode as described in Editing a Dashboard earlier in this book 100 Using the DeepSee Dashboard Designer Deleting Objects from the Dashboard Library Click the add library object button amp DeepSee displays a dialog box that lists all the objects in the dashboard library 3 Click the Select option in the row for each object you want to delete 4 Click Delete 5 Click OK You might need to resize the dialog box in order to see this button Using the DeepSee Dashboard Designer 101 13 Using Query Variables This chapter discusses DeepSee query variables 13 1 Introduction to Query Variables In DeepSee you can define and later reuse query variables A query variable can be defined as any valid Cach ObjectScript expression You use query variables within DeepSee filter expressions At run time when DeepSee examines the filter expression it checks for any query vari
62. g box specify the following basic information e For Board Name type the name of this dashboard For Folder click the browse button and select a folder to contain this dashboard Using the DeepSee Dashboard Designer 11 Tutorial 4 Click OK You might need to resize the dialog box in order to see this button DeepSee then displays the dashboard in edit mode 5 Add a pivot table to this dashboard as follows 4 Click the add pivot table bution MLD b In the List Of Pivot section expand folders as needed and click the pivot table that you want to add c Click OK You might need to resize the dialog box in order to see this button The pivot table is added in the upper left corner of the dashboard d Drag and drop the pivot table to the desired location e Resize the pivot table as needed 6 Add a combo box to this dashboard as follows a Click the add combo box button EE b For Subject Area click the browse button click a subject area and click OK The dimensions in the subject area are then displayed within Dimensions c For Dimensions double click a dimension When you do so the system puts your subject area and dimension name into Schema and Dimension on the right as follows Subject Area Orders Dimension Staff d Click OK You might need to resize the dialog box in order to see this button The combo box is added in the upper left corner of the dashboard e Drag and drop t
63. g the Current IASG are scissione nre eneen n eaei aaa Sra E E aaa 9 1 6 Switching to Another Namespace sc 0 52cc2s ksieciecs teninin isnie e oia ikasa 10 Le Boating the Dashboard Designet crror aao E 10 2 Tutorial scssssssssscessscessssessssssecessesssnesssnesssvessesessscassssessscasossessasesasssnesssessssessesassesessesesosoesossess 11 21 Tunal Pa lone aae ded is cosckiesoceidan cabins custs avons diy veshaceasdvsscunestivsctouressivatsauessasnessvoniaweals 11 D2 WUMOT A PAG Des E T E E 14 2 3 Nutone Part 3 ea ent e esis E EEEE RE EE ESEE E EE EE EEEE womans 16 3 Creating Dashboards sccsccssscsccsscscscssccssscsssesccsscssscscssscsscsssessesssessccsscssocsscesesenecsscssecsssenes 19 3 1 Creating a New Dashboard 5 05 csiesesccscsseasbccens duces tiaus ouccvaes sued case eaa E O e EERE EE ORE 19 3 2 Edine a Dash boatel eee eE REEE EEEE E EE EE O anew 21 3 3 Enabling Security Options for a Dashboard 0 scissseaessascessacsnabsseasesussessevnsenseanesbanscss 22 Di Sel AGG oA PassWord seii tarok e e nas EE EEEE NEER E EE EE ES 22 33 2 Eneryptng a Dashboard sissies sxcisccsnseseisosisacpansuaseneuitbassubeatavsseunesceivendsoevexs ean cepvetsaass 23 3 3 3 Restricting a Dashboard by Roles or UsSefSonisaaiormoneeni etiese 23 J4 Copying a Dashboard es oc cascade ods reen einiino ga ee painea s e e E R ae a Ra Raa ea SR a EEPE 24 SS Adding an EREN esi ii ea e e EEE eea oE VEE EOE EEEE s 25 3 5 Overview of th
64. ground Color o 500 W o0FFo00 Arial Black 500 1000 SFFFF66 Arial Black 1000 Ml cco000 Arial Black Each range of values can also have an associated image not shown in this example For labels you can use KPI display rules to override the text display options that the label uses Simi larly for images you can use KPI display rules to override the image that is used In either case you select a KPI When the dashboard is shown the system evaluates the KPI determines which display tule to use and overrides the default label or image as appropriate To apply KPI display rules to a label or image 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Double click the label or image in the dashboard 3 For KPI Override Setting click the browse button and select a KPI 4 Optionally to filter the data used to evaluate the KPI type a filter expression into KPI Filter For example Ship Country Australia See the appendix Filter Expressions 5 Click OK You might need to resize the dialog box in order to see this button Using the DeepSee Dashboard Designer 73 Adding Text and Graphics For information on defining KPIs see Using the DeepSee Analyzer 74 Using the DeepSee Dashboard Designer Adding Frames This chapter describes how to add frames to a dashboard It discusses the following topics e How to add a frame to a dashboard e How to conf
65. groups those individual shortcuts See the DeepSee Site Config uration and Maintenance Guide Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book Click the add drop down menu button DeepSee displays a dialog box in which you specify the details The Menu List area lists all the shortcuts that are groups of other shortcuts In Menu List click the shortcut to associate with this drop down menu Optionally specify the following e Normal Display Specifies the appearance of the drop down menu in normal mode To specify the font typeface font size font style and font color click Font and then specify the details To choose an image click the browse button next to Image List and then click an image Or click Browse and then click an image file e On mouse over Specifies the appearance of the drop down menu when the user hovers the cursor over it By default the drop down menu appears the same as in normal mode To customize its appearance when the user hovers the cursor over it click the On mouse over tab and then specify the details as described in the previous bullet Click OK You might need to resize the dialog box in order to see this button Right click the drop down menu and select Set as Refresh Trigger Right click the frame and select Set as Refresh Target When you do so a gray line is drawn between the frame and the drop down menu 10 Optionally save
66. he background of the speedometer the area outside of the speedometer itself This area is white by default The following example shows non default colors for the outer region inner region and background First the settings used are as follows Outer Layout left Color CO Inner Layout Color ea Background Background Color Fa The resulting speedometer is as follows Using the DeepSee Dashboard Designer 37 Adding Data Elements BALISSAL5 Background Border Color Specifies the color of the border around the rectangle that encloses the speedometer There is no border by default An example border is shown later in this section see Meter Reading Back Color e Meter Reading Number Color Specifies the color of the numbers in the meter shown in boxes in the examples The default is white e Meter Reading Back Color Specifies the color of the background for the meter numbers The default is black The following example shows a speedometer with black meter numbers and white background for the meter numbers The example also shows a green border e Scale Colored If selected this option displays the scale in a color that you choose see Scale Color By default the scale is shown in the same color as the outer area of the speedometer e Scale Color Specifies the color of the scale The following examples show colored scales both inner and outer versions B4WSS4087 38 Using the De
67. he combo box to the desired location f Resize the combo box as needed 7 Create a filter link between the combo box and the pivot table as follows a Right click the combo box and then click Set as Filter b Right click the pivot table and then click Apply Filter to this object When you do so a blue line is drawn between the two elements 12 Using the DeepSee Dashboard Designer Tutorial Part 1 8 Create a refresh link between the combo box and the pivot table as follows a Right click the combo box and then click Set as Refresh Trigger b Right click the pivot table and then click Set as Refresh Target When you do so a gray line is drawn between the two elements Click the save dashboard icon El Then click OK 10 Click the close button X in the upper right DeepSee displays the new dashboard in view mode 11 Refresh the browser window Depending upon your data your data model and your pivot table DeepSee displays something like this E Level EJ of o E a i 9 i Country Federal Shipping Argentina Speedy Express United Package Federal Shipping Austria Speedy Express United Package Federal Shipping v il Pase of 2 gt gt Test the dashboard by selecting a dimension member from the combo box The pivot table should be filtered and refreshed immediately to show only data associated with that member Using the DeepSee Dashboard Designer 13 Tutorial s Count
68. igure an image button or picture button to control a frame e How to configure a drop down menu to control a frame e How to display a Web page in a frame 8 1 Overview of Frames Frame Controls and Drop down Menus A dashboard can include frames A frame is a rectangular area that typically displays another dashboard it can also display a Web page You position and resize the frame as needed In general you can use frames in any of the following ways e Asa static element that displays another dashboard resulting in a more complex visual layout e Asadynamic element controlled by an image button or picture button These objects are known as frame controls in this book When you add a frame control to a dashboard you associate it with a specific dashboard When the user clicks a given frame control the frame is refreshed to show the dashboard associated with that frame control e Asadynamic element controlled by a drop down menu Each item in the drop down menu corre sponds to a dashboard For example Using the DeepSee Dashboard Designer 75 Adding Frames Dashboard 1 Dashboard 2 Dashboard 3 Dashboard 4 When the user clicks an option in the drop down menu the frame is refreshed to show the dashboard associated with that item in the drop down list 8 2 Adding a Frame To add a frame to a dashboard 1 2 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book
69. imensions in the subject area are then displayed within Dimensions 2 For Dimensions double click a dimension When you do so the system puts your subject area and dimension name into Schema and Dimension on the right The box below Condition now displays all currently existing members of this dimension 3 Optionally do some or all of the following e Control whether the list includes the special first line 46 Using the DeepSee Dashboard Designer Using Combo Boxes By default the first line in the combo box or a list box is a blank line and this line corresponds to all members no filtering To remove this first line clear the First Line Display check box To specify a title for the first line such as A11 type a value into the unlabeled box to the right of First Line Display Note This option does not apply to search boxes e Restrict the set of members in the list To do so double click the name of each member you want to include When you do so the member is added to the unlabeled box below Sort Order If this box is empty the default all members of this dimension are included in the list unless they are filtered out due to the user s permissions To clear this box click Clear e Specify how the list items are sorted To do so click a value for Sort Order Be sure to use a sorting type that is appropriate for this dimension For example if Ship Date Year is a text valued dimension numeric sorting has no
70. is document and it reserves the right in its sole discretion and without notice to make substitutions and modifications in the products and practices described in this document For Support questions about any InterSystems products contact InterSystems Worldwide Customer Support Tel 1 617 621 0700 Fax 1 617 374 9391 Email support InterSystems com Table of Contents About This Book ccccsssssssssssesscsesessesecsesscsssscsssscsssscssssosssssssssessssnsessnsessnscsesesseneesesessesessesssnesessevess 1 1 Introduction to the Dashboard Designer sssssccsssssscsscssscsssssccsssssscsesssessecssessoessessocsseeses 3 1 1 Purpose of the DeepSee Dashboard Designer oisinn iniiis aiiniianeun 3 1 2 Reguregd Preparato 5 2055e 0 lt csese0c35sccseeasacedasscsscessceswinacssudeesepeessesede RE oee EE E AEE E EE 4 1 3 Summary of Dashboard Options sessin e i ERS 4 DB Wy atl DS Elernenis seio ninen a E E EE E RARR 4 13 2 Links Among Blements vesise iir E EEE E E e AEE EEEE E aE 6 1 3 3 Programmatic Connections Among Elements necssiiiririissirencicriiesiiie 7 134 Post ACODE ecriecciesnierri esmines resterer r RENE e D RES NERE REE T EREE IRE i E ETR Ea iE 7 14 Logging Into Deepsee is csisc sets abscesses stirpes rissen ees EAE T T ER OR EEE EEE uate 7 1 5 Accessing the Dashboard Designer c scss2ccccisspseseabascessevscoveee a atret eae EE ER E EERE eE ES EEES 8 1 3 1 Displaying a Dashboatdl sc cic lh EEEE 9 1 5 2 Editin
71. izes the cases for your convenience It discusses the following topics e Filter expressions e Function calls e Cach ObjectScript expressions e Cach ObjectScript scripts A 1 Filter Expressions A filter expression is a boolean expression that specifies which records to use A 1 1 Where Used Filter expressions are used in the following contexts in dashboards as well as many other contexts in DeepSee e In the configuration of a data element pivot table speedometer or detail listing included on a dashboard See the chapter Adding Data Elements e In the KPI Filter option of a label or image that uses the KPI override feature See the section Using KPI Display Rules to Override Text or Graphics Using the DeepSee Dashboard Designer 109 Expressions and Scripts in the Dashboard Designer e In the Filter setting of a frame that is configured to display listing fields or other source data See Manually Creating Dashboards to Display Source Data e In the definitions of the three main groups in a Venn diagram See Defining Venn Diagrams A 1 2 Syntax A filter expression has one of the following syntax DimensionName String Here e DimensionName is the name of a dimension without quotes e String is an unquoted string that typically equals the name of a member of that dimension or the start of a name Notes e The spaces before and after the equals sign are required e There
72. le enter the name of that variable into Store In Variable See Using a Control to Set a Variable later in this chapter 6 Click OK You might need to resize the dialog box in order to see this button 7 Ifyou are using the user s entry as a filter link the date picker to the element that it filters See Using a Control to Filter a Dashboard Element later in this chapter Note Ignore the Sort Order Custom and Post Loading Scripts options 5 7 Using Check Boxes A check box looks like this O 52 Using the DeepSee Dashboard Designer Using Check Boxes Each state of the check box cleared or selected corresponds to a value To configure a check box specify its properties as follows Optionally type a name into Name This name is not visible in the dashboard itself but is useful when you edit the dashboard If you are using this check box as a filter select the dimension to which the filter refers To do so a For Subject Area select a subject area and click OK The dimensions in the subject area are then displayed within Dimensions b For Dimensions double click a dimension When you do so the system puts your subject area and dimension name into Schema and Dimension on the right Specify the values associated with the selected and cleared states To do so type values into Checked and Unchecked If you are using the check box as a filter these values must be equal to the names of membe
73. ly unselected The same is true when you create multiple picture buttons To group images or picture buttons 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Do the following to each image picture button a Double click the image or picture button in the dashboard b For On Click Grouping type a string that identifies the group Be sure to use the identical string including case in all other picture buttons in this group c Click OK You might need to resize the dialog box in order to see this button 3 Optionally configure one of the images or picture buttons so that it is automatically selected when the dashboard is open To do so select On Click Startup for that item 72 Using the DeepSee Dashboard Designer Using KPI Display Rules to Override Text or Graphics Note that the only purpose of the group is to control which group member is selected at any given time 7 11 Using KPI Display Rules to Override Text or Graphics For labels and images you can use the KPI override feature which uses the display rules defined in a KPI and applies them to the object A KPI consists of two general elements e A measure or formula e A set of display rules Each display rule specifies a range of values and has an associated display options The display options can include font size typeface color and so on The following example shows three rules Foreground Color Back
74. mage tiled repeatedly to fill the element Button bod A button that displays a string which can be the result of a Cach ObjectScript function call Can be interactive Picture button A button that displays a string and an image Can be See Overview of Text and Graphic Elements interactive Drop down A button that displays a See Adding Frames menu drop down menu when clicked Controls a frame Frame A frame that contains a dashboard Timer A timer that can refresh one or See Adding Refresh more data elements Timer control A control with which the user can start and stop a timer Timers Pivot table A pivot table Speedometer A KPI key performance indicator displayed within a speedometer Detail listing A detail listing See Overview of Data Elements Venn diagram Bei FEST OO E E A Venn diagram See Adding Venn Diagrams Using the DeepSee Dashboard Designer Introduction to the Dashboard Designer ElementType Icon Purpose For Details Combo box A drop down list from which the See Overview of Data user can select one item Controls List box El A list from which the user can select one or maybe more item Shown in a box Text box A box into which the user can type a value Date picker Ea A control into which the user can type a date or can click a button to choose a date Check box A check box tha
75. ments on top of each other typically to display elements in front of graphics you may sometimes need to control which element is in front 30 Using the DeepSee Dashboard Designer Adjusting Positions and Sizes of Elements To adjust how far in front an element is right click it and then click one of the following e Bring it forward Send it back Using the DeepSee Dashboard Designer 31 Adding Data Elements This chapter describes how to add elements that display data It discusses the following topics An overview of the available data elements How to add a pivot table to a dashboard How to add a speedometer to a dashboard Details on the display properties of speedometers How to add a detail listing to a dashboard Also see the chapter Displaying Listing Fields and Other Source Data later in this book 4 1 Overview of Data Elements DeepSee dashboards can include any of the following data elements Pivot table E Displays a pivot table Speedometer ae Displays a KPI within a speedometer Detail listing Displays a detail listing Using the DeepSee Dashboard Designer 33 Adding Data Elements For information on adding data controls that affect these data elements see the chapter Adding Data Controls later in this book 4 2 Adding a Pivot Table To add a pivot table to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard e
76. n select an image e Select an external image file To do so click Browse navigate to the file and click OK This action loads the file into the database and uses it as this dashboard element The dialog box displays a preview of the image 4 Optionally specify the following e Upon Clicked Specifies the image to display when the user clicks the picture button Click the browse button next to Upon Clicked and choose a image as described previously If you use this option make sure that the image has the same dimensions as the main image e Tool Tip Text Specifies a short string to display when the user hovers the cursor over the button You can type a Cach ObjectScript expression that refers to a user defined function function starting with see Function Calls in the appendix You can use the KPI function which is also described in that section 68 Using the DeepSee Dashboard Designer Adding a Picture Box e Auto Resize If you select this the image object is resized to fit the image as soon as you click OK 5 Click OK You might need to resize the dialog box in order to see this button The image is added in the upper left corner of the dashboard Other options are discussed later in this book as follows DashboardID Configuring an Image Button or Picture Button to Control a Frame KPI Override Setting and KPI Filter Using KPI Display Rules to Override Text or Graphics On Click
77. nd DeepSee assigns an internal ID to it and creates an image file in the DeepSee library This image file is then available for use in dashboards 1 First e Ifyou are currently viewing a DeepSee module click Controls gt Image List e Ifyou are currently viewing a dashboard right click and then click Controls gt Image List 2 Right click a folder in the left area and then select Add Image DeepSee displays a dialog box where you specify the details of the image file that you are creating 64 Using the DeepSee Dashboard Designer Adding a Background Image to a Dashboard Image Name Folder 1 Default E Save to Database Image Browse Save as File Path Preview On this dialog box specify the following e Image Name Type a name for this image DeepSee displays this name when you are selecting an image to add it to a dashboard but users do not see the name e Folder Optionally select a different folder to contain the image file e Image Click Browse and navigate to the actual image file that you want to use Optionally click Save as File if you do not want to load the image into the database If you choose this option DeepSee copies the image file into the directory install dir CSP sys bi work namespace img giving the file a new name based on the internal ID it assigns to the image If you instead use Save as File DeepSee copies the image into the database Cli
78. ng 1 ie 5 Shap Dale Year lt oS me ame 10042 sample 7 Detail Using the DeepSee Dashboard Designer 87 10 Adding Venn Diagrams This chapter describes how to add Venn diagrams to your dashboards It discusses the following topics e An overview of Venn diagrams in DeepSee e How to define a reusable Venn diagram e How to add a Venn diagram to a dashboard 10 1 Overview of Venn Diagrams DeepSee provides a simple capability for creating Venn diagrams A Venn diagram is assumed to have three main groups which are shown as circles with labels for example Using the DeepSee Dashboard Designer 89 Adding Venn Diagrams Denmark Federal Shipping 2005 To work with this Venn diagram the user has the following options Right click on any segment of the diagram and then click Listing to Screen whole group DeepSee then displays a detail listing that shows the records that make up the selected group This refers to the area that is outlined with a bold red line Right click on any segment of the diagram and then click Listing to Screen selected section only DeepSee then displays a detail listing that shows the records that make up the section that your cursor is on This may be the same as the selected group Right click and then click Switch Table Venn DeepSee then displays a table listing the number of records in each group and in each intersection as follows Sample Denmark Fede
79. nk between the button and the pivot table as follows a Right click the button and then click Set as Refresh Trigger b Right click the pivot table and then click Set as Refresh Target When you do so a gray line is drawn between the two elements Click the save dashboard icon E Then click OK Click the close button X in the upper right DeepSee displays the new dashboard in view mode Using the DeepSee Dashboard Designer 17 Tutorial 12 Refresh the browser window Depending upon your data your data model and your pivot table DeepSee displays something like this Country amp shipper by year Level 0 of 0 Federal Shipping Argentina Speedy Express United Package Federal Shipping Austria Speedy Express United Package Federal Shipping v Page of 2 gt gt I Test the new dashboard by clicking options from the drop down lists Notice that the pivot table is not refreshed until you click Find 18 Using the DeepSee Dashboard Designer Creating Dashboards This chapter describes the basics of creating dashboards It discusses the following topics e How to create a new dashboard e How to edit a dashboard in general e How to enable the security options for a dashboard e How to add an element e How to edit an element e How to copy an element e How to delete an element e How to delete a dashboard e How to adjust the sizes and positions of dashboard elements
80. nt style and font size for the caption You can also choose underline or strike through properties Ignore the color options and alignment which have no effect Click this and specify the options e Fore Color Click this and then select the color of the caption text e Auto Resize If you select this the picture button is resized to fit the image as soon as you click OK e Picture Position Specifies the position of the image within the picture button Click an option from the drop down list Using the DeepSee Dashboard Designer 71 Adding Text and Graphics e Caption Position Specifies the position of the caption within the picture button Click an option from the drop down list 6 Click OK You might need to resize the dialog box in order to see this button The picture button is added in the upper left corner of the dashboard Other options are discussed later in this book as follows DashboardID Configuring an Image Button or Picture Button to Control a Frame On Click Grouping and On Click Grouping Images and Picture Buttons Startup Back Color Border Width SetValue Ignore these options Appearance and Style Ignore the other options for this object 7 10 Grouping Images and Picture Buttons When you create multiple images you can group them so that only one is selected at any given time That is if the user clicks one of them any previously selected image is automatical
81. oices for the detail listing e For Detail Listing click the browse button and then click the detail listing to use Click Next DeepSee then displays a list of the dimensions in the selected subject area You choose the dimensions by which the user can filter the displayed detail listing Double click each dimension that you want to filter on The dimension is added to the Selected Filter s list The order in which you add the dimensions controls the order in which the corresponding filters are displayed In example shown here the dimensions Shipper Ship Country and then Ship Date Year were selected Click Next DeepSee then displays a list of all the listing fields in your selected detail list Double click each listing field that you want to display The listing field is added to the Selected Data Object s list The order in which you add the listing fields controls the order in which they are displayed In example shown here the listing fields OrderID Ship Date and then Customer were selected Click Next DeepSee displays a table of the selected listing fields Optionally edit the captions for the listing fields To do so type a value into Caption for the corre sponding entry in this table Click Finish and then click OK DeepSee creates the specified dashboards and then displays the primary dashboard in view mode Using the DeepSee Dashboard Designer 83 Displaying Listing Fields and Other Source Data
82. one combo box would give the user a choice of countries When the user selected a country the country combo box would refresh the ship region combo box If you are using the user s selection as a filter optionally choose a comparison operator for use in the filter By default the filter uses the equals operator For example suppose the combo box lists ship years If the user selects the ship year 2005 data is shown for the ship year equal to 2005 You can instead use other comparison operators e Greater than gt e Greater than or equal to gt e Less than gt e Less than or equal to gt e Equal to e Not equal to If you are using the user s selection to set a variable enter the name of that variable into Store In Variable See Using a Control to Set a Variable later in this chapter Click OK You might need to resize the dialog box in order to see this button If you are using the user s selection as a filter link the combo box to the element that it filters See Using a Control to Filter a Dashboard Element later in this chapter Note Ignore the Custom and Post Loading Scripts options 5 3 1 Creating a List of Dimension Members For combo boxes as well as list boxes and search boxes both discussed later you can create a list of dimension members that the control uses The steps are similar for all three controls 1 For Subject Area select a subject area and click OK The d
83. operator for use in the filter By default the filter uses the equals operator For example suppose the text box uses the ship year dimension If the user types the value 2005 into the text box data is shown for the ship year equal to 2005 You can instead use other comparison operators e Greater than gt e Greater than or equal to gt e Less than gt e Less than or equal to gt e Equal to e Not equal to 4 Optionally do some or all of the following e Specify a default value to show in the text box To do so click the browse button next to Default Value Then type a Cach ObjectScript expression into Cach Scripts Typically you type a string or a number For example Federal Shipping The expression can evaluate to anything but must be consistent with your validation script if you add one Then click OK e Specify a validation script To do so type one or more Cach ObjectScript statements into Validation Scripts These statements can use and set the variable val which contains the current value of the text box control e Specify options to control the appearance of the text as it is being typed in To do so click the Customize tab and set some or all of the following options Font Click this to choose the font typeface size and style Ignore the other options which are not used in this case Fore Color Click this to choose the color of the text Back Color Click thi
84. ound image from a dashboard How to add a label How to add an image How to add a picture box How to add a button How to add a picture button How to group multiple picture buttons How to use the KPI override feature to control the appearance of a label or image 7 1 Overview of Text and Graphic Elements You can specify a background image for a dashboard to display You can also include the following text and graphic elements in a dashboard note that some of these elements can be interactive Using the DeepSee Dashboard Designer 63 Adding Text and Graphics Label Ela Displays a string which can be the No result of a Cach ObjectScript function call Image ce Displays an image Yes Picture box A Displays an image tiled repeatedly to No fill the element Button bod Adds a button that displays a string Veg which can be the result of a Cach ObjectScript function call Picture button Adds a button that displays a string i Es i and an image See Configuring an Image Button or Picture Button to Control a Frame later in this book 7 2 Loading Images into the DeepSee Library DeepSee provides a module that enables you to load existing image files into the DeepSee library Depending on your choice the actual image file is either copied into the database or is copied into the DeepSee directories on the server In either case you specify a name for the image a
85. oves the post action 5 Click OK to close the dialog box 98 Using the DeepSee Dashboard Designer 12 Using the Dashboard Library The DeepSee Designer provides a simple mechanism for you to save dashboard elements so that you can reuse them elsewhere This chapter discusses the following topics e How to copy an element to the dashboard library e How to use a library object in a dashboard e How to delete objects from the library 12 1 Adding an Element to the Dashboard Library To add an element to the dashboard library 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Right click the element and then click Add to Dashboard Library DeepSee immediately copies the element as is to the dashboard library and assigns it an internal identifier The copy includes any post actions defined for this element This copy does not however include any links Using the DeepSee Dashboard Designer 99 Using the Dashboard Library 12 2 Using a Library Object in a Dashboard To add a library object to a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 DeepSee displays a dialog box that lists all the objects in the dashboard library Control Type Origin of object 10001 10002 10003 10007 10008 10009 10010 3 Click the row that contains the object you want to add When you do a pr
86. ow size unchanged 11 3 2 Options for Executing Cach ObjectScript If you choose Scripts specify the details as follows e For Cach Scripts type in one line of Cach ObjectScript To clear your entry click Clear 11 3 3 Options for Displaying a Web Page If you choose Web Page specify the details as follows e For URL type in the URL of the Web page to open To clear your entry click Clr Ignore the Load a doc option which does not apply to DeepSee 11 3 4 Options for Displaying a KPI Drill down If you choose KPI Drill Down specify the details as follows e For KPI type in the ID of the KPI to display Or click the browse button click the KPI and then click OK e For Filter optionally type a filter expression This filters the data used to evaluate the KPI For example Ship Country Australia See the appendix Filter Expressions For information on defining KPIs see Using the DeepSee Analyzer 11 4 Deleting a Post Action To delete a post action from a dashboard element Using the DeepSee Dashboard Designer 97 Configuring Post Actions 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book 2 Right click the element and then click Post Action DeepSee displays a dialog box in which you specify the details 3 In the upper area click the row corresponding to the post action you want to delete 4 Click Delete DeepSee immediately rem
87. ppearance and Style Ignore these options 3 2 Editing a Dashboard To edit a dashboard 1 Display the dashboard in view mode as follows 2 Tip If you are currently viewing a different dashboard in view mode right click and then click Recent Dashboard and then the dashboard name Or right click click Open Dashboard navigate to the dashboard and then click OK If you are elsewhere within DeepSee click Main gt Open Dashboard or Main gt Recent Dash board Then proceed as described in the previous bullet Be careful where you do this If one dashboard is enclosed in another via a frame you could accidentally open a different dashboard than you expect DeepSee displays the dashboard in edit mode in a child browser window 3 Make changes as needed Here you can do the following Add an element to the dashboard Edit an element Copy an element Delete an element Delete the dashboard itself Adjust the sizes and positions of dashboard elements Using the DeepSee Dashboard Designer 21 Creating Dashboards These tasks are described later in this chapter Save the dashboard To do so click the save dashboard icon E and then click OK Or discard any unsaved changes by clicking the refresh icon amp 5 Click the close button X in the upper right DeepSee displays the dashboard in view mode 6 Refresh the browser window Note When you view a dashboard in edit mode you can edit only th
88. r in this book To add a speedometer to a dashboard 1 2 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this book Click the add speedometer table button DeepSee displays a dialog box in which you specify the details For KPI Override Setting at the bottom of the dialog box click the browse button and select the KPI to display in this speedometer For information on defining KPIs see Using the DeepSee Analyzer Optionally specify the following Caption Specifies a caption for the speedometer You can type a Cach ObjectScript expression that refers to a user defined function function starting with see Function Calls in the appendix You can use the VAR function which is also described in that section By default the speedometer has no caption Filter Specifies an additional filter to apply to the data used in the KPI Type a filter expression For example Ship Country Australia See the appendix Filter Expressions Specify display properties as described in the following section Click OK You might need to resize the dialog box in order to see this button The speedometer is added in the upper left corner of the dashboard 4 4 Speedometer Display Properties This section describes the display properties for speedometers and shows examples for quick reference Using the DeepSee Dashboard Designer 35 Adding Data Elements
89. ral Shipping Denmark AND Federal Shipping Denmark AND 2005 Federal Shipping AND 2005 Denmark AND Federal Shipping AND 2005 90 Using the DeepSee Dashboard Designer Defining Venn Diagrams 10 2 Defining Venn Diagrams You define Venn diagrams in a separate part of DeepSee and then you add them to dashboards as needed First configure DeepSee to give you access to Venn diagram setup To do so 1 4 First e Ifyou are currently viewing a dashboard in view mode right click and then click Go to gt Administrator gt Shortcut Management e Ifyou are elsewhere within DeepSee click Administrator gt Shortcut Management In the Available Shortcuts list scroll down to and double click Data Modeler In the left list scroll down to and double click Venn Diagram Setup This adds Venn Diagram Setup to the list on the right which is the list of shortcuts within the Data Modeler shortcut Click Save The preceding setup is necessary only once To define a Venn diagram 1 First e Ifyou are currently viewing a dashboard in view mode right click and then click Go to gt Data Modeler gt Venn Diagram Setup e Ifyou are elsewhere within DeepSee click Data Modeler gt Venn Diagram Setup The left area of the page then displays the folders stored in DeepSee along with any Venn diagrams that currently exist The right area of the page displays details for the selected Venn
90. rol to filter a data element or another control 1 Configure the control as described earlier in this chapter following the instructions for using the control as a filter 2 Specify the control as the refresh trigger and as a filter To do so do both of the following in either order e Right click the control and then click Set as Refresh Trigger e Right click the control and then click Set as Filter 3 Specify the other element as the refresh target and as the filtered object To do so do both of the following in either order e Right click the element and then click Set as Refresh Target When you do so a gray line is drawn between the control and the other element e Right click the element and then click Apply Filter to this object When you do so a blue line is drawn between the control and the other element Tip To delete links to an object right click it and then click Delete all links to object 5 11 Using a Control to Set a Variable You can use any of the controls to set system variables used by data elements in the same dashboard For example suppose that the dashboard included a pivot table that ranked the top ten sales regions by default You could add a combo box that listed the numbers 5 10 15 and 20 and you could use the user s selection to control the number of top ranked sales regions that are shown That is the user 56 Using the DeepSee Dashboard Designer Using a Control to Set a Variable
91. rs of the dimension you selected previously Optionally configure the default state of the check box a Click the browse button next to Default Value b Type a Cach ObjectScript expression into Cach Scripts This expression must evaluate to one of the values that you typed in the previous step c Click OK If you do not do this the check box is cleared by default If you are using the user s selection to set a variable enter the name of that variable into Store In Variable See Using a Control to Set a Variable later in this chapter Click OK You might need to resize the dialog box in order to see this button If you are using the user s selection as a filter link the check box to the element that it filters See Using a Control to Filter a Dashboard Element later in this chapter Note Ignore the Custom and Post Loading Scripts options Using the DeepSee Dashboard Designer 53 Adding Data Controls 5 8 Using Search Boxes A search box is meant to help the user find an item in a list typically in a very long list It includes a plain box into which a user can type a value as well as an icon that displays a search dialog box as follows P To use this control the user optionally types a value into the box and then clicks the search icon The search dialog box then displays all list items that start with the same characters the comparison is case sensitive For example Search value
92. ry amp shipper by year Level o of 0 Shipper Argentina Speedy Express Austria Speedy Express Denmark Finland Nie Ol OIN O amp 0 2 2 Tutorial Part 2 In this part of the tutorial we edit the previous dashboard to add a speedometer and a label 1 Right click and then click Edit Dashboard 2 Add a speedometer to this dashboard as follows i Click the add speedometer button E b For KPI Override Setting click the browse button expand folders as needed and click a KPI c Click OK You might need to resize the dialog box in order to see this button The speedometer is added in the upper left corner of the dashboard d Drag and drop the speedometer to the desired location e Resize the speedometer as needed 3 Create a filter link between the combo box and the speedometer as follows a Right click the combo box and then click Set as Filter b Right click the speedometer and then click Apply Filter to this object When you do so a blue line is drawn between the two elements 4 Create a refresh link between the combo box and the speedometer as follows a Right click the combo box and then click Set as Refresh Trigger 14 Using the DeepSee Dashboard Designer Tutorial Part 2 b Right click the speedometer and then click Set as Refresh Target When you do so a gray line is drawn between the two elements 5 Add a label to this dashboard to place near the combo box as follows
93. s of InterSystems Corporation No part of this publication is to be used for any other purpose and this publication is not to be reproduced copied disclosed transmitted stored in a retrieval system or translated into any human or computer language in any form by any means in whole or in part without the express prior written consent of InterSystems Corporation The copying use and disposition of this document and the software programs described herein is prohibited except to the limited extent set forth in the standard software license agreement s of InterSystems Corporation covering such programs and related documentation InterSystems Corporation makes no representations and warranties concerning such software programs other than those set forth in such standard software license agreement s In addition the liability of InterSystems Corporation for any losses or damages relating to or arising out of the use of such software programs is limited in the manner set forth in such standard software license agreement s THE FOREGOING IS A GENERAL SUMMARY OF THE RESTRICTIONS AND LIMITATIONS IMPOSED BY INTERSYSTEMS CORPORATION ON THE USE OF AND LIABILITY ARISING FROM ITS COMPUTER SOFTWARE FOR COMPLETE INFORMATION REFERENCE SHOULD BE MADE TO THE STANDARD SOFTWARE LICENSE AGREEMENT S OF INTERSYSTEMS CORPORATION COPIES OF WHICH WILL BE MADE AVAILABLE UPON REQUEST InterSystems Corporation disclaims responsibility for errors which may appear in th
94. s option to enable the scroll bars e Inherit Query Variable Enables this dashboard to use values for any query variables that are passed in as part of the URL e Font Specifies the initial font typeface font size font color and font size for any elements you add to this dashboard To use this option click Font specify the details and then click OK e Height Specifies the height of this dashboard 5 Click OK You might need to resize the dialog box in order to see this button DeepSee then displays the dashboard in edit mode in a child browser window 6 Add elements to the dashboard as described in the following section s Click the save dashboard icon Then click OK Or discard any unsaved changes by clicking the refresh icon amp 8 Click the close button X in the upper right DeepSee displays the new dashboard in view mode 9 Refresh the browser window 20 Using the DeepSee Dashboard Designer Editing a Dashboard Note When you view a dashboard in edit mode you can edit only that dashboard To edit another dashboard or to create a new one you must first exit the editor by clicking the close button X in the upper right Other dashboard options are discussed later in this book as follows Subject Area and Detail Listing Displaying Listing Fields and Other Source Data Security Enabling Security Options for a Dashboard Board Background Picture Adding a Background Image to a Dashboard A
95. s to choose the background color of the text box control CAPS lock on all entry Click this to convert all text to upper case 50 Using the DeepSee Dashboard Designer Using Date Pickers Alignment Click an option to control the alignment of the text within the text box control Ignore the Border setting 5 If you are using the user s entry to set a variable enter the name of that variable into Store In Variable See Using a Control to Set a Variable later in this chapter 6 Click OK You might need to resize the dialog box in order to see this button 7 Ifyou are using the user s entry as a filter link the text box to the element that it filters See Using a Control to Filter a Dashboard Element later in this chapter Note Ignore the Sort Order Custom Post Loading Scripts options 5 6 Using Date Pickers A date picker includes a plain box into which a user can type a date in the format dd mm yy or dd mm yyyy as well as a button with which the user can open a dialog box for choosing a date as follows F Date If you use this element as a refresh trigger the trigger is activated only if the check box is selected otherwise the element is ignored To configure a date picker specify its properties as follows 1 Optionally type a name into Name This name is not visible in the dashboard itself but is useful when you edit the dashboard 2 If you are using the user s entry as a filter
96. sccsncssccssscssccescescssscessssesscesscssesssesseessorsecees 59 GeV Adding a TIMET se s2saisdenescshcecuatssedaveates ibcongstvantazhvecteasadecs dated IEEE EEE EIEEE EEE OERE ET a Ea 59 6 2 Adding a Timer COM ois 38 sascha ce shaat Hake i ee a a E EE ETO iE 60 7 Adding Text and Graphics c ssssssessssessesersesessessssessssessssessssersssesessesessessesessesessessssessssessssesssses 63 71 Overview of Text and Graphic BIGments s c sccssscsccistisscvvesssanetsndestiansouiesbaasss e oes ein ES 63 7 2 Loading Images into the DeepSee Libtary secscisorociscssrecisereni cirin 64 7 3 Adding a Backeround Image to a Dashboard cii 3 sscssessecsstessscosvsssoastesnscontcesscseaacsenaseoisesys 65 7 4 Removing a Background Image from a Dashboard 0 00 0 ee eeeeeeeeeseecee cece ceecnseeseenseeeeeees 66 PDP a Labelon n A A E E A E A E R AREE 67 T6 Addins an IMA2E enenu a raed E EEE E A EEEE 68 TT PIS a Pietre BOX lt onnie i eE EE E EE E E EERE Ea 69 PO RAGIN a BUWAN soicresccsoni vas Shs ca baht a e a EE E eiii 70 FO Addins a Picture BUON siroce ni rinena EAE A E EEE E EA A i 71 7 10 Grouping Images and Picture Buttons scssccicciionnpgiu raen eE i Eeoa 72 7 11 Using KPI Display Rules to Override Text or Graphics c c c0c ieenvesuschsecesseeseassonvecess 73 Using the DeepSee Dashboard Designer Adding Fram s cssscccacsscsescsvessavessesssessssseussenscetseasvesssvesssactsevessessasasiscvacasssesseussessesvessssessosscesvc sos
97. select the date dimension to which the filter refers To do so a For Subject Area select a subject area and click OK The dimensions in the subject area are then displayed within Dimensions b For Dimensions double click a date dimension Note To use the date picker be sure to select the base date dimension name for example Order Date Do not use the variants Order Date Year Order Dat Quarter Order Date Month and so on Using the DeepSee Dashboard Designer 51 Adding Data Controls When you do so the system puts your subject area and dimension name into Schema and Dimension on the right 3 Ifyou are using the user s entry as a filter optionally choose a comparison operator for use in the filter By default the filter uses the equals operator For example suppose the date picker uses the Order Date dimension If the user selects the date 06 01 1980 data is shown for that date You can instead use other comparison operators e Greater than gt e Greater than or equal to gt e Less than gt e Less than or equal to gt e Equal to e Not equal to 4 Optionally specify a default value to show in the date box To do so click the browse button next to Default Value Then type a date valued Cach ObjectScript expression into Cach Scripts Use the format dd mm yy or dd mm yyyy For example 15 06 08 Then click OK 5 If you are using the user s entry to set a variab
98. signer 27 Creating Dashboards 3 The system immediately deletes the element You can also select multiple elements so that you can delete them To select them left click and hold while dragging the selected elements are highlighted in orange Then press Delete The elements are immediately removed 3 9 Deleting a Dashboard To delete a dashboard 1 Open the dashboard in edit mode as described in Editing a Dashboard earlier in this chapter 2 Click the delete dashboard icon DeepSee prompts you for confirmation 3 Click OK DeepSee then displays the Dashboard List dialog box to prompt you to open a different dashboard 3 10 Adjusting Positions and Sizes of Elements In addition to standard mouse gestures the Dashboard Designer provides a couple of options to let you fine tune the positions and sizes of elements on a dashboard e You can display a grid that helps you align elements while editing a dashboard e You can use the dashboard management tool to adjust all elements e You can display and edit the size and position of a single element e You can move elements backward and forward when they are stacked 3 10 1 Displaying the Grid While you are viewing a dashboard in edit mode you can display a grid of dots that can help you align elements with each other To do this you use an icon in the toolbar This icon is shown as follows 28 Using the DeepSee Dashboard Designer Adjusting Positions and Siz
99. t the user can select or clear Search box re A control into which the user can type a value or can click a button to search for a value ina list Dashboard An element that has been See Using the library object ta copied to the dashboard library Dashboard Library You can move and resize these elements as needed You can place elements in front of each other for example if you want to display a label in front of a graphic The Designer provides a couple of tools you can use to fine tune the placement and size of the elements 1 3 2 Links Among Elements You can create links between elements for several purposes e You can specify a link between two elements so that one element filters the other one For example if a user selects a customer from a drop down list that selection can filter a pivot table or other data element e You can specify a link between two elements so that if the user selects or makes a change in one element that refreshes the other one For example you can add a Search button that updates a pivot table or other data element Frequently you combine the two preceding types of links For example if you have a filter link from a drop down list to for another object you might also add a refresh link between these objects e You can specify a link between a timer control and a timer 6 Using the DeepSee Dashboard Designer Logging Into DeepSee Not all elements can be used in links But for any
100. ter expression like the following Ship Country MyVar e Labels button captions and speedometer captions can use the VAR function to refer to a variable set within the same dashboard or to a query variable You can use any of these variables as parameters and provide values for them within the URL to access the dashboard For example http localhost 57772 csp sys bi speedLogin csp NAMESPACE NS amp usr username amp pwd password role rolename amp dbId 10026 amp MyVar Spain Note Depending upon your application you might need to use amp 38 or amp amp rather than amp in order for your application to compile For example http localhost 57775 csp sys bi speedLogin csp NAMESPACE ENSEMBLE amp amp usr demo amp amp pwd demo amp amp role demo amp amp dbId 10026 To enable a dashboard to accept a value for a query variable that you pass in this manner be sure to check the Inherit Query Variable option for the dashboard see Create a New Dashboard earlier in this book 106 Using the DeepSee Dashboard Designer Security Settings for Internet Explorer 14 3 Security Settings for Internet Explorer To enable the use of use DeepSee dashboards while providing a secure environment try the following settings in Internet Explorer To access these options click Tools gt Internet Options in Internet Explorer click the Security tab and then edit the details for the applicable zone NET Framework Sele
101. the dashboard Tip To delete links to an object right click it and then click Delete all links to object 78 Using the DeepSee Dashboard Designer Displaying a Web Page in a Frame 8 5 Displaying a Web Page in a Frame You can embed Web pages in your dashboards by displaying the Web pages within frames The process is as follows 1 First define a shortcut that acts as a logical name for the URL of the Web page To do so a b Click the close button X in the upper right of the Dashboard Designer Right click and then click Go To gt Administration gt Shortcut Management Type a name into Name so that you can identify this shortcut later Click Call a Module For URL type the complete URL to use Click Save 2 Return to the Dashboard Designer 3 Adda frame to your dashboard as described earlier in this chapter When you do specify the frame properties as follows a b Click the browse button for Default Dashboard Expand the Modules folder This folder lists the DeepSee modules as well as any shortcuts you have defined Click the shortcut you created and then click OK Using the DeepSee Dashboard Designer 79 Displaying Listing Fields and Other source Data This chapter describes how to create dashboards that display listing fields or other lowest level source data It discusses the following topics e An overview e How to use the Detail Listing Dashboard wizard to create a
102. ting is added in the upper left corner of the dashboard Using the DeepSee Dashboard Designer 41 Adding Data Controls This chapter describes how to add data controls to a dashboard It discusses the following topics e An overview of the data controls e How to add a control in general e How to configure a combo box e How to configure a list box e How to configure a text box e How to configure a date picker e How to configure a check box e How to configure a search box e Details on the default value options e How to use a control as a filter for other dashboard elements e How to use a control to set a variable used by data elements 5 1 Overview of Data Controls In user interface design the word control refers generally to an object with which the user interacts with the application The Dashboard Designer provides many kinds of controls In this book data controls are the objects with which the user can control the data elements pivot tables speedometers and detail listings The data controls are as follows Using the DeepSee Dashboard Designer 43 Adding Data Controls Combo box User can select one item from the drop down list List box User can select one or maybe more item from the list shown in the box Text box User can type a value Date picker User can type a date or can click a button to choose a date Check box User can select or clear the check box Search box Pe User
103. try USA 112 Using the DeepSee Dashboard Designer Cach ObjectScript Expressions This expression returns the average freight cost per order for orders sent to the USA A 2 2 VAR Function To refer to the value of a variable set within the same dashboard use the VAR function SSVAR varname This function takes the following argument varname Name of a variable used within the same dashboard To set this variable use the Store In Variable option of another element in the dashboard A 3 Cache ObjectScript Expressions You can use Cach ObjectScript expressions in multiple places in dashboards e Within the name of a member in a filter expression as described earlier in this appendix e As the default value for combo boxes list boxes and other data controls A 4 Cache ObjectScript Scripts A custom script is one or more Cach ObjectScript statements You can write custom scripts in the following places e Post loading scripts for combo boxes list boxes and other data controls e Post actions associated with dashboard elements Using the DeepSee Dashboard Designer 113 Index D dashboards embedding Web pages 79 F frame displaying Web page 79 WwW Web pages in dashboards 79 Using the DeepSee Dashboard Designer 115
104. tutorials later in this book or see the chapter Creating Dashboards 8 Using the DeepSee Dashboard Designer Accessing the Dashboard Designer 1 5 1 Displaying a Dashboard If you are currently viewing a DeepSee module do either of the following to display a dashboard e Click Main gt Open Dashboard and then click a dashboard e Click Main gt Recent Dashboard and then click a dashboard If you are currently viewing a dashboard do either of the following to display some other dashboard e Right click and then click Go To gt Main gt Open Dashboard Then click a dashboard e Right click and then click Go To gt Main gt Recent Dashboard Then click a dashboard 1 5 2 Editing the Current Dashboard To edit the dashboard you are currently viewing right click and then click Edit Dashboard Depending on the dashboard you may see something like the following Pivot table 10006 Country amp shipper by year Using the DeepSee Dashboard Designer 9 Introduction to the Dashboard Designer 1 6 Switching to Another Namespace To switch to a different namespace 1 Log out To do so do one of the following depending on what you are currently viewing e Ifyou are currently viewing a DeepSee module click the Log Off button in the upper right e Ifyou are currently viewing a DeepSee dashboard right click and then click the Log Out option The system logs you out of DeepSee 2 Click Switch Namespace 3
105. uery Variables osocs lt ssccccteccssencedssacecenseessgansuss csueesaccovsscesostscidnecssnsateesdeieny 103 13 2 Defining Query Varia Ble ss cisc2 eis 2 ciscictsvsescevcesscastescncecesctacechaesdeavaclags oa G pEi EES desis dos 103 13 3 Referring toa Query Varia le s s ci cs ects cotelia scnsee ssid sensdsdiees stheviustistevscsatidusastesasdenieeetaa bene 104 14 Adding Dashboards to Your Applications csssssssssssssssessssessssesscsesscsensesenscsenscsensesenseses 105 14 1 Adding Dashboards to Your Applications 5 s c cscsccsoqbssses ess dechseccsaceeseveocsdecgnesseeseusveuniens 105 14 2 Passing Parameters to Dashboards 06 csc cesscseccesseescicessccsencssssuceaes eiiie igenis enas 106 14 3 Security Settings for Internet Explorer sidiciyssoi inoen Shichi lededaeitavtedestaeesssaeieeee 107 Using the DeepSee Dashboard Designer v Appendix A Expressions and Scripts in the Dashboard Designer sssscssssssssessesesesesees 109 Ak Piter Expressions coricce creron nein EEEn E E E EEE E REEERE E EREE 109 Adsl E eN a T 109 EE e e E E E E A E EEEE E E EE 110 A13 Filter Expression Using IN scisco inean ieee EE a EE ENE ER EE REEE 110 A14 Filter Expression with Pull Date cieciossienriicesiieisinreene ieiet 111 A 1 5 Filter Expression with Embedded Cach ObjectScript seeeeseeeesreresrseerrrersrerrereees 111 Aa lo Filter Expression That Uses Query Variable scccicc s5ds cissesssinsdsetuestsvecteanterente 111 A 1

Using the DeepSee Dashboard Designer

Contents

Download Pdf Manuals

Related Search

Related Contents