We're updating some of our product names. K2 Five will soon be Automation On-Prem. You may see both product names in our help pages while we make this change.

Get Library Reference

This content applies to legacy design tools (such as K2 Studio, K2 for Visual Studio, or the Silverlight-based K2 workflow design tool). If you have upgraded from K2 blackpearl 4.7 to K2 Five, these tools may still be available in your environment. These legacy tools may not be available in new installations of K2 Five. These legacy tools may also not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.

What does it do?

The Get Library Reference wizard creates a reusable reference to a SharePoint library on a SharePoint Site that has the K2 for SharePoint app registered.

How is it used?

A library reference can be reused throughout a workflow for a specific SharePoint Library. If, for example, a business workflow needs to add many documents to a single library, using a library reference can allow easy access for each subsequent workflow step to identify a library. A reference can also be created for multiple SharePoint libraries where these libraries contain at least one field (column) with the same value.

Wizards can be edited. For more information see Edit Wizards.

Specify Site

Specify the site and set filters to define a library for the reference and provide a name for the reference.

Field	Description	Sample Value
Site Collection	If no reference is available, browse to the Site on a registered SharePoint Site Collection. The Site Collection field is populated with the default Site Collection.	Choose a site collection from the available site collections that have the K2 for SharePoint app registered. If there is only one it is auto-selected.
Search	Use search criteria to minimize the fields displayed. It is useful to search for a specific field using the search criteria when having lots of fields to select from. The list of fields automatically refreshes when text is entered.	Type text to filter the number of fields displayed in the grid
Show	All fields - Displays all fields linked to the Library Required fields - Displays only fields marked as required	Select the required option
Subsite Relative URL	Use to filter out the site where the library is located. Can be used as the first part of the multi-level subsite (ie: sites/hr/) Or the first level of a wildcard site (ie: sites/wildcard)	Select the check box in front of the field to enable the filter. Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Relative URL	Use to filter out the site where the library is located. Can be used to set the second part of a multi-level site (ie: /docs) It will concatenate this part with the part specified in Subsite Relative URL field (ie: sites/hr/docs) Or the second level of a wildcard site (ie: sites/wildcard/hr) It will concatenate this part with the part specified in Subsite Relative URL field (ie: sites/wildcard/sites/wildcard/hr) Can be used to set the entire Relative URL of a subsite (ie: sites/hr/docs)	Select the check box in front of the field to enable the filter. Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Name	The system name of the library.	Select the check box in front of the field to enable the filter. Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Title	The display name of the library, will typically see this in the SharePoint site when clicking to that library.	Select the check box in front of the field to enable the filter. Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
ID	Unique identifier of the library.	Select the check box in front of the field to enable the filter. Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Description	Description for the library, you will typically see this under the library title in the SharePoint site when clicking to that library.	Select the check box in front of the field to enable the filter. Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Reference Name	Specify the Reference Name for the SharePoint Library. This value must be unique for this workflow.	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
List Template	String value of the SharePoint template the library is based on.	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Allow Content Types	Boolean value stating if the list supports other content types (other than document).	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Content Types Enabled	Boolean value stating if management of content types is enabled.	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Enable Folder Creation	Boolean value if sating if folder creation is enabled (can you create folders in this library).	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Enable Minor Versions	Boolean value stating if minor versioning should be used (can only be taken into consideration if Enable Versioning is set to true).	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Enable Versioning	Boolean value stating if versioning is enabled on the library.	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
Hidden	Boolean value stating if the library is visible in SharePoint.	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.
OnQuickLaunch	Boolean value stating if the library displays as a quick launch link on the site it is created on.	Type the value of the field, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method. Note that when a SmartObject Load method is used, an input property is required for the correct data to load.