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.

Create Reference Wizard

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 Create Reference wizard generates dynamic item references against a SmartObject which can be used across different line of business applications. An item reference is an XML structure that contains all the information of the specific SmartObject. The Create Reference wizard automatically binds the SmartObject data to the workflow making it easier and quicker to design a workflow. This eliminates the need to manually configure certain rules such as the rule to return data on a Form at approval and the need to define each Data Field.

How is it used?

The Create Reference workflow step can be used in any scenario where an item reference needs to be created for use within a workflow to return data. This wizard is typically used with the For Each wizard to convert the data returned into a list of items, see the Considerations section.

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

Select SmartObject and Method

Field	Description	Sample Value
SmartObject	The SmartObject used to create a reference	Click on the ellipsis and select a SmartObject from the category system
Method	The SmartObject selected populates the Method drop down with methods. Select the appropriate method used to return data	Select a method from the drop down list: Get List: Returns a list of all SmartObject properties. Load: Returns a single SmartObject Property.
Identifier	The selected method populates the Identifier drop down. The key property used to retrieve records from the SmartObject is by default the Identifier. The Identifier field only displays when the SmartObject does not contain a Key property and requires manual selection	Select an identifier from the drop down list
Reference	The name of the Reference to be created. The field is auto populated using the name of the SmartObject selected. Specify another name if desired	Type text in the field

Parameters or Filters

Field	Description	Sample Value
Search	The search criteria to be used 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 minimize the fields
Show	All fields - Displays all fields linked to the SmartObject Required fields - Displays only fields marked as required	Select the required option
Name	List of parameter names	N/A
Value	Parameter value. This value can be set using text or dropping a field from the Context Browser	Type text or drag and drop a field from the Context Browser
And/Or	And and Or logical operators to be used in the expression	Select the required option
Left	Value on the left of the expression. The values are determined by the SmartObject fields	Select a value from the drop down list
Operator	Operators used to compare the left and right values of the expression	Select an option from the drop down list
Right	Value on the right of the expression. SmartObject fields are listed in the drop down. In addition, values can be typed of dropped from the Context Browser	Select a value from the drop down list, type text or drag and drop a field from the Context Browser