Get Document Reference step

1. From the Toolbox click the SharePoint category, the Document category and then drag the Get Document Reference step onto the canvas.
   
2. 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.
   
3. Select the Get Document Reference tab. Use this tab to configure the reference.
   

The following table explains the options available on this tab:

Option	Explanation	How to Use
Library	Use this to browse to the library containing the document.	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. At runtime, the Get Document Reference step returns single or multiple documents from the SharePoint library. Use the Filter section on the step to configure conditions to return one or more documents from the library. If you don't configure a filter, all documents in the library are returned.	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.
Use Document Later	Use this option to create a reference to use from other steps within the workflow.	Click the Create link to create a reference. Click the Edit link to edit the reference name. If you edited the reference name and want to reset it, click the Reset Name link.

4. From the Library section click the menu, select Browse and navigate to the location of the library.
   
5. Select the library and document, click OK.
   

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.

6. Click the Add Filter link to add filters.
   
Applying filters is optional. 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.
7. 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.
   

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.

8. In the Filters section, click Add to add a property.
   
9. To delete filter properties, select it and click the Trash bin.
   
10. To create a reference click Create. Reuse this reference in the current step or from another step in your workflow.
    
11. To edit the auto-generated reference title, click Edit.
    
12. To locate the added reference, expand the Context Browser, select Fields and then expand the Reference section.
    
13. With the step selected, select the Properties tab.
    

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.

14. Click the Errors tab.
    

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.

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.

The exceptions in the table above is an example of those available in Workflow steps. The exceptions available depend on the Workflow step used in the design canvas.

15. Your changes are automatically saved.

At runtime, the Get Document Reference step returns single or multiple documents from the SharePoint library. Use the Filter section on the step to configure conditions to return one or more documents from the library. If you don't configure a filter, all documents in the library are returned.

Scenario

Your company uses a SharePoint document library to store legal documents. As part of the employee onboarding policy, a new employee signs a contract and receives the company's policy and procedures. The employee receives an email with the Contract as well as the Policy and Procedures attached. In this scenario, you need to specify a condition on the Get Document Reference step to make sure the correct documents from the library are attached to the email. To do this, you add a condition in the Filter section.

The Legal Documents library contains several legal documents. You only need to attach the Policy and Procedure and Employee Contract PDFs to the email.

In the Filter section, configure the filter by adding two conditions. One for the Employee Contract.pdf and one for the Policy and Procedures.pdf. This filter ensures that these are the only two documents attached to the email.

In the Use Document Later section click the Create link.

This creates the Legal Documents reference for you to use in the Send Email step.

To attached the documents to the email, configure the Send Email step and drag the Document property (located in the Legal Documents reference section) from the Context Browser into the Attachment section.

At runtime the employee receives an email with two attachments.