Discard Document Checkout step
Use the Discard Document Checkout step to discard a check out of a SharePoint document. You can, for example, use the Discard Document Checkout step in a business application to undo any changes made to a document if these changes are not approved.
Drag the Discard Document Checkout step from the SharePoint category, Favorites bar, or the Recent category onto the canvas.
Example of a Discard Document Checkout step in a workflow
How to add a Discard Document Checkout step
- From the Toolbox click the SharePoint category, the Document category, and then drag the Discard Document Checkout step onto the canvas.
For more information on how to use the error console, see the Error Console topic. - 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 Discard Document Checkout tab. Use this tab to configure the step's properties.
- 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 discard the check out on. Notice that the library selected in the Check Out Document step shows in the menu.
- In this example, select the referenced document library and 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.
- With the step selected, select the Properties tab.
- Click the Errors tab.
- 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. | 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 library containing the desired 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. |
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.
While applying filters is optional, it is generally used in order to specify exactly which documents should be affected by this action. Parameters depend on the SmartObject method and are sometimes required. The filter may have a positive impact on performance by limiting the number of records returned. When you create a filter, only records that match the filter criteria are returned.
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:
| Exception | Explanation | How to Use |
|---|---|---|
| Continue on error | On step execution and an error occurs, continue to the next step in the workflow. | Check the check box to continue the workflow. |
| Continue if document is checked in | On step execution and the added document is checked in, the following options are available: | Check the check box to continue to the next step if document is checked out. Uncheck the check box causes Runtime exception error. |
The tab contains the following unhandled exception:
| Exception | Explanation | How to Use |
|---|---|---|
| Log Exception | Logs the exception to the error log. | Check the box to log the exception. |