Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{anchor:top}
{toc: class=contents}
h2. Getting Started
{styleclass: Class=topLink} [top|#top] {styleclass}
There are three different types of KPI Report available in Yellowfin:
|*Spot*|Basic KPI Report that allows you to set up a KPI without displaying any additional information, other than the value itself.|
|*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*|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).|

You will need to create at least one of these before attempting this tutorial. 

bq. See [KPI Report Tutorial|KPI ReportsKPIレポート] for more information.


h2. Creating a KPI Tab
{styleclass: Class=topLink} [top|#top] {styleclass}
{section}
{column: width=30%}
*1.* Now that you have created a KPI Report, you can create a KPI Tab. Click on the !dash_add.png! {color:#357CB6}Add Tab{color} link and select the KPI Tab option. This will bring up a blank tab, ready for reports to be added.	 
{column}
{column: width=70%}
!01.png!	 
{column}
{section}

{section}
{column: width=30%}
*2.* As you will have noticed, this tab looks a little different to the other tabs you have worked with so far. The empty scale in the middle will be filled with your KPI Report.	 
{column}
{column: width=70%}
!02.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*3.* To add a report to the dashboard you will need to search for it in the list of active reports. Type *KPI Tutorial* into the search box and click on !go.gif! to see results.

*4.* Add all three of the KPI reports to your tab, you will need to drag them into the KPI Report portlet in the middle.
{column}
{column: width=70%}
!03.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*5.* Your tab should now look like the one pictured. 	 
{column}
{column: width=70%}
!04.png|thumbnail,border=1! 
{column}
{section}

{section}
{column: width=30%}
*6.* You have now finished creating your KPI Tab so it's time to Save and Activate it. 

*7.* Click on the Save Menu and enter *KPI Tab Tutorial* in the Name field. 

*8.* Type *This tab was created using the Dashboard Tab tutorial* in the Description box. 

*9.* Click *Activate* to finish.
{column}
{column: width=70%}
!05.png|thumbnail,border=1!
{column}
{section}


h2. Reading and using the KPI Tab
{styleclass: Class=topLink} [top|#top] {styleclass}
{section}
{column: width=30%}
Now that you have a finished KPI Tab and Report it's time to learn what it all means. 

*1.* Click on the !dash_options_over.png! next to the name of the KPI Report. This opens up the menu pictured. 

*2.* From here you can reorder your KPI Reports (if you have more than one, and if the tab is in Edit mode) by clicking on the *Move Up* and *Move Down* options

*3.* You can view the original report by either clicking on the *View Report* option or clicking on the name of the report itself

*4.* You can select the *Print* option to generate a hard copy of the report

*5.* You can the *Delete* option to remove the report from the tab
{column}
{column: width=70%}
!06.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*6.* You can *Export* the report to various other programs. A list will open when you click on the option, simply choose the program you wish to export to and it will do it for you 
{column}
{column: width=70%}
!07.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*7.* Now, remember the conditional formatting alerts you set earlier? They appear to the left of the report title. 	 
{column}
{column: width=70%}
!08.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*8.* The *Trend* field is displayed using a Sparkline Graph. This compares the current version of the KPI report run with the previous version, indicates change and whether it is positive or negative.

{color: #C00000}*Note:*{color} the sparkline only appears for the time KPI as this is using historical data. The other KPIs will generate a sparkline when they have run more than once.
{column}
{column: width=70%}
!09.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*9.* The next fields display the *Actual*, which is the current value of the metric, the *Target*, which you set earlier, and the *Variance* between the two.	 
{column}
{column: width=70%}
!09.png|thumbnail,border=1!	 
{column}
{section}

{section}
{column: width=30%}
*10.* The *% of Target* is a Bullet Chart that helps visualise performance and lets you compare all metrics on an equal basis. 

*11.* Finally, the Last Run field tells you when the report was refreshed.

*12.* You have now finished with KPI Tabs.	
{column}
{column: width=70%}
!09.png|thumbnail,border=1! 
{column}
{section}

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