Skip To Content

Cleanup

The Cleanup step deletes active job versions associated with a job. It also deletes the target version on the branch versioned feature service. When the step is run, it checks the job for active job versions to delete.

Примечание:

Versions owned by other users can only be deleted by a portal administrator. If an active job version is owned by another user, the version can't be deleted and the Cleanup step fails.

When the step finishes running, a message appears on the job tile with the result of the step.

If the step fails to delete all job versions associated with the job, a CleanupFailed message appears in the job tile and the job doesn't proceed to the next step. Hover over the error message to display additional information about the error.

If the step fails and the return codes don't match any of the configured paths, and the step isn't optional, the step remains in a failed state and can’t be skipped.

Configure the step

Complete these steps to configure the Cleanup step:

  1. Create or edit a workflow diagram to access the Step Library panel.
  2. Drag Cleanup from the Step Library to a connection arrow of a step on the workflow canvas.

    The Step Details panel appears.

  3. Provide a name for the step in the Step Name text box.
  4. In the Arguments section, ensure that the Job Versions check box is checked.
  5. Click the Options tab.
  6. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.
    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

  7. Optionally, provide help text for the step in the Step Help text box.
  8. Optionally, click the Style tab to change the shape and color of the step.
  9. Optionally, click the About tab and provide a description for the step in the Step Description text box.
    Примечание:

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

Return codes

When the step finishes running, it sends a return code to indicate the result of the step. The return code is evaluated, and the workflow follows all paths that match the step's return value. The following table lists the step's return codes:

Return codeDescription

Failure

The step failed to complete successfully.

Success

The step completed successfully.

Step output

When the step finishes running, its output is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table lists the step's stored outputs:

OutputDescription

F000001

The step failed to complete successfully.

S000001

The step completed successfully.

Связанные разделы


В этом разделе
  1. Configure the step
  2. Return codes
  3. Step output