Skip to main content
Pentaho Documentation

Learn about the PDI client

Parent article

PDI client (Spoon) is a desktop application you install on your workstation enabling you to build transformations and jobs or schedule when jobs should run.

Start the PDI client

There are a few different ways to start the PDI client. The method that you should use depends on the way you installed Pentaho Data Integration (PDI).

If you used the Pentaho Installation Wizard to install Pentaho

If you installed Pentaho using the Pentaho Installation Wizard, you can launch the PDI client from your Windows Start menu.

Procedure

  1. Start the Pentaho Server.

  2. From the Windows Start menu, select All Programs Pentaho Enterprise Edition Design Tools Data Integration.

    The PDI client appears.

If you used manual installation to install Pentaho

If you installed Pentaho using the manual method, you can launch the PDI client from the Pentaho directory.

Procedure

  1. Start the Pentaho Server.

  2. Navigate to the folder where you have installed PDI. For example ...\pentaho\design-tools\data-integration.

  3. Launch the PDI client in the best way for your operating system.

    • For Windows: Double-click Spoon.bat
    • For Linux: Double-click spoon.sh
    • For Macintosh: Go to .../pdi-ee/data-integration and double-click the Data Integration icon.
  4. When the Pentaho License Manager dialog box appears, you must, at a minimum, enter the Pentaho PDI Enterprise Edition and the Pentaho Hadoop Enterprise Edition licenses to start the PDI client. For more information, see Manage Pentaho licenses.

Use the PDI client perspectives

Pentaho Data Integration (PDI) empowers you with tools that include ETL and scheduling in one unified environment — the PDI client interface. This integrated environment enables you to work in close cooperation with business users to build business intelligence solutions more quickly and efficiently.

When you are working in the PDI client, you can change perspectives to easily switch back and forth from:

  • Designing ETL jobs and transformations, and
  • Scheduling jobs and transformations.

As users provide you with feedback about how the data is presented to them, you can also quickly make iterative changes to your data directly using our data inspection tools in the PDI client.

From within the PDI client, you can change perspectives using the Perspective button in the toolbar.

Perspective selection

Perspectives in PDI help you focus how you work with different tasks.

Data Integration perspective

The Data Integration perspective allows you to create transformations and jobs. See Data Integration perspective in the PDI client for more details. You can also Inspect your data to make iterative updates as you work.

Data Integration perspective

In the table below, use the numbered items in the illustration above to reference the toolbars, buttons, and areas on the PDI client.

ItemFeatureDescription
1ToolbarUse this toolbar to access commonly performed actions:
  • New file button ( New file ) to create a new job, transformation, database connection, or slave server.
  • Open file button ( Open file ) to open a transformation or job from a file.
  • Explore Repository button ( Explore repository ) to explore the repositories.
  • Save button ( Save ) to save the current transformation or job to a file or repository.
  • Save As button ( Save as ) to save the transformation or job under a different file name or type.
  • Perspectives button ( Perspectives ) to switch between the different perspectives:
2Connect buttonUse this button to access the menu to create and connect to repositories for central storage of your ETL jobs and transformations.
3Sub-toolbarUse this toolbar to perform transformation or job actions:
  • Run button ( Run ) to run a transformation or job:
    • Run: Runs the current transformation or job from an XML file or a repository.
    • Run Options: Sets the Run Options and then runs the current transformation or job from an XML file or a repository.
  • Pause button ( Pause ) to pause a running transformation or job.
  • Stop button ( Stop ) to stop a running transformation or job:
    • Stop: Stops the transformation or job immediately.
    • Stop input processing: Stops the input steps to the transformation or job, while allowing any records already retrieved or initiated to be processed and then stopped.
  • Preview button ( Preview ) to run the transformation in preview mode to examine the rows produced by the selected steps.
  • Debug button ( Debug ) to run the transformation in debug mode to troubleshoot execution errors.
  • Replay button ( Replay ) to replay the processing of a transformation.
  • Verify button ( Verify ) to verify the transformation.
  • Analyze button ( Analyze ) to run an impact analysis on the database.
  • SQL button ( SQL ) to generate the SQL that is needed to run the loaded transformation.
  • Explore DB button ( ) to launch the Database Explorer to perform actions such as preview data, run SQL queries, and generate DDL.
  • Results button ( ) to show the Execution Results pane.
  • Lock button ( ) to lock the transformation.
