Get CRM Entity Item Reference step

Use the Get CRM Entity Item Reference step to create a reusable reference to an entity item. Use this step ahead of an Update or Delete CRM entity item step in your workflow. Use the Get CRM Entity Item Reference step in all applications where you need to Update or Delete a CRM entity.

Configure your CRM server during setup. Once setup is complete, most entity types from the CRM server can be used with K2. For more information, see Integration with your CRM Server.

Drag the Get CRM Entity Item Reference step from the CRM category, Favorites bar, or the Recent category onto the canvas.

Example of a Get CRM Entity Item Reference step in a workflow

How to add a Get CRM Entity Item Reference step

From the Toolbox click the CRM category, and then drag the Get CRM Entity Item 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 CRM Entity Item Reference tab. Use this tab to configure the properties.

The table below explains the options available on this tab:

Option	Explanation	How to Use
CRM Entity - Find Entity Item	Use this to select a CRM entity item to create the reference.	Click the menu and select Browse to browse to a specific entity. Click edit to make changes to the field.
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 CRM Entity Item Later	Use this to create a reference to the CRM entity item 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

CRM Entity - Find Entity Item

Use this to select a CRM entity item to create the reference.

Click the menu and select Browse to browse to a specific entity.

Click edit to make changes to the field.

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 CRM Entity Item Later

Use this to create a reference to the CRM entity item 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 menu select Browse and navigate to the entity. This is a required field.
Select the entity 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.

Select the entity, 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.

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 in this section:

Option	Explanation	How to Use
Name	By default, each step that is dragged onto the canvas contains a step title name. Change this title to suit your requirements.	Enter value into the field.
Reset link	Use the link to reset any changes to the Title field to default. This is only available if the Title field has been customized.	Click the Reset link to reset the Name field to default value.
Show Label	This option enables the step label to display on the canvas. The label is linked to the Title field.	Check the check box to display step label on the canvas.
Description	Use this field to add a detailed description for the selected step. This field allows you to add multiple lines of text.	Add a value into the Description field.
Priority	Use this field to select the priority level for the selected step. You can select between Low, Medium, or High priority.	Select the value from the Priority menu.
Notes	Use this field to add additional notes for the selected step. You can use this field to add notes and other useful details to designers and architects on the specifics of the workflow. This field allows you to add multiple lines of text.	Enter required 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 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.

Your changes are automatically saved.