Getting Started With Pentaho
Getting Started With Pentaho
Getting Started With Pentaho
https://help.pentaho.com/Draft_Content/Version_5.4
Updated: Fri, 29 May 2015 14:52:00 GMT
1/30
Copyright Page
This document supports Pentaho Business Analytics Suite 5.4 GA and Pentaho Data Integration 5.4 GA,
documentation revision June 9th, 2015, copyright 2015 Pentaho Corporation. No part may be reprinted
without written permission from Pentaho Corporation. All trademarks are the property of their respective
owners.
Trademarks
The trademarks, logos, and service marks ("Marks") displayed on this website are the property of Pentaho
Corporation or third party owners of such Marks. You are not permitted to use, copy, or imitate the Mark, in
whole or in part, without the prior written consent of Pentaho Corporation or such third party. Trademarks of
Pentaho Corporation include, but are not limited, to "Pentaho", its products, services and the Pentaho logo.
https://help.pentaho.com/Draft_Content/Version_5.4/Copyright_Page
Updated: Fri, 29 May 2015 14:52:00 GMT
2/30
Trademarked names may appear throughout this website. Rather than list the names and entities that own the
trademarks or inserting a trademark symbol with each mention of the trademarked name, Pentaho
Corporation states that it is using the names for editorial purposes only and to the benefit of the trademark
owner, with no intention of infringing upon that trademark.
Contact Us
Global Headquarters Pentaho Corporation Citadel International, Suite 460
5950 Hazeltine National Drive Orlando, FL 32822
Phone: +1 407 812-OPEN (6736)
Fax: +1 407 517-4575
http://www.pentaho.com
Sales Inquiries: [email protected]
https://help.pentaho.com/Draft_Content/Version_5.4/Copyright_Page
Updated: Fri, 29 May 2015 14:52:00 GMT
3/30
Introduction
The User Console is a fun, easy to use, web-based design environment where you can analyze data, create
interactive reports, dashboard reports, and build integrated dashboards to share business intelligence
solutions with others in your organization and on the internet. In addition to its design features, the User
Console offers a wide variety of system administration features for configuring the Business Analytics (BA)
Server, maintaining Pentaho licences, setting up security, managing report scheduling, and tailoring system
performance to meet your requirements.
The topics found in this section give you an overview of the reports and dashboards you create with the User
Console, to help you became familiar with the look and feel of the console.
Prerequisites
Before you can work with the User Console, you will have to have installed the Pentaho software and
configured the BA Server.
Expertise
The User Console does not require any special skills or knowledge to use its design environment. However, to
use its system administration features you should know where your data is stored and how to access it, as well
as details about your system configuration and security providers.
Tools
Through the User Console you can access these Pentaho tools and features, as well as the BA Repository on
the BA Server.
Analyzer
Interactive Reports
Dashboard Reports
Dashboard Designer
Data Source Wizard
Data Source Model Editor
Login Credentials
These tasks require that you login to the User Console with an evaluator user name and password.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/000
Updated: Fri, 29 May 2015 14:52:00 GMT
4/30
After you define the data sources for your BA Server, you are ready to begin working with the Pentaho User
Console to create your first reports.
To create a report, just follow the directions in each tutorial. Each section uses the sample data sources that
are included with the installation of the Pentaho suite of software.
It is time to take a look at the User Console and learn how to create reports. Just follow the Guide Post graphics
as you work with the tutorials to create your first Pentaho Reports and Dashboards.
Tour the Pentaho User Console
Get Started with Interactive Reports
Get Started with Analyzer Reports
Get Started with Dashboard Designer
Next Steps
https://help.pentaho.com/Documentation/5.4/0J0/0D0/010
Updated: Fri, 29 May 2015 14:52:00 GMT
5/30
Home
The first thing you see after you login to the console is the Home page, which serves as the starting place for
the User Console and all of the tasks that you do with it.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/020
Updated: Fri, 29 May 2015 14:52:00 GMT
6/30
Item
Name
Home view
Function
The Home drop-down menu lets you flip easily from page to page, or
return to your Home page.
Getting Started
Shows the name of the person currently logged in to the User Console.
Clicking the arrow next to the name lets you log out of the User Console.
Browse Files
Brings you to the Browse Files window, where you can locate your files
using the Browsing and Files panes, and manage them using the Actions
pane. Any files that you open appear in a new window.
Create New
Documentation
Recents, Favorites
Shows a list of your most recently opened files. Clicking on the star next to
a recently opened file adds it to your Favorites list.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/020
Updated: Fri, 29 May 2015 14:52:00 GMT
7/30
Browse Files
The Browse Files page helps you keep your files organized and makes them easier for you to find and work
with.
Opened
The Opened page activates after you open a file from the Browse Files page and provides a simple space to
work with your files.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/020
Updated: Fri, 29 May 2015 14:52:00 GMT
8/30
Schedules
All of your active scheduled reports appear in the list of schedules, which you can get to by clicking the Home
drop-down menu, then the Schedules link, in the upper-left corner of the User Console page. You can also
access your list of schedules from the Browse Files pane, if you have a report selected.
The list of schedules shows which reports are scheduled to run, the recurrence pattern for the schedule, when
it was last run, when it is set to run again, and the current state of the schedule. You can edit and maintain
each of your schedules by using the controls above the schedules list, on the right end of the toolbar.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/020
Updated: Fri, 29 May 2015 14:52:00 GMT
9/30
Explore
Considerations
Choose Options
Interactive Reports
Analyzer Reports
Summary
Interactive Reports is a
web-based design
interface which is used to
create both simple and
on-demand operational
reports without
depending on IT or report
developers.
Analyzer Reports is an
intuitive analytical
visualization tool that
filters and drills down into
business information
contained in Pentaho
Analysis data sources.
Dashboard Designer
allows users to create
dashboards with little or
no training. The
dashboard is several
different reports brought
together inside one
screen.
Expertise
Knowledge of basic
computer functions, such
as operating systems and
web browsers.
Knowledge of basic
computer functions, such
as operating systems and
web browsers.
Knowledge of basic
computer functions, such
as operating systems and
web browsers.
Recommendation
https://help.pentaho.com/Documentation/5.4/0J0/0D0/020
Updated: Fri, 29 May 2015 14:52:00 GMT
Dashboard Designer
10/30
Interactive Reports is a web-based interface which is used to create on-demand operational reports.
Interactive Reports is a web-based design interface which is used to create both simple and on-demand
operational reports without depending on IT or report developers. Use Interactive Reports if you want to
create a quick report that answers an immediate business question, looks professional, and provides
significant control over formatting elements such as fonts, column width or sorting, background colors, and
more.
If you want to start creating your first report right away, feel free to jump ahead to Create Your First Interactive
Report.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/030
Updated: Fri, 29 May 2015 14:52:00 GMT
11/30
2. Click to select Vendor Sales from the scrolling panel on the right.
3. Click Explore in the Samples pane. A new window opens showing the Vendor Sales sample report.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/030
Updated: Fri, 29 May 2015 14:52:00 GMT
12/30
Item
Name
Function
Opened view
Displays quick access buttons across the top to create and save new
Analysis reports, Interactive reports, and Dashboards. Opened reports and
files show as a series of tabs across the page.
Use the Data panel to drag information into a column or a row on the
report. Your report display changes as you drag items onto the Report
Canvas.
Shows a dynamic view of your Interactive report as you work to build it.
The look of your report changes constantly as you work with Data,
Formatting, and General panels to refine it.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/030
Updated: Fri, 29 May 2015 14:52:00 GMT
13/30
Item
Name
Interactive Toolbar and
Filters
Function
Use the Toolbar functions to undo or redo actions, hide lists of fields, add
or hide filters, disable the auto-refresh function, adjust settings, and
change the view of your report.
Use the Filters panel to display a list of filters applied to the active
report, or edit or delete filters.
2. Choose the Inventory data source from the Select Data Source dialog box. Click OK.
3. Click Get Started on the dialog box that appears. A blank Interactive report canvas appears.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/030
Updated: Fri, 29 May 2015 14:52:00 GMT
14/30
4. Click and drag the Product Code element onto the report canvas until a highlighted vertical line
appears. Drop it onto the Report Canvas.
5. Continue dragging and dropping these fields onto the canvas: Product Name, Product Vendor,
Quantity in Stock, MSRP, and Buy Price.
The data from the chosen fields appears on the report canvas and populates with the information from
the server.
NOTE:
You can change the order of the columns by clicking the column heads and dragging the columns left or
right until they are in the order you want. If you want to delete a column, just drag and drop the column
title into the trash can.
6. Rename your report by double-clicking on Untitled in the Report Canvas, and typing a name in the field
that appears. In Stock Report is used in this example.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/030
Updated: Fri, 29 May 2015 14:52:00 GMT
15/30
7. After you have arranged your columns in order, apply a filter to the data by clicking on the Filter icon in
the toolbar. After the filter pane expands, drag the Product Code field onto the filter workspace.
9. Choose items from the Filter list by using one of these methods.
Click on the arrows to move your selected filters on to or off of the Filter list.
To choose more than one item from the Filter list, hold down the Ctrl key and click the items that
you want to filter by, then click the top arrow to move the items to the right panel.
Or you can choose a series from the list by holding down the Shift key and clicking on the first item
you want to use, then clicking on the last item that you want to use.
Choose individual items by clicking to highlight them, and then clicking on the top arrow to move it
to the right panel.
10.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/030
Updated: Fri, 29 May 2015 14:52:00 GMT
16/30
The report exports in the selected format and a paper copy can be printed from the export.
You have successfully created a simple Interactive report from scratch. Use Interactive Reports shows you
how to work with more complex Interactive reports.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/030
Updated: Fri, 29 May 2015 14:52:00 GMT
17/30
Analyzer Reports is an intuitive analytical visualization tool that filters and drills down into business
information contained in Pentaho Analysis data sources. Use Analyzer Reports if you want to compile data
quickly in an interactive environment, perform advanced sorting and filtering of your data, and want to see
chart visualizations that include conditional stop-lighting.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/040
Updated: Fri, 29 May 2015 14:52:00 GMT
18/30
https://help.pentaho.com/Documentation/5.4/0J0/0D0/040
Updated: Fri, 29 May 2015 14:52:00 GMT
19/30
Item
Name
Function
Opened view
Displays quick access buttons across the top to create and save new
Analysis reports, Interactive reports, and Dashboards. Opened reports and
files show as a series of tabs across the page.
Use the Available Fields and Layout panels to drag levels and measures
into a report.
Shows a dynamic view of your report as you work to build it. The look of
your report changes constantly as you work with Available Fields and
Layout panels to refine it.
The Report Canvas shows different fields based on the chart type
selected.
Analyzer Toolbar and Filters
Use the Analyzer Toolbar functions to undo or redo actions, hide lists of
fields, add or hide filters, disable the auto-refresh function, adjust settings,
and change the view of your report.
Use the Filters panel to display a list of filters applied to the active
report, or edit or delete filters.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/040
Updated: Fri, 29 May 2015 14:52:00 GMT
20/30
A table with the Territory, Years, and Sales data appears and populates with the information from the
server.
4. Click and drag the Line field and drop it next to the Territory column on the canvas. Right-click the Line
column header and select Show Subtotals from the menu that appears.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/040
Updated: Fri, 29 May 2015 14:52:00 GMT
21/30
5. Right-click the first Sales column and select Conditional Formatting -> Data Bar - Green in the menu
that appears.
6. Right-click the same Sales column and select User Defined Measure -> % of Rank, Running Sum... In
the dialog box that appears, select the radio button next to % of Sales. Click Next.
7. Select the radio button for Each Line Column/Row Subtotal (Subtotal is 100%). Click Done.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/040
Updated: Fri, 29 May 2015 14:52:00 GMT
22/30
8. Expand the Filters canvas by clicking the Show Filters icon. Click and drag the Territory field from the
Available Fields panel into the filter canvas. The Filter on Territory dialog box appears.
9. In the Filter on Territory dialog box, select APAC from the list and click the top, right-pointing arrow to
move it to the box on the right.
10. Enable Parameter Name by clicking on the check box in the bottom left of the dialog box. Type region
as your parameter name in the text box. Click OK.
The report updates and displays sales data for APAC exclusively.
Click the line that separates each column to adjust it for better viewing. Move the line right or left as
needed.
11. Click the Save As icon in the toolbar. When the Save As dialog box appears, save your report as
Territory - Sales in your user folder and click Save.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/040
Updated: Fri, 29 May 2015 14:52:00 GMT
23/30
You have successfully created a simple Analyzer report from scratch. You may export the report to one of
several different formats or close the report. Use Analyzer Reports guides you through working with complex
Analyzer reports.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/040
Updated: Fri, 29 May 2015 14:52:00 GMT
24/30
Dashboard Designer allows you to create dashboards with little or no training. The dashboard is several
different reports brought together inside one screen. Use Dashboard Designer if you want to create an
interface to view many different reports at once, have quick access to web pages that you visit often, or view
dynamic charts and graphs within a space while you create reports in another.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/050
Updated: Fri, 29 May 2015 14:52:00 GMT
25/30
https://help.pentaho.com/Documentation/5.4/0J0/0D0/050
Updated: Fri, 29 May 2015 14:52:00 GMT
26/30
Item
Name
Function
Opened view
Displays quick access buttons across the top to create and save new
Analysis reports, Interactive reports, and Dashboards. Opened reports
and files show as a series of tabs across the page.
Prompts panel
The Prompts panel gives you a way to add filters to the individual parts
of your dashboard.
Locate your files using the Browse and Files panels, and add them to
dashboards.
Dashboard canvas
Shows a dynamic view of your Dashboard as you work to build it. The
look of your dashboard refreshes as you add content from the Browse
Folders and Files panels, and work with the Prompts or Objects panels.
Objects panel
Refine the look of your dashboard with the Objects panel by choosing a
dashboard template or changing the titles for each object in the
dashboard.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/050
Updated: Fri, 29 May 2015 14:52:00 GMT
27/30
4. Click the Themes tab and select the theme of your choice. The new theme will be applied to your
dashboard immediately.
5. Locate the Analyzer report you created earlier by going to the Browse pane to the left of the Dashboard
canvas and clicking on the Users folder and clicking to highlight your folder. Click-and-drag the
Territory - Sales file from the Files pane and onto the top-left dashboard panel.
6. Within the Edit Pane, type Territory - Sales in the Title text box and click Apply. The dashboard panel is
populated with the Territory - Sales report.
7. Locate your Interactive report by going to the Browse pane to the left of the Dashboard canvas and
clicking on the Users folder and clicking to highlight your folder. Click-and-drag the First Interactive
Report file from the Files pane and onto the top-right dashboard panel.
8. Within the Edit Pane, type First Interactive Report in the Title text box and click Apply. The right
dashboard panel is populated by the First Interactive Report report. You can drag any report from the
Steel Wheels folder in Public into the bottom dashboard panel.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/050
Updated: Fri, 29 May 2015 14:52:00 GMT
28/30
9. Click on the Save as icon in the toolbar. When the Save As dialog box appears, save your dashboard as
My Dashboard in your user folder and click Save.
a. Close the dashboard, then go to Browse Files and double-click on My Dashboard in the Files
pane.
You have successfully created a simple Dashboard from scratch. Use Dashboard Designer illustrates
how to work with complex dashboards.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/050
Updated: Fri, 29 May 2015 14:52:00 GMT
29/30
Next Steps
After you have finished working through the walk through tutorials, you are ready to learn more about
Pentaho reporting.
Learn More
Create Analysis, Interactive Reports, and Dashboards provides in-depth details about creating eyecatching business intelligence deliverables for your user community.
The Build Full-Featured Solutions category contains a large number of topics on working with the BA
Suite. Here you can learn about defining data models, fine-tuning your reports and dashboards, how to
create print-quality reports, or work with Big Data.
Work with Big Data tells you how to use big data as a data source.
https://help.pentaho.com/Documentation/5.4/0J0/0D0/060
Updated: Fri, 29 May 2015 14:52:00 GMT
30/30