Local Filters
The Local Filters screen opens when you click the Filters button beside a parent field. You can configure local filters and filters on a sum in this screen. In addition, you can configure a Choose Record filter on fields within an array. This ensures that you are only sending the appropriate information to a target system. For example, you can configure an integration to only send the data of employees that are assigned a specific value in a specific employee property.
For example, you can set a filter to exclude all terminated and inactive employees, or to include only active employees, or even to include only those employees who have been hired in the last 30 days.
Filtering for Unmapped and Required Fields
You can filter for unmapped and required fields in your integration by using the following switches in the mapping step:
- Show Only Unmapped Fields
- Show Only Required Fields
The Show Only Required Fields and the Show Only Unmapped Fields switches are disabled by default and are not shown in Integration Studio for integrations that are edited entirely in IDL.
Filtering on Parent Destination Fields
All parent fields in the destination structure, including the root field, have a Filter button beside them. You can group criteria fields together using the AND or the OR operators when you are configuring a filter for a parent field that is mapped to a specific source array. You can also apply these operators at different levels in your destination structure to customize what data is included in the output. For example, you can include or exclude an entire parent node from an integration run when the nested child fields don’t contain any data by enabling or disabling the Include Null/Empty Parent in Output switch. In addition, you can configure filters that cannot be configured in the UI by using a Parent Filter Expression.
Field options in the Local Filters screen that opens when you click the Filter button beside the root field, are restricted when the root field is mapped to a source array.
Parent fields that are arrays must be mapped to a source array before you configure a filter. When selected, the criteria field and the comparison values in the filter are restricted to data fields under the selected source array, including child arrays if any. You can configure a filter without mapping to a source array when a parent field is not an array.
For all output types, the root field and each parent in the destination field structure has a Filter button beside it. When you click the Filter button, the Local Filters screen opens. Field options are restricted to data fields under the selected source array, including child arrays if any.
Note that the Filter button isn’t shown for Parent elements that have the Configure Expression on Parent option selected.
Using Conditional Inclusion
You can conditionally include data without the need to filter a specific source array in the Local Filters screen.
The following options are available in the Select filter option drop-down list that is shown at the top of the Local Filters screen:
- Filter data before mapping
- Define criteria for when the <ParentField> should populate
- Define criteria for when the <ParentField> should populate and filter data before mapping
The information on the Local Filters screen is organized into these two cards:
| Cards | Information contained in the card |
|---|---|
|
Filter Data to be Mapped |
Contains filters you can use to limit the data included in your integration. |
|
Include Data in Output If |
Contains the conditional inclusion options. |
Depending on the filter option you select in the Select filter option drop-down list, the following cards are shown on the Local Filters screen:
| Filter name | Card shown | Intended use |
|---|---|---|
|
Filter Data to be Mapped |
|
To limit the <SourceArray> data included in the integration. |
|
Include Data in Output If |
|
To determine when <ParentField> records should be included in the integration based on any value in the source. |
| Define criteria for when the <ParentField> should populate and filter data before mapping |
|
Combines the intended use of the first two filter options. |
Using Custom Tokens in your Filters
You can also configure Local Filters and Choose Record filters to use custom tokens by selecting Token from the Comparison Value drop-down list.