Delete Document step
Use the Delete Document step to delete a document from a SharePoint library. You can, for example, use the Delete Document step in a business application that deletes a document after it has been copied to an archival location.
Drag the Delete Document step from the SharePoint category, Favorites bar, or the Recent category onto the canvas.
Example of a Delete Document step in a workflow- From the Toolbox click the SharePoint category, the Document category, and then drag the Delete Document step onto the canvas.
- Select the added step and click the expand / collapse toggle to expand the Configuration Panel. You can also double click the step to expand the panel..
- Select the Delete Document tab. Use this tab to configure which document to delete.
- From the Document section, select either Pick Document (select a referenced document from the menu) or Find Document (browse to the document). In this example, select Find Document. From the menu select Browse and navigate to a location of the document to delete.
- Select the library and document, click OK
- Click the Add Filter link to specify parameters and filters.
- Select a property from the menu. Select an operator to define the filter. Type values or create dynamic values by dragging Functions,
Fields,
SmartObjects and
Workflow-related items from the Context Browser into the fields.
- In the Filters section, click Add to add a property.
- To delete properties, select them and click the Trash bin.
- From the Recycle Bin section select whether to send items to the recycle bin (checked by default).
- With the step selected, select the Properties tab.
- Click the Errors tab.
- If the option is selected - the document is sent to the recycle bin.
- If the option is not selected - the document is permanently deleted.
- If the option is selected - the instance continues to the next step in the workflow.
- If the option is not selected - Runtime exception error occurs.
- If the option is selected - the instance continues to the next step in the workflow.
- If the option is not selected - Runtime exception error occurs.
Your changes are automatically saved.
The following table explains the options available on this tab:
Option | Explanation | How to Use |
---|---|---|
Pick Document | Use this to pick a referenced document. The menu contains a list of referenced documents in the workflow. If you don't see items in the menu, you need to create a SharePoint referenced item using a SharePoint reference step within the workflow. | Select the Pick Document radio button to enable this option. Click the menu and select the reference name. |
Find Document | Use this to browse to the document. | Click the Find Document radio button to enable this option. Click the menu and select Browse to browse to a specific one. |
Filters | The filter allows you to specify parameters and filters to return data. Applying filters is optional. Use operators such as Equal, Not Equal, Starts With, Ends With, and Contains. Parameters are sometimes required - it depends on the SmartObject method selected. If the method has parameters, you probably need to provide values for those parameters to execute the method. | Click the Add Filter link to add filters. Select filter values from the drop-down menu. Click the operator button to select the operator. Click Add to add additional filter properties Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields. To delete properties, select them and click the Trash bin. |
Recycle Bin | Select this to place deleted items in the Site Recycle Bin. Items in the bin can be restored. Note that if the SharePoint list or library exist on a subsite, the deleted item is placed in the main recycle bin of the site collection. When this option is not selected, deleted items are immediately deleted and cannot be restored. | Check or uncheck the Sent items to recycle bin check box. |
For more information about the different browse states and errors, see the Browse States topic.
For more information on how to use the breadcrumb bar, see the How to use the Breadcrumb topic.
For more information on how to use Smartfields see the Smartfield Composer topic. Added filters can be grouped together to form parameters. To group parameters, click the AND button.
The following table explains the options available on this tab:
Option | Explanation | How to Use |
---|---|---|
Title / Name | By default, each step on the canvas has a step title. You can change this title to suit your workflow logic and show it on the canvas by checking the Show Label box. | Enter a value into the Title/Name field. |
Reset link | Use the link to reset any changes to the title. | Click the Reset link to reset the Title/Name field to default value. |
Show Label | Allows you to see the step label on the canvas. The label shows the value of the title. | Check the check box to display step label on the canvas. |
Description | Allows you to add a detailed description for the step. | Enter a value into the Create New field. |
Notes | Allows you to add additional notes for the step. | Enter a value into the Notes field. |
Different types of exceptions can occur on a step, such as:
Type | Description |
---|---|
Known exceptions | Any SmartWizard or standard wizard that has Boolean options for handling known exceptions have these options displayed as check boxes in the Known exceptions section of the Exceptions tab. |
Unhandled exceptions | Any unknown runtime exceptions. |
The tab contains the following Known exception/s:
Exception | Explanation | How to Use |
---|---|---|
Continue on error | When this option is selected the workflow is not in an error state, but merely continues executing the next step. | Check the check box to continue the workflow. |
Send document to recycle bin | On step execution the following options are available: | Check the check box to send document to recycle bin. Uncheck the check box to delete document permanently. |
Continue if document is not found | On step execution and the document is not found, the following options are available: | Check the check box to continue to the next step if document is not found. Uncheck the check box causes Runtime exception error. |
Continue if document is checked out | On step execution and the document is checked out, the following options are available: | Check the check box to continue to the next step if document is not found. Uncheck the check box causes Runtime exception error. |
The tab contains the following unhandled exceptions:
Exception | Explanation |
---|---|
Log Exception | Logs the exception to the error log. |
Force error when required SmartObject inputs are missing | Will forcefully throw an error if a SmartObject method has input missing. |
Continue on error | Will force the workflow to continue running the SmartObject method, even if it runs into an error. |