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.
Note:
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 wasn't configured with Can Be Skipped, the step remains in a failed state and can’t be skipped.
Configure the step
Complete these steps to configure the Cleanup step:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Cleanup from the Step Library to a connection arrow of a step on the workflow canvas.
The Settings panel appears.
- Provide a name for the step in the Step Name text box.
- Optionally, provide a description for the step in the Step Description text box.
- Configure step options in the Options section as necessary.
- Automatically Executes—Runs the step as soon as it becomes active.
- Can Be Skipped—Allows the step to be finished without being run.
- In the Logic section, choose the following options as necessary.
- Job Versions—Deletes all job versions associated with the job.
- Attachments—Deletes all attachments associated with the job.
- Optionally, click the Help tab and provide help text for the step in the Help text box.
- Optionally, click the Style tab to change the shape and color of the step.
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 is a list of return codes:
| Return code | Description |
|---|---|
| Failure | The step failed to complete successfully. |
| Success | The step completed successfully. |