How to: Use the SmartObject Get List custom filter

This topic shows you how to use a custom filter on a SmartObject Get List method to return a list of items. To configure the custom filter, you use a SmartObject property to create a criteria. Use operators, such as equal, not equal, greater than, less than, contains, starts with, and ends with to build criteria. You can create one or more criteria to filter.

Use the list options to return the first, the last, or all matching records. You can order the filtered data with a SmartObject property and sort it ascending or descending.

To add a custom filter, drag a SmartObject Get List method property into a SmartField. In the Smartfield Composer select the Custom option and open the List Method Configuration panel. From here, you use the Filter and Properties panels to add criteria and build your custom filter. Type or drag Fields, Functions, SmartObjects, or Workflow-related properties from the Context Browser.

This How To assumes that you are familiar with K2 for SharePoint.

Using a custom filter to return a specific list of items

Scenario

Your company uses a Track Leave Days workflow to keep track of the amount of leave days each employee has. This workflow runs at the beginning of every month and runs on a scheduled start.

As per your leave policy, employees with 15 or more available leave days need to submit leave or lose the days. You need to inform employees with an email if they have excess leave days.

To do this you use a custom filter to extract a list of employees with excess available leave days. In this filter you specify a criteria to send the email if they have 15 or more leave days available.

Steps

In this scenario, you begin by creating a custom SharePoint List. This list captures the employee and available leave days remaining. You need to populate this list with employee details.

Next you create a workflow that contains a Send Email, Update List Item, and End steps. You use the Send Email step to configure the criteria and create the custom filter. The Update List Item step updates the SharePoint list to show who received an email.

The final piece of this solution is adding a workflow schedule to start the workflow the first day of every month.

Setup Steps

The following steps set up the scenario from start to finish. If you want to skip the setup steps and view the topic step, go to Configure the SmartObject Get List Custom filter.

1. Create a SharePoint Custom List that contains employee and leave detail properties (such as name, department, email, available leave days, update email sent). Also add custom columns (Name (text), Department (text), Email (text), Available Leave Days (number) and Update Email Sent (text).) to the list and populate them with list items.
   1. Create a new SharePoint Custom List. Name the list
      Employee Details.
      
   2. Select the Employee Details list and click edit.
      
   3. Add the following columns: Name (text), Department (text), Email (text), Available Leave Days (number) and Update Email Sent (text).
      
   4. Select new item and add the list items shown in the image below.
      
   5. You have now added employee details to your list. You reference this list in your workflow and use the Available Leave Days column (in step 3) to configure the SmartObject Get List custom filter.
2. Create a workflow called Track Leave Days.
   1. From the K2 Designer click New and select Workflow
      
   2. Name this workflow Track Leave Days and click Create.
      
   3. The Track Leave Days workflow opens ready for you to start building it.
      

Configure the SmartObject Get List custom filter

The following step describes how to configure a SmartObject Get List custom filter. You add the filter on the Send Email step in the To address field. The property you use to filter with is Available Leave Days. In this scenario, you use the filter to return a list of employees with 15 or more available leave days. A notification email is sent to these employees.

3. Configure the SmartObject Get list custom filter on the Send Email step
   1. From the Toolbox, click the Basic category and drag the Send Email step onto the canvas. Click the expand / collapse toggle to expand the Configuration Panel. You can also double click the step to expand the panel. Click the Edit button to enable editing in the To field.
      
   2. Delete the Originator's Email and expand the Context Browser. Select Functions tab and drag the Join function, from the Text section, into the To field.
      
      For more information on the Join function and how to configure it with the All items as a collection option, see the How to: Use the All items as a collection option.
   3. The Smartfield Composer opens. Select SmartObjects tab and browse to the SharePoint Employee Details SmartObject Get List items method. Drag the Email property into the Values field. This property contains the email address of each employee on the SharePoint Employee Details list.
      
   4. In the Customer SmartObject properties section drop down select Custom. This is how you add a custom filter.
      
   5. Click Open Configuration Panel to open the List Method Configuration panel. You configure the custom filter criteria here.
      
   6. The List Method Configuration panel opens.
      
   7. To add a custom filter, select the Filter tab click the Add Filter link.
      
   8. On the Filter tab you specify the filter criteria. Select a property from the Choose Property menu. This menu contains all available properties in the SmartObject. In this example you see all properties from the Employee Details SmartObject. Select Available Leave Days property from the menu.
      
   9. Expand the Context Browser. Type or drag Fields, Functions, SmartObjects, or Workflow-related properties to customize the filter. In this example, you need to filter the list to only show items where the Available Leave Days property has a value of 15 or more. This filter consists of two parameters. One to filter 15 days and one to filter more than 15 days. To create the first part, type 15 as the value. Click Add to add another filter criterion.
      
   10. For the second part, select Available Leave Days from the Choose Property menu. Click = to show the operators and select Greater Than.
       
   11. Type 15 as the value. Click AND and change it to OR. The parameter is set and the filter finds all employees with 15 or more available leave days.
       
   12. In the List Options section, keep the default values as shown below.
       
   13. Click X to close the Smartfield Composer.
       
   14. Configure the Subject and Body of the email as shown below.
       
4. Configure and complete the rest of the workflow. In this step you also deploy the workflow.
   1. From the Toolbox click the SharePoint category, the List Items category, and then drag the Update List Item step onto the canvas. Connect the step to the Send Email step. In this scenario, you use the Update List Item step to update the Update Email Sent column on the Employee Details SharePoint list. After the email is sent to the employee, the current date and time is set in this field.
      
   2. In the List Item section select Find List Items and browse to the Employee Details list.
      
   3. You need to add a filter to make sure the correct list item gets updated. In this scenario, only employees that received the email need to be updated. Click the Add Filter link. Configure the filter as shown below.
      
   4. In the Properties section, specify the property you want to update and what it should be updated with. To add a property click Add. Select Update Email Sent from the menu and drag the Today (Date and Time) function from the Context Browser as the value. In this scenario, the Update Email Sent field in the SharePoint list is updated with today's date and time for employees who received a warning email.
      
      For more information on the Update List Item step, see Update List Item Step.
   5. From the Toolbox, click the Logic category and drag the End step onto the canvas. Connect the step to the Update List Item step.
      
      For more information on the End step, see End step.
   6. The final thing to do is to deploy your workflow. From the File menu select Deploy.
      
      For more information on deploying a workflow, see Deploy a Workflow.
5. Add a workflow schedule to start the Track Leave Days workflow on the first day of every month. For more information on how to schedule a workflow, see the Start a Workflow with a Schedule.
6. Test the solution. In this step you manually start an instance of the Track Leave Days workflow. The workflow references the Employee Details SharePoint list and sends an email to all employees with 15 or more available leave days using the custom filter you created. It then updates the Update Email Sent column with today's date and time.
   1. Open the Employee Details SharePoint list. Notice that no updates shows on the Update Email Sent column.
      
   2. From K2 Management start a new instance of the Track Leave Days workflow.
      
      For more information on manually starting a workflow, see Start a Workflow Manually in K2 Management.
   3. From K2 Management select the Reports tab. Locate the Track Leave Days workflow in the All Instances section and click View Flow.
      
      For more information on reporting, see Reports.
   4. On the View Flow report, notice that the workflow completed successfully.
      
      For more information on View Flow, see View Flow.
   5. Open the Employee Details SharePoint list. The Update Email Sent field for Codi, Barry and Erica updated with today's date.
      
   6. Open Codi's email. The email was sent to three employees.
      

Review

You learned how to use a custom filter on a SmartObject Get List method to return a list of items. You used this custom filter to create criteria to send an email to specific people.