Hide All Show All

User Guides

  • Getting Started with BI Suite
    Detailed walkthroughs that show how to create content with Pentaho User Console design tools.
  • Pentaho User Console Guide
    Reference material and task-based documentation on Pentaho Dashboard Designer, Pentaho Analyzer, Pentaho Interactive Reporting, and the content scheduling and authorization features in the Pentaho User Console.
  • Analysis Guide
    Guidance and theory on creating ROLAP schemas with Schema Workbench and Pentaho Data Integration; Pentaho Analyzer and JPivot user documentation; Mondrian engine and Pentaho Analyzer configuration instructions. Also includes an MDX element reference.
  • Report Designer User Guide
    Reference material and task-based documentation on creating, editing, and publishing reports with Pentaho Report Designer. Includes a complete chart property reference.
  • Metadata Editor User Guide
    Reference material and task-based documentation for creating, editing, and publishing metadata models with Pentaho Metadata Editor.
  • Getting Started with PDI
    Evaluation document showcasing the high-value features of PDI.
  • PDI User Guide
    Reference material and task-based documentation that covers the majority of the functionality in Pentaho Data Integration.
  • Big Data Guide
    How to install and configure Pentaho's Big Data distribution, along with procedural documentation on how to implement the Big Data related job entries and transformation steps in Pentaho Data Integration.
  • Aggregation Designer User Guide
    Information on creating aggregate tables for Pentaho Analysis.

Administrator Guides

  • BI Suite Admin Guide
    Explains system configuration and administration tasks for the Pentaho BI Server and DI Server. (Please see the Security Guide for detailed instructions on implementing different user authentication methods).
  • BI Suite Troubleshooting Guide
    A collection of troubleshooting topics from all other Pentaho guides. You may find this useful if you have encountered some kind of error but don't know where in the BI Suite to look for the root cause.
  • BI Suite Graphical Installation Guide
    Installation instructions for the graphical BI Suite installer, including system requirements and a high-level list of the software that is installed to your machine. NOTE: This is the most common installation method, but requires that you use the Pentaho-supplied Java Runtime Environment, MySQL database, and Tomcat application server.
  • BI Suite Archive-based Installation Guide
    Installation instructions for deploying zip or tar.gz archive packages for every part of the BI Suite. Includes system requirements and a high-level list of the software that is installed to your machine. This installation method allows you to use Oracle, PostgreSQL, or your own version of MySQL for the BI Server solution database, and your own Java Runtime Environment.
  • BI Suite Manual Deployment Guide
    J2EE WAR assembly and deployment instructions for the Pentaho BI Server. Only use this installation path if you must use your own version of Tomcat or JBoss to run the BI Server.
  • BI Suite Security Guide
    Instructions and guidance for implementing a different user authentication method, or for implementing SSL on the BI Server. Covers Active Directory, LDAP, single sign-on, and custom JDBC authentication.
  • BI Suite Performance-Tuning Guide
    Guidance and instructions for improving performance in most areas of the BI Suite. Covers modification of the BI Suite, guidelines for content streamlining, application server clustering, and advice on performance monitoring and testing.
  • PDI Installation Guide
    Installation instructions for both the graphical PDI installer and the zip and tar.gz archive packages. Covers server and workstation installations. Includes system requirements and a high-level list of the software that is installed to your machine.
  • PDI Administrator's Guide
    Explains system configuration and administration tasks for the DI Server.
  • PDI Upgrade Guide
    Instructions for upgrading from the previous version of Pentaho Data Integration to the newest. This pertains to both the client tool (Spoon) and the Data Integration Server (DI Server).

Developer Guides

  • Customizing the BI Suite
    Instructions for localization and basic customization of the Pentaho User Console, including Pentaho Analyzer, Interactive Reporting, and Dashboard Designer.
  • Creating Pentaho Dashboards
    Design theory for creating dashboards that use Pentaho content. Covers Pentaho Dashboard Designer, Community Dashboard Framework (CDF), and basic guidance for custom JSPs.
  • Integrating the BI Server
    Code samples and URL parameter reference material that shows how to interact with or embed (in an existing Web application) Pentaho Analyzer, Dashboard Designer, and Interactive Reporting.
  • Embedding the Pentaho Reporting Engine
    Guidance and code samples for using the Pentaho Reporting SDK to embed the Reporting engine in Java applications.
  • Creating Action Sequences
    Reference material, guidance, and code samples for creating action sequences to run on the Pentaho BI Platform. Includes user documentation for Pentaho Design Studio.