Skip to main content
Pentaho Documentation

Documenting Transformations and Jobs

Overview

Explains how to use the note documentation feature.

Good documentation can help you and others understand the structure, design decisions, business rules, dependencies, and other aspects of your transformations and jobs.  To assist you with this, Spoon allows you to add notes to your transformations and jobs.  These notes appear on the canvas and can easily be edited.

Creating a Note

To create a note:

  1. Right-click the canvas and select New Note
  2. The Notes window appears.
  3. Click the Font Style tab to customize the font and color.
  4. Click the Note tab, then in the Note field and begin typing the note.
  5. Click OK to save the note.
  6. The note appears on the canvas.

Editing a Note

To edit a note:

  1. Double-click the note on the canvas.
  2. The Notes window appears.
  3. Click the Font Style tab to customize the font and color.
  4. Click the Note tab, then in the Note field to edit the note.
  5. Click OK to save the note.
  6. The note appears on the canvas.

Reposition a Note

To move the note to a different area of the canvas, do one of the following:

  • Drag the note to the desired position on the canvas.
  • Right-click and select Raise Note, then drag the note upwards on the canvas.
  • Right-click and select Lower Note, then drag the note downwards on the canvas.

Deleting a Note

To delete a note, right-click the note, then select Delete Note.