Skip to main content
Pentaho Documentation

Add notes to transformations and jobs

Parent article

Notes can help you and others understand the structure, design decisions, business rules, dependencies, and other aspects of your transformations and jobs.

You can add and edit notes to your transformations and jobs in the PDI client canvas.

Create a note

Perform the following steps to create a note:

Procedure

  1. Right-click the canvas and select New Note.

    The Notes window appears.
  2. Click the Font Style tab to customize the font and color.

  3. Click the Note tab, then in the Note field and begin typing the note.

  4. Click OK to save the note.

Results

The note appears on the canvas.

Edit a note

Perform the following steps to edit a note:

Procedure

  1. Double-click the note on the canvas.

    The Notes window appears.
  2. Click the Font Style tab to customize the font and color.

  3. Click the Note tab, then in the Note field to edit the note.

  4. Click OK to save the note.

Results

The note appears on the canvas.

Reposition a note

Perform the following steps to move the note to a different area of the canvas:

Procedure

  1. Drag the note to the desired position on the canvas:

  2. Right-click on the note and then perform one of the following actions:

    • Raise Note then drag the note upwards on the canvas.
    • Lower Note then drag the note downwards on the canvas.

Delete a note

Perform the following steps to delete a note:

Procedure

  1. Hover over the note.

  2. Right-click and then select Delete Note from the menu that appears.