Skip to main content
Pentaho Documentation

Use Checkpoints to Restart Jobs

Checkpoints let you restart jobs that fail without you having to rerun the entire job from the beginning.  You add checkpoints at hops that connect one job entry to another.  Then, when you run the job and a checkpoint is encountered, the software saves the state of the job entry, including the parameters, internal result rows, and result files.  If an error occurs that causes the job to fail, like the database is not functioning properly so you can't connect to it, the job ends.  But, when the error is resolved and you restart the job, instead of the job starting at the beginning, it starts at the last checkpoint before the error occurred.  Because the state of the job entry performed up to the checkpoint was saved, the job resumes as if the failure had not occurred.  In addition to setting up checkpoints, you need to set up a checkpoint log. The checkpoint log tracks each time a job runs and where failures occur. This can be helpful for troubleshooting.

In addition to the general instructions presented in this section, checkpoints are addressed in detail in the wiki.

Add a Checkpoint

To add a checkpoint, complete these steps.
  1. In Spoon, open a job.
  2. Right-click a step or transformation in the job, then select Restartable Checkpoint from the menu that appears.
  3. The checkpoint is added to the job.

Delete a Checkpoint

To delete a checkpoint, complete these steps.
  1. In Spoon, open a job.
  2. Right-click a step or transformation in the job, then select Clear Checkpoint Marker from the menu that appears.
  3. The checkpoint is cleared from the job.

Set Up a Checkpoint Log

To set up a checkpoint log, complete these steps. Checkpoints logs are covered in detail in the wiki.
  1. In Spoon, open a job.
  2. Right-click in an empty space in the job’s tab that appears in the Spoon window.   In the Job Properties window, click the Log tab.
  3. Select Checkpoints log table.

checkpointlogtable1.png

  1. Add the log connection and the name of the log table, as well as other information as needed.
  2. Choose the log table fields you want enabled.
  3. When complete, click OK.