Update CRM Entity Item Step
Use the Update CRM Entity Item step to update a CRM entity. Before adding the Update CRM Entity Item step to a workflow, you first need to create a reference to the item that you want to delete. Use the Create CRM Entity Item step or the Get CRM Entity Item Reference step to create a reference. For example, a Client entity item is updated after their contact information change is verified.
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 Update CRM Entity Item step from the CRM category, Favorites bar, or the Recent category onto the canvas.
Example of an Update CRM Entity Item step in a workflow
- From the Toolbox click the CRM category, and then drag the Update CRM Entity Item 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 Update CRM Entity Item tab. Use this tab to configure the entity properties.
- Select the Get CRM Entity Item Reference step and create a reference to the CRM entity.
- Select the Update CRM Entity Item step. From the Pick Entity Item drop down menu, select referenced entity created in the Get CRM Entity Item Reference step.
- In the added property field, type a value, use inline functions, or dynamic fields, by clicking on the Add button to expand the Context Browser. Within the Context Browser, select inline functions and fields from the Functions, Fields, SmartObjects and Workflow categories. Click and drag the function into the property field.
- To add additional properties, click the Add button.
- To delete properties, select them and click the Trash bin.
- With the step selected, select the Properties tab.
- Click the Errors tab.
-
Your changes are automatically saved.
The following table explains the available options:
Option | Explanation | How to Use |
---|---|---|
CRM Entity - Pick Entity Item |
Use this to select a CRM entity reference created in the Create CRM Entity Item or Get CRM Entity Item Reference step. |
Click the drop down menu and select a reference. Click the edit button to make changes to the field. |
Properties |
Use this to add properties and detail for the entity item. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields. |
Click the property field to add a value by typing or dragging it. Click the Add button to add the property field. To delete a property, select it and click the trash can. |
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 field. |
Reset link | Use the link to reset any changes to the title. | Click the Reset link to reset the Title 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 Description field. |
Notes | Allows you to add additional notes for the step. | Enter a value into the Notes field. |
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 | When this option is selected the workflow is not in an error state, but merely continues executing the next step. | Check the check box to continue the workflow. |
The tab contains the following unhandled exception:
Exception | Explanation | How to Use |
---|---|---|
Log Exception | Logs the exception to the error log. | Check the box to log the exception. |
When working with the Update CRM Entity Item step keep in mind the following considerations:
- Before adding the Update CRM Entity Item step to a workflow, you first need to create a reference to the item that you want to delete. Use the Create CRM Entity Item step or the Get CRM Entity Item Reference step to create a reference.
- Ensure the CRM service type is registered in your environment