Delete CRM Entity Item step

Use the Delete CRM Entity Item step to delete an entity item. Before adding the Delete 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 deleted after the deactivation of the client is approved.

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 Delete CRM Entity Item step from the CRM category, Favorites bar, or the Recent category onto the canvas.

Example of a Delete CRM Entity Item step in a workflow
  1. From the Toolbox click the CRM category, and then drag the Delete CRM Entity Item step onto the canvas.
    2. Before adding the Delete 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.
  2. 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.
  3. Select the Delete CRM Entity Item tab. Use this tab to configure the entity properties.

    4. The following table explains the available options:

    Option Explanation How to Use
    CRM Entity - Pick Entity

    Use this section to select a CRM entity item reference.

    Click the menu and select referenced CRM entity item.

    Click edit to make changes to the field.
  4. Select the Get CRM Entity Item Reference step and create a reference to the CRM entity.
  5. Select the Delete CRM Entity Item step. From the Pick Entity Item menu, select the referenced entity item.
  6. With the step selected, select the Properties tab.

    7. 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.
  7. Click the Errors tab.

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

  8. Your changes are automatically saved.

When working with the Delete CRM Entity Item step keep in mind the following considerations:

  • Before adding the Delete 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