Ctrlk
Customer Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Adding Filters to Objects

Overview

This guide explains how to add filters to objects in a template to control exactly which records are migrated. Filters let you move only the specific records you need for an object, rather than transferring its entire data set. You can choose between two filter types: Declarative and SOQL.

  • Declarative: Uses a simple user interface to create filter conditions. You can combine multiple conditions to create more complex filters.

  • SOQL: Uses an SOQL (Salesforce Object Query Language) WHERE clause to build a complex record filter. SOQL provides greater flexibility and control over which records are included in the data migration.

Add Filters

1

Select Template

  1. Click Templates from the left sidebar menu.

  2. Click the template to add object filters to.

2

Select Filter Type

For each object, select the type of filter to add: Declarative or SOQL. Configuring each is explained in the following sections.

  1. Click the object to add filters to.

  2. Click the Filters tab.

  3. Select the type of filter to use.

    1. Declarative: See the following sections:

      1. Add Single Declarative Filter Condition

      2. Add Multiple Declarative Filter Conditions

    2. SOQL: See the following section:

      1. Add SOQL Filter

Only one filter type can be used per object. You cannot mix Declarative conditions and SOQL filters. The saved filter type is the one you used, and anything entered for the other type is removed.

3

Add Single Declarative Filter Condition

A Declarative filter consists of one or more filter conditions. A filter condition checks whether a record meets a specific rule by comparing a field's value against the filter’s value using a logical operation.

The filter in this example does the following:

  • Filter Account records whose Name equals Example Company.

  1. Select Declarative for the filter type.

  2. Click Add Filter to add a new filter condition.

  3. Click the Select field dropdown menu.

  4. (Optional) Enter the field name to search for the field.

  5. Select the field to use for the filter condition.

  6. Click the Select option dropdown menu.

  7. Select the logic operation to use for the filter condition.

  8. Enter a filter Value in the last textbox of the filter condition. This is the value the filter compares to the record's value.

  9. Click Save to save the filter.

4

Add Multiple Declarative Filter Conditions

Multiple declarative filter conditions can be added to an object. There are two options for combining filter conditions:

Basic Logic

All filter conditions are combined with an AND operation. Meaning all filter conditions must be met.

Custom Logic

With custom logic, you can combine filter conditions by defining your own custom logic using AND, OR, and () operations. Filter conditions are included with their row number. For example 2 AND (1 OR 3) means that the filter is true if condition 2 is met, and either condition 1 or condition 3 is met.

The filter in this example does the following:

  • Filter Account records whose Name equals Example Company.

  • Or, filter Account records whose Type is not a Temp.

  1. Click Add Filter to add another filter condition.

  2. Complete the filter condition by following the instructions in the section above.

  3. Repeat this process to add as many filter conditions as needed.

  4. Determine how you want the filter conditions combined. See the table above for an explanation of the options. If Basic Logic is used, no other action is necessary.

Use Custom Logic

  1. Click the Logic Selection dropdown menu.

  2. Select Custom logic.

  3. Enter your custom logic in the textbox to the right of the dropdown menu.

Custom logic can use AND, OR, and () operations to combine filter conditions by their row number.

  1. Click Save to save the filter.

5

Add SOQL Filter

The SOQL filter type lets you build complex record filters using a SOQL (Salesforce Object Query Language) WHERE clause. SOQL gives you greater flexibility and control over which records are included in the data migration.

The filter in this example does the following:

  • Filter Account records whose Name equals Example Company.

  • Or, filter Account records whose Type is not a Temp.

  1. Select SOQL for the filter type.

  2. Enter your SOQL filter statement in the WHERE textbox.

  3. Click Validate SOQL to make sure the filter statement follows valid syntax.

  4. If the filter statement is valid, you receive a "SOQL filter is valid" message.

  5. If there is an issue with the filter statement, the message indicates where the issue is. Fix the issue and validate the filter again.

  6. Click Save to save the filter.

6

Save Template

Once you have added filters to as many objects as necessary, save the template.

  1. Click Save template to save your changes.

PreviousAdding Fields to Objects
NextPreserving Object Relationships

Last updated

Was this helpful?