Manage a running pipeline batch

Abstract

How to control or stop a pipeline batch while it is running in Sitecore Data Exchange Framework.

You can use various methods to see if a pipeline batch is currently running. If necessary, you can stop it before it has finished running.

Check if a pipeline batch is running

The pipeline batch runs as an asynchronous task on the server. You will therefore not be notified when the pipeline batch is finished running. There are, however, three ways you can see if the pipeline batch has completed:

  • While the pipeline batch is running, the Run Pipeline Batch button is disabled.

    Note

    The button may be disabled for other reasons, such as if the tenant is disabled, or if no pipelines are assigned to the pipeline batch.

  • While the pipeline batch is running, the Stop Pipeline Batch button is enabled. If the button is disabled, the pipeline batch is not running.

  • On the pipeline batch item, in the Summary section, there is a Last Run Finished field. If the date-time value in this field is equal to or later than the value in the Requested At field, the pipeline batch has completed.

    Note

    If the pipeline batch throws an unhandled exception during execution, the Last Run Finished value is not updated.

Stop a pipeline batch

You might need to stop a pipeline batch before its completion, for example, if it was started by an error.

Warning

When a pipeline batch is stopped, any data that it has already processed remains in the system. This can lead to inconsistent, unexpected, or corrupted data. There is no automatic rollback or undo.

To stop a pipeline batch while it is running:

  1. In Sitecore Content Editor, navigate to the tenant containing the pipeline batch.

  2. Navigate to the Pipeline Batches folder. Select the pipeline batch in the folder.

  3. On the ribbon, on the Data Exchange tab, click Stop Pipeline Batch.

  4. A message appears asking you to confirm that you want to stop the pipeline batch. Click OK to stop the pipeline batch.

    Note

    Clicking OK sends an instruction to the server to stop the pipeline batch. This is handled asynchronously, and as a result, the pipeline batch might not stop immediately.