4Explore paneUse this pane to access the Design and View tabs:
  • The Design tab provides a list of steps or entries that are used to build transformations or jobs.
  • The View tab provides information about available database connections and the steps and hops used for the transformation or job.
5CanvasUse this canvas for designing and building transformations and jobs for the ETL activities you want to perform.

Schedule perspective

You can plan when to run transformations and jobs, and set timed intervals to automatically send the output to your preferred destinations. See Schedule a transformation or job for more details.

Schedule perspective

The table below explains the menu, panel, and buttons on the Schedule perspective.

ItemFeatureDescription
1Menu barProvides access to common features such as properties, actions and tools. The right side of the menu bar is also where you can switch between perspectives.
2Main toolbarProvides single-click access to common actions such as edit, refresh, enable, disable, or delete. See Schedule a transformation or job for more details.
3Schedule panelContains a list of schedules to select. Double-click a highlighted schedule to access the Schedule dialog box for editing.

Customize the PDI client

The PDI client allows you to customize certain aspects of its behavior, along with the look and feel of the interface. The following table describes each of these options, which can be accessed from the menu bar: Go to Tools Options, then in the Kettle Options dialog box, select the Look & Feel tab.

OptionDescription
Fixed width fontThis option customizes the font that is used in the dialog boxes, trees, input fields, and more; click Edit to edit the font or Delete to return the font to its default value.
Font on workspaceThis option customizes font that is used in the PDI client interface; click Edit to edit the font or Delete to return the font to its default value.
Font for notesThis option customizes the font used in notes that are displayed in the PDI client; click Edit to edit the font or Delete to return the font to its default value.
Background colorThis option sets the background color in the PDI client and affects all dialog boxes; click Edit to edit the color or Delete to return the background color to its default value.
Workspace background colorThis option sets the background color in the graphical view of the PDI client; click Edit to edit the background color or Delete to return the background color to its default value.
Tab colorThis option customizes the color that is being used to indicate tabs that are active/selected; click Edit to edit the tab color or Delete to return the color to its default value.
Icon size in workspaceAffects the size of the icons in the graph window. The original size of an icon is 32x32 pixels. The best results (graphically) are probably at sizes 16,24,32,48,64 and other multiples of 32.
Line width on workspaceAffects the line width of the hops in the the PDI client graphical view and the border around the step.
Shadow size on workspaceIf this size is larger than 0, a shadow of the steps, hops, and notes is drawn on the canvas, making it look like the transformation floats above the canvas.
Dialog middle percentageBy default, a parameter is drawn at 35% of the width of the dialog box, counted from the left. You can change using this option in instances where you use unusually large fonts.
Canvas Grid SizeIndicates the size of the grid on the PDI client canvas.
Show Canvas GridEnabling this option will show a dotted grid on the PDI client canvas.
Canvas anti-aliasingSome platforms like Windows, OSX and Linux support anti-aliasing through GDI, Carbon or Cairo. Enable this option for smoother lines and icons in your graph view. If you enable the option and your environment does not work, change the value for option EnableAntiAliasing to N in file $HOME/.kettle/.spoonrc (C:\Documents and Settings\<user>\.kettle\.spoonrc on Windows).
Show bottleneck transformation stepsIf a step in the transformation is processing slowly, a graphic displays around that step to make the bottleneck visible.
Use look of OSEnabling this option on Windows allows you to use the default system settings for fonts and colors in the PDI client. On other platforms, the default is always enabled.
Show branding graphicsEnabling this option will draw Pentaho Data Integrationbranding graphics on the canvas and in the left-hand side "expand bar."
Preferred LanguageSpecifies the preferred language setting.
Alternative LanguageSpecifies the alternative language setting. Because the original language in which Pentaho Data Integration was written is English, it is best to set this locale to English.