Add and configure Cleanup

License:

Organization members must be assigned a license for the ArcGIS Advanced Editing user type extension to use this step.

The Cleanup step can be used to remove the active job version, the location defined in the job, replicas associated with the job, and the replica files from the shared file location. When used to delete the active job version, the Cleanup step deletes the target version on the branch versioned feature service.

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 more 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 cannot be skipped.

Configure the step

Do the following to configure the step:

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

   Learn more about adding steps to a workflow diagram

   The Step Details panel appears.

3. Provide a name for the step in the Step Name text box.
4. Check one or more options in the Arguments section:
   • Job Versions—Removes the job's active version and the target version on the branch versioned feature service
   • Job Location—Removes the location defined in the job
   • Unregister Job Replicas—Removes the replica's association with the job
   • Delete Replica Files from Shared Location—Removes the replica from the shared file location
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.

     Note:

     If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running more automated steps without manual intervention.

   • Run on a Schedule—Run the step according to a schedule you set.

     Learn more about scheduling options

7. Optionally, choose one of the following options to configure help in the step:
   • None—Configure the step without step help.
   • Text—Configure help text for the step in the Text text box.

     You can use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, you must format the text as follows:

     
     'For further assistance, please contact' + JobCreator($Job) + '.'

   • URL—Configure the step with a link to a help resource in the URL text box.

     Note:

     Steps run in the web app only support HTTP and HTTPS URL formats. Steps run in ArcGIS Pro support HTTP, HTTPS, and file formats.

     You can also use Arcade expressions to provide a dynamic value. If the URL contains plain text and Arcade expressions, you must format the text as follows:

     
     'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'

     Configure the Automatically Encode Arcade Result check box:

     • If an Arcade expression returns special characters that must be escaped when converted to a URL, such as a space or a forward slash, ensure that the Automatically Encode Arcade Result check box is checked.
     • If an Arcade expression is used to form the base URL, uncheck the Automatically Encode Arcade Result check 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.

   Tip:

   The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output. Click Copy Step ID to copy the step ID to your clipboard.

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return value	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.