Move List Item step

Use the Move List Item step to move a SharePoint list item to another list or folder. The SharePoint list item is moved to a list in a SharePoint Site where the K2 for SharePoint app is registered. List items are used to represent actual items or metadata of an item. You can, for example, use the Move List Item step in a business application to move an order (represented as a list item) from an In Transit to a Delivered List.

You need to first identify the List Item you need to move. To do this:

  • Use the Pick List Item option to select a previously created List Item reference
  • Use the Find List Items option to browse to a specific list and filter for desired items
To use the SharePoint steps in K2 Workflow Designer, you must have SharePoint installed in your environment. To see the version of SharePoint that K2 supports, view the Compatibility and Support Matrix.

Drag the Move List Item step from the SharePoint category, Favorites bar, or the Recent category onto the canvas.

Example of a Move List Item step in a workflow

  1. From the Toolbox click the SharePoint category, the Document category, and then drag the Move List Item step onto the canvas.
    2. For more information on how to use the error console, see the Error Console topic.
  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 Move List Item tab. Use this tab to configure the step's properties.

    4. The following table explains the options available on this tab:

    OptionExplanationHow to Use
    Pick List Item

    Use this to pick a list item reference. The menu contains a list of available list item references within this workflow.

    If you don't see items in the menu, you need to create a SharePoint referenced item using a SharePoint reference step within the workflow.

    Select the Pick List Item radio button to enable this option.

    Click the menu and select the reference name.

    Find List Items

    Use this to browse to the list containing the list item to update.

    		Click the Find List Item radio button to enable this option.

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

    Filters

    Filter enable you to specify parameters and / or filters to return data dynamically.

    Use the operators to refine the filters. Select between the following options: Equal, Not Equal, Starts With, Ends With or Contains

    Applying parameters and filters is optional. Parameters are dependent on the Service Object it is mapped to.

    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.

    Destination List
    Pick List

    Use this to either select a list reference (created previously in this workflow) or browse to a specific list.

    Select the Pick List radio button to enable this option.

    Click the menu and select the reference name.

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

    Folder

    Use this to specify a destination folder where the List Item is moved to.

    When a SmartObject load method property is used, an input property is required for the correct information to load.

    Note: If the provided Folder value exists in the destination library, the document is copied to that folder. If the provided Folder value does not exist in the destination library, a new folder with this name is created and the document copied to that folder.

    In order to interact with sub folders, include the " \ " (back slash) character. Example: You have a list called Regions, a folder called North America with sub folder called United States. To place the document in the United States sub folder, use the following value North America\United States.

    Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.

    Properties

    Use this to set the filters to determine the list item to be updated, and add field details to update the it with.

    Note that when a SmartObject Load method property is used, an input property is required for the correct data to load.

    Click Add to add a property.

    Click the menu to select the property. 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 List Item LaterUse this to create a reference to use from other steps within the workflow. A reference can only be created if a reference is NOT consumed.

    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.

  4. From the List Item section select either Pick List Item (select a referred list item from the menu) or Find List Items (browse to required list). For this example, select Find List Items. From the drop-down menu select Browse and navigate to a list to update the list item.
  5. Select the site and list and click OK.

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

  6. Click the Add Filter link to filter for specified values in one or more fields to identify the list.

    7. Applying filters is optional. Parameters depend on the SmartObject method and are sometimes required. The filter may have a positive impact on performance by limiting the number of records returned. When you create a filter, only records that match the filter criteria are returned.

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

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

  8. In the Filters section, click Add to add a property.
  9. To delete properties, select them and click the Trash bin.
  10. From the Destination List section, select a list to use as the destination for the copied list item. Select a referenced list from the menu or browse to one using the Browse option. This selection is required.
  11. Specify the folder, in the list, where the list item is copied. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.
  12. In the Properties section, add fields and values to update with. Click Add.
  13. Select a property from the menu. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.
  14. To create a reference click Create. Reuse this reference in the current step or from another step in your workflow.
  15. To edit the auto-generated reference title, click Edit.
  16. To locate the added reference, expand the Context Browser, select Fields and then expand the Reference section.
  17. With the step selected, select the Properties tab.

    18. The following table explains the options available on this tab:

    OptionExplanationHow to Use
    Title / NameBy 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 linkUse the link to reset any changes to the title.Click the Reset link to reset the Title/Name field to default value.
    Show LabelAllows 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.
    DescriptionAllows you to add a detailed description for the step.Enter a value into the Create Newfield.
    NotesAllows you to add additional notes for the step.Enter a value into the Notes field.
  18. Click the Errors tab.

    19. Different types of exceptions can occur on a step, such as:

    TypeDescription
    Known exceptionsAny 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 exceptionsAny unknown runtime exceptions.

    The tab contains the following known exception:

    ExceptionExplanationHow to Use
    Continue on errorOn 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 exception:

    ExceptionExplanationHow to Use
    Log ExceptionLogs the exception to the error log.Check the box to log the exception.

  19. Your changes are automatically saved.