User Guides
Pentaho User Console Guide
Introduction
Pentaho User Console Basics
Logging into the Pentaho User Console
Navigating the Pentaho User Console
Creating a New Solution Folder
Deleting a Solution Folder
Using My Workspace
Creating Reports
Role and User Based Access
Using Pentaho Interactive Reporting
Selecting a Data Source
Creating a New Interactive Report
Saving Interactive Reports
Filtering Reports
Adding a Filter
Creating Advanced Filters
Applying a Summary Function
Applying an Aggregate Function
Flagging a Filter Constraint for Use as a Dashboard Parameter
Adding a Filter on Date Fields
Disabling Auto Refresh Mode in Interactive Reports
Enabling Row Limit and Query Timeout
Refining Your Report
Editing Report Headers and Footers
Editing the Report Title
Reordering and Adjusting Columns
Formatting Reports
Changing the Report Template
Changing Page Format and Orientation
Changing a Column Header Name
Applying Copy/Paste Formatting
Changing the Format of Numeric Values
Editing Interactive Reports
Interactive Reports and Report Designer
Examining an Interactive Report in View-Only Mode
Interactive Reporting Quick Reference
Using Pentaho Analyzer
Creating a New Analyzer Report
Adding Filters to an Analyzer Report
Adding Query Parameters to Analyzer Reports
Exporting an Analyzer Report
Displaying Member Properties
Configuring Drill-Down Links
Disabling Auto Refresh Mode
Defining Hyperlinks
Simple Conditional Formatting of Measures
Conditional Formatting Types
Analyzer Visualizations
Setting Chart Options
Displaying Multi-Charts in Analyzer
Geography Map Visualizations In Analyzer
Customizing Geography Map Visualizations In Analyzer
Scatter Chart Visualizations In Analyzer
Customizing Scatter Chart Visualizations In Analyzer
Heat Grid Visualizations In Analyzer
Customizing Heat Grid Visualizations In Analyzer
Creating a New Analysis View
Using Pentaho Dashboard Designer
Creating a New Dashboard
Working with the Chart Designer
Adding Data to a Chart
Working with Pie Charts
Working with Dial Charts
Correcting Scaling Issues
Rotating Chart Axis Labels
Editing a Chart
Adding a Data Table to a Dashboard
Updating the Data Table Display
Adding a Report Designer Report to a Dashboard
Adding an Action Sequence to a Dashboard
Adding an Analyzer Report to a Dashboard
Adding a Web Site to a Dashboard
Implementing Filters
Filtering Dashboards
Creating a SQL List
Creating a Metadata List
Creating a Cascading Filter
Editing Filters
Linking Dashboard Filters to Analyzer Parameters
Dashboard Parameters
Creating Chart or Data Table Parameters With the Query Editor
Dynamic Dashboard Titles
Using Content Linking to Create Interactive Dashboards
Linking Charts and Data Tables
Linking Columns in a Data Table to Content in other Dashboard Panels
Creating Content to Content Links in an Analyzer Report
Linking an Analyzer Chart to a Report
Linking an Action Sequence Parameter to Content in other Dashboard Panels
Controlling a Dashboard Parameter From a PRPT Hyperlink
Adding Content to a Dashboard Using Drag-and-Drop
Adjusting Whitespace in Dashboard Panels
Setting the Refresh Interval
Using Pentaho Mobile
Setting Up Mobile Access
Getting Started with Pentaho Mobile
Creating a Shortcut Using Safari
Working with the Home Screen
Navigating Files
Creating and Removing Favorites
Settings
Working with Pentaho Mobile Tools
Using the Overlay Toolbar
Mobile Reports
Mobile Analyzer
Mobile Dashboards
Administration and Advanced User Topics
Customizing the Pentaho User Console
Adding a Data Source in the Pentaho User Console
Connecting to Your Database
Creating a SQL Query Data Source in the Pentaho User Console
Creating a CSV Data Source in the Pentaho User Console
Increasing the CSV File Upload Limit
Changing the Staging Database
Creating Database Table(s) Data Sources
Reporting Only
Reporting and Analysis
Creating a Database Table Data Source (Reporting Only)
Creating a Database Table Data Source (Reporting and Analysis)
Where Metadata Models and Mondrian Schemas are Stored
Using the Modeler to Customize a Data Source
Customizing a Reporting Data Source
Customizing an Analysis Data Source
Editing a Database Connection in the Pentaho User Console
Deleting a Database Connection in the Pentaho User Console
Deleting a Data Source in the Pentaho User Console
Adding Member Properties
Auto Modeling Geography Dimension
Scheduling Reports
Scheduling a Report
Quartz Cron Attributes
Deactivating Schedules
Refreshing the Reporting Data Cache
Pentaho Interactive Report Settings
Troubleshooting
Analysis Guide
Introduction
ROLAP Defined
Pentaho Analysis Enterprise Edition Features
Workflow Overview
Dimensional Modeling
Virtual ROLAP Cubes
Prototyping With Pentaho Data Integration
Creating a Prototype Schema With a Non-PDI Data Source
Creating a Prototype Schema With a PDI Data Source
Testing With Pentaho Analyzer and Report Wizard
Prototypes in Production
Creating and Modifying Mondrian Schemas
Schema Workbench Notes
Adding a Data Source in Schema Workbench
Adding a Simple JNDI Data Source For Design Tools
Simple JNDI Options
Adding a JDBC Driver
Removing Mondrian Data Sources
Creating a Mondrian Schema
Using MDX Mode and Hand-Editing a Schema
Adding Business Groups
Adding Field Descriptions
Building a Schema and Detecting Errors
Adapting Mondrian Schemas to Work with Pentaho Analyzer
Applying Relative Date Filters
Adjusting for Calculated Members and Named Sets
Adding Geo Map Support to a Mondrian Schema
Localization/Internationalization of Analysis Schemas
BA Server and Thin Client Message Bundles
Pentaho Analyzer Localization
Setting a Default Font for PDF Exports
Analysis Schema Security
Restricting Access to Specific Members
Mondrian Role Mapping in the BA Server
The Mondrian One-To-One UserRoleMapper
The Mondrian SampleLookupMap UserRoleMapper
The Mondrian SampleUserSession UserRoleMapper
Restricting ROLAP Schemas Per User
Configuring Analysis Options
Managing Analysis Data Sources
Configuring the Mondrian Engine (mondrian.properties)
Configuring Pentaho Analyzer (analyzer.properties)
Adjusting Drill Link Limitations
All Filter Parameter
Defining Global Default Chart Options in Analyzer
Analyzer Chart Properties
Divide by Zero Display
PDF Logo and Cover Page Customization
Setting Query Limits
Mondrian Cache Control
Segment Cache Architecture
Cache Configuration Files
Modifying the JGroups Configuration
Switching to Another Cache Framework
Switching to Memcached
Memcached Configuration Options
Switching to Pentaho Platform Delegating Cache
Using a Custom SegmentCache SPI
Clearing the Mondrian Cache
Visualizing Your Data
Introduction to the Multidimensional Expression Language (MDX)
Further Reading
Creating Analyzer Reports and Analysis Views
Creating a New Analyzer Report
Adding Query Parameters to Analyzer Reports
Configuring Drill-Down Links
Displaying Member Properties
Disabling Auto Refresh Mode
Defining Hyperlinks
Number Formatting
Conditional Formatting
Simple Conditional Formatting of Measures
Conditional Formatting Types
Advanced Conditional Formatting With MDX Expressions
Conditional Formatting Expressions
Analyzer Visualizations
Geography Map Visualizations In Analyzer
Customizing Geography Map Visualizations In Analyzer
Scatter Chart Visualizations In Analyzer
Customizing Scatter Chart Visualizations In Analyzer
Heat Grid Visualizations In Analyzer
Customizing Heat Grid Visualizations In Analyzer
Setting Chart Options
Displaying Multi-Charts in Analyzer
Drilling in Charts
Creating a New Analysis View
Using Analysis Cubes in Report Designer
Adding an OLAP Data Source
Creating an MDX Query
Logging
Analysis SQL Output Logging
Enabling Segment Cache Logging
Viewing Log Output in Analyzer
Troubleshooting
Old Analysis Schemas Still Show Up in Pentaho User Console
Multi-Byte Characters Don't Appear In PDFs Exported From Analyzer
Mondrian Schema Element Quick Reference
AggExclude
AggFactCount
AggForeignKey
AggIgnoreColumn
AggLevel
AggMeasure
AggName
AggPattern
AggTable
CalculatedMember
CalculatedMemberProperty
CaptionExpression
Closure
ColumnDef
ColumnDefs
Cube
CubeGrant
CubeUsage
CubeUsages
Dimension
DimensionGrant
DimensionUsage
Formula
Hierarchy
HierarchyGrant
InlineTable
Join
KeyExpression
Level
Measure
MeasureExpression
MemberGrant
NamedSet
NameExpression
OrdinalExpression
Parameter
ParentExpression
Property
PropertyExpression
Role
RoleUsage
Row
Rows
Schema
SchemaGrant
SQL
Table
Union
UserDefinedFunction
Value
View
VirtualCube
VirtualCubeDimension
VirtualCubeMeasure
Report Designer User Guide
Introduction
How to Start Report Designer
Starting Report Designer on Windows
Starting Report Designer on Linux
Starting Report Designer on OS X
Report Designer Configuration Directories
Pentaho Reporting Configuration Files
Workflow
Navigating Report Designer
The Welcome Screen
The Report Designer Main Toolbar
Report Designer's Tabbed Views
The Report Workspace
The Structure Pane
The Data Pane
Function Reference
Common Functions
Report Functions
Summary Functions
Running Functions
Advanced Functions
Chart Data Functions
Image Functions
Script Functions
Deprecated Functions
The Style Pane
Style Properties Reference
Font Styles
Text Styles
Text Spacing Styles
Padding Styles
Object Styles
Size & Position Styles
Links Styles
Excel Styles
Sparkline Styles
Page Behavior Styles
Border Styles
The Attributes Pane
Element Attributes Reference
Barcode
Common
Table of Contents
Index
Excel
HTML
HTML-Events
Images
PDF
Pentaho
Query
Query-Metadata
Parameter
Sparkline
Survey-Scale
Swing
Wizard
The Palette
Data Sources and Queries
Supported Data Sources
Adding Data Sources
Adding a JDBC Driver
Adding a JDBC Data Source
Passing Security Information to a Report over a JDBC Connection
Adding a Metadata Data Source
Adding a Pentaho Data Integration Data Source
Adding an OLAP Data Source
Adding an OLAP (Advanced) Data Source
Adding an XML Data Source
Adding a Table Data Source
Adding Advanced Data Sources
Adding a JNDI Data Source
Creating Queries
Hadoop Hive-Specific SQL Limitations
Creating Queries With SQL Query Designer
Creating Queries With Metadata Query Editor
Dynamic Query Scripting
Creating Sub-queries With SQL Query Designer
Adding Report Elements
Report Layout Types
Adding Standard Design Elements
Aligning Elements
Adding Bands
Creating Sub-Reports
Referring to Report Elements by Name or Column Position
Creating a Table of Contents
Creating an Index
Creating Charts
Choosing the Right Chart Type
Creating a JFreeChart Element
Creating a Sparkline Chart
Sparkline
Applying Formatting to Report Elements
Standard Element Formatting
Creating Hyperlinks on Visualizations
Creating a Link to a Report on a Chart
Paste Formatting
Morphing an Element
Implementing Row Banding
Performing Calculations
Using the Formula Editor
Common Formulas
Conditional Formatting
Calculated Dates
Date and Time Parameters
Page Numbering
Summarizing Data in Groups
Output Parameterization
Simple SQL Output Parameterization
Advanced SQL Output Parameterization
Simple Metadata Output Parameterization
Simple OLAP Output Parameterization
Permanently Overriding the Auto-Submit Option
Integration With the Pentaho BA Server
Publishing to the BA Server
Editing an Interactive Report (.prpti) in Report Designer
Hiding Reports
Linking Reports
Linking in Tabs
Localizing a Report
Using Externalized Message Bundles
Creating Report Design Wizard and Interactive Reporting Templates
Report Design Wizard Template Design Guidelines
Interactive Reporting Template Design Guidelines
Dynamic Element Positioning in Templates
Template Properties
Deploying a Template to Report Design Wizard
Deploying a Template to Interactive Reporting
Setting the Default Interactive Reporting Template
Troubleshooting
Enabling Multi-Valued report Parameters for Metadata-based Queries Created with Previous Versions of Report Designer
Report Elements With Dynamic Heights Overlap Other Elements
Columns Unexpectedly Merge When Exporting to Excel
Tutorials
Creating a Report Using Report Designer
Designing Your Report
Refining Your Report
More about Row Banding, Data Formatting, and Alignment
Adding a Chart to Your Report
Adding Parameters to Your Report
Publishing Your Report
Chart Types
Bar
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
stacked
stacked-percent
horizontal
bar-borders
max-bar-width
series-color
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
item-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Line
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
line-style
line-size
show-markers
horizontal
series-color
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Area
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
stacked
stacked-percent
horizontal
series-color
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Pie
Data Collectors
PieSet
Chart Properties
Required
name
data-source
ignore-nulls
ignore-zeros
no-data-message
Title
chart-title
chart-title-field
title-font
Options
slice-colors
show-labels
label-font
label-format
rotate-clockwise
explode-slice
explode-pct
General
3-D
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
shadow-paint
shadow-x-offset
shadow-y-offset
url-formula
tooltip-formula
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
legend-label-format
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Multi-Pie
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
by-row
series-color
show-labels
label-font
label-format
General
3-D
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
shadow-paint
shadow-x-offset
shadow-y-offset
url-formula
tooltip-formula
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Bar Line Combination
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
bar-data-source
line-data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
stacked
stacked-percent
horizontal
series-color
max-bar-width
bar-borders
ctgry-tick-font
line-style
line-size
show-markers
line-series
lines-label-font
line-tick-fmt
line-tick-font
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
item-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
y2-same-as-y-axis
y2-axis-title
y2-font
y2-tick-interval
y2-tick-font
y2-min
y2-max
y2-tick-period
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Ring
Data Collectors
PieSet
Chart Properties
Required
name
data-source
ignore-nulls
ignore-zeros
no-data-message
Title
chart-title
chart-title-field
title-font
Options
slice-colors
show-labels
label-font
label-format
rotate-clockwise
explode-slice
explode-pct
section-depth
General
3-D
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
shadow-paint
shadow-x-offset
shadow-y-offset
tooltip-formula
url-formula
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
legend-label-format
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Bubble
Data Collectors
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
horizontal
series-color
max-bubble-size
show-labels
label-font
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Scatter Plot
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
stacked
horizontal
series-color
dot-height
dot-width
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
show-labels
label-font
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
XY Bar
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
stacked
horizontal
series-color
bar-borders
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
show-labels
label-font
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
XY Line
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
stacked
horizontal
series-color
line-style
line-size
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
show-labels
label-font
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
XY Area
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title-field
title-font
pos-title
chart-title
Options
stacked
horizontal
series-color
line-style
line-size
show-markers
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
label-font
show-labels
tooltip-formula
url-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
XY Extended Line (XY Step, XY StepArea, XY Difference)
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
ext-chart-type
stacked
horizontal
series-color
line-style
line-size
show-markers
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
show-labels
label-font
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Waterfall
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
horizontal
series-color
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Radar
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
line-size
head-size
series-color
gridline-interval
radar-web-filled
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
X Axis
x-font
show-labels
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Metadata Editor User Guide
About this Guide
Knowledge Prerequisites
A Conceptual Overview of the Pentaho Metadata Editor
The Physical Layer
The Business View
The Abstract Business Layer
Incorporating Metadata
Creating a New Domain
Examining the Default Metadata Model
Setting Up a Database Connection
Adding a JDBC Driver
An Example Connection: A JDBC Connection to a MySQL Database
An Example Connection: A JNDI Connection to a Hypersonic Database
Importing Physical Tables and Columns
Importing Tables Inside a Schema
Creating a Business Model
Creating Business Tables and Columns
Removing Unnecessary Business Columns
Creating Relationships between Business Tables
Creating Relationships Using the Editor Graph
Hadoop Hive-Specific SQL Limitations
Building a Business View
Building a Business View Using Manage Categories
Creating a New Category from a Business Table
Moving Columns into Categories
Adding a New Category
Remove Categories and Columns
Enriching Your Data — Understanding Metadata Concepts and Properties
Exceptions to the Rules
Required Properties
Applying Concepts and Properties in the Pentaho Metadata Editor
Applying Self Concepts: Managing Properties on the Model
The Properties List
The Properties Editor (Settings)
Adding New Properties
Removing a Property
The Concept Editor
Building Concepts
Applying Concepts to Business Objects
Removing the Parent Concept
Adding Security to Metadata Business Objects
Defining Security Settings
Getting Security Settings Offline
Changing Security Constraints
Adding Row Level Security to a Pentaho Metadata Model
Applying Data Constraints
Importing and Exporting Domains
Importing a Domain
Exporting a Domain
Configuring and Managing Locales (Internationalization)
Setting Up Locales
Domain Backup and Recovery
Publishing a Domain to a Pentaho BA Server
Before you Publish Your Domain
Publishing a Domain
Restricting Metadata Models to Specific Client Tools
Metadata Properties Reference
Out-of-the-Box Properties
Custom Properties
Required Properties per Business Object
Pentaho Metadata Formulas
Supported Functions
Supported Operators
Supported Aggregate Functions
Troubleshooting
Managing Multiple Outer-Joins
Using the Delay Outer Join Conditions Property
PDI User Guide
Introduction
Pentaho Data Integration Architecture
Pentaho Data Integration Components
Starting Pentaho Data Integration
Starting the Pentaho Data Integration Servers
Starting Spoon
Installing and Managing Enterprise Edition License Keys
Connecting to the Repository
Storing Content Alternatives
PDI Interface Perspectives
Introducing Perspectives
Data Integration (ETL) Perspective
VFS File Dialogues in Spoon
Model Perspective
Visualization Perspective
Instaview Perspective
Data Mining Perspectives
Forecast Perspective
ScatterPlot3D Perspective
Customizing the Spoon Interface
Terminology and Basic Concepts
Transformations, Steps, and Hops
Jobs
More About Hops
Creating Transformations
Getting Started
Saving Your Transformation
Running Your Transformation Locally
Building a Job
Executing Transformations
Creating a Slave Server in Spoon
Creating a Cluster Schema
Executing Transformations in a Cluster
Executing Jobs and Transformations from the Repository on the Carte Server
Impact Analysis
Working with the Enterprise Repository
Adding an Enterprise Repository
Editing Enterprise Repository Details
Deleting an Enterprise or Kettle Database Repository
Managing Content in the Enterprise Repository
Setting Folder-Level Permissions
Access Control List (ACL) Permissions
Exporting Content from an Enterprise Repositories with Command-Line Tools
Working with Version Control
Examining Version History
Restoring a Previously Saved Version of a Job or Transformation
Reusing Transformation Flows with Mapping Steps
Arguments, Parameters, and Variables
Arguments
Parameters
VFS Properties
Configuring SFTP VFS
Variables
Variable Scope
Environment Variables
Kettle Variables
Internal Variables
Rapid Analysis Schema Prototyping
Creating a Prototype Schema With a Non-PDI Data Source
Creating a Prototype Schema With a PDI Data Source
Testing With Pentaho Analyzer and Report Wizard
Prototypes in Production
Managing Connections
Adding a JDBC Driver
Defining Database Connections
Working with JNDI Connections
Working with JNDI Connections in Carte and Spoon
Database-Specific Options
Adding Database-Specific Options
Database Connections Advanced Configurations
Connection Pooling
Clustering
Editing, Duplicating, Copying, and Deleting Connections
Using the SQL Editor
Using the Database Explorer
Unsupported Databases
Performance Monitoring and Logging
Monitoring Step Performance
Using Performance Graphs
Logging Steps
Logging Transformations
Pentaho Data Integration Performance Tuning Tips
Working with Big Data and Hadoop in PDI
Pentaho MapReduce Workflow
PDI Hadoop Job Workflow
Hadoop to PDI Data Type Conversion
Hadoop Hive-Specific SQL Limitations
Big Data Tutorials
Hadoop Tutorials
Loading Data into a Hadoop Cluster
Prerequisites
Sample Data
Using a Job Entry to Load Data into Hadoop's Distributed File System (HDFS)
Using a Job Entry to Load Data into Hive
Using a Transformation Step to Load Data into HBase
Transforming Data within a Hadoop Cluster
Extracting Data from a Hadoop Cluster
Reporting on Data within a Hadoop Cluster
MapR Tutorials
Loading Data into a MapR Cluster
Transforming Data within a MapR Cluster
Extracting Data from a MapR Cluster
Reporting on Data within a MapR Cluster
Cassandra Tutorials
MongoDB Tutorials
Interacting With Web Services
Scheduling and Scripting PDI Content
Scheduling Transformations and Jobs From Spoon
Command-Line Scripting Through Pan and Kitchen
Pan Options and Syntax
Pan Status Codes
Kitchen Options and Syntax
Kitchen Status Codes
Importing KJB or KTR Files From a Zip Archive
Connecting to Enterprise Repositories with Command-Line Tools
Exporting Content from an Enterprise Repositories with Command-Line Tools
Transformation Step Reference
Big Data
Avro Input
Cassandra Input
Cassandra Output
CouchDB Input
Hadoop File Input
Hadoop File Output
HBase Input
HBase Output
HBase Row Decoder
MapReduce Input
MapReduce Output
MongoDB Input
MongoDB Output
SSTable Output
Input
Cassandra Input
CSV File Input
Data Grid
De-serialize From File
Email Messages Input
ESRI Shapefile Reader
Fixed File Input
Generate Random Credit Card Numbers
Generate Random Value
Generate Rows
Get Data From XML
Get File Names
Get Files Rows Count
Get Repository Names
Get Subfolder Names
Get System Info
Get Table Names
Google Analytics Input
Setting Up Google Analytics API
Google Analytics Plugin Installation
Google Docs Input
GZIP CSV Input
HBase Input
HL7 Input
JMS Consumer
JSON Input
LDAP Input
LDIF Input
Load File Content In Memory
Microsoft Access Input
Microsoft Excel Input
Mondrian Input
MongoDB Input
OLAP Input
OpenERP Object Input
Palo Cell Input
Palo Dim Input
Property Input
RSS Input
S3 CSV Input
Salesforce Input
SAP Input
SAS Input
Table Input
Text File Input
XBase Input
XML Input Stream (StAX)
YAML Input
Output
Automatic Documentation Output
Cassandra Output
Delete
HBase Output
Insert/Update
JMS Producer
JSON Output
LDAP Output
Microsoft Access Output
Microsoft Excel Output
Microsoft Excel Writer
OpenERP Object Input
Palo Cell Output
Palo Dim Output
Pentaho Reporting Output
Properties Output
RSS Output
S3 File Output
Salesforce Delete
Salesforce Insert
Salesforce Update
Salesforce Upsert
Serialize to File
SQL File Output
Synchronize After Merge
Table Output
Text File Output
Update
XML Output
Transform
Add a Checksum
Add Constants
Add Sequence
Add Value Fields Changing Sequence
Add XML
Calculator
Closure Generator
Example Plugin
Get ID From Slave Server
Number Range
Replace in String
Row Denormalizer
Row Flattener
Row Normalizer
Select Values
Set Field Value
Set Field Value to a Constant
Sort Rows
Split Field to Rows
Split Fields
String Operations
Strings Cut
Unique Rows
Unique Rows (HashSet)
Value Mapper
XSL Transformation
Utility
Change File Encoding
Clone Row
Delay Row
Edit to XML
Execute a Process
If Field Value is Null
Mail
Metadata Structure of Stream
Null if...
Process Files
Run SSH Commands
Send Message to Syslog
Write to Log
Flow
Abort
Append Streams
Block This Step Until Steps Finish
Blocking Step
Detect Empty Stream
Dummy (do nothing)
ETL Metadata Injection
Filter Rows
Identify Last Row in a Stream
Java Filter
Prioritize Streams
Single Threader
Switch / Case
Scripting
Execute Row SQL Script
Execute SQL Script
Formula
Modified JavaScript Value
Regex Evaluation
User Defined Java Class
User Defined Java Expression
Lookup
Call DB Procedure
Check if a Column Exists
Check if File is Locked
Check if Webservice is Available
Database Join
Database Lookup
Dynamic SQL Row
File Exists
Fuzzy Match
HTTP Client
HTTP Post
MaxMind GeoIP Lookup
RESTClient
Stream Lookup
Table Exists
Web Services Lookup
Joins
Join Rows (Cartesian Product)
Merge Join
Merge Rows (diff)
Sorted Merge
XML Join
Data Warehouse
Combination Lookup/Update
Dimension Lookup/Update
Validation
Credit Card Validator
Data Validator
Mail Validator
XSD Validator
Statistics
Analytic Query
Group By
Memory Group By
Output Steps Metrics
Reservoir Sampling
Sample Rows
Univariate Statistics
Palo
Palo Cell Input
Palo Cell Output
Palo Dim Input
Palo Dim Output
Job
Copy Rows to Result
Get Files From Result
Get Rows From Result
Get Variables
Set Files in Result
Set Variables
Mapping
Mapping (sub-transformation)
Mapping Input Specification
Mapping Output Specification
Bulk Loading
ElasticSearch Bulk Insert
Greenplum Bulk Loader
Greenplum Load
Infobright Loader
Ingres VectorWise Bulk Loader
LucidDB Streaming Loader
MonetDB Bulk Loader
MySQL Bulk Loader
Oracle Bulk Loader
PostgreSQL Bulk Loader
Teradata Fastload Bulk Loader
Inline
Injector
Socket Reader
Socket Writer
Data Mining Steps
Weka Scoring
Reservoir Sampling
ARFF Output
Univariate Statistics
Knowledge Flow
Univariate Statistics
Weka Forecasting
Job Entry Reference
File Encryption
Decrypt Files With PGP
Encrypt Files With PGP
Verify File Signature With PGP
Big Data
Amazon EMR Job Executor
Amazon Hive Job Executor
Hadoop Copy Files
Hadoop Job Executor
Oozie Job Executor
Pentaho MapReduce
Pig Script Executor
Sqoop Export
Sqoop Import
General
Start
Dummy
Example Plugin
Job
Set Variables
Success
Transformation
Mail
Get Mails (POP3/IMAP)
Mail
Mail Validator
File Management
Add Filenames to Result
Compare Folders
Convert File Between DOS and Unix
Copy Files
Copy or Remove Result Filenames
Create a Folder
Create File
Delete File
Delete Filenames From Result
Delete Files
Delete Folders
File Compare
HTTP
Move Files
Unzip File
Wait For File
Write to File
Zip File
Conditions
Check DB Connections
Check Files Locked
Check If a Folder is Empty
Check Webservice Availability
Checks If Files Exist
Columns Exist in a Table
Evaluate Files Metrics
Evaluate Rows Number in a Table
File Exists
Simple Evaluation
Table Exists
Wait For
Scripting
JavaScript
Shell
SQL
Bulk Loading
Bulkload From MySQL Into File
Bulkload Into MSSQL
Bulkload Into MySQL
MS Access Bulk Load
XML
Check if XML FIle is Well-Formed
DTD Validator
XSD Validator
XSL Transformation
Utility
Abort Job
Display Msgbox Info
HL7 MLLP Acknowledge
HL7 MLLP Input
Ping a Host
Send Information Using Syslog
Send SNMP Trap
Talend Job Execution
Truncate Tables
Wait for SQL
Write to Log
Repository
Check if Connected to Repository
Export Repository to XML File
File Transfer
FTP Delete
Get a File with FTP
Get a File With FTPS
Get a file with SFTP
Put a File With FTP
Put a File With SFTP
SSH2 Get
SSH2 Put
Upload Files to FTPS
Palo
Palo Cube Create
Palo Cube Delete
Troubleshooting
Changing the Pentaho Data Integration Home Directory Location (.kettle folder)
Changing the Kettle Home Directory within the Pentaho BI Platform
Kitchen can't read KJBs from a Zip export
Generating a PDI Enterprise Repository Configuration Without Running Spoon
Connecting to Enterprise Repositories with Command-Line Tools
Unable to Get List of Repositories Exception
Executing Jobs and Transformations from the Repository on the Carte Server
Database Locks When Reading and Updating From A Single Table
Reading and Updating Table Rows Within a Transformation
Force PDI to use DATE instead of TIMESTAMP in Parameterized SQL Queries
PDI Does Not Recognize Changes Made To a Table
Using ODBC
Sqoop Import into Hive Fails
FAQ: Pentaho Data Integration
Big Data Guide
Getting Started with PDI and Hadoop
Pentaho, Big Data, and Hadoop
About Hadoop
Big Data Resources
Configuring Your Big Data Environment
Setting the Active Hadoop Configuration
Configuring for Cloudera
Configuring for MapR
Creating a New Hadoop Configuration
Working with Big Data and Hadoop in PDI
Pentaho MapReduce Workflow
PDI Hadoop Job Workflow
Hadoop to PDI Data Type Conversion
Hadoop Hive-Specific SQL Limitations
Big Data Tutorials
Hadoop Tutorials
Loading Data into a Hadoop Cluster
Prerequisites
Sample Data
Using a Job Entry to Load Data into Hadoop's Distributed File System (HDFS)
Using a Job Entry to Load Data into Hive
Using a Transformation Step to Load Data into HBase
Transforming Data within a Hadoop Cluster
Extracting Data from a Hadoop Cluster
Reporting on Data within a Hadoop Cluster
MapR Tutorials
Loading Data into a MapR Cluster
Transforming Data within a MapR Cluster
Extracting Data from a MapR Cluster
Reporting on Data within a MapR Cluster
Cassandra Tutorials
MongoDB Tutorials
PDI Hadoop Configurations
Including/Excluding Classes or Packages for a Hadoop Configuration
PDI Big Data Transformation Steps
Avro Input
Cassandra Input
Cassandra Output
CouchDB Input
Hadoop File Input
Hadoop File Output
HBase Input
HBase Output
HBase Row Decoder
MapReduce Input
MapReduce Output
MongoDB Input
MongoDB Output
SSTable Output
PDI Big Data Job Entries
Amazon EMR Job Executor
Amazon Hive Job Executor
Hadoop Copy Files
Hadoop Job Executor
Oozie Job Executor
Pentaho MapReduce
Pig Script Executor
Sqoop Export
Sqoop Import
Aggregation Designer User Guide
Introduction
Pentaho Aggregation Designer Overview
Defining the Data Source
Adding a JDBC Driver
Adding a Simple JNDI Data Source For Design Tools
Simple JNDI Options
Defining Additional Parameters
Selecting a Model
Getting Recommendations Using Aggregate Advisor
Customizing Aggregates
Customizing an aggregate
Adding Aggregates
Deleting Aggregates
Exporting Aggregates
Glossary of Terms
Aggregate
Aggregate Tables
Aggregation
Data Definition Language (DDL)
Mondrian Schema
Relational Online Analytic Processing (ROLAP)
Snowflake Schema
Pentaho User Console Guide
Introduction
Pentaho User Console Basics
Logging into the Pentaho User Console
Navigating the Pentaho User Console
Creating a New Solution Folder
Deleting a Solution Folder
Using My Workspace
Creating Reports
Role and User Based Access
Using Pentaho Interactive Reporting
Selecting a Data Source
Creating a New Interactive Report
Saving Interactive Reports
Filtering Reports
Adding a Filter
Creating Advanced Filters
Applying a Summary Function
Applying an Aggregate Function
Flagging a Filter Constraint for Use as a Dashboard Parameter
Adding a Filter on Date Fields
Disabling Auto Refresh Mode in Interactive Reports
Enabling Row Limit and Query Timeout
Refining Your Report
Editing Report Headers and Footers
Editing the Report Title
Reordering and Adjusting Columns
Formatting Reports
Changing the Report Template
Changing Page Format and Orientation
Changing a Column Header Name
Applying Copy/Paste Formatting
Changing the Format of Numeric Values
Editing Interactive Reports
Interactive Reports and Report Designer
Examining an Interactive Report in View-Only Mode
Interactive Reporting Quick Reference
Using Pentaho Analyzer
Creating a New Analyzer Report
Adding Filters to an Analyzer Report
Adding Query Parameters to Analyzer Reports
Exporting an Analyzer Report
Displaying Member Properties
Configuring Drill-Down Links
Disabling Auto Refresh Mode
Defining Hyperlinks
Simple Conditional Formatting of Measures
Conditional Formatting Types
Analyzer Visualizations
Setting Chart Options
Displaying Multi-Charts in Analyzer
Geography Map Visualizations In Analyzer
Customizing Geography Map Visualizations In Analyzer
Scatter Chart Visualizations In Analyzer
Customizing Scatter Chart Visualizations In Analyzer
Heat Grid Visualizations In Analyzer
Customizing Heat Grid Visualizations In Analyzer
Creating a New Analysis View
Using Pentaho Dashboard Designer
Creating a New Dashboard
Working with the Chart Designer
Adding Data to a Chart
Working with Pie Charts
Working with Dial Charts
Correcting Scaling Issues
Rotating Chart Axis Labels
Editing a Chart
Adding a Data Table to a Dashboard
Updating the Data Table Display
Adding a Report Designer Report to a Dashboard
Adding an Action Sequence to a Dashboard
Adding an Analyzer Report to a Dashboard
Adding a Web Site to a Dashboard
Implementing Filters
Filtering Dashboards
Creating a SQL List
Creating a Metadata List
Creating a Cascading Filter
Editing Filters
Linking Dashboard Filters to Analyzer Parameters
Dashboard Parameters
Creating Chart or Data Table Parameters With the Query Editor
Dynamic Dashboard Titles
Using Content Linking to Create Interactive Dashboards
Linking Charts and Data Tables
Linking Columns in a Data Table to Content in other Dashboard Panels
Creating Content to Content Links in an Analyzer Report
Linking an Analyzer Chart to a Report
Linking an Action Sequence Parameter to Content in other Dashboard Panels
Controlling a Dashboard Parameter From a PRPT Hyperlink
Adding Content to a Dashboard Using Drag-and-Drop
Adjusting Whitespace in Dashboard Panels
Setting the Refresh Interval
Using Pentaho Mobile
Setting Up Mobile Access
Getting Started with Pentaho Mobile
Creating a Shortcut Using Safari
Working with the Home Screen
Navigating Files
Creating and Removing Favorites
Settings
Working with Pentaho Mobile Tools
Using the Overlay Toolbar
Mobile Reports
Mobile Analyzer
Mobile Dashboards
Administration and Advanced User Topics
Customizing the Pentaho User Console
Adding a Data Source in the Pentaho User Console
Connecting to Your Database
Creating a SQL Query Data Source in the Pentaho User Console
Creating a CSV Data Source in the Pentaho User Console
Increasing the CSV File Upload Limit
Changing the Staging Database
Creating Database Table(s) Data Sources
Reporting Only
Reporting and Analysis
Creating a Database Table Data Source (Reporting Only)
Creating a Database Table Data Source (Reporting and Analysis)
Where Metadata Models and Mondrian Schemas are Stored
Using the Modeler to Customize a Data Source
Customizing a Reporting Data Source
Customizing an Analysis Data Source
Editing a Database Connection in the Pentaho User Console
Deleting a Database Connection in the Pentaho User Console
Deleting a Data Source in the Pentaho User Console
Adding Member Properties
Auto Modeling Geography Dimension
Scheduling Reports
Scheduling a Report
Quartz Cron Attributes
Deactivating Schedules
Refreshing the Reporting Data Cache
Pentaho Interactive Report Settings
Troubleshooting
Analysis Guide
Introduction
ROLAP Defined
Pentaho Analysis Enterprise Edition Features
Workflow Overview
Dimensional Modeling
Virtual ROLAP Cubes
Prototyping With Pentaho Data Integration
Creating a Prototype Schema With a Non-PDI Data Source
Creating a Prototype Schema With a PDI Data Source
Testing With Pentaho Analyzer and Report Wizard
Prototypes in Production
Creating and Modifying Mondrian Schemas
Schema Workbench Notes
Adding a Data Source in Schema Workbench
Adding a Simple JNDI Data Source For Design Tools
Simple JNDI Options
Adding a JDBC Driver
Removing Mondrian Data Sources
Creating a Mondrian Schema
Using MDX Mode and Hand-Editing a Schema
Adding Business Groups
Adding Field Descriptions
Building a Schema and Detecting Errors
Adapting Mondrian Schemas to Work with Pentaho Analyzer
Applying Relative Date Filters
Adjusting for Calculated Members and Named Sets
Adding Geo Map Support to a Mondrian Schema
Localization/Internationalization of Analysis Schemas
BA Server and Thin Client Message Bundles
Pentaho Analyzer Localization
Setting a Default Font for PDF Exports
Analysis Schema Security
Restricting Access to Specific Members
Mondrian Role Mapping in the BA Server
The Mondrian One-To-One UserRoleMapper
The Mondrian SampleLookupMap UserRoleMapper
The Mondrian SampleUserSession UserRoleMapper
Restricting ROLAP Schemas Per User
Configuring Analysis Options
Managing Analysis Data Sources
Configuring the Mondrian Engine (mondrian.properties)
Configuring Pentaho Analyzer (analyzer.properties)
Adjusting Drill Link Limitations
All Filter Parameter
Defining Global Default Chart Options in Analyzer
Analyzer Chart Properties
Divide by Zero Display
PDF Logo and Cover Page Customization
Setting Query Limits
Mondrian Cache Control
Segment Cache Architecture
Cache Configuration Files
Modifying the JGroups Configuration
Switching to Another Cache Framework
Switching to Memcached
Memcached Configuration Options
Switching to Pentaho Platform Delegating Cache
Using a Custom SegmentCache SPI
Clearing the Mondrian Cache
Visualizing Your Data
Introduction to the Multidimensional Expression Language (MDX)
Further Reading
Creating Analyzer Reports and Analysis Views
Creating a New Analyzer Report
Adding Query Parameters to Analyzer Reports
Configuring Drill-Down Links
Displaying Member Properties
Disabling Auto Refresh Mode
Defining Hyperlinks
Number Formatting
Conditional Formatting
Simple Conditional Formatting of Measures
Conditional Formatting Types
Advanced Conditional Formatting With MDX Expressions
Conditional Formatting Expressions
Analyzer Visualizations
Geography Map Visualizations In Analyzer
Customizing Geography Map Visualizations In Analyzer
Scatter Chart Visualizations In Analyzer
Customizing Scatter Chart Visualizations In Analyzer
Heat Grid Visualizations In Analyzer
Customizing Heat Grid Visualizations In Analyzer
Setting Chart Options
Displaying Multi-Charts in Analyzer
Drilling in Charts
Creating a New Analysis View
Using Analysis Cubes in Report Designer
Adding an OLAP Data Source
Creating an MDX Query
Logging
Analysis SQL Output Logging
Enabling Segment Cache Logging
Viewing Log Output in Analyzer
Troubleshooting
Old Analysis Schemas Still Show Up in Pentaho User Console
Multi-Byte Characters Don't Appear In PDFs Exported From Analyzer
Mondrian Schema Element Quick Reference
AggExclude
AggFactCount
AggForeignKey
AggIgnoreColumn
AggLevel
AggMeasure
AggName
AggPattern
AggTable
CalculatedMember
CalculatedMemberProperty
CaptionExpression
Closure
ColumnDef
ColumnDefs
Cube
CubeGrant
CubeUsage
CubeUsages
Dimension
DimensionGrant
DimensionUsage
Formula
Hierarchy
HierarchyGrant
InlineTable
Join
KeyExpression
Level
Measure
MeasureExpression
MemberGrant
NamedSet
NameExpression
OrdinalExpression
Parameter
ParentExpression
Property
PropertyExpression
Role
RoleUsage
Row
Rows
Schema
SchemaGrant
SQL
Table
Union
UserDefinedFunction
Value
View
VirtualCube
VirtualCubeDimension
VirtualCubeMeasure
Report Designer User Guide
Introduction
How to Start Report Designer
Starting Report Designer on Windows
Starting Report Designer on Linux
Starting Report Designer on OS X
Report Designer Configuration Directories
Pentaho Reporting Configuration Files
Workflow
Navigating Report Designer
The Welcome Screen
The Report Designer Main Toolbar
Report Designer's Tabbed Views
The Report Workspace
The Structure Pane
The Data Pane
Function Reference
Common Functions
Report Functions
Summary Functions
Running Functions
Advanced Functions
Chart Data Functions
Image Functions
Script Functions
Deprecated Functions
The Style Pane
Style Properties Reference
Font Styles
Text Styles
Text Spacing Styles
Padding Styles
Object Styles
Size & Position Styles
Links Styles
Excel Styles
Sparkline Styles
Page Behavior Styles
Border Styles
The Attributes Pane
Element Attributes Reference
Barcode
Common
Table of Contents
Index
Excel
HTML
HTML-Events
Images
PDF
Pentaho
Query
Query-Metadata
Parameter
Sparkline
Survey-Scale
Swing
Wizard
The Palette
Data Sources and Queries
Supported Data Sources
Adding Data Sources
Adding a JDBC Driver
Adding a JDBC Data Source
Passing Security Information to a Report over a JDBC Connection
Adding a Metadata Data Source
Adding a Pentaho Data Integration Data Source
Adding an OLAP Data Source
Adding an OLAP (Advanced) Data Source
Adding an XML Data Source
Adding a Table Data Source
Adding Advanced Data Sources
Adding a JNDI Data Source
Creating Queries
Hadoop Hive-Specific SQL Limitations
Creating Queries With SQL Query Designer
Creating Queries With Metadata Query Editor
Dynamic Query Scripting
Creating Sub-queries With SQL Query Designer
Adding Report Elements
Report Layout Types
Adding Standard Design Elements
Aligning Elements
Adding Bands
Creating Sub-Reports
Referring to Report Elements by Name or Column Position
Creating a Table of Contents
Creating an Index
Creating Charts
Choosing the Right Chart Type
Creating a JFreeChart Element
Creating a Sparkline Chart
Sparkline
Applying Formatting to Report Elements
Standard Element Formatting
Creating Hyperlinks on Visualizations
Creating a Link to a Report on a Chart
Paste Formatting
Morphing an Element
Implementing Row Banding
Performing Calculations
Using the Formula Editor
Common Formulas
Conditional Formatting
Calculated Dates
Date and Time Parameters
Page Numbering
Summarizing Data in Groups
Output Parameterization
Simple SQL Output Parameterization
Advanced SQL Output Parameterization
Simple Metadata Output Parameterization
Simple OLAP Output Parameterization
Permanently Overriding the Auto-Submit Option
Integration With the Pentaho BA Server
Publishing to the BA Server
Editing an Interactive Report (.prpti) in Report Designer
Hiding Reports
Linking Reports
Linking in Tabs
Localizing a Report
Using Externalized Message Bundles
Creating Report Design Wizard and Interactive Reporting Templates
Report Design Wizard Template Design Guidelines
Interactive Reporting Template Design Guidelines
Dynamic Element Positioning in Templates
Template Properties
Deploying a Template to Report Design Wizard
Deploying a Template to Interactive Reporting
Setting the Default Interactive Reporting Template
Troubleshooting
Enabling Multi-Valued report Parameters for Metadata-based Queries Created with Previous Versions of Report Designer
Report Elements With Dynamic Heights Overlap Other Elements
Columns Unexpectedly Merge When Exporting to Excel
Tutorials
Creating a Report Using Report Designer
Designing Your Report
Refining Your Report
More about Row Banding, Data Formatting, and Alignment
Adding a Chart to Your Report
Adding Parameters to Your Report
Publishing Your Report
Chart Types
Bar
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
stacked
stacked-percent
horizontal
bar-borders
max-bar-width
series-color
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
item-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Line
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
line-style
line-size
show-markers
horizontal
series-color
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Area
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
stacked
stacked-percent
horizontal
series-color
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Pie
Data Collectors
PieSet
Chart Properties
Required
name
data-source
ignore-nulls
ignore-zeros
no-data-message
Title
chart-title
chart-title-field
title-font
Options
slice-colors
show-labels
label-font
label-format
rotate-clockwise
explode-slice
explode-pct
General
3-D
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
shadow-paint
shadow-x-offset
shadow-y-offset
url-formula
tooltip-formula
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
legend-label-format
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Multi-Pie
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
by-row
series-color
show-labels
label-font
label-format
General
3-D
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
shadow-paint
shadow-x-offset
shadow-y-offset
url-formula
tooltip-formula
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Bar Line Combination
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
bar-data-source
line-data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
stacked
stacked-percent
horizontal
series-color
max-bar-width
bar-borders
ctgry-tick-font
line-style
line-size
show-markers
line-series
lines-label-font
line-tick-fmt
line-tick-font
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
item-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
y2-same-as-y-axis
y2-axis-title
y2-font
y2-tick-interval
y2-tick-font
y2-min
y2-max
y2-tick-period
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Ring
Data Collectors
PieSet
Chart Properties
Required
name
data-source
ignore-nulls
ignore-zeros
no-data-message
Title
chart-title
chart-title-field
title-font
Options
slice-colors
show-labels
label-font
label-format
rotate-clockwise
explode-slice
explode-pct
section-depth
General
3-D
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
shadow-paint
shadow-x-offset
shadow-y-offset
tooltip-formula
url-formula
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
legend-label-format
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Bubble
Data Collectors
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
horizontal
series-color
max-bubble-size
show-labels
label-font
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Scatter Plot
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
stacked
horizontal
series-color
dot-height
dot-width
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
show-labels
label-font
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
XY Bar
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
stacked
horizontal
series-color
bar-borders
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
show-labels
label-font
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
XY Line
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
stacked
horizontal
series-color
line-style
line-size
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
show-labels
label-font
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
XY Area
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title-field
title-font
pos-title
chart-title
Options
stacked
horizontal
series-color
line-style
line-size
show-markers
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
label-font
show-labels
tooltip-formula
url-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
XY Extended Line (XY Step, XY StepArea, XY Difference)
Data Collectors
TimeSeries
XYSeries
XYZSeries
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
pos-title
Options
ext-chart-type
stacked
horizontal
series-color
line-style
line-size
show-markers
General
3-D
bg-color
bg-image
show-border
border-color
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
anti-alias
show-labels
label-font
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-sticky-0
x-incl-0
x-min
x-max
x-tick-interval
x-vtick-label
x-tick-font
x-tick-fmt-str
x-tick-period
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Waterfall
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
horizontal
series-color
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
url-formula
tooltip-formula
X Axis
x-axis-title
x-font
x-axis-label-width
x-axis-label-rotation
show-labels
label-rotation
numeric-format
text-format
date-format
category-margin
lower-margin
upper-margin
Y Axis
y-axis-title
y-font
y-sticky-0
y-incl-0
y-auto-range
y-min
y-max
y-tick-interval
y-tick-font
y-tick-fmt-str
y-tick-period
enable-log-axis
log-format
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Radar
Data Collectors
CategorySet
PivotCategorySet
Chart Properties
Required
name
data-source
no-data-message
Title
chart-title
chart-title-field
title-font
Options
line-size
head-size
series-color
gridline-interval
radar-web-filled
General
3-D
gridlines
bg-color
bg-image
show-border
border-color
anti-alias
plot-bg-color
plot-fg-alpha
plot-bg-alpha
plot-border
X Axis
x-font
show-labels
Legend
show-legend
location
legend-bg-color
legend-border
legend-font
legend-font-color
Scripting
Chart Post Processing Script Language
Chart Post Processing Script
Metadata Editor User Guide
About this Guide
Knowledge Prerequisites
A Conceptual Overview of the Pentaho Metadata Editor
The Physical Layer
The Business View
The Abstract Business Layer
Incorporating Metadata
Creating a New Domain
Examining the Default Metadata Model
Setting Up a Database Connection
Adding a JDBC Driver
An Example Connection: A JDBC Connection to a MySQL Database
An Example Connection: A JNDI Connection to a Hypersonic Database
Importing Physical Tables and Columns
Importing Tables Inside a Schema
Creating a Business Model
Creating Business Tables and Columns
Removing Unnecessary Business Columns
Creating Relationships between Business Tables
Creating Relationships Using the Editor Graph
Hadoop Hive-Specific SQL Limitations
Building a Business View
Building a Business View Using Manage Categories
Creating a New Category from a Business Table
Moving Columns into Categories
Adding a New Category
Remove Categories and Columns
Enriching Your Data — Understanding Metadata Concepts and Properties
Exceptions to the Rules
Required Properties
Applying Concepts and Properties in the Pentaho Metadata Editor
Applying Self Concepts: Managing Properties on the Model
The Properties List
The Properties Editor (Settings)
Adding New Properties
Removing a Property
The Concept Editor
Building Concepts
Applying Concepts to Business Objects
Removing the Parent Concept
Adding Security to Metadata Business Objects
Defining Security Settings
Getting Security Settings Offline
Changing Security Constraints
Adding Row Level Security to a Pentaho Metadata Model
Applying Data Constraints
Importing and Exporting Domains
Importing a Domain
Exporting a Domain
Configuring and Managing Locales (Internationalization)
Setting Up Locales
Domain Backup and Recovery
Publishing a Domain to a Pentaho BA Server
Before you Publish Your Domain
Publishing a Domain
Restricting Metadata Models to Specific Client Tools
Metadata Properties Reference
Out-of-the-Box Properties
Custom Properties
Required Properties per Business Object
Pentaho Metadata Formulas
Supported Functions
Supported Operators
Supported Aggregate Functions
Troubleshooting
Managing Multiple Outer-Joins
Using the Delay Outer Join Conditions Property
PDI User Guide
Introduction
Pentaho Data Integration Architecture
Pentaho Data Integration Components
Starting Pentaho Data Integration
Starting the Pentaho Data Integration Servers
Starting Spoon
Installing and Managing Enterprise Edition License Keys
Connecting to the Repository
Storing Content Alternatives
PDI Interface Perspectives
Introducing Perspectives
Data Integration (ETL) Perspective
VFS File Dialogues in Spoon
Model Perspective
Visualization Perspective
Instaview Perspective
Data Mining Perspectives
Forecast Perspective
ScatterPlot3D Perspective
Customizing the Spoon Interface
Terminology and Basic Concepts
Transformations, Steps, and Hops
Jobs
More About Hops
Creating Transformations
Getting Started
Saving Your Transformation
Running Your Transformation Locally
Building a Job
Executing Transformations
Creating a Slave Server in Spoon
Creating a Cluster Schema
Executing Transformations in a Cluster
Executing Jobs and Transformations from the Repository on the Carte Server
Impact Analysis
Working with the Enterprise Repository
Adding an Enterprise Repository
Editing Enterprise Repository Details
Deleting an Enterprise or Kettle Database Repository
Managing Content in the Enterprise Repository
Setting Folder-Level Permissions
Access Control List (ACL) Permissions
Exporting Content from an Enterprise Repositories with Command-Line Tools
Working with Version Control
Examining Version History
Restoring a Previously Saved Version of a Job or Transformation
Reusing Transformation Flows with Mapping Steps
Arguments, Parameters, and Variables
Arguments
Parameters
VFS Properties
Configuring SFTP VFS
Variables
Variable Scope
Environment Variables
Kettle Variables
Internal Variables
Rapid Analysis Schema Prototyping
Creating a Prototype Schema With a Non-PDI Data Source
Creating a Prototype Schema With a PDI Data Source
Testing With Pentaho Analyzer and Report Wizard
Prototypes in Production
Managing Connections
Adding a JDBC Driver
Defining Database Connections
Working with JNDI Connections
Working with JNDI Connections in Carte and Spoon
Database-Specific Options
Adding Database-Specific Options
Database Connections Advanced Configurations
Connection Pooling
Clustering
Editing, Duplicating, Copying, and Deleting Connections
Using the SQL Editor
Using the Database Explorer
Unsupported Databases
Performance Monitoring and Logging
Monitoring Step Performance
Using Performance Graphs
Logging Steps
Logging Transformations
Pentaho Data Integration Performance Tuning Tips
Working with Big Data and Hadoop in PDI
Pentaho MapReduce Workflow
PDI Hadoop Job Workflow
Hadoop to PDI Data Type Conversion
Hadoop Hive-Specific SQL Limitations
Big Data Tutorials
Hadoop Tutorials
Loading Data into a Hadoop Cluster
Prerequisites
Sample Data
Using a Job Entry to Load Data into Hadoop's Distributed File System (HDFS)
Using a Job Entry to Load Data into Hive
Using a Transformation Step to Load Data into HBase
Transforming Data within a Hadoop Cluster
Extracting Data from a Hadoop Cluster
Reporting on Data within a Hadoop Cluster
MapR Tutorials
Loading Data into a MapR Cluster
Transforming Data within a MapR Cluster
Extracting Data from a MapR Cluster
Reporting on Data within a MapR Cluster
Cassandra Tutorials
MongoDB Tutorials
Interacting With Web Services
Scheduling and Scripting PDI Content
Scheduling Transformations and Jobs From Spoon
Command-Line Scripting Through Pan and Kitchen
Pan Options and Syntax
Pan Status Codes
Kitchen Options and Syntax
Kitchen Status Codes
Importing KJB or KTR Files From a Zip Archive
Connecting to Enterprise Repositories with Command-Line Tools
Exporting Content from an Enterprise Repositories with Command-Line Tools
Transformation Step Reference
Big Data
Avro Input
Cassandra Input
Cassandra Output
CouchDB Input
Hadoop File Input
Hadoop File Output
HBase Input
HBase Output
HBase Row Decoder
MapReduce Input
MapReduce Output
MongoDB Input
MongoDB Output
SSTable Output
Input
Cassandra Input
CSV File Input
Data Grid
De-serialize From File
Email Messages Input
ESRI Shapefile Reader
Fixed File Input
Generate Random Credit Card Numbers
Generate Random Value
Generate Rows
Get Data From XML
Get File Names
Get Files Rows Count
Get Repository Names
Get Subfolder Names
Get System Info
Get Table Names
Google Analytics Input
Setting Up Google Analytics API
Google Analytics Plugin Installation
Google Docs Input
GZIP CSV Input
HBase Input
HL7 Input
JMS Consumer
JSON Input
LDAP Input
LDIF Input
Load File Content In Memory
Microsoft Access Input
Microsoft Excel Input
Mondrian Input
MongoDB Input
OLAP Input
OpenERP Object Input
Palo Cell Input
Palo Dim Input
Property Input
RSS Input
S3 CSV Input
Salesforce Input
SAP Input
SAS Input
Table Input
Text File Input
XBase Input
XML Input Stream (StAX)
YAML Input
Output
Automatic Documentation Output
Cassandra Output
Delete
HBase Output
Insert/Update
JMS Producer
JSON Output
LDAP Output
Microsoft Access Output
Microsoft Excel Output
Microsoft Excel Writer
OpenERP Object Input
Palo Cell Output
Palo Dim Output
Pentaho Reporting Output
Properties Output
RSS Output
S3 File Output
Salesforce Delete
Salesforce Insert
Salesforce Update
Salesforce Upsert
Serialize to File
SQL File Output
Synchronize After Merge
Table Output
Text File Output
Update
XML Output
Transform
Add a Checksum
Add Constants
Add Sequence
Add Value Fields Changing Sequence
Add XML
Calculator
Closure Generator
Example Plugin
Get ID From Slave Server
Number Range
Replace in String
Row Denormalizer
Row Flattener
Row Normalizer
Select Values
Set Field Value
Set Field Value to a Constant
Sort Rows
Split Field to Rows
Split Fields
String Operations
Strings Cut
Unique Rows
Unique Rows (HashSet)
Value Mapper
XSL Transformation
Utility
Change File Encoding
Clone Row
Delay Row
Edit to XML
Execute a Process
If Field Value is Null
Mail
Metadata Structure of Stream
Null if...
Process Files
Run SSH Commands
Send Message to Syslog
Write to Log
Flow
Abort
Append Streams
Block This Step Until Steps Finish
Blocking Step
Detect Empty Stream
Dummy (do nothing)
ETL Metadata Injection
Filter Rows
Identify Last Row in a Stream
Java Filter
Prioritize Streams
Single Threader
Switch / Case
Scripting
Execute Row SQL Script
Execute SQL Script
Formula
Modified JavaScript Value
Regex Evaluation
User Defined Java Class
User Defined Java Expression
Lookup
Call DB Procedure
Check if a Column Exists
Check if File is Locked
Check if Webservice is Available
Database Join
Database Lookup
Dynamic SQL Row
File Exists
Fuzzy Match
HTTP Client
HTTP Post
MaxMind GeoIP Lookup
RESTClient
Stream Lookup
Table Exists
Web Services Lookup
Joins
Join Rows (Cartesian Product)
Merge Join
Merge Rows (diff)
Sorted Merge
XML Join
Data Warehouse
Combination Lookup/Update
Dimension Lookup/Update
Validation
Credit Card Validator
Data Validator
Mail Validator
XSD Validator
Statistics
Analytic Query
Group By
Memory Group By
Output Steps Metrics
Reservoir Sampling
Sample Rows
Univariate Statistics
Palo
Palo Cell Input
Palo Cell Output
Palo Dim Input
Palo Dim Output
Job
Copy Rows to Result
Get Files From Result
Get Rows From Result
Get Variables
Set Files in Result
Set Variables
Mapping
Mapping (sub-transformation)
Mapping Input Specification
Mapping Output Specification
Bulk Loading
ElasticSearch Bulk Insert
Greenplum Bulk Loader
Greenplum Load
Infobright Loader
Ingres VectorWise Bulk Loader
LucidDB Streaming Loader
MonetDB Bulk Loader
MySQL Bulk Loader
Oracle Bulk Loader
PostgreSQL Bulk Loader
Teradata Fastload Bulk Loader
Inline
Injector
Socket Reader
Socket Writer
Data Mining Steps
Weka Scoring
Reservoir Sampling
ARFF Output
Univariate Statistics
Knowledge Flow
Univariate Statistics
Weka Forecasting
Job Entry Reference
File Encryption
Decrypt Files With PGP
Encrypt Files With PGP
Verify File Signature With PGP
Big Data
Amazon EMR Job Executor
Amazon Hive Job Executor
Hadoop Copy Files
Hadoop Job Executor
Oozie Job Executor
Pentaho MapReduce
Pig Script Executor
Sqoop Export
Sqoop Import
General
Start
Dummy
Example Plugin
Job
Set Variables
Success
Transformation
Mail
Get Mails (POP3/IMAP)
Mail
Mail Validator
File Management
Add Filenames to Result
Compare Folders
Convert File Between DOS and Unix
Copy Files
Copy or Remove Result Filenames
Create a Folder
Create File
Delete File
Delete Filenames From Result
Delete Files
Delete Folders
File Compare
HTTP
Move Files
Unzip File
Wait For File
Write to File
Zip File
Conditions
Check DB Connections
Check Files Locked
Check If a Folder is Empty
Check Webservice Availability
Checks If Files Exist
Columns Exist in a Table
Evaluate Files Metrics
Evaluate Rows Number in a Table
File Exists
Simple Evaluation
Table Exists
Wait For
Scripting
JavaScript
Shell
SQL
Bulk Loading
Bulkload From MySQL Into File
Bulkload Into MSSQL
Bulkload Into MySQL
MS Access Bulk Load
XML
Check if XML FIle is Well-Formed
DTD Validator
XSD Validator
XSL Transformation
Utility
Abort Job
Display Msgbox Info
HL7 MLLP Acknowledge
HL7 MLLP Input
Ping a Host
Send Information Using Syslog
Send SNMP Trap
Talend Job Execution
Truncate Tables
Wait for SQL
Write to Log
Repository
Check if Connected to Repository
Export Repository to XML File
File Transfer
FTP Delete
Get a File with FTP
Get a File With FTPS
Get a file with SFTP
Put a File With FTP
Put a File With SFTP
SSH2 Get
SSH2 Put
Upload Files to FTPS
Palo
Palo Cube Create
Palo Cube Delete
Troubleshooting
Changing the Pentaho Data Integration Home Directory Location (.kettle folder)
Changing the Kettle Home Directory within the Pentaho BI Platform
Kitchen can't read KJBs from a Zip export
Generating a PDI Enterprise Repository Configuration Without Running Spoon
Connecting to Enterprise Repositories with Command-Line Tools
Unable to Get List of Repositories Exception
Executing Jobs and Transformations from the Repository on the Carte Server
Database Locks When Reading and Updating From A Single Table
Reading and Updating Table Rows Within a Transformation
Force PDI to use DATE instead of TIMESTAMP in Parameterized SQL Queries
PDI Does Not Recognize Changes Made To a Table
Using ODBC
Sqoop Import into Hive Fails
FAQ: Pentaho Data Integration
Big Data Guide
Getting Started with PDI and Hadoop
Pentaho, Big Data, and Hadoop
About Hadoop
Big Data Resources
Configuring Your Big Data Environment
Setting the Active Hadoop Configuration
Configuring for Cloudera
Configuring for MapR
Creating a New Hadoop Configuration
Working with Big Data and Hadoop in PDI
Pentaho MapReduce Workflow
PDI Hadoop Job Workflow
Hadoop to PDI Data Type Conversion
Hadoop Hive-Specific SQL Limitations
Big Data Tutorials
Hadoop Tutorials
Loading Data into a Hadoop Cluster
Prerequisites
Sample Data
Using a Job Entry to Load Data into Hadoop's Distributed File System (HDFS)
Using a Job Entry to Load Data into Hive
Using a Transformation Step to Load Data into HBase
Transforming Data within a Hadoop Cluster
Extracting Data from a Hadoop Cluster
Reporting on Data within a Hadoop Cluster
MapR Tutorials
Loading Data into a MapR Cluster
Transforming Data within a MapR Cluster
Extracting Data from a MapR Cluster
Reporting on Data within a MapR Cluster
Cassandra Tutorials
MongoDB Tutorials
PDI Hadoop Configurations
Including/Excluding Classes or Packages for a Hadoop Configuration
PDI Big Data Transformation Steps
Avro Input
Cassandra Input
Cassandra Output
CouchDB Input
Hadoop File Input
Hadoop File Output
HBase Input
HBase Output
HBase Row Decoder
MapReduce Input
MapReduce Output
MongoDB Input
MongoDB Output
SSTable Output
PDI Big Data Job Entries
Amazon EMR Job Executor
Amazon Hive Job Executor
Hadoop Copy Files
Hadoop Job Executor
Oozie Job Executor
Pentaho MapReduce
Pig Script Executor
Sqoop Export
Sqoop Import
Aggregation Designer User Guide
Introduction
Pentaho Aggregation Designer Overview
Defining the Data Source
Adding a JDBC Driver
Adding a Simple JNDI Data Source For Design Tools
Simple JNDI Options
Defining Additional Parameters
Selecting a Model
Getting Recommendations Using Aggregate Advisor
Customizing Aggregates
Customizing an aggregate
Adding Aggregates
Deleting Aggregates
Exporting Aggregates
Glossary of Terms
Aggregate
Aggregate Tables
Aggregation
Data Definition Language (DDL)
Mondrian Schema
Relational Online Analytic Processing (ROLAP)
Snowflake Schema
Tutorials and Walkthroughs
Getting Started with Pentaho Business Analytics
Welcome
Overview
Components Included in this Release
Thin Client Tools
Design Tools
Server Applications
System Requirements
Installing Pentaho Business Analytics
Logging into the Pentaho User Console
Starting and Stopping the Servers
Examining Sample Reports
Inventory List Report
Top Five Product Lines by Territory
Regional Sales Performance Dashboard
Creating a Data Source
Adding a JDBC Driver
Connecting to Your Database
Creating a Database Table(s) Data Source (Reporting and Analysis)
Customizing the Data Source
Creating a New Analyzer Report
Working with Dashboards
Defining Your Dashboard Look-and-Feel
Adding Data to Your Dashboard
Saving Your Dashboard
Editing Your Dashboard
Appendix: Troubleshooting Your Installation
Verifying Your Installation
Referencing Your Installation Summary
Resolving an Unable to Connect Error
Resolving a License Not Found Error
Default Port Configuration
Getting Started with Pentaho Data Integration
Introduction
Pentaho Data Integration Architecture
Downloading Pentaho Data Integration
Installing Pentaho Data Integration
Starting the Spoon Client Tool
Starting the Data Integration Server
Pentaho Data Integration Folders and Scripts
Adding a JDBC Driver
Connecting to the Enterprise Repository
Navigating through the Interface
Introducing Perspectives
Instaview Perspective
Creating Transformations
Retrieving Data from a Flat File (Text File Input Step)
Saving Your Transformation
Filter Records with Missing Postal Codes (Filter Rows Step)
Loading Your Data into a Relational Database (Table Output Step)
Retrieving Data from your Lookup File (Text File Input Step)
Resolving Missing Zip Code Information (Stream Lookup Step)
Completing your Transformation (Select Values Step)
Running Your Transformation
Creating Jobs
Scheduling Jobs
Building Business Intelligence Solutions Using Agile BI
Using Agile BI
Correcting the Data Quality Issue
Creating a Top Ten Countries by Sales Chart
Breaking Down Your Chart by Deal Size
Wrapping it Up
Getting Started with PDI and Hadoop
Pentaho, Big Data, and Hadoop
About Hadoop
Big Data Resources
Why Choose Enterprise Edition?
Professional, Technical Support
Enterprise Edition Features
Certified Software Releases
Troubleshooting
I don't know what the default login is for the DI Server, Enterprise Console, and/or Carte
Getting Started with Pentaho Report Designer
Introduction to Pentaho Report Designer
Tutorials
Creating a Report Using Report Designer
Designing Your Report
Refining Your Report
More about Row Banding, Data Formatting, and Alignment
Adding a Chart to Your Report
Adding Parameters to Your Report
Publishing Your Report
Further Reading
Getting Started with PDI Instaview
Introduction to Instaview
What is Instaview?
Installing Instaview
Starting Instaview
Using Instaview
Connecting to Data in Instaview
Creating an Analyzer Report in Instaview
Correcting Data Quality Issues in Instaview
Clearing and Refreshing the Data Cache in Instaview
Adding a Filter in Instaview
Creating Visualizations in Instaview
Creating a Chart in Instaview
Creating a Geographic Map in Instaview
Using Conditional Formatting in Instaview
Configuring an Existing Instaview
Opening Existing Instaviews
Saving an Instaview
Closing an Instaview
Deleting an Instaview
Editing Instaview Data Sources
Managing Visualizations in Instaview
Navigating The Instaview Interface
Configure Mode
View Mode
Advanced User Topics
Advanced Analyzer Report Formatting Data in Instaview
Setting Chart Options
Customizing Geo Map Appearance
Editing Instaview Data Transformations
Editing Instaview Metadata Models
Getting Started with Pentaho Business Analytics
Welcome
Overview
Components Included in this Release
Thin Client Tools
Design Tools
Server Applications
System Requirements
Installing Pentaho Business Analytics
Logging into the Pentaho User Console
Starting and Stopping the Servers
Examining Sample Reports
Inventory List Report
Top Five Product Lines by Territory
Regional Sales Performance Dashboard
Creating a Data Source
Adding a JDBC Driver
Connecting to Your Database
Creating a Database Table(s) Data Source (Reporting and Analysis)
Customizing the Data Source
Creating a New Analyzer Report
Working with Dashboards
Defining Your Dashboard Look-and-Feel
Adding Data to Your Dashboard
Saving Your Dashboard
Editing Your Dashboard
Appendix: Troubleshooting Your Installation
Verifying Your Installation
Referencing Your Installation Summary
Resolving an Unable to Connect Error
Resolving a License Not Found Error
Default Port Configuration
Getting Started with Pentaho Data Integration
Introduction
Pentaho Data Integration Architecture
Downloading Pentaho Data Integration
Installing Pentaho Data Integration
Starting the Spoon Client Tool
Starting the Data Integration Server
Pentaho Data Integration Folders and Scripts
Adding a JDBC Driver
Connecting to the Enterprise Repository
Navigating through the Interface
Introducing Perspectives
Instaview Perspective
Creating Transformations
Retrieving Data from a Flat File (Text File Input Step)
Saving Your Transformation
Filter Records with Missing Postal Codes (Filter Rows Step)
Loading Your Data into a Relational Database (Table Output Step)
Retrieving Data from your Lookup File (Text File Input Step)
Resolving Missing Zip Code Information (Stream Lookup Step)
Completing your Transformation (Select Values Step)
Running Your Transformation
Creating Jobs
Scheduling Jobs
Building Business Intelligence Solutions Using Agile BI
Using Agile BI
Correcting the Data Quality Issue
Creating a Top Ten Countries by Sales Chart
Breaking Down Your Chart by Deal Size
Wrapping it Up
Getting Started with PDI and Hadoop
Pentaho, Big Data, and Hadoop
About Hadoop
Big Data Resources
Why Choose Enterprise Edition?
Professional, Technical Support
Enterprise Edition Features
Certified Software Releases
Troubleshooting
I don't know what the default login is for the DI Server, Enterprise Console, and/or Carte
Getting Started with Pentaho Report Designer
Introduction to Pentaho Report Designer
Tutorials
Creating a Report Using Report Designer
Designing Your Report
Refining Your Report
More about Row Banding, Data Formatting, and Alignment
Adding a Chart to Your Report
Adding Parameters to Your Report
Publishing Your Report
Further Reading
Getting Started with PDI Instaview
Introduction to Instaview
What is Instaview?
Installing Instaview
Starting Instaview
Using Instaview
Connecting to Data in Instaview
Creating an Analyzer Report in Instaview
Correcting Data Quality Issues in Instaview
Clearing and Refreshing the Data Cache in Instaview
Adding a Filter in Instaview
Creating Visualizations in Instaview
Creating a Chart in Instaview
Creating a Geographic Map in Instaview
Using Conditional Formatting in Instaview
Configuring an Existing Instaview
Opening Existing Instaviews
Saving an Instaview
Closing an Instaview
Deleting an Instaview
Editing Instaview Data Sources
Managing Visualizations in Instaview
Navigating The Instaview Interface
Configure Mode
View Mode
Advanced User Topics
Advanced Analyzer Report Formatting Data in Instaview
Setting Chart Options
Customizing Geo Map Appearance
Editing Instaview Data Transformations
Editing Instaview Metadata Models
Installation and Upgrade Guides
Pentaho Business Analytics Graphical Installation Guide
Installation Overview
The Pentaho Directory Structure: Graphical Installer
Installation Checklist
Prerequisites
Obtaining the Pentaho Business Analytics Graphical Installer
How to Check Your Java Version
Graphical Installer Procedures
Installing on Linux
Local User Accounts on Linux
Creating a Pentaho System User on Linux
Using the Graphical Installer on Linux
Preparing a Headless Linux or Solaris Server
Starting the Servers At Boot Time On Linux
Using the Graphical Installer on Mac Operating Systems
Using the Graphical Installer on Windows Operating Systems
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Workstation Installation Procedure
Testing and Using Your Server
Post-install Configurations
Creating Directories and Accounts
Preparing for Production
Removing Pentaho Sample Data and Solutions
Switching to a Production Login Screen
Customizing Port Numbers
Master Service Control Scripts From the Graphical Installer
Default Pentaho Business Analytics Port Numbers
Uninstalling Pentaho Business Analytics
Compatibility Matrix: Supported Components
JDBC Drivers
Troubleshooting
Evaluation Licenses are Not Granted
Pentaho Business Analytics Archive-Based Installation Guide
Archive-Based Installation Overview
Prerequisites
Installation Checklist
Obtaining the Installation Materials
Creating a Pentaho System User on Linux
Local User Accounts on Linux
Setting the PENTAHO_JAVA_HOME Variable on Linux
Setting the PENTAHO_JAVA_HOME Variable on Windows
How to Check Your Java Version
Deploying the BA Server
Copying Solution Database JDBC Drivers
Initializing a MySQL Database
MySQL Solution Repository Configuration
Configuring Quartz For MySQL
Configuring Audit Logging For MySQL
Initializing a PostgreSQL Database
PostgreSQL Solution Repository Configuration
Configuring Quartz For PostgreSQL
Configuring Audit Logging For PostgreSQL
Initializing an Oracle Database
Oracle Solution Repository Configuration
Configuring Quartz For Oracle
Configuring Audit Logging For Oracle
Changing the Solution Database Hostname
Customizing Port Numbers
Installing Pentaho User Console Plugins
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Initial Startup of the BA Server and Pentaho Enterprise Console
Post-Install Configuration
Preparing a Headless Linux or Solaris Server
Starting the BA Server At Boot Time On Linux
Starting the BA Server At Boot Time On Solaris
Starting the BA Server At Boot Time On Windows
Post-Install Configuration
Installing the Pentaho Client Design Tools
Preparing for Production
Removing Pentaho Sample Data and Solutions
Switching to a Production Login Screen
Compatibility Matrix: Supported Components
JDBC Drivers
Troubleshooting
Version Check
File Names and Paths
Examining Log Files
Unable to Use the Database Init Scripts for PostgreSQL
context.xml Changes Do Not Take Effect After Deploying a WAR
JDBC Driver Problems
Licenses Not Found After Installation
Cannot Create Hibernate Tables in MySQL
Action Sequences That Call PDI Content Won't Run
Adding PDI Enterprise Repository Content Support to the BA Server
Pentaho BA Server Manual Deployment Guide
Manual Deployment Overview
Installation Checklist
Prerequisites
Local User Accounts on Linux
Creating a Pentaho System User on Linux
How to Check Your Java Version
Setting the PENTAHO_JAVA_HOME Variable on Linux
Setting the PENTAHO_JAVA_HOME Variable on Windows
Setting the PENTAHO_INSTALLED_LICENSE_PATH Variable on Linux
Setting the PENTAHO_INSTALLED_LICENSE_PATH Variable on Windows
Preparing a Headless Linux or Solaris Server
Obtaining the Pentaho BA Server Build Materials
Building the BA Server
Establishing a context.xml File For Tomcat
Solution Repository JNDI Configuration Files for JBoss Deployments
Changing the Web Application Context
Changing the Web Application Name on Tomcat
Changing the Web Application Name on JBoss
Customizing Port Numbers
Creating a Pentaho Directory
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Copying the Oracle Quartz JAR Pre-Build
Removing the Xalan JAR for JBoss Deployments
How to Build BA Server WARs with Apache Ant
Ant Build Options
Moving JDBC Drivers
Deploying the BA Server Web Application
Moving the Pentaho Solutions Directory
Installing Pentaho User Console Plugins
Removing the Sample Pentaho Analysis Data Source
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Initializing a PostgreSQL Database
PostgreSQL Solution Repository Configuration
Configuring Quartz For PostgreSQL
Configuring Audit Logging For PostgreSQL
Initializing a MySQL Database
MySQL Solution Repository Configuration
Configuring Quartz For MySQL
Configuring Audit Logging For MySQL
Initializing an Oracle Database
Oracle Solution Repository Configuration
Configuring Quartz For Oracle
Configuring Audit Logging For Oracle
Deploying to Tomcat
Modifying startup.bat on Windows
Modifying startup.sh on Linux and Solaris
Modifying server.xml To Work With Accented Characters
Deploying a WAR to Tomcat
Deploying to JBoss
Modifying run.bat on Windows
Modifying run.conf on Linux and Solaris
Deploying a WAR to JBoss
Adding PDI Enterprise Repository Content Support to the BA Server
Installing the Pentaho Enterprise Console: Linux/OS X/Windows
Installing the Pentaho Enterprise Console: Solaris
Initial Startup of the BA Server and Pentaho Enterprise Console
Post-Install Configuration
Testing and Using Your Server
Preparing for Production
Switching to a Production Login Screen
Compatibility Matrix: Supported Components
JDBC Drivers
Troubleshooting
Version Check
Examining Log Files
File Names and Paths
JDBC Driver Problems
Licenses Not Found After Installation
Cannot Create Hibernate Tables in MySQL
Unable to Use the Database Init Scripts for PostgreSQL
context.xml Changes Do Not Take Effect After Deploying a WAR
vfs-provider.xml Duplicates
Library Conflicts
Varying Context and Data Source Configuration Methods
Report Parameters That Include Accented Characters Fail to Validate
JBoss Fails to Start When the Pentaho HSQLDB Sample Database Is Running
JBoss Fails to Start After Manually Unpacking pentaho.war
Web-App Path doesn't validate in Enterprise Console
Action Sequences That Call PDI Content Won't Run
Adding PDI Enterprise Repository Content Support to the BA Server
Appendix: Installation Notes For FreeBSD
Pentaho Data Integration Installation Guide
Installation Overview
Installation Methods
The Graphical Installer
The Archive-Based Installation Process
Installation Checklist: Server
Installation Checklist: Workstation
Prerequisites for Archive Installation
How to Check Your Java Version
Local User Accounts on Linux
Creating a Pentaho System User on Linux
Setting the PENTAHO_JAVA_HOME Variable on Linux
Setting the PENTAHO_JAVA_HOME Variable on Windows
Obtaining the Archive Packages
Server Installation Procedure
Server Archive Package Deployment
Installing or Updating License Keys Using the Pentaho Enterprise Console
Working From the Command Line Interface
Installing License Keys from the Command-line Interface
Post-Install Configuration
Starting the DI Server At Boot Time On Linux
Switching LDAP Authentication
Workstation Installation Procedures
Workstation Archive Package Deployment
Configuring Monetdb for Instaview
Troubleshooting Monetdb for Instaview
Connecting to an Enterprise Repository
Testing and Cleanup
Adding PDI Enterprise Repository Content Support to the BA Server
Adding a JDBC Driver
Compatibility Matrix: Supported Components
JDBC Drivers
Business Analytics Upgrade Guide
Introduction
New Features in 4.8
Introducing Pentaho Mobile
Introducing Instaview
New Features in Big Data
New Features in Pentaho Data Integration
New Features in Analyzer, Dashboards, and Interactive Reporting
New Features in Information Assets
Best Practices for Production Upgrades
Prerequisites
Backing Up
Stopping the Solution Database Service on Windows
How to Check Your Java Version
Default Port Configuration
Upgrading the BA Server
Manual WAR Deployment
Manual Deployment Upgrade Checklist
Obtaining the Pentaho BA Server Build Materials
Changes to the Solution Database
The Solution Database: Upgrading the Quartz Schema
Removing the Xalan JAR for JBoss Deployments
Copying the Oracle Quartz JAR Pre-Build
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Building New WAR Files
Building and Deploying a New JBoss WAR
Building and Deploying a New Tomcat WAR
Rebuilding the Solutions Directory
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Installing Pentaho User Console Plugins
Continuing the Manual Upgrade Process
Archive-Based Deployment
Archive Deployment Upgrade Checklist
Obtaining the Installation Materials
Deploying the BA Server
Changes to the Solution Database
The Solution Database: Upgrading the Quartz Schema
Copying Solution Database JDBC Drivers
Copying context.xml, server.xml, web.xml, and log4j.xml
Installing Pentaho User Console Plugins
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Removing Pentaho Sample Data and Solutions
Continuing the Archive-Based Upgrade Process
Business Analytics Graphical Installer Deployment
Graphical Installer Deployment Upgrade Checklist
Obtaining the Installation Materials
Deploying the BA Server
Copying context.xml, server.xml, web.xml, and log4j.xml
Changes to the Solution Database
The Solution Database: Upgrading the Quartz Schema
Installing Pentaho User Console Plugins
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Copying Startup Scripts
Copying Windows 64-bit Tomcat Executables
Copying Windows Start Menu Icons
Removing Pentaho Sample Data and Solutions
Migrating Your Solutions
Merging Your BA Server Configuration Files
Updating pentahoObjects.spring.xml
Updating applicationContext-spring-security.xml
Updating web.xml
Upgrading Your Single-Sign On Configuration
CAS Property Reference
Upgrading the Pentaho Enterprise Console
Moving JDBC Drivers
Testing Your New BA Server
Upgrading the Pentaho Client Tools
Post-Upgrade Configuration
Cleanup
Compatibility Matrix: Supported Components
JDBC Drivers
Troubleshooting
File Names and Paths
Examining Log Files
JDBC Driver Problems
Unable to Use the Database Init Scripts for PostgreSQL
context.xml Changes Do Not Take Effect After Deploying a WAR
Tomcat Logs Report Memory Leaks
User Console Themes Render Improperly After Upgrade
PDI Upgrade Guide
Introduction
Introducing Instaview
New Features in Pentaho Data Integration
Upgrade Best Practices
Upgrade Checklist
Downloading Client and Server Packages
Creating Backups
Backing Up Content Files
Backing Up a Database Repository
Moving JDBC Drivers for PDI
How to Back Up the Enterprise Repository
Backing Up the .kettle Directory
Backing Up the data-integration Directory
Upgrading a Data Integration Server
Upgrading the Pentaho Enterprise Console
Upgrading a Data Integration Workstation
Upgrading a Data Integration Work Station in Ubuntu 12
Configuring Monetdb for Instaview
Troubleshooting Monetdb for Instaview
Calculator Step Bug Fix
Upgrading the Google Analytics Step
Testing and Cleanup
Compatibility Matrix: Supported Components
JDBC Drivers
Pentaho Business Analytics Graphical Installation Guide
Installation Overview
The Pentaho Directory Structure: Graphical Installer
Installation Checklist
Prerequisites
Obtaining the Pentaho Business Analytics Graphical Installer
How to Check Your Java Version
Graphical Installer Procedures
Installing on Linux
Local User Accounts on Linux
Creating a Pentaho System User on Linux
Using the Graphical Installer on Linux
Preparing a Headless Linux or Solaris Server
Starting the Servers At Boot Time On Linux
Using the Graphical Installer on Mac Operating Systems
Using the Graphical Installer on Windows Operating Systems
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Workstation Installation Procedure
Testing and Using Your Server
Post-install Configurations
Creating Directories and Accounts
Preparing for Production
Removing Pentaho Sample Data and Solutions
Switching to a Production Login Screen
Customizing Port Numbers
Master Service Control Scripts From the Graphical Installer
Default Pentaho Business Analytics Port Numbers
Uninstalling Pentaho Business Analytics
Compatibility Matrix: Supported Components
JDBC Drivers
Troubleshooting
Evaluation Licenses are Not Granted
Pentaho Business Analytics Archive-Based Installation Guide
Archive-Based Installation Overview
Prerequisites
Installation Checklist
Obtaining the Installation Materials
Creating a Pentaho System User on Linux
Local User Accounts on Linux
Setting the PENTAHO_JAVA_HOME Variable on Linux
Setting the PENTAHO_JAVA_HOME Variable on Windows
How to Check Your Java Version
Deploying the BA Server
Copying Solution Database JDBC Drivers
Initializing a MySQL Database
MySQL Solution Repository Configuration
Configuring Quartz For MySQL
Configuring Audit Logging For MySQL
Initializing a PostgreSQL Database
PostgreSQL Solution Repository Configuration
Configuring Quartz For PostgreSQL
Configuring Audit Logging For PostgreSQL
Initializing an Oracle Database
Oracle Solution Repository Configuration
Configuring Quartz For Oracle
Configuring Audit Logging For Oracle
Changing the Solution Database Hostname
Customizing Port Numbers
Installing Pentaho User Console Plugins
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Initial Startup of the BA Server and Pentaho Enterprise Console
Post-Install Configuration
Preparing a Headless Linux or Solaris Server
Starting the BA Server At Boot Time On Linux
Starting the BA Server At Boot Time On Solaris
Starting the BA Server At Boot Time On Windows
Post-Install Configuration
Installing the Pentaho Client Design Tools
Preparing for Production
Removing Pentaho Sample Data and Solutions
Switching to a Production Login Screen
Compatibility Matrix: Supported Components
JDBC Drivers
Troubleshooting
Version Check
File Names and Paths
Examining Log Files
Unable to Use the Database Init Scripts for PostgreSQL
context.xml Changes Do Not Take Effect After Deploying a WAR
JDBC Driver Problems
Licenses Not Found After Installation
Cannot Create Hibernate Tables in MySQL
Action Sequences That Call PDI Content Won't Run
Adding PDI Enterprise Repository Content Support to the BA Server
Pentaho BA Server Manual Deployment Guide
Manual Deployment Overview
Installation Checklist
Prerequisites
Local User Accounts on Linux
Creating a Pentaho System User on Linux
How to Check Your Java Version
Setting the PENTAHO_JAVA_HOME Variable on Linux
Setting the PENTAHO_JAVA_HOME Variable on Windows
Setting the PENTAHO_INSTALLED_LICENSE_PATH Variable on Linux
Setting the PENTAHO_INSTALLED_LICENSE_PATH Variable on Windows
Preparing a Headless Linux or Solaris Server
Obtaining the Pentaho BA Server Build Materials
Building the BA Server
Establishing a context.xml File For Tomcat
Solution Repository JNDI Configuration Files for JBoss Deployments
Changing the Web Application Context
Changing the Web Application Name on Tomcat
Changing the Web Application Name on JBoss
Customizing Port Numbers
Creating a Pentaho Directory
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Copying the Oracle Quartz JAR Pre-Build
Removing the Xalan JAR for JBoss Deployments
How to Build BA Server WARs with Apache Ant
Ant Build Options
Moving JDBC Drivers
Deploying the BA Server Web Application
Moving the Pentaho Solutions Directory
Installing Pentaho User Console Plugins
Removing the Sample Pentaho Analysis Data Source
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Initializing a PostgreSQL Database
PostgreSQL Solution Repository Configuration
Configuring Quartz For PostgreSQL
Configuring Audit Logging For PostgreSQL
Initializing a MySQL Database
MySQL Solution Repository Configuration
Configuring Quartz For MySQL
Configuring Audit Logging For MySQL
Initializing an Oracle Database
Oracle Solution Repository Configuration
Configuring Quartz For Oracle
Configuring Audit Logging For Oracle
Deploying to Tomcat
Modifying startup.bat on Windows
Modifying startup.sh on Linux and Solaris
Modifying server.xml To Work With Accented Characters
Deploying a WAR to Tomcat
Deploying to JBoss
Modifying run.bat on Windows
Modifying run.conf on Linux and Solaris
Deploying a WAR to JBoss
Adding PDI Enterprise Repository Content Support to the BA Server
Installing the Pentaho Enterprise Console: Linux/OS X/Windows
Installing the Pentaho Enterprise Console: Solaris
Initial Startup of the BA Server and Pentaho Enterprise Console
Post-Install Configuration
Testing and Using Your Server
Preparing for Production
Switching to a Production Login Screen
Compatibility Matrix: Supported Components
JDBC Drivers
Troubleshooting
Version Check
Examining Log Files
File Names and Paths
JDBC Driver Problems
Licenses Not Found After Installation
Cannot Create Hibernate Tables in MySQL
Unable to Use the Database Init Scripts for PostgreSQL
context.xml Changes Do Not Take Effect After Deploying a WAR
vfs-provider.xml Duplicates
Library Conflicts
Varying Context and Data Source Configuration Methods
Report Parameters That Include Accented Characters Fail to Validate
JBoss Fails to Start When the Pentaho HSQLDB Sample Database Is Running
JBoss Fails to Start After Manually Unpacking pentaho.war
Web-App Path doesn't validate in Enterprise Console
Action Sequences That Call PDI Content Won't Run
Adding PDI Enterprise Repository Content Support to the BA Server
Appendix: Installation Notes For FreeBSD
Pentaho Data Integration Installation Guide
Installation Overview
Installation Methods
The Graphical Installer
The Archive-Based Installation Process
Installation Checklist: Server
Installation Checklist: Workstation
Prerequisites for Archive Installation
How to Check Your Java Version
Local User Accounts on Linux
Creating a Pentaho System User on Linux
Setting the PENTAHO_JAVA_HOME Variable on Linux
Setting the PENTAHO_JAVA_HOME Variable on Windows
Obtaining the Archive Packages
Server Installation Procedure
Server Archive Package Deployment
Installing or Updating License Keys Using the Pentaho Enterprise Console
Working From the Command Line Interface
Installing License Keys from the Command-line Interface
Post-Install Configuration
Starting the DI Server At Boot Time On Linux
Switching LDAP Authentication
Workstation Installation Procedures
Workstation Archive Package Deployment
Configuring Monetdb for Instaview
Troubleshooting Monetdb for Instaview
Connecting to an Enterprise Repository
Testing and Cleanup
Adding PDI Enterprise Repository Content Support to the BA Server
Adding a JDBC Driver
Compatibility Matrix: Supported Components
JDBC Drivers
Business Analytics Upgrade Guide
Introduction
New Features in 4.8
Introducing Pentaho Mobile
Introducing Instaview
New Features in Big Data
New Features in Pentaho Data Integration
New Features in Analyzer, Dashboards, and Interactive Reporting
New Features in Information Assets
Best Practices for Production Upgrades
Prerequisites
Backing Up
Stopping the Solution Database Service on Windows
How to Check Your Java Version
Default Port Configuration
Upgrading the BA Server
Manual WAR Deployment
Manual Deployment Upgrade Checklist
Obtaining the Pentaho BA Server Build Materials
Changes to the Solution Database
The Solution Database: Upgrading the Quartz Schema
Removing the Xalan JAR for JBoss Deployments
Copying the Oracle Quartz JAR Pre-Build
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Building New WAR Files
Building and Deploying a New JBoss WAR
Building and Deploying a New Tomcat WAR
Rebuilding the Solutions Directory
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Installing Pentaho User Console Plugins
Continuing the Manual Upgrade Process
Archive-Based Deployment
Archive Deployment Upgrade Checklist
Obtaining the Installation Materials
Deploying the BA Server
Changes to the Solution Database
The Solution Database: Upgrading the Quartz Schema
Copying Solution Database JDBC Drivers
Copying context.xml, server.xml, web.xml, and log4j.xml
Installing Pentaho User Console Plugins
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Removing Pentaho Sample Data and Solutions
Continuing the Archive-Based Upgrade Process
Business Analytics Graphical Installer Deployment
Graphical Installer Deployment Upgrade Checklist
Obtaining the Installation Materials
Deploying the BA Server
Copying context.xml, server.xml, web.xml, and log4j.xml
Changes to the Solution Database
The Solution Database: Upgrading the Quartz Schema
Installing Pentaho User Console Plugins
Installing the Analysis Enterprise Edition Plugin
Switching to Memcached
Memcached Configuration Options
Adding Linux and OS X Support for Printing Analyzer Geo Maps
Adding Windows Support for Printing Analyzer Geo Maps
Copying Startup Scripts
Copying Windows 64-bit Tomcat Executables
Copying Windows Start Menu Icons
Removing Pentaho Sample Data and Solutions
Migrating Your Solutions
Merging Your BA Server Configuration Files
Updating pentahoObjects.spring.xml
Updating applicationContext-spring-security.xml
Updating web.xml
Upgrading Your Single-Sign On Configuration
CAS Property Reference
Upgrading the Pentaho Enterprise Console
Moving JDBC Drivers
Testing Your New BA Server
Upgrading the Pentaho Client Tools
Post-Upgrade Configuration
Cleanup
Compatibility Matrix: Supported Components
JDBC Drivers
Troubleshooting
File Names and Paths
Examining Log Files
JDBC Driver Problems
Unable to Use the Database Init Scripts for PostgreSQL
context.xml Changes Do Not Take Effect After Deploying a WAR
Tomcat Logs Report Memory Leaks
User Console Themes Render Improperly After Upgrade
PDI Upgrade Guide
Introduction
Introducing Instaview
New Features in Pentaho Data Integration
Upgrade Best Practices
Upgrade Checklist
Downloading Client and Server Packages
Creating Backups
Backing Up Content Files
Backing Up a Database Repository
Moving JDBC Drivers for PDI
How to Back Up the Enterprise Repository
Backing Up the .kettle Directory
Backing Up the data-integration Directory
Upgrading a Data Integration Server
Upgrading the Pentaho Enterprise Console
Upgrading a Data Integration Workstation
Upgrading a Data Integration Work Station in Ubuntu 12
Configuring Monetdb for Instaview
Troubleshooting Monetdb for Instaview
Calculator Step Bug Fix
Upgrading the Google Analytics Step
Testing and Cleanup
Compatibility Matrix: Supported Components
JDBC Drivers
Administrator Guides
Business Analytics Administrator's Guide
Introduction
Prerequisites
Accessing the Pentaho Enterprise Console
Service Control
Master Service Control Scripts From the Graphical Installer
Individual Service Control Scripts
Starting the BA Server At Boot Time On Linux
Starting the BA Server At Boot Time On Solaris
Starting the BA Server At Boot Time On Windows
Pentaho Enterprise Console Configuration
Install or Update License Keys
Installing or Updating License Keys Using the Pentaho Enterprise Console
Installing License Keys from the Command-line Interface
Configuring the Proxy Trusting Filter
Changing the Admin Credentials for the Pentaho Enterprise Console
Cleanup and Audit Reports
More About Audit Reports
The Data Integration Server
Configuring the Enterprise Console
Connecting to the Data Integration Server
Establishing Data Sources
Creating JNDI Data Connections
Adding a JNDI Data Connection to JBoss
Adding a JNDI Data Connection to Tomcat
Adding a Simple JNDI Data Source For Design Tools
Simple JNDI Options
Creating JDBC Database Connections
Adding a JDBC Driver
Adding a JDBC Database Connection In Enterprise Console
Using Advanced JNDI Connection Options in the Enterprise Console
Adding a Data Source in the Pentaho User Console
Creating a Relational Data Source in the Pentaho User Console
Creating a CSV Data Source in the Pentaho User Console
Increasing the CSV File Upload Limit
Changing the Staging Database
Where Metadata Models and Mondrian Schemas are Stored
Customizing an Analysis Data Source
Editing a Database Connection in the Pentaho User Console
Deleting a Database Connection in the Pentaho User Console
Deleting a Data Source in the Pentaho User Console
Adjusting Name Restrictions in Data Source Wizard
Restricting Metadata Models to Specific Client Tools
Managing Schedules
Entering Schedules in the Schedule Creator Dialog Box
Associating Schedules with Action Sequences
Removing Action Sequence Files from a List
Examining the List of Schedules
Configuring the BA Server
Software Updates
Email Settings
Specifying Your Publisher Password
Specifying Global and Session Variables
Changing the Location of the Server Log File
Changing the Tomcat Port
Hiding Report Parameters In URLs
Setting the Geo Map Rendering Wait Time
Solution Repository and Cache Management
Backing Up the Solution Repository
Checking the Status of the Solution Repository
Configuring the Solution Repository
Hibernate Dialects
Refreshing the Reporting Data Cache
Clearing the Content Repository
Clearing the Mondrian Cache
Content Promotion (Lifecycle Management)
Lifecycle Management Checklist
Preparing the Configuration for Promotion
Promoting Solutions
Migrating Data Sources
Promoting Schedules
Artifact Cleanup
Logging, Performance Monitoring, and Troubleshooting
Viewing Errors
Viewing Environment Settings
Viewing Security Settings
Configuring and Testing System Settings
Monitoring Performance
Changing the Show for Last Interval
Refreshing the Metrics Values
Preventing Timeout Transaction Errors Associated with Scheduled Reports
Using Performance Charts
Changing the Chart Analysis Time Period
Changing the Execution Performance Limit for the Execution Performance Limit Deviation Chart
Refreshing the Performance Charts
Estimating the Size of the Audit Log
Switching to File-Based Audit Logging
Removing Audit Logging
Defining Result Row Limit and Timeout
Column Metadata Security Restrictions On Columns With Inner Joins
Disabling Server and Session-Related Timeouts in the Pentaho User Console
Log Rotation
Troubleshooting
Address Already In Use: JVM_Bind When Starting Enterprise Console
Case-Insensitivity for Usernames, Passwords, and Filenames
HTTP 500 or "Unable to connect to BA Server" Errors When Trying to Access Enterprise Console
Windows Domains Won't Authenticate When Using the JTDS Driver
Geo Maps partially rendered
Getting Support
Working From the Command Line Interface
Managing Enterprise Edition Keys (CLI)
Resetting the Default Access Control Lists (CLI)
Business Analytics Troubleshooting Guide
Introduction
General
File Names and Paths
JDBC Driver Problems
Adding a JDBC Driver
Data Conversion Issues With MySQL Driver 5.0.8
Fixing JTDS varchar(MAX) Limitations in MSSQL 2005
Windows Domains Won't Authenticate When Using the JTDS Driver
Version Check
I don't know what the default login is for the DI Server, Enterprise Console, and/or Carte
Examining Log Files
Upgrade
Tomcat Logs Report Memory Leaks
context.xml Changes Do Not Take Effect After Deploying a WAR
javax.jcr.RepositoryException: no search manager configured for this workspace
User Console Themes Render Improperly After Upgrade
BA Server and Pentaho Enterprise Console
Address Already In Use: JVM_Bind When Starting Enterprise Console
Library Conflicts
Report Parameters That Include Accented Characters Fail to Validate
Modifying server.xml To Work With Accented Characters
vfs-provider.xml Duplicates
Varying Context and Data Source Configuration Methods
Licenses Not Found After Installation
Evaluation Licenses are Not Granted
Cannot Create Hibernate Tables in MySQL
Case-Insensitivity for Usernames, Passwords, and Filenames
Unable to Use the Database Init Scripts for PostgreSQL
HTTP 500 or "Unable to connect to BA Server" Errors When Trying to Access Enterprise Console
Configuring the Proxy Trusting Filter
JBoss Fails to Start When the Pentaho HSQLDB Sample Database Is Running
JBoss Fails to Start After Manually Unpacking pentaho.war
Web-App Path doesn't validate in Enterprise Console
LDAP incorrectly authenticates user IDs that don't match letter case
Forcing Case-Sensitivity in LDAP
LDAP Roles Are Not "Admin" and "Authenticated"
With LDAP Authentication, the PDI Repository Explorer is Empty
Old Action Sequences Fail on Scrollable Result Sets
Geo Maps partially rendered
Setting the Geo Map Rendering Wait Time
Report Designer and Reporting Engine
Enabling Multi-Valued report Parameters for Metadata-based Queries Created with Previous Versions of Report Designer
Report Elements With Dynamic Heights Overlap Other Elements
Null Pointer Exception When Sharing Result Sets
Columns Unexpectedly Merge When Exporting to Excel
Analysis
Old Analysis Schemas Still Show Up in Pentaho User Console
Removing Mondrian Data Sources
Multi-Byte Characters Don't Appear In PDFs Exported From Analyzer
Setting a Default Font for PDF Exports
Data Integration
Troubleshooting a Corrupted DI Server Repository
Using the H2 Database Recovery Tool
Action Sequences That Call PDI Content Won't Run
Adding PDI Enterprise Repository Content Support to the BA Server
Jobs scheduled on the DI Server cannot execute a transformation on a remote Carte server
Executing Scheduled Jobs on a Remote Carte Server
Kitchen can't read KJBs from a Zip export
PDI Transformation Logging Doesn't Show In PEC
DI Server fails to start (IOException: Premature end of file)
Using ODBC
Metadata
Managing Multiple Outer-Joins
Using the Delay Outer Join Conditions Property
Business Analytics Security Guide
Introduction: Configuring Security
Security Overview
Supported Technologies
Security Implementation Checklist
BA Server User Authentication
Pentaho (Default)
Switching to LDAP
Microsoft Active Directory Configuration
LDAP Configuration in the Pentaho Enterprise Console
Forcing Case-Sensitivity in LDAP
Switching to JDBC
Switching to an LDAP/JDBC Hybrid
Implementing Single Sign-On
Switching to Central Authentication Service (CAS)
CAS Property Reference
Switching to Integrated Windows Authentication (IWA)
Assigning Permissions in the Pentaho User Console
Permissions Settings
BA Server Content Authorization
User and Role Configuration
Adding Users
Editing User Information
Deleting Users
Adding Roles
Editing Roles
Deleting Roles
Assigning Users to Roles
How to Change the Administrator Role
Implementing Nested Roles in LDAP
Resetting or Creating a new Pentaho Enterprise Console User
Adding Web Resource Authentication
Domain Object Authorization
Reapplying the Default Access Control Lists
Configuring SQL Filters for Dashboards
Assigning Data Source Permissions for the Pentaho User Console
Managing Users and Roles in the Pentaho Enterprise Repository
Adding Users
Editing User Information
Deleting Users
Best Practices for Deleting Users and Roles in the Pentaho Enterprise Repository
Adding Roles
Editing Roles
Deleting Roles
Assigning Users to Roles
Making Changes to the Admin Role
Assigning Permissions in the Pentaho Enterprise Repository
Permissions Settings
Enabling System Role Permissions in the Pentaho Enterprise Repository
Securing the Pentaho Enterprise Console and BA Server
Configuring SSL (HTTPS) in the Pentaho Enterprise Console and BA Server
Enabling SSL in the BA Server With a Certificate Authority
Enabling SSL in the BA Server With a Self-Signed Certificate
Trusting a Self-Signed Certificate
Changing the BA Server Base URL
Enabling SSL in the Pentaho Enterprise Console
Starting the Pentaho Enterprise Console using SSL
Changing Default Enterprise Console Security Settings
Changing the Admin Credentials for the Pentaho Enterprise Console
Creating a Custom Login Module
Using the Apache Web Server (httpd) For Socket Handling
Using Apache httpd With SSL For Delivering Static Content
Removing Security
Switching the Metadata Domain Repository
Switching to a File-Based Solution Repository
Metadata Security
Configuring the Security Service
Adding Column-Level Security Constraints
Adding Global Row-Level Security Constraints
MQL Formula Syntax For Global Constraints
Adding User or Role Row-Level Security Constraints
MQL Formula Syntax For User and Role Row-Level Constraints
Restricting Metadata Models to Specific Client Tools
Analysis Schema Security
Restricting Access to Specific Members
Mondrian Role Mapping in the BA Server
The Mondrian One-To-One UserRoleMapper
The Mondrian SampleLookupMap UserRoleMapper
The Mondrian SampleUserSession UserRoleMapper
Restricting ROLAP Schemas Per User
Using Security Information In Action Sequences
Troubleshooting
Miscellaneous Troubleshooting Tips
Increasing Security Log Levels in the BI Platform
Enabling Extra LDAP Security Logging
Log Output Analysis
LDAP Roles Are Not "Admin" and "Authenticated"
With LDAP Authentication, the PDI Repository Explorer is Empty
LDAP incorrectly authenticates user IDs that don't match letter case
Business Analytics Performance-Tuning Guide
Introduction
System Requirements
Pentaho BA Server Performance Tips
Move Pentaho Managed Data Sources to JNDI
Manual Cleanup of the /tmp Directory
Memory Optimization for the Geo Service Plugin
Switching to a File-Based Solution Repository
Turning Off Audit Logging
Using Apache httpd With SSL For Delivering Static Content
Testing BA Server Scalability
Pentaho Reporting Performance Tips
Caching Report Content
Result Set Caching
Result Set Cache Options
Streamlining Printed Output
Paginated Exports
Table Exports
HTML Exports
Pentaho Reporting Configuration Files
Pentaho Data Integration Performance Tips
Upgrading to the Latest Release
Pentaho Data Integration Performance Tuning Tips
Limiting In-Memory Log Output
HBase Performance in PDI
Pentaho Analysis (Mondrian) Performance Tips
Optimizing Your Infrastructure
Redesigning Your Data Warehouse
Switching to an Analytic Database
Query Optimization
Optimizing Pentaho Analysis
Mondrian Cache Control
Segment Cache Architecture
Cache Configuration Files
Modifying the JGroups Configuration
Switching to Another Cache Framework
Switching to Memcached
Memcached Configuration Options
Switching to Pentaho Platform Delegating Cache
Using a Custom SegmentCache SPI
Clearing the Mondrian Cache
Partitioning High-Cardinality Dimensions
Mondrian Log Analysis
Configuring Pentaho Analyzer for Large Data Warehouses
Configuring the Mondrian Engine for Large Data Warehouses
Redesigning Analyzer Reports for Maximum Performance
Pentaho Analysis Configuration Files
Pentaho Data Mining (Weka) Performance Tips
Vertical Resource Scaling
Horizontal Resource Scaling
Clustering the Application Server
Clustering Requirements
Sharing the Solution Repository
Installing and Configuring Apache as a Load Balancer
Tomcat Configuration
Copying WAR Files to the Nodes
Starting and Testing the Cluster
Changing the Java VM Memory Limits
Increasing Memory Limits on Microsoft Windows with a Graphical Installation
Increasing Memory Limits on Linux with a Graphical Install
Increasing Memory Limits with an Archive or Manual Deployment
Increasing the Memory Limit in Aggregation Designer
Increasing the Memory Limit in PDI
Increasing the Memory Limit in Report Designer
Increasing the Memory Limit in Weka
PDI Administrator's Guide
Introduction
Adding a JDBC Driver
PDI Functions in the Pentaho Enterprise Console
Connecting to the Data Integration Server
Monitoring Current Activity and Alerts
Registering PDI Jobs and Transformations
Registering Transformations and Jobs from the Pentaho Enterprise Repository
Registering Transformations and Jobs from a Database Repository
Registering Transformations and Jobs from a File System
Monitoring Jobs and Transformations
Monitoring Performance Trends for Jobs and Transformations
Managing Licenses
Managing Licenses from the Command Line Interface
Installing License Keys from the Command-line Interface
Security and Authorization Configuration
Changing the Admin Credentials for the Pentaho Enterprise Console
Managing Users and Roles in the Pentaho Enterprise Repository
Adding Users
Editing User Information
Deleting Users
Best Practices for Deleting Users and Roles in the Pentaho Enterprise Repository
Adding Roles
Editing Roles
Deleting Roles
Assigning Users to Roles
Making Changes to the Admin Role
Assigning Permissions in the Pentaho Enterprise Repository
Permissions Settings
Enabling System Role Permissions in the Pentaho Enterprise Repository
Configuring the DI Server for LDAP Authentication
LDAP Properties
Clustering
Configuring Carte to Be a Static Slave Instance
Configuring a Dynamic Cluster
Configuring Carte as a Master (Load Balancer)
Configuring Carte to Be a Dynamic Slave Instance
Creating a Cluster Schema in Spoon
Executing Transformations in a Cluster
Initializing Slave Servers in Spoon
Executing Scheduled Jobs on a Remote Carte Server
Impact Analysis
List of Server Ports Used by PDI
How to Change Service Port Numbers
How to Change the DI Server URL
How to Back Up the Enterprise Repository
Importing and Exporting Content
Importing Content Into a Pentaho Enterprise Repository
Using the Import Script From the Command Line
Exporting Content From a Pentaho Enterprise Repository
Logging and Monitoring
How to Enable Logging
Monitoring Job and Transformation Results
slave-server-config.xml
Log Rotation
PDI Operations Mart
Installing the PDI Operations Mart
Setting Up Database Connections
Creating the PDI Operations Mart
Configuring Logging Data Collection
Updating the PDI Operations Mart
Loading the Sample PDI Operations Mart
Loading the Sample Reports, Charts, and Dashboards
Setting Up and Distributing the Data Models
Giving Users Access to the Pentaho Operations Mart
Creating Charts, Reports, and Dashboards Using PDI Operations Mart Data
Creating ETL Logging Reports
Creating ETL Logging Charts
Creating ETL Logging Dashboards
PDI Operations Mart Logging Tables Status Descriptions
PDI Operation Mart Logging Dimensions and Metrics
PDI Operations Mart Best Practices
Cleaning Up Operations Mart Tables
Using PDI Data Sources in Action Sequences
Configuring Your Big Data Environment
Setting the Active Hadoop Configuration
Configuring for Cloudera
Configuring for MapR
Creating a New Hadoop Configuration
Troubleshooting
I don't know what the default login is for the DI Server, Enterprise Console, and/or Carte
Jobs scheduled on the DI Server cannot execute a transformation on a remote Carte server
PDI Transformation Logging Doesn't Show In PEC
Troubleshooting a Corrupted DI Server Repository
Using the H2 Database Recovery Tool
DI Server fails to start (IOException: Premature end of file)
Sqoop Import into Hive Fails
Contents of the .kettle Directory
Changing the PDI Home Directory Location (.kettle folder)
Business Analytics Administrator's Guide
Introduction
Prerequisites
Accessing the Pentaho Enterprise Console
Service Control
Master Service Control Scripts From the Graphical Installer
Individual Service Control Scripts
Starting the BA Server At Boot Time On Linux
Starting the BA Server At Boot Time On Solaris
Starting the BA Server At Boot Time On Windows
Pentaho Enterprise Console Configuration
Install or Update License Keys
Installing or Updating License Keys Using the Pentaho Enterprise Console
Installing License Keys from the Command-line Interface
Configuring the Proxy Trusting Filter
Changing the Admin Credentials for the Pentaho Enterprise Console
Cleanup and Audit Reports
More About Audit Reports
The Data Integration Server
Configuring the Enterprise Console
Connecting to the Data Integration Server
Establishing Data Sources
Creating JNDI Data Connections
Adding a JNDI Data Connection to JBoss
Adding a JNDI Data Connection to Tomcat
Adding a Simple JNDI Data Source For Design Tools
Simple JNDI Options
Creating JDBC Database Connections
Adding a JDBC Driver
Adding a JDBC Database Connection In Enterprise Console
Using Advanced JNDI Connection Options in the Enterprise Console
Adding a Data Source in the Pentaho User Console
Creating a Relational Data Source in the Pentaho User Console
Creating a CSV Data Source in the Pentaho User Console
Increasing the CSV File Upload Limit
Changing the Staging Database
Where Metadata Models and Mondrian Schemas are Stored
Customizing an Analysis Data Source
Editing a Database Connection in the Pentaho User Console
Deleting a Database Connection in the Pentaho User Console
Deleting a Data Source in the Pentaho User Console
Adjusting Name Restrictions in Data Source Wizard
Restricting Metadata Models to Specific Client Tools
Managing Schedules
Entering Schedules in the Schedule Creator Dialog Box
Associating Schedules with Action Sequences
Removing Action Sequence Files from a List
Examining the List of Schedules
Configuring the BA Server
Software Updates
Email Settings
Specifying Your Publisher Password
Specifying Global and Session Variables
Changing the Location of the Server Log File
Changing the Tomcat Port
Hiding Report Parameters In URLs
Setting the Geo Map Rendering Wait Time
Solution Repository and Cache Management
Backing Up the Solution Repository
Checking the Status of the Solution Repository
Configuring the Solution Repository
Hibernate Dialects
Refreshing the Reporting Data Cache
Clearing the Content Repository
Clearing the Mondrian Cache
Content Promotion (Lifecycle Management)
Lifecycle Management Checklist
Preparing the Configuration for Promotion
Promoting Solutions
Migrating Data Sources
Promoting Schedules
Artifact Cleanup
Logging, Performance Monitoring, and Troubleshooting
Viewing Errors
Viewing Environment Settings
Viewing Security Settings
Configuring and Testing System Settings
Monitoring Performance
Changing the Show for Last Interval
Refreshing the Metrics Values
Preventing Timeout Transaction Errors Associated with Scheduled Reports
Using Performance Charts
Changing the Chart Analysis Time Period
Changing the Execution Performance Limit for the Execution Performance Limit Deviation Chart
Refreshing the Performance Charts
Estimating the Size of the Audit Log
Switching to File-Based Audit Logging
Removing Audit Logging
Defining Result Row Limit and Timeout
Column Metadata Security Restrictions On Columns With Inner Joins
Disabling Server and Session-Related Timeouts in the Pentaho User Console
Log Rotation
Troubleshooting
Address Already In Use: JVM_Bind When Starting Enterprise Console
Case-Insensitivity for Usernames, Passwords, and Filenames
HTTP 500 or "Unable to connect to BA Server" Errors When Trying to Access Enterprise Console
Windows Domains Won't Authenticate When Using the JTDS Driver
Geo Maps partially rendered
Getting Support
Working From the Command Line Interface
Managing Enterprise Edition Keys (CLI)
Resetting the Default Access Control Lists (CLI)
Business Analytics Troubleshooting Guide
Introduction
General
File Names and Paths
JDBC Driver Problems
Adding a JDBC Driver
Data Conversion Issues With MySQL Driver 5.0.8
Fixing JTDS varchar(MAX) Limitations in MSSQL 2005
Windows Domains Won't Authenticate When Using the JTDS Driver
Version Check
I don't know what the default login is for the DI Server, Enterprise Console, and/or Carte
Examining Log Files
Upgrade
Tomcat Logs Report Memory Leaks
context.xml Changes Do Not Take Effect After Deploying a WAR
javax.jcr.RepositoryException: no search manager configured for this workspace
User Console Themes Render Improperly After Upgrade
BA Server and Pentaho Enterprise Console
Address Already In Use: JVM_Bind When Starting Enterprise Console
Library Conflicts
Report Parameters That Include Accented Characters Fail to Validate
Modifying server.xml To Work With Accented Characters
vfs-provider.xml Duplicates
Varying Context and Data Source Configuration Methods
Licenses Not Found After Installation
Evaluation Licenses are Not Granted
Cannot Create Hibernate Tables in MySQL
Case-Insensitivity for Usernames, Passwords, and Filenames
Unable to Use the Database Init Scripts for PostgreSQL
HTTP 500 or "Unable to connect to BA Server" Errors When Trying to Access Enterprise Console
Configuring the Proxy Trusting Filter
JBoss Fails to Start When the Pentaho HSQLDB Sample Database Is Running
JBoss Fails to Start After Manually Unpacking pentaho.war
Web-App Path doesn't validate in Enterprise Console
LDAP incorrectly authenticates user IDs that don't match letter case
Forcing Case-Sensitivity in LDAP
LDAP Roles Are Not "Admin" and "Authenticated"
With LDAP Authentication, the PDI Repository Explorer is Empty
Old Action Sequences Fail on Scrollable Result Sets
Geo Maps partially rendered
Setting the Geo Map Rendering Wait Time
Report Designer and Reporting Engine
Enabling Multi-Valued report Parameters for Metadata-based Queries Created with Previous Versions of Report Designer
Report Elements With Dynamic Heights Overlap Other Elements
Null Pointer Exception When Sharing Result Sets
Columns Unexpectedly Merge When Exporting to Excel
Analysis
Old Analysis Schemas Still Show Up in Pentaho User Console
Removing Mondrian Data Sources
Multi-Byte Characters Don't Appear In PDFs Exported From Analyzer
Setting a Default Font for PDF Exports
Data Integration
Troubleshooting a Corrupted DI Server Repository
Using the H2 Database Recovery Tool
Action Sequences That Call PDI Content Won't Run
Adding PDI Enterprise Repository Content Support to the BA Server
Jobs scheduled on the DI Server cannot execute a transformation on a remote Carte server
Executing Scheduled Jobs on a Remote Carte Server
Kitchen can't read KJBs from a Zip export
PDI Transformation Logging Doesn't Show In PEC
DI Server fails to start (IOException: Premature end of file)
Using ODBC
Metadata
Managing Multiple Outer-Joins
Using the Delay Outer Join Conditions Property
Business Analytics Security Guide
Introduction: Configuring Security
Security Overview
Supported Technologies
Security Implementation Checklist
BA Server User Authentication
Pentaho (Default)
Switching to LDAP
Microsoft Active Directory Configuration
LDAP Configuration in the Pentaho Enterprise Console
Forcing Case-Sensitivity in LDAP
Switching to JDBC
Switching to an LDAP/JDBC Hybrid
Implementing Single Sign-On
Switching to Central Authentication Service (CAS)
CAS Property Reference
Switching to Integrated Windows Authentication (IWA)
Assigning Permissions in the Pentaho User Console
Permissions Settings
BA Server Content Authorization
User and Role Configuration
Adding Users
Editing User Information
Deleting Users
Adding Roles
Editing Roles
Deleting Roles
Assigning Users to Roles
How to Change the Administrator Role
Implementing Nested Roles in LDAP
Resetting or Creating a new Pentaho Enterprise Console User
Adding Web Resource Authentication
Domain Object Authorization
Reapplying the Default Access Control Lists
Configuring SQL Filters for Dashboards
Assigning Data Source Permissions for the Pentaho User Console
Managing Users and Roles in the Pentaho Enterprise Repository
Adding Users
Editing User Information
Deleting Users
Best Practices for Deleting Users and Roles in the Pentaho Enterprise Repository
Adding Roles
Editing Roles
Deleting Roles
Assigning Users to Roles
Making Changes to the Admin Role
Assigning Permissions in the Pentaho Enterprise Repository
Permissions Settings
Enabling System Role Permissions in the Pentaho Enterprise Repository
Securing the Pentaho Enterprise Console and BA Server
Configuring SSL (HTTPS) in the Pentaho Enterprise Console and BA Server
Enabling SSL in the BA Server With a Certificate Authority
Enabling SSL in the BA Server With a Self-Signed Certificate
Trusting a Self-Signed Certificate
Changing the BA Server Base URL
Enabling SSL in the Pentaho Enterprise Console
Starting the Pentaho Enterprise Console using SSL
Changing Default Enterprise Console Security Settings
Changing the Admin Credentials for the Pentaho Enterprise Console
Creating a Custom Login Module
Using the Apache Web Server (httpd) For Socket Handling
Using Apache httpd With SSL For Delivering Static Content
Removing Security
Switching the Metadata Domain Repository
Switching to a File-Based Solution Repository
Metadata Security
Configuring the Security Service
Adding Column-Level Security Constraints
Adding Global Row-Level Security Constraints
MQL Formula Syntax For Global Constraints
Adding User or Role Row-Level Security Constraints
MQL Formula Syntax For User and Role Row-Level Constraints
Restricting Metadata Models to Specific Client Tools
Analysis Schema Security
Restricting Access to Specific Members
Mondrian Role Mapping in the BA Server
The Mondrian One-To-One UserRoleMapper
The Mondrian SampleLookupMap UserRoleMapper
The Mondrian SampleUserSession UserRoleMapper
Restricting ROLAP Schemas Per User
Using Security Information In Action Sequences
Troubleshooting
Miscellaneous Troubleshooting Tips
Increasing Security Log Levels in the BI Platform
Enabling Extra LDAP Security Logging
Log Output Analysis
LDAP Roles Are Not "Admin" and "Authenticated"
With LDAP Authentication, the PDI Repository Explorer is Empty
LDAP incorrectly authenticates user IDs that don't match letter case
Business Analytics Performance-Tuning Guide
Introduction
System Requirements
Pentaho BA Server Performance Tips
Move Pentaho Managed Data Sources to JNDI
Manual Cleanup of the /tmp Directory
Memory Optimization for the Geo Service Plugin
Switching to a File-Based Solution Repository
Turning Off Audit Logging
Using Apache httpd With SSL For Delivering Static Content
Testing BA Server Scalability
Pentaho Reporting Performance Tips
Caching Report Content
Result Set Caching
Result Set Cache Options
Streamlining Printed Output
Paginated Exports
Table Exports
HTML Exports
Pentaho Reporting Configuration Files
Pentaho Data Integration Performance Tips
Upgrading to the Latest Release
Pentaho Data Integration Performance Tuning Tips
Limiting In-Memory Log Output
HBase Performance in PDI
Pentaho Analysis (Mondrian) Performance Tips
Optimizing Your Infrastructure
Redesigning Your Data Warehouse
Switching to an Analytic Database
Query Optimization
Optimizing Pentaho Analysis
Mondrian Cache Control
Segment Cache Architecture
Cache Configuration Files
Modifying the JGroups Configuration
Switching to Another Cache Framework
Switching to Memcached
Memcached Configuration Options
Switching to Pentaho Platform Delegating Cache
Using a Custom SegmentCache SPI
Clearing the Mondrian Cache
Partitioning High-Cardinality Dimensions
Mondrian Log Analysis
Configuring Pentaho Analyzer for Large Data Warehouses
Configuring the Mondrian Engine for Large Data Warehouses
Redesigning Analyzer Reports for Maximum Performance
Pentaho Analysis Configuration Files
Pentaho Data Mining (Weka) Performance Tips
Vertical Resource Scaling
Horizontal Resource Scaling
Clustering the Application Server
Clustering Requirements
Sharing the Solution Repository
Installing and Configuring Apache as a Load Balancer
Tomcat Configuration
Copying WAR Files to the Nodes
Starting and Testing the Cluster
Changing the Java VM Memory Limits
Increasing Memory Limits on Microsoft Windows with a Graphical Installation
Increasing Memory Limits on Linux with a Graphical Install
Increasing Memory Limits with an Archive or Manual Deployment
Increasing the Memory Limit in Aggregation Designer
Increasing the Memory Limit in PDI
Increasing the Memory Limit in Report Designer
Increasing the Memory Limit in Weka
PDI Administrator's Guide
Introduction
Adding a JDBC Driver
PDI Functions in the Pentaho Enterprise Console
Connecting to the Data Integration Server
Monitoring Current Activity and Alerts
Registering PDI Jobs and Transformations
Registering Transformations and Jobs from the Pentaho Enterprise Repository
Registering Transformations and Jobs from a Database Repository
Registering Transformations and Jobs from a File System
Monitoring Jobs and Transformations
Monitoring Performance Trends for Jobs and Transformations
Managing Licenses
Managing Licenses from the Command Line Interface
Installing License Keys from the Command-line Interface
Security and Authorization Configuration
Changing the Admin Credentials for the Pentaho Enterprise Console
Managing Users and Roles in the Pentaho Enterprise Repository
Adding Users
Editing User Information
Deleting Users
Best Practices for Deleting Users and Roles in the Pentaho Enterprise Repository
Adding Roles
Editing Roles
Deleting Roles
Assigning Users to Roles
Making Changes to the Admin Role
Assigning Permissions in the Pentaho Enterprise Repository
Permissions Settings
Enabling System Role Permissions in the Pentaho Enterprise Repository
Configuring the DI Server for LDAP Authentication
LDAP Properties
Clustering
Configuring Carte to Be a Static Slave Instance
Configuring a Dynamic Cluster
Configuring Carte as a Master (Load Balancer)
Configuring Carte to Be a Dynamic Slave Instance
Creating a Cluster Schema in Spoon
Executing Transformations in a Cluster
Initializing Slave Servers in Spoon
Executing Scheduled Jobs on a Remote Carte Server
Impact Analysis
List of Server Ports Used by PDI
How to Change Service Port Numbers
How to Change the DI Server URL
How to Back Up the Enterprise Repository
Importing and Exporting Content
Importing Content Into a Pentaho Enterprise Repository
Using the Import Script From the Command Line
Exporting Content From a Pentaho Enterprise Repository
Logging and Monitoring
How to Enable Logging
Monitoring Job and Transformation Results
slave-server-config.xml
Log Rotation
PDI Operations Mart
Installing the PDI Operations Mart
Setting Up Database Connections
Creating the PDI Operations Mart
Configuring Logging Data Collection
Updating the PDI Operations Mart
Loading the Sample PDI Operations Mart
Loading the Sample Reports, Charts, and Dashboards
Setting Up and Distributing the Data Models
Giving Users Access to the Pentaho Operations Mart
Creating Charts, Reports, and Dashboards Using PDI Operations Mart Data
Creating ETL Logging Reports
Creating ETL Logging Charts
Creating ETL Logging Dashboards
PDI Operations Mart Logging Tables Status Descriptions
PDI Operation Mart Logging Dimensions and Metrics
PDI Operations Mart Best Practices
Cleaning Up Operations Mart Tables
Using PDI Data Sources in Action Sequences
Configuring Your Big Data Environment
Setting the Active Hadoop Configuration
Configuring for Cloudera
Configuring for MapR
Creating a New Hadoop Configuration
Troubleshooting
I don't know what the default login is for the DI Server, Enterprise Console, and/or Carte
Jobs scheduled on the DI Server cannot execute a transformation on a remote Carte server
PDI Transformation Logging Doesn't Show In PEC
Troubleshooting a Corrupted DI Server Repository
Using the H2 Database Recovery Tool
DI Server fails to start (IOException: Premature end of file)
Sqoop Import into Hive Fails
Contents of the .kettle Directory
Changing the PDI Home Directory Location (.kettle folder)
Developer Guides
Customizing Pentaho Business Analytics
Introduction
Pentaho User Console Styling
Overview of Customizable Configuration Files
Replacing the Default Icon Set
Changing the Default Logo
Changing the Workspace Background
Customizing and Developing User Console Themes
Theme Engine Overview
Creating a New Theme
Setting the Default Theme
Switching PUC Themes
Removing or Changing Support Messages
Removing the Support Warning Message From JPivot
Removing the Support Warning Message From WAQR
Switching to a Production Login Screen
Testing Your Design Changes
Using the PUC UI Widget Test Page
Using Firebug to Test CSS Changes
Localization
BA Server and Thin Client Message Bundles
Pentaho User Console and Dashboard Designer Message Bundles
Switching PUC Message Bundles
Pentaho Analyzer Localization
Localization/Internationalization of Analysis Schemas
Pentaho Interactive Reporting Localization
Geographic Service (pentaho-geo) Localization
Enterprise Console Message Bundles
Enterprise Console Character Set Encoding
Action Sequence Message Bundles
Report Viewer Localization
Design Tool Localization
Using the Kettle Translator
Creating Design Tool Templates
Creating a Dashboard Designer Template
Reporting Templates
Report Design Wizard Template Design Guidelines
Interactive Reporting Template Design Guidelines
Dynamic Element Positioning in Templates
Template Properties
Deploying a Template to Report Design Wizard
Deploying a Template to Interactive Reporting
Setting the Default Interactive Reporting Template
Extending Pentaho Analyzer with Custom Visualizations
Create a Pentaho BA Server Plug-in
Custom Visualizations
Define the Custom Visualization
Register the Visualization with Pentaho Visualization API
Register the Visualization with Pentaho Analyzer
Register the Created JavaScript Files with Pentaho Analyzer
Restart the BA Server and Test the Visualization
Additional Resources
Creating Pentaho Dashboards
Introduction
Dashboard Theory
Dashboard Designer
Using Pentaho Dashboard Designer
Creating a New Dashboard
Working with the Chart Designer
Rotating Chart Axis Labels
Correcting Scaling Issues
Working with Dial Charts
Working with Pie Charts
Adding Data to a Chart
Adding a Data Table to a Dashboard
Updating the Data Table Display
Adding a Report Designer Report to a Dashboard
Adding an Action Sequence to a Dashboard
Adding an Analyzer Report to a Dashboard
Adding a Web Site to a Dashboard
Implementing Filters
Filtering Dashboards
Creating a SQL List
Creating a Metadata List
Creating a Cascading Filter
Linking Dashboard Filters to Analyzer Parameters
Editing Filters
Dashboard Parameters
Creating Chart or Data Table Parameters With the Query Editor
Using Content Linking to Create Interactive Dashboards
Linking Charts and Data Tables
Linking Columns in a Data Table to Content in other Dashboard Panels
Creating Content to Content Links in an Analyzer Report
Linking an Action Sequence Parameter to Content in other Dashboard Panels
Controlling a Dashboard Parameter From a PRPT Hyperlink
Dynamic Dashboard Titles
Using Save As in Dashboards
Editing Dashboards
Adding Content to a Dashboard Using Drag-and-Drop
Adjusting Whitespace in Dashboard Panels
Setting the Refresh Interval
Creating a Dashboard Designer Template
Community Dashboard Framework (CDF)
Exploring the CDF Sample Content
Custom JSP Dashboards
Enterprise Dashboard Support
Integrating With the BA Server
Introduction
Required Knowledge and Expertise
Required Software
Defining the BI Platform, BA Server, and Business Analytics
What We Mean By "Integrating"
BA Server Capabilities and Features
Input Types
Output Types
Engines and Content Creation
Security Integration
Scheduling and Distribution
Explanation of the BA Server Example Application
Deploying pentaho_integration_examples.war
Integrating BA Server Functionality
Using ViewAction to Retrieve Content
Understanding the ViewAction Content Generator
Operational ViewAction Parameters
Generating an HTML Report
Generating an HTML Report With a Form
Using ReportViewer to Generate User-Driven Reports
Understanding the ReportViewer Content Generator
Operational ReportViewer Parameters
Analyzing the Top N Customers
Displaying Content With the Reporting URL
Understanding the Reporting URL Content Generator
Operational Reporting URL Parameters
Static Display of the Top Three Customers
Exposing New/Open/SaveAs in the Analyzer Window
Creating and Displaying Analyzer and Interactive Reporting Content
Understanding Analyzer Service URLs
Operational Analyzer Viewer URL Parameters
Operational Analyzer Editor Parameters
Operational Interactive Reporting URL Parameters
Displaying an Analyzer Report in Viewer Mode
Displaying an Analyzer Report in Editor Mode
Creating a New Analyzer Report
Integrating Pentaho Web-Based Client Tools
Running Pentaho Analyzer In an iframe
Running Interactive Reporting In an iframe
Listing Content with the SolutionRepositoryService
Understanding the SolutionRepositoryService
SolutionRepositoryService Component Parameters
Retrieving a List of Solution Files
Getting Details for a Solution File
Creating a Solution Folder
Deleting a File
Retrieving Solution File and Directory Permission Settings
Setting Permissions On a Solution File
Solution ACL Permission Values
Using XML Services With ServiceAction
Understanding ServiceAction
Operational ServiceAction Parameters for Action Sequences
Operational ServiceAction Parameters for Security Details
Executing an Action Sequence With a SOAP Response
Retrieving the Security Model
Using the Ajax API For Asynchronous Execution
Understanding the Ajax API
pentahoAction Method Parameters
pentahoService Method Parameters
Executing an Action Sequence With JavaScript
Integrating Pentaho Mobile for OEM Software Vendors
Other Embedding Scenarios
Embedding the Core BI Platform
Embedding the Reporting Engine
Embedding the Analysis Engine
Developer Support
License Information
Obtaining the Source Code
Embedding the Pentaho Reporting Engine
Introduction
Required Knowledge and Expertise
Obtaining the Pentaho Reporting SDK
Using the Included Eclipse Project
Embedding the Reporting Engine Into a Java Application
Overview
Sample 0: The Base Class
Sample 1: Static Report Definition, JDBC Input, PDF Output
Sample 2: Static Report Definition, JDBC Input, HTML Output
Pentaho Reporting's Capabilities
Technological Advantages
Input Types
Output Types
Pentaho Report Designer
Other Embedding Scenarios
Building a Custom Reporting Tool
Hacking Pentaho Report Designer
Embedding the Pentaho BI Platform
License Information
Developer Support
Anatomy of the Pentaho Reporting SDK
JAR Reference
Source Code Links
More Examples
Sample 3: Dynamically Generated, JDBC Input, Swing Output
Sample 4: Dynamically Generated, JDBC Input, Java Servlet Output
Creating Action Sequences
Introduction
What is an Action Sequence?
What is a Solution?
Requirements and Recommendations
Using Design Studio
Initial Design Studio Configuration
Using PDI Data Sources in Action Sequences
The Design Studio Interface
Creating a Solution Directory
Your First Action Sequence
Anatomy of an Action Sequence
Output Types
Input Types
Resources
Parameter Data Types
Action Definition Reference
ContentRepositoryCleaner
EmailComponent
PrintComponent
SecureFilterComponent
SubActionComponent
TemplateComponent (Message Template)
JavascriptRule
SimpleReportingComponent
JFreeReportComponent
Charting
JFreeChart (ChartComponent)
Pentaho ChartBeans (ChartBeansComponent)
OpenFlashChart (OpenFlashChartComponent)
Introducing the Flash Chart Component
Sample Action Sequence
Optional Inputs
Required Inputs
Bar Chart
Line Chart
Bar and Line Combination Chart
Pie Chart
Area Chart
XY Dot Chart
Bubble Chart
Editing Existing Action Sequences
Internationalization Guidelines
Action Sequence Error Handling
Customizing Error Output
Error Token Reference
Basic Action Sequence Tips and Tricks
Emailing a Report
Advanced Action Sequence Tips and Tricks
Using Java Virtual Machine Input Parameters
Using Action Sequence Variables in Kettle/PDI
Sharing Result Sets in Action Sequences
Using Security Information In Action Sequences
Content Linking in Dashboards
In-Depth Action Sequence Tutorials
Creating a Bar Chart Using the Flash Chart Component
Configuring Design Studio
Creating the Chart Definition
Customizing the Template
Creating the Action Sequence
Creating a New Action Sequence
Defining General Properties
Defining Processes
Viewing your Chart in the BI Platform
Finding More Information
Troubleshooting
Action Sequences That Call PDI Content Won't Run
Adding PDI Enterprise Repository Content Support to the BA Server
Null Pointer Exception When Sharing Result Sets
Embedding and Extending Pentaho Data Integration
Getting Started
Extending Pentaho Data Integration
Creating Step Plugins
Maintaining Step Settings
Implementing the Step Settings Dialog Box
Processing Rows
Storing the Processing State
Working with Rows
Working With Fields
Handling Errors
Understanding Row Counters
Logging in Transformation Steps
Deploying Step Plugins
Sample Step Plugin
Exploring More Steps
Creating Job Entry Plugins
Implementing a Job Entry
Implementing the Job Entry Settings Dialog Box
Logging in Job Entries
Deploying Job Entry Plugins
Sample Job Entry Plugin
Exploring More Job Entries
Creating Database Plugins
Deploying Database Plugins
Sample Database Plugin
Exploring Existing Database Implementations
Creating Partioner Plugins
Implementing the Partitioner Interface
Implementing the Partitioner Settings Dialog Box
Deploying Partitioner Plugins
Sample Partitioner Plugin
Exploring Existing Partitioners
Debugging Plugins
Localization
Embedding Pentaho Data Integration
Running Transformations
Running Jobs
Building Transformations Dynamically
Building Jobs Dynamically
Obtaining Logging Information
Exposing a Transformation or Job as a Web Service
Customizing Pentaho Business Analytics
Introduction
Pentaho User Console Styling
Overview of Customizable Configuration Files
Replacing the Default Icon Set
Changing the Default Logo
Changing the Workspace Background
Customizing and Developing User Console Themes
Theme Engine Overview
Creating a New Theme
Setting the Default Theme
Switching PUC Themes
Removing or Changing Support Messages
Removing the Support Warning Message From JPivot
Removing the Support Warning Message From WAQR
Switching to a Production Login Screen
Testing Your Design Changes
Using the PUC UI Widget Test Page
Using Firebug to Test CSS Changes
Localization
BA Server and Thin Client Message Bundles
Pentaho User Console and Dashboard Designer Message Bundles
Switching PUC Message Bundles
Pentaho Analyzer Localization
Localization/Internationalization of Analysis Schemas
Pentaho Interactive Reporting Localization
Geographic Service (pentaho-geo) Localization
Enterprise Console Message Bundles
Enterprise Console Character Set Encoding
Action Sequence Message Bundles
Report Viewer Localization
Design Tool Localization
Using the Kettle Translator
Creating Design Tool Templates
Creating a Dashboard Designer Template
Reporting Templates
Report Design Wizard Template Design Guidelines
Interactive Reporting Template Design Guidelines
Dynamic Element Positioning in Templates
Template Properties
Deploying a Template to Report Design Wizard
Deploying a Template to Interactive Reporting
Setting the Default Interactive Reporting Template
Extending Pentaho Analyzer with Custom Visualizations
Create a Pentaho BA Server Plug-in
Custom Visualizations
Define the Custom Visualization
Register the Visualization with Pentaho Visualization API
Register the Visualization with Pentaho Analyzer
Register the Created JavaScript Files with Pentaho Analyzer
Restart the BA Server and Test the Visualization
Additional Resources
Creating Pentaho Dashboards
Introduction
Dashboard Theory
Dashboard Designer
Using Pentaho Dashboard Designer
Creating a New Dashboard
Working with the Chart Designer
Rotating Chart Axis Labels
Correcting Scaling Issues
Working with Dial Charts
Working with Pie Charts
Adding Data to a Chart
Adding a Data Table to a Dashboard
Updating the Data Table Display
Adding a Report Designer Report to a Dashboard
Adding an Action Sequence to a Dashboard
Adding an Analyzer Report to a Dashboard
Adding a Web Site to a Dashboard
Implementing Filters
Filtering Dashboards
Creating a SQL List
Creating a Metadata List
Creating a Cascading Filter
Linking Dashboard Filters to Analyzer Parameters
Editing Filters
Dashboard Parameters
Creating Chart or Data Table Parameters With the Query Editor
Using Content Linking to Create Interactive Dashboards
Linking Charts and Data Tables
Linking Columns in a Data Table to Content in other Dashboard Panels
Creating Content to Content Links in an Analyzer Report
Linking an Action Sequence Parameter to Content in other Dashboard Panels
Controlling a Dashboard Parameter From a PRPT Hyperlink
Dynamic Dashboard Titles
Using Save As in Dashboards
Editing Dashboards
Adding Content to a Dashboard Using Drag-and-Drop
Adjusting Whitespace in Dashboard Panels
Setting the Refresh Interval
Creating a Dashboard Designer Template
Community Dashboard Framework (CDF)
Exploring the CDF Sample Content
Custom JSP Dashboards
Enterprise Dashboard Support
Integrating With the BA Server
Introduction
Required Knowledge and Expertise
Required Software
Defining the BI Platform, BA Server, and Business Analytics
What We Mean By "Integrating"
BA Server Capabilities and Features
Input Types
Output Types
Engines and Content Creation
Security Integration
Scheduling and Distribution
Explanation of the BA Server Example Application
Deploying pentaho_integration_examples.war
Integrating BA Server Functionality
Using ViewAction to Retrieve Content
Understanding the ViewAction Content Generator
Operational ViewAction Parameters
Generating an HTML Report
Generating an HTML Report With a Form
Using ReportViewer to Generate User-Driven Reports
Understanding the ReportViewer Content Generator
Operational ReportViewer Parameters
Analyzing the Top N Customers
Displaying Content With the Reporting URL
Understanding the Reporting URL Content Generator
Operational Reporting URL Parameters
Static Display of the Top Three Customers
Exposing New/Open/SaveAs in the Analyzer Window
Creating and Displaying Analyzer and Interactive Reporting Content
Understanding Analyzer Service URLs
Operational Analyzer Viewer URL Parameters
Operational Analyzer Editor Parameters
Operational Interactive Reporting URL Parameters
Displaying an Analyzer Report in Viewer Mode
Displaying an Analyzer Report in Editor Mode
Creating a New Analyzer Report
Integrating Pentaho Web-Based Client Tools
Running Pentaho Analyzer In an iframe
Running Interactive Reporting In an iframe
Listing Content with the SolutionRepositoryService
Understanding the SolutionRepositoryService
SolutionRepositoryService Component Parameters
Retrieving a List of Solution Files
Getting Details for a Solution File
Creating a Solution Folder
Deleting a File
Retrieving Solution File and Directory Permission Settings
Setting Permissions On a Solution File
Solution ACL Permission Values
Using XML Services With ServiceAction
Understanding ServiceAction
Operational ServiceAction Parameters for Action Sequences
Operational ServiceAction Parameters for Security Details
Executing an Action Sequence With a SOAP Response
Retrieving the Security Model
Using the Ajax API For Asynchronous Execution
Understanding the Ajax API
pentahoAction Method Parameters
pentahoService Method Parameters
Executing an Action Sequence With JavaScript
Integrating Pentaho Mobile for OEM Software Vendors
Other Embedding Scenarios
Embedding the Core BI Platform
Embedding the Reporting Engine
Embedding the Analysis Engine
Developer Support
License Information
Obtaining the Source Code
Embedding the Pentaho Reporting Engine
Introduction
Required Knowledge and Expertise
Obtaining the Pentaho Reporting SDK
Using the Included Eclipse Project
Embedding the Reporting Engine Into a Java Application
Overview
Sample 0: The Base Class
Sample 1: Static Report Definition, JDBC Input, PDF Output
Sample 2: Static Report Definition, JDBC Input, HTML Output
Pentaho Reporting's Capabilities
Technological Advantages
Input Types
Output Types
Pentaho Report Designer
Other Embedding Scenarios
Building a Custom Reporting Tool
Hacking Pentaho Report Designer
Embedding the Pentaho BI Platform
License Information
Developer Support
Anatomy of the Pentaho Reporting SDK
JAR Reference
Source Code Links
More Examples
Sample 3: Dynamically Generated, JDBC Input, Swing Output
Sample 4: Dynamically Generated, JDBC Input, Java Servlet Output
Creating Action Sequences
Introduction
What is an Action Sequence?
What is a Solution?
Requirements and Recommendations
Using Design Studio
Initial Design Studio Configuration
Using PDI Data Sources in Action Sequences
The Design Studio Interface
Creating a Solution Directory
Your First Action Sequence
Anatomy of an Action Sequence
Output Types
Input Types
Resources
Parameter Data Types
Action Definition Reference
ContentRepositoryCleaner
EmailComponent
PrintComponent
SecureFilterComponent
SubActionComponent
TemplateComponent (Message Template)
JavascriptRule
SimpleReportingComponent
JFreeReportComponent
Charting
JFreeChart (ChartComponent)
Pentaho ChartBeans (ChartBeansComponent)
OpenFlashChart (OpenFlashChartComponent)
Introducing the Flash Chart Component
Sample Action Sequence
Optional Inputs
Required Inputs
Bar Chart
Line Chart
Bar and Line Combination Chart
Pie Chart
Area Chart
XY Dot Chart
Bubble Chart
Editing Existing Action Sequences
Internationalization Guidelines
Action Sequence Error Handling
Customizing Error Output
Error Token Reference
Basic Action Sequence Tips and Tricks
Emailing a Report
Advanced Action Sequence Tips and Tricks
Using Java Virtual Machine Input Parameters
Using Action Sequence Variables in Kettle/PDI
Sharing Result Sets in Action Sequences
Using Security Information In Action Sequences
Content Linking in Dashboards
In-Depth Action Sequence Tutorials
Creating a Bar Chart Using the Flash Chart Component
Configuring Design Studio
Creating the Chart Definition
Customizing the Template
Creating the Action Sequence
Creating a New Action Sequence
Defining General Properties
Defining Processes
Viewing your Chart in the BI Platform
Finding More Information
Troubleshooting
Action Sequences That Call PDI Content Won't Run
Adding PDI Enterprise Repository Content Support to the BA Server
Null Pointer Exception When Sharing Result Sets
Embedding and Extending Pentaho Data Integration
Getting Started
Extending Pentaho Data Integration
Creating Step Plugins
Maintaining Step Settings
Implementing the Step Settings Dialog Box
Processing Rows
Storing the Processing State
Working with Rows
Working With Fields
Handling Errors
Understanding Row Counters
Logging in Transformation Steps
Deploying Step Plugins
Sample Step Plugin
Exploring More Steps
Creating Job Entry Plugins
Implementing a Job Entry
Implementing the Job Entry Settings Dialog Box
Logging in Job Entries
Deploying Job Entry Plugins
Sample Job Entry Plugin
Exploring More Job Entries
Creating Database Plugins
Deploying Database Plugins
Sample Database Plugin
Exploring Existing Database Implementations
Creating Partioner Plugins
Implementing the Partitioner Interface
Implementing the Partitioner Settings Dialog Box
Deploying Partitioner Plugins
Sample Partitioner Plugin
Exploring Existing Partitioners
Debugging Plugins
Localization
Embedding Pentaho Data Integration
Running Transformations
Running Jobs
Building Transformations Dynamically
Building Jobs Dynamically
Obtaining Logging Information
Exposing a Transformation or Job as a Web Service
Documentation Archives: Previous Pentaho Releases
Documentation for Previous Supported Pentaho Releases
Documentation for Previous Supported Pentaho Releases