Administer Pentaho Data Integration and Analytics

Version: 10.2.x
Audience: anonymous
Part Number: MK-95PDIA002-12

Pentaho administration
Manage the Pentaho system
Manage Pentaho licenses
Acquire a trial license
Acquire and install enterprise licenses
Process overview for enterprise licenses
Acquire an enterprise license
Activate a license using a cloud license server
Activate a license using a local license server
Install and manage a local license server
Install a local license server on Linux
Install a local license server on Windows
Administrative commands for local license server
Set up Self-Signed Certificate (SSL)
Activate offline entitlements for a local license server
Uninstall a local license server (Linux)
Uninstall a local license server (Windows)
Install licenses using PUC
Install licenses using the PDI client
Manage licenses using the command line interface
Setting the license path environment variable
Set the license path environment variable on Linux
Set the license path environment variable on Windows
Install or update license files from the command line
Manage the Pentaho Server
Hide User Console Home perspective widgets
Turn off autocompletion of User Console sign-in credentials
Remove sample data from the Pentaho Server
Importing and updating email addresses used for scheduling from data sources
Import and update email addresses from a JDBC source
Import and update email addresses from an LDAP source
Advanced topics
Customize the Pentaho Server
Change the PDI home directory location
Standalone PDI client tool deployments
Pentaho Server deployments that run PDI content
Windows service modification
Change Ports and URLs
List of server ports used by PDI
Change Pentaho Server (Tomcat) port numbers
Change the Pentaho Server URL
Change the location of the server log file
Manage config files for the Scheduler plugin
Change the Quartz misfire threshold
Set default SELECT DISTINCT for Interactive Reports
Set system max row limit for Interactive Reports
Roll back system max row limit
Increase the CSV file upload limit
Change the staging database for CSV files
Change the Karaf startup timeout setting
Change the port numbers for the Pentaho Server
Change the web application name or port
Change the web application name on Tomcat
Change the web application name on JBoss
Activate view-only mode for Interactive reports
Set up a cluster
Step 1: Address prerequisites for clustering
Step 2: Initialize and configure repository
Step 3: Configure Jackrabbit Journal
Step 4: Configure Quartz
Step 5: Start and test the cluster
Manage the Pentaho Repository
Upload and download from the Pentaho Repository
Upload folders and files
Upload from the command line
Download folders and files
Download action permissions
Download a folder
Download a file
Download from the command line
Response code definitions
Command line arguments reference
Upload
Download
Backup and restore
Common arguments
Import and export PDI content
Import content into a repository
Import content from the command line
Export content from the repository
Export content from the command line
Set PDI version control and comment tracking options
Editing the version control statement
Verifying the version control option
Editing the comment tracking statement
Verifying the comment tracking option
Purge transformations, jobs, and shared objects from the Pentaho Repository
Backup and restore Pentaho repositories
Backup and restore the Pentaho Repository
Step 1: Backup the Pentaho Repository
Step 2: Restore the Pentaho Repository
Localize Folders and Reports
Localization file structure
Localization file names
Localization variables
Popularly used country and location codes
Set default localization for reports and folders
Localize for additional languages
Edit existing localization information
Secure the Pentaho system
User security
Pentaho Server security
Restrict or share files and folders
Pass authentication credentials in URL parameters
Remove Pentaho Server security
Enable anonymous access
Modify application security
Modify Pentaho configuration
Modify repository properties
Map the appropriate role
Remove security from data source management
Hiding user folders in PUC and PDI
Hide Home folders for users in PUC and PDI
Override the hidden Home folder for a user
Stop hiding the Home folder for new users
Assign the Write permission to a user folder in PUC
Assign the Write permission to a user folder in the PDI client
Advanced security providers
AES security
Create an AES key file
Specify AES variables in the properties file
Configure Pentaho for AES encryption
Use a batch file command to verify encryption
Use the PDI client to verify encryption
MSAD security
Switch to MS Active Directory
Manual configuration
Binding
Referrals
Nested groups
See also
LDAP security
Switch to LDAP
Manual configuration
Chain LDAP servers
Step 1: Configure the authentication manager
Step 2: Configure the your users and roles
Step 3: Create a spring security application context file
Step 4: Create Pentaho security application context file
Step 5: Create a properties file for the ldapProvider
Step 6: Apply your new files
Step 7: Complete the configuration process
Use nested roles
LDAP properties
Connection information (context)
Users
Populator
All authorities search
All user name search
JDBC security
Switch to JDBC security
Manual LDAP/JDBC hybrid configuration
Step 1: Create user/authorities database tables
Step 2: Update user and role values for tables
Step 3: Update JDBC security queries
Step 4: Enable JDBC Authorization beans
Update security properties file
Update spring security-jdbc properties file
Update the pentaho-security-jdbc file
Update the pentahoObjects spring file
Update spring security-ldap file
Update the repository spring properties file
Step 5: Verify LDAP/JDBC Configuration
SSO security
Switch to Central Authentication Service (CAS)
Configure session timeout
SSL Security
Configure SSL (HTTPS) in the Pentaho User Console and Pentaho Server
Enable SSL in the Pentaho Server with a certificate authority
Enable SSL in the Pentaho Server with a self-signed certificate
Change the Pentaho Server fully qualified URL
Use the Apache web server (HTTPd) for socket handling
Change the administrator role
Spring (authentication providers) security
ApplicationContext
Add the Jackrabbit provider
Add another provider
Configure authentication
Authentication provider examples
SAML security
Server-Side Request Forgery prevention
Preventing Server-Side Request Forgery
Big data security
Kerberos authentication versus secure impersonation
Prerequisites
Supported components
How to enable secure impersonation
Understanding secure impersonation
Use secure impersonation with a cluster
Prerequisites
Configuring MapReduce jobs
Connecting to a Cloudera Impala database
Next steps
How to enable Kerberos authentication
Set Up Kerberos for Pentaho
Configure Kerberos on Linux
Configure JCE
Modify the Kerberos configuration file
Synchronize clocks
Obtain Kerberos ticket
Next step
Configure Kerberos for Windows
Configure JCE
Download and install Kerberos
Modify the Kerberos configuration file
Synchronize clocks
Obtain Kerberos ticket
Set up user accounts and network access for all OS
Next step
Use Kerberos with MongoDB
Complete MongoDB and client prerequisites
Add users to Kerberos database
Set up Kerberos Administrative Server and KDC to start when server starts
Configure client-side nodes
Configure Linux and Mac client nodes
Install JCE on Linux and Mac clients
Download and install Kerberos client on Linux and Mac clients
Modify Kerberos configuration file to reflect Realm, KDC, and admin server on Linux and Mac clients
Specify the location of the Kerberos configuration file on Mac clients that run the PDI client
Specify the location of the Kerberos configuration file on Mac clients that run PRD
Synchronize clock on Linux client
Obtain Kerberos ticket on Linux client
Configure Windows client nodes
Install JCE on Windows client
Download and install Kerberos client on Windows client
Modify Kerberos configuration file to reflect Realm, KDC, and admin server on Windows client
Synchronize clock on Windows client
Obtain Kerberos ticket on Windows client
Test authentication with the PDI client using configuration fields
Test authentication with the PDI client using a connection string
Use Kerberos with Spark Submit
Prerequisites
Spark Submit entry properties
Use Knox to access CDP
Setup requirements for Knox with Pentaho
Hive configuration with Knox
Pentaho and CDP security
Use of Knox as a gateway for CDP and Pentaho
Optimize the Pentaho system
Performance monitoring
PDI logging
Set up the log file
Use the log file
Maintain logging
Log rotation
Execution status
On Carte
Best practices for logging
Pentaho Operations Mart
Business Analytics Operations Mart
Download and install Operations Mart files
Increase the maximum character length in audit table fields
Choose a pre-built Operations Mart report
View and edit Operations Mart reports
Create Operations Mart reports
Update the Operations Mart
Clean up Operations Mart
Data Integration Operations Mart
Setting up DI Operations Mart with an archive installation
Before you begin
Process overview
Step 1: Get the Data Integration Operations Mart files
Step 2: Run the setup scripts
Step 3: Set the global Kettle logging variables
Step 4: Add the JNDI connections for logging
Step 5: Add a JDBC connection for the Pentaho Server
Step 6: Add the Data Integration Operations Mart ETL solutions to the Pentaho Repository default content folder
Step 7: Initialize the Data Integration Operations Mart
Step 8: Verify the Data Integration Operations Mart is working
Setting up the DI Operations Mart with a manual installation
Before you begin
Process overview
Step 1: Get the Data Integration Operations Mart files
Step 2: Run the setup scripts
Step 3: Set the global Kettle logging variables
Step 4: Add the JNDI connections for logging
Step 5: Add a JDBC connection for the Pentaho Server
Step 6: Add the Data Integration Operations Mart ETL solutions to the Pentaho Repository default content folder
Step 7: Initialize the Data Integration Operations Mart
Step 8: Verify the Data Integration Operations Mart is working
Charts, reports, and dashboards using the DI Operations Mart data
Data Integration Operations Mart Reference
Logging tables status
Transformation log tables
Jobs logs tables
Logging dimensions and metrics
Fact table
Batch dimension
Date dimension
Execution dimension
Executor dimension
Log table
Time-of-day dimension
Step fact table
Step dimension
Job entry fact table
Execution performance fact table
Clean up DI Operations Mart tables
Third-party monitoring with SNMP
Before you begin
Send traps through a centralized monitoring server
Step 1: Configure Pentaho Server to send trap events
Step 2: Configure the monitoring tool to recieve trap events
Upload the MIB file to a monitoring tool
Convert the MIB file to a configuration file
Add the newly generated configuration file to the SNMP initialization file
Send traps from PDI tools to monitoring tool
From all PDI client tools
From a specific PDI client tool such as Carte
Configuring the type of events to be monitored
Available extension points
Tracking access to sensitive data
Mapped Diagnostic Context (MDC) tracking properties
Activate logging with MDC tracking properties
Working with Pentaho Operations Mart
Correlating Pentaho logs with third-party tools
Performance tuning
Pentaho Server performance tips
Set timeouts
Disable server and session-related timeouts to debug
Define result row limit and timeout
Move Pentaho managed data sources to JNDI
Manual cleanup of the Temporary folder
Memory optimization for the Geo Service plugin
Turn off audit logging
Test Pentaho Server scalability
Sessions and URLs
Memory and sessions
Use Apache HTTPd with SSL for delivering static content
Pentaho Reporting performance tips
Cache report content
Result set caching
Result set cache options
Streamline printed output
Paginated exports
Page break methods
Page states
Table exports
HTML exports
Pentaho Reporting configuration files
Pentaho Data Integration performance tips
Limit in-memory log output
HBase Output performance considerations
HBase Input performance considerations
Enable Weka plugins
Mondrian performance tips
Optimize your infrastructure
Redesign your data warehouse
Switch to analytic database
Query optimization
Optimize Pentaho Analyzer
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
Mondrian cache control
PentahoAnalyzer configuration files
Pentaho data mining (Weka) performance tips
Change the Java VM memory limits
Microsoft Windows with a graphical installation
Linux with a graphical install
Archive or manual deployment
Aggregation Designer
Pentaho Data Integration
Report Designer
Weka
Jackrabbit repository perfomance tuning
Jackrabbit hangs on unused data
Jackrabbit runs slowly with too many home directories
Jackrabbit Lucene SearchIndex slows server performance
If you have a custom-configured repository XML file
If you are using the default repository XML file
Karaf performance tuning
Set up write permissions for directories containing Karaf
Issue description
Solution: Define -D variables for Karaf
Define system variable
Add -D parameters to PDI client and/or PRD
Troubleshoot the Pentaho system
General issues
JDBC driver issues
Data conversion issues with MySQL driver 5.0.8
Fixing JTDS varchar(Max) limitations in MSSQL 2005
Security issues
Increase security log levels in the Pentaho Server
Enable extra LDAP security logging
Log output security analysis
LDAP roles issues with Admin and Authenticated
With LDAP authentication, the PDI Repository Explorer is empty
LDAP incorrectly authenticates user IDs that do not match letter case
Connection timeout issues when using CAS
Cannot change Administrator password in PUC
Snowflake logging errors
Pentaho Server issues
Publishing domain to the Pentaho Server fails
Library conflicts
Report parameters that include accented characters
VFS provider XML duplicates
Tomcat logs report memory leaks
Windows domains will not authenticate when using the JTDS driver
Unable to run XAction when using JavaScript component
PDI cannot access Amazon S3
Pentaho Repository issues
Debugging a corrupted Pentaho Server repository
Using the H2 database recovery tool
Unable to get list of repositories
Importing and exporting PDI content with Pentaho 8.0 and earlier
Developer center
Platform JavaScript APIs
Visualization API
Create a visualization
Develop a visualization in a sandbox
Quick start
Setting up the sandbox environment
Inspect your sandbox environment
Creating the model
Completing the model code
About the model properties
Registering the model
Additional model metadata
Creating the view
Styling the view
Styling the model for applications
Adding interactive elements to the view
Implementing the Execute action
Implementing the Select action
Adding a default configuration
Create the Pentaho web package
Deploying a visualization
OSGi artifacts deployment
Inspecting tutorial results
Configuring a visualization
Common model configurations
Common view configurations
Common color palette configurations
Stock visualizations identifiers
Stock color palettes identifiers
Moving to Visualization API 3.0
Metadata and registration conversion
Configuration
Converting the visualization class
Packaging
Analyzer and the Visualization API
Difference between Visualization API 2.0 and 3.0 in Analyzer
Changing the Visualization API version in Analyzer
Migrating visualization settings in Analyzer
Differences between Visualization API 2.0 and 3.0
Visualization identifiers in Visualization API 2.0 and 3.0
Visualization property values in Visualization API 2.0 and 3.0
Configuration API
Configuration module example
Global configuration file
Known values of Pentaho platform environment variables
Pentaho web package
The name and version fields
The paths field
The dependencies field
The config field
OSGi artifacts deployment
Customize Pentaho products
Customize the Pentaho User Console
Location of customizable configuration files
Mantle style CSS
Theme-specific local and global style sheets for PUC
Product-specific theme settings for Analyzer, Dashboard Designer, and Interactive Reports
Change the application login page logo and background
Add a logo to the web application
Make custom User Console themes
Understanding theme system basics
Creating a new theme
Setting the default theme
Switching console themes
Test your CSS changes
Localize the Pentaho Server
Customize Pentaho Analyzer
Properties file
Setting the default placement of column and row totals
Collapse business group folders in the Available Fields list
Sort options in the Available Fields list
Default sort option priorities
Specify with an URL
Specify with annotation
Specify through the properties file
Set discrete axis for line, area, and scatter charts
Set time dimensions to discrete axes in Analyzer
Set number dimensions to discrete axes in Analyzer
Removing headers, filters, and actions for reports in dashboards
Control empty rows in reports
Localization
Assign Analyzer chart colors
Assigning colors using a text-based file
Assigning colors using a member property
Assigning colors to levels
Assigning colors to measures
Custom Analyzer action links to JavaScript functions
Define custom actions in Mondrian
Implement a custom action JavaScript function
Determine when to show a custom action
Third-party visualizations
PDF and Excel export customizations
PDF and Excel settings
Customizing the PDF cover page
Customizing the PDF logo
Set default fonts for PDF export
Removing report attributes
Removing a data table and report worksheet
Creating custom headers and footers
Theming a pivot table
Set pivot table minimum font size
Customize the logo on Excel exports
Customize the font on Excel exports
Embed and extend Pentaho functionality
Embed Pentaho Server functionality into web applications
Get started with the embedded samples
Report Designer samples
Execute a report from a HTML form (POSTing parameters)
Render a report in an IFRAME
Render report viewer with available parameters and executed report
Publish a file to the Pentaho Server
Analyzer samples
Display a report in viewer mode
Display a report in editor mode
Create a new Analyzer report
Integrate into a custom web application via an IFRAME
Specify the select schema service
Interactive Reports samples
Display Interactive Reports
Create new Interactive Reports
Integrate into a custom web application via an IFRAME
Action sequence samples
Run an action sequence to generate a report
Run an action sequence to generate a report with prompts
Configure the proxy trusting filter
Developer support
Embed and extend PDI functionality
Get started with the sample PDI project
Download the sample project
Set up a development environment
Get PDI sources
Attach source to PDI JAR files
Additional developer documentation
Embed Pentaho Data Integration
Get started with embedding PDI
Complete set of dependent PDI files
OSGi features for PDI
Kettle (non-OSGi) plugins
Pentaho license file
Sample class scenarios
Run transformations
Run jobs
Dynamically build transformations
Dynamically build jobs
Obtain logging information
Expose a transformation or job as a web service
Use non-native plugins
Extend Pentaho Data Integration
Create different types of plugins
Create step plugins
Using your icon in PDI
Including images in a built-in Kettle transformation or job
Including images in a Kettle plugin
Maintain step settings
Implement the Step Settings dialog box
Process rows
Store the processing state
Work with rows
Work with fields
Handling errors
Understanding row counters
Logging in steps
Add metadata injection support to your step
InjectionSupported
Injection
InjectionDeep
Generics
Deploy step plugins
Sample step plugin
Exploring more steps
Create 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
Create database plugins
Understanding database plugins
Exploring existing database implementations
Deploying database plugins
Sample database plugin
Build and deploy sample database plugin from the command line
Build and deploy sample database plugin from Eclipse
Create partitioner plugins
Implementing the partitioner interface
Keep track of partitioner settings
Serialize partitioner settings
Provide the name of the dialog class
Partition incoming rows during runtime
Interface with the PDI plugin system
Implementing the Partitioner Settings dialog box
Maintain the dialog for partitioner settings
Deploying partitioner plugins
Sample partitioner plugin
Exploring existing partitioners
Create PDI icons
The anatomy of a PDI icon
Positioning action indicators
Action indicator badges
Color palette
Downloading PDI icon template
Debug plugins
Localize plugins
Embed reporting functionality
Get started with the Pentaho Reporting SDK
Use the included Eclipse project
SDK directory structure
Content of the samples directory
Embed the reporting engine into a Java application
Work with the reporting engine samples
Sample1.java
Sample2.java
Sample 0: The base class
Sample 1: Static report definition, JDBC input, PDF output
Sample 2: Static report definition, JDBC input, HTML output
Other embedding scenarios
Build a custom reporting tool
Hack the Pentaho Report Designer
Embed the Pentaho BI platform
Developer support
License information
Advanced topics
JAR reference
Pentaho-authored JARs
Included third-party JARs
JARs exclusive to the embedding samples
Source code links
Included third-party JARs
JARs exclusive to the embedding samples
Sample 3: Dynamically generated, JDBC input, swing output
Sample 4: Dynamically generated, JDBC input, Java servlet output
Directions for running Sample4
Multi-tenancy
What is multi-tenancy?
Multi-tenancy in Pentaho
Preparing for multi-tenancy in Pentaho
Data multi-tenancy and supported methods
Sharding data multi-tenancy
IDBDatasourceService implementation example
Configuring IDBDatasourceService
Using the data source
Striping and data model multi-tenancy
Pentaho metadata security
Set the global constraint
SQL generator
Analyzer data multi-tenancy
Dynamic schema processor
Delegate roles
Populate the user session
Add a role to the schema
Configure the role mapper
Create a custom connection
Create a delegating role class
Solution multi-tenancy
Roles and Access Control Lists (ACLs)
Multi-tenancy at the content level
Custom voters
Managing ACLs via a web service
UI multi-tenancy
Theming
Setting the theme per tenant
Additional resources
Pentaho support
Training and services
Liability limits and warranty disclaimer
Trademarks
Third-party open source software
About the documentation

Back to home page