Custom Dashboard Tiles June 2014

Transcription

1 Overview This guide details the process for the creation of your own metric tiles on the Analytics Web dashboard. The creation of custom tiles requires both a knowledge of the underlying Inteum data table structure, and familiarization with SQL concepts, such as table relationships, primary key and foreign key columns. If you are not familiar with these concepts, but do need to produce your own custom dashboard metrics, supporting services are available from Inprisys support, support@inprisys.com. A metric tile requires setup of 4 aspects of the tile to make it function properly: The Tile Name the name of the Tile shown on the Dashboard. The Metric SQL the SQL that runs to derive the single metric (number total or financial total) for the aspect of Inteum you need to see. The Detail SQL the SQL that runs to derive the detail fields you see when the metric total is clicked for drill down. The Date Filter the Inteum date used for the date from and date to filter application on the Analytics Web dashboard. Each of these items is covered in detail below. Technical Requirements Creation of custom Dashboard metrics is supported in Analytics Web version onwards. Our Example In our example below, we are creating a tile to show the number of Agreements we have Active for any date range configured on the Dashboard. Step 1 Adding your own Tile The Metric SQL is the SQL that produces the primary metric total in a tile, for example in Patents Filed below, the metric SQL creates both the 14 and the comparable 6 values: The first step in creating a tile, is to access the Dashboard Configuration, through the Configure Dashboard icon on the Analytics Web ribbon menu:

2 Here you will see the standard Dashboard Tiles provided with Analytics, and the option to Add Tile> which lets you define the details for your own metric tile. Clicking the Add Tie> button will prompt you for a Tile Name. This name is both the reference to your own tile in the Tiles list, and the Header for the tile on the Dashboard, so name it something short but meaningful. In our example below, we are showing Active Agreements : When you click Add, your tile will be added to the Tiles list. Step 2 Creating the Metric SQL In our example, we are working with Agreements, and will use the V_AgreementSummarized Inteum view to derive information from Agreements. In Appendix A, we have detailed some Inteum view objects you may find useful for creating your own tiles. We can either write the SQL directly, or use the Build SQL button to use the graphical SQL query builder. In either case, the structure of the resulting Metric SQL must follow the templates as follows: SELECT COUNT(*) AS TOTAL FROM TABLE WHERE CONDITIONS Or, for financial values: SELECT SUM(FIELD) AS TOTAL FROM TABLE WHERE CONDITIONS The Analytics Web Dashboard relies on the TOTAL field alias to display the resulting data, so any count/sum must always be aliased to TOTAL. The SQL for our example Active Agreements will derive as: SELECT COUNT(*) AS TOTAL FROM V_AGREEMENTSUMMARIZED WHERE STATUS= Active As shown here:

3 When our Metric SQL has been defined, we can then move on to define our Detail SQL. Step 3 Creating the Detail SQL As we are working with Agreements in our example, the Detail SQL we define should provide the user with some detail from the Agreement data when they click on our tile values and drill down into the detail. We ll use the following fields in our Detail SQL: Agreement ID Agreement Title Agreement Type Effective Date The Detail SQL can be entered directly in the field, or can be derived using the Build SQL button. The Detail SQL follows the template: SELECT FIELD1, FIELD2, FIELD3, FIELD4.FIELDN FROM TABLE WHERE CONDITIONS For our example, our Detail SQL will be: SELECT AGRMNTID, TITLE, AGREEMENTTYPE, EFFECTIVEDATE FROM V_AGREEMENTSUMMARIZED WHERE STATUS= Active We have also set the Metric Type to Integer as we are displaying a total count, if we has a financial value, this would be set to Currency. So, now we have defined the Name, Metric SQL, Detail SQL and Metric Type: At this stage, we can click Save and save our tile, then move on to define the Date Filter.

4 Step 4 Adding the Date Filter In our example so far, we have defined the Metric SQL and Detail SQL for our tile. If we enable the tile, then it will show on the Dashboard: However, at the moment, the tile is showing data for ALL time, across our entire dataset it will not respond to the Dashboard date from / date to filter until we configure the tile to work across a date range. To do this, we open the configuration for our tile, through Configure Dashboard, then select our tile from the tile list. We then must decide which Inteum Date we want to filter when the date range is applied. In our example, we are working with Agreements, so our options are: Created Date, Updated Date, Effective Date, Status Date, Termination Date and Signed Date. Four our example, we ll choose Effective Date. To apply the date filter, we simply need to add a condition into the WHERE clause of both the Metric SQL and the Detail SQL. The template for this date condition is: WHERE INTEUMDATE BETWEEN :from AND :to If, like in our example, you already have a WHERE condition, you should add the date conditions following the template: AND INTEUMDATE BETWEEN :from AND :to So our resulting clause will be: AND EFFECTIVEDATE BETWEEN :from AND :to So the full clause is: WHERE STATUS= Active AND EFFECTIVEDATE BETWEEN :from AND :to

5 We apply this to both the Metric SQL and the Detail SQL in order that the resulting number and drill down details both recognize the Date Filter applied on the Dashboard: Remember to Save your changes. That completes the tile setup. When we view the Dashboard, we now see the tile has adjusted for the date range on our Dashboard, and we can see the drill down details when we click either the metric for the current period, or the comparable period:

6 Appendix A Inteum data views handle a lot of the mechanics of SQL join between different Inteum tables to provide you a single view of data across an area of Inteum. These are useful for building your own dashboard tiles. V_AgreementSummarized V_TechnologySummarized V_PatentSummarized V_ReceivableSummarized V_ReceiableDetailSummarized V_PayableSummarized V_PayableDetailSummarized There are many more, you can use the SQL Builder to review these views and their contents.