We're updating some of our product names. K2 Five is now Nintex Automation. You may see both product names in our help pages while we make this change.

Get List Reference step

Use the Get List Reference step to create a reference to a SharePoint list.. You can reuse a list reference throughout a workflow. You can, for example, use the Get List Reference step in the following scenarios:

In a workflow you need to add various list items in a single list. You create and use a list reference once and use the reference for each subsequent step that adds a new item
You create a reference for multiple SharePoint lists where these lists contain at least one field with the same name. A SmartObject will be generated for every list returned in the reference

To use the SharePoint steps in K2 Workflow Designer, you must have SharePoint installed in your environment. To see the version of SharePoint that K2 supports, view the Compatibility and Support Matrix.

Drag the Get List Reference step from the SharePoint category, Favorites bar, or the Recent category onto the canvas.

Example of a Get List Reference step in a workflow

How to add a Get List Reference step

From the Toolbox click the SharePoint category, the List category and then drag the Get List Reference 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 Get List Reference tab. Use this tab to configure the list reference properties.

The following table explains the options available on this tab:

Option	Explanation	How to Use
Find Lists	Specify the list and set filters. If no reference is available to select from the Pick List menu, browse to the site containing the list.	Click the Find List 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.
Use List 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.

Option

Explanation

How to Use

Find Lists

Specify the list and set filters. If no reference is available to select from the Pick List menu, browse to the site containing the list.

Click the Find List 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.

Use List 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.

From the List section select Find List menu. Browse and navigate to the location of the list.
Select the Site and 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.

Click the Add Filter link to add 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.

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.

In the Filters section, click Add to add a property.
To delete properties, select them and click the Trash bin.
To create a reference click Create. Reuse this reference in the current step or from another step in your workflow.
To edit the auto-generated reference title, click Edit.
To locate the added reference, expand the Context Browser, select Fields and then expand the Reference section.
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.

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 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.

Your changes are automatically saved.