Page Comparison

{anchor:top}
{toc: class=contents}
h2. Overview
{styleclass: Class=topLink}[top|#top]{styleclass}
KPI reports are a style of report which assists you to measure actual performance against targets. A KPI is usually made of:
* A metric
* A filter
* A date restriction or period

By using KPI metrics, you can track actual performance and compare it to a goal and you can detect trends. These metrics are most commonly used in organisations as Key Performance Indicators (KPIs) to monitor critical business areas. KPI reports are designed to be used on a KPI Dashboard Tab, not as stand alone reports.  

bq. See [KPI Tabs] for more information.

h3. Difference between KPI & Standard Reports
A KPI report differs from a standard report in a number of ways - these include:
# It is run periodically to detect trends and changes in data (or uses a date field)
# It uses Conditional Formatting functionality to classify the current status of the metric 
# It can be added to a KPI dashboard tab to easily monitor critical business areas.
{color:#C00000}*Note:*{color} KPI reports do not support the use of cross tabs - you can only choose the column or row formats for your report.

bq. See [KPI Tab Tutorial|Tutorial - KPI Tab] for more information.

h3. Types of KPI Report
There are three different types of KPI Report available in Yellowfin:
|*[Spot|#Spot]*|Basic KPI Report that allows you to set up a KPI without displaying any additional information, other than the value itself.|
|*[Categorical|#Categorical]*|KPI Report that splits what's displayed on the tab into categories when viewed as a report. This allows you to display break up the value into categories for further examination.|
|*[Time|#Time]*|KPI Report that allows you to show a trend according to time series data, rather than real-time trends. It also allows you to show more detail in the report (like a Categorical KPI).|


{anchor:Spot}
h2. Creating a KPI Spot Report
{styleclass: Class=topLink} [top|#top] {styleclass}
{section}
{column: width=30%}
*1.* Click on the *Create* link and select *Report* to begin building your report.
{column}
{column: width=70%}
!01.png! 
{column}
{section}

{section}
{column: width=30%}
*2.* You should now be on the Initialise Report page. Select the *Drag and Drop Builder* as the build tool.
{column}
{column: width=70%}
!02.png! 
{column}
{section}

{section}
{column: width=30%}
*3.* Select *Ski Team* as the View.

*4.* Now click the !step_right_on.png! button to proceed.
{column}
{column: width=70%}
!2a.png|thumbnail,border=1! 
{column}
{section}

{section}
{column: width=30%}
*5.* To start with, set the Report Type to *KPI* by selecting it in the *Report Options* section on the right. This will ensure that the KPI options are available in later steps.
{column}
{column: width=70%}
!03.png!	 
{column}
{section}

{section}
{column: width=30%}
*6.* Now you need to add metrics to your report. Drag in the !rpt_metric.png! *Invoiced Amount* metric into the Column Fields area, and !rpt_dim.png! *Invoiced Date* dimension into the Filters section. 

{color:#C00000}*Note:*{color} Yellowfin always takes the max date when calculating the final KPI value.

*7.* Click on !step_right_on.png! at the top of the page to move to the next step.
{column}
{column: width=70%}
!04.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*8.* Set the filter logic to *Between*.
{column}
{column: width=70%}
!05.png!	 
{column}
{section}

{section}
{column: width=30%}
*9.* Click on the {color:#357CB6}Change{color} link.

*10.* Set the dates to *01/01/2010* and *01/01/2011*.

*11.* Click *Submit* link to continue.

!submit.png!

{color: #C00000}*Note:*{color} You have added this filter to ensure that the Ski Team data is available. This filter should not be necessary for your real reports.
{column}
{column: width=70%}
!06.png|thumbnail,border=1!
{column}
{section}

{section}
{column: width=30%}
*12.* You should now have filters set up, as shown here.

*13.* Click on step three.
{column}
{column: width=70%}
!07.png!	 
{column}
{section}

{section}
{column: width=30%}
*14.* You should now be on the *Report Preview* page. At the moment your report should look the one pictured.

{color: #C00000}*Note:*{color} The invoiced amount may differ depending on the current date and filters applied above.
{column}
{column: width=70%}
!08.png!	 
{column}
{section}

{section}
{column: width=30%}
*15.* Now you can set Alerts using Conditional Formatting. Click on the {color:#357CBC}Columns{color} link at the top of the page.
{column}
{column: width=70%}
!09.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*16.* Select the *Sum Invoiced Amount* column. 
{column}
{column: width=70%}
!10.png!	 
{column}
{section}

{section}
{column: width=30%}
*17.* Click on the *Conditional* Menu. 

*18.* Click {color:#357CB6}Add Rule{color}

*19.* Set the Display Style to *Icon*, the Format to *Traffic Lights* and the Type to *Value*. 

*20.* As you will see, a set of three green circles and a set of fields has appeared. 

*21.* Set the top Style to *Red*, the Rule to *Less than*, and the Value to *2500000*. (Again, only use numeric values).

*22.* Set the middle Style to *Orange*, the Rule to *Between*, and the Values to *2500000* and *3000000*.

*23.* Set the lower Style to *Green*, the Rule to *Greater than* and the Value to *3000000*.

*24.* Click *Save*. 

!save.png!
{column}
{column: width=70%}
!11.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*25.* Your report should now look like this, with an alert for the current *Sum Invoiced Amount* value.

*26.* The Conditional Format Alerts are listed at the bottom of the page for reference
{column}
{column: width=70%}
!12.png!	 
{column}
{section}

{section}
{column: width=30%}
*27.* To set up the report click on the *KPI Menu* and set the KPI Metric to *Sum Invoiced Amount*. This will bring up options for you to set the trend details.
{column}
{column: width=70%}
!13.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*28.* Set the Desired Trend to *Up* and the Target Value to *Manually* with a value of *30000000* (do not include any non-numeric characters as the report will not work).

*29.* Set the KPI Type to *Spot*. 

*30.* Click *Save*.

!save.png!

{color:#C00000}*Note:*{color} You will notice that there is an error message referencing the lack of refresh schedule, this will be addressed in the next step.
{column}
{column: width=70%}
!14.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*31.* Now you need to set how often this report will be automatically refreshed. Click on the *Refresh* Menu and set the Frequency to *Daily*. 

*32.* This will determine how the trend of the KPI report will be built, how often data will be collected.
{column}
{column: width=70%}
!15.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*33.* It is now time to save your report. Go back to the *Report* tab, and click on the *SaveReport* Menu and select *Save*. 

*34.* Set the Name to *KPI Spot Report Tutorial*. 

*35.* Type *This report was created as part of the KPI Report tutorial* into the Description box. 

*36.* Select *Advanced Reporting* for the Sub Category.

*37.* Click *Activate*. 

!activate.png!
{column}
{column: width=70%}
!16.png|thumbnail,border=1!
{column}
{section}	 


{anchor:Categorical}
h2. Creating a Categorical KPI Report
{styleclass: Class=topLink} [top|#top] {styleclass}
{styleclass: Class=topLink} [top|#top] {styleclass}
{section}
{column: width=30%}
*1.* Click on the *Create* link and select *Report* to begin building your report.
{column}
{column: width=70%}
!01.png! 
{column}
{section}

{section}
{column: width=30%}
*2.* You should now be on the Initialise Report page. Select the *Drag and Drop Builder* as the build tool.
{column}
{column: width=70%}
!02.png! 
{column}
{section}

{section}
{column: width=30%}
*3.* Select *Ski Team* as the View.

*4.* Now click the !step_right_on.png! button to proceed.
{column}
{column: width=70%}
!2a.png|thumbnail,border=1! 
{column}
{section}

{section}
{column: width=30%}
*5.* Set the Report Type to *KPI* by selecting it in the *Report Options* section on the right. 	 
{column}
{column: width=70%}
!03.png!
{column}
{section}

{section}
{column: width=30%}
*6.* Now you need to add metrics to your report. Drag in the !rpt_dim.png! *Athlete Region* dimension, and the !rpt_metric.png! *Invoiced Amount* metric twice into the *Column Fields* area, and !rpt_dim.png! Invoiced Date dimension into the *Filters* section.

*7.* Now click the !step_right_on.png! button to proceed.
{column}
{column: width=70%}
!17.png|thumbnail,border=1!
{column}
{section}

{section}
{column: width=30%}
*8.* Set the filter logic to *Between*.	

*9.* Click on the {color:#357CB6}Change{color} link.

*10.* Set the dates to *01/01/2010* and *01/01/2011*.

*11.* Click the *Submit* button to continue.

!submit.png!

{color: #C00000}*Note:*{color} We have again added this filter due to the nature of the Ski Team sample data.	 
{column}
{column: width=70%}
!06.png|thumbnail,border=1!
{column}
{section}

{section}
{column: width=30%}
*12.* You should now have filters set up, as shown here.

*13.* Click on step three.
{column}
{column: width=70%}
!07.png!
{column}
{section}

{section}
{column: width=30%}
*14.* You should now be on the *Report Preview* page. At the moment your report should look the one pictured.	 
{column}
{column: width=70%}
!18.png!
{column}
{section}

{section}
{column: width=30%}
*15.* Set Alerts using Conditional Formatting. Click on the {color:#357CB6}Columns{color} link at the top of the page.	 
{column}
{column: width=70%}
!09.png|thumbnail,border=1!
{column}
{section}

{section}
{column: width=30%}
*16.* Select the second *Sum Invoiced Amount* column. 

*17.* Change the Display Name of the column to *Invoiced Amount KPI*.
{column}
{column: width=70%}
!19.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*18.* Click on the *Conditional* Menu. 

*19.* Click {color:#357CB6}Add Rule{color}

*20.* Set the Display Style to *Icon*, the Format to *Traffic Lights* and the Type to *Value*. 

*21.* Set the top Style to *Red*, the Rule to *Less than*, and the Value to *1000000*. (Again, only use numeric values).

*22.* Set the middle Style to *Orange*, the Rule to *Between*, and the Values to *1000000* and *1500000*.

*23.* Set the lower Style to *Green*, the Rule to *Greater than* and the Value to *1500000*.

*24.* Click *Save*.

!save.png!
{column}
{column: width=70%}
!20.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*25.* Your report should now look like this, with an alert for the current *Invoiced Amount KPI* value.

*26.* The Conditional Format Alerts are listed at the bottom of the page for reference	 
{column}
{column: width=70%}
!21.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*27.* To set up the report click on the *KPI Menu* and set the KPI Metric to *Invoiced Amount KPI*. This will bring up options for you to set the trend details.

*28.* Set the Desired Trend to *Up* and the Target Value to *Manually* with a value of *1500000* (do not include any non-numeric characters as the report will not work).

*29.* Set the KPI Type to *Categorical*. 

*30.* Set the category to be Keyed On *Athlete Region*.

*31.* Click *Save*.	

!save.png! 
{column}
{column: width=70%}
!22.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*32.* Now you need to set how often this report will be automatically refreshed. Click on the *Refresh* Menu and set the Frequency to *Daily*. 

*33.* This will determine how the trend of the KPI report will be built, how often data will be collected.	 
{column}
{column: width=70%}
!23.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*34.* It is now time to save your report. Go back to the *Report* tab and, click on the *SaveReport* Menu and select *Save*. 

*35.* Set the Name to *Categorical KPI Tutorial*. 

*36.* Type *This report was created using the KPI Report tutorial* into the Description box. 

*37.* Select *Advanced Reporting* for the Sub Category.

*38.* Click *Activate* 	

!activate.png! 
{column}
{column: width=70%}
!24.png|thumbnail,border=1!	 
{column}
{section}


{anchor:Time}
h2. Creating a KPI Time Report 
{styleclass: Class=topLink} [top|#top] {styleclass}
{styleclass: Class=topLink} [top|#top] {styleclass}
{section}
{column: width=30%}
*1.* Click on the *Create* link and select *Report* to begin building your report.
{column}
{column: width=70%}
!01.png! 
{column}
{section}

{section}
{column: width=30%}
*2.* You should now be on the Initialise Report page. Select the *Drag and Drop Builder* as the build tool.
{column}
{column: width=70%}
!02.png! 
{column}
{section}

{section}
{column: width=30%}
*3.* Select *Ski Team* as the View.

*4.* Now click the !step_right_on.png! button to proceed.
{column}
{column: width=70%}
!2a.png|thumbnail,border=1! 
{column}
{section}

{section}
{column: width=30%}
*5.* To start with, set the Report Type to *KPI* by selecting it in the *Report Options* section on the right. 	 
{column}
{column: width=70%}
!03.png!	 
{column}
{section}

{section}
{column: width=30%}
*6.* Now you need to add metrics to your report. Drag in the !rpt_dim.png! *Year* dimension into the *Column Fields* area.

*7.* You now need to create a calculated field for the metric. Set up a calculation *COUNT(Athlete ID)* called *Athletes* and add it to the *Column Fields* area.

*8.* Click the !step_right_on.png! button to proceed.
{column}
{column: width=70%}
!25.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*9.* You should now be on the *Report Preview* page. At the moment your report should look the one pictured.	 
{column}
{column: width=70%}
!27.png!	 
{column}
{section}

{section}
{column: width=30%}
*10.* Set Alerts using Conditional Formatting. Click on the {color:#357CB6}Columns{color} link at the top of the page.	 
{column}
{column: width=70%}
!09.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*11.* Select the second *Athletes* column. 

*12.* Click on the *Conditional* Menu. 

*13.* Click {color:#357CB6}Add Rule{color}

*14.* Set the Display Style to *Icon*, the Format to *Traffic Lights* and the Type to *Value*. 

*15.* Set the top Style to *Red*, the Rule to *Less than or equal to*, and the Value to *250*.

*16.* Set the middle Style to *Orange*, the Rule to *Between*, and the Values to *250* and *500*.

*17.* Set the lower Style to *Green*, the Rule to *Greater than or equal to* and the Value to *500*.

*18.* Click *Save*.

!save.png!
{column}
{column: width=70%}
!29.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*19.* Your report should now look like this, with an alert for the current *Athletes* value.
{column}
{column: width=70%}
!30.png!	 
{column}
{section}

{section}
{column: width=30%}
*20.* To set up the report click on the *KPI Menu* and set the KPI Metric to *Athletes*. This will bring up options for you to set the trend details.

*21.* Set the Desired Trend to *Up* and the Target Value to *Manually* with a value of *500*.

*22.* Set the KPI Type to *Time*. 

*23.* Set the category to be Keyed On *Year*.

*24.* Click *Save*.

!save.png!
{column}
{column: width=70%}
!31.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*25.* It is now time to save your report. Go back to the *Report* tab, and click on the *SaveReport* Menu and select *Save*. 

*26.* Set the Name to *KPI Time Tutorial*. 

*27.* Type *This report was created as part of the KPI Report tutorial* into the Description box. 

*28.* Select *Advanced Reporting* for the Sub Category.

*29.* Click *Activate*. 

!activate.png!	 
{column}
{column: width=70%}
!32.png|thumbnail,border=1!	 
{column}
{section}

\\
\\
{horizontalrule}
{styleclass: Class=topLink}[top|#top]{styleclass}