What are Filters?

A filter is used to limit the amount of data that is used in integrations. It is a set of rules that is applied on the source data.

When to use Filters

Filters should be used when only specific data from your source program should be brought over to the other program. (I.e., Only plans that are marked to be imported into OnePlan will be brought into OnePlan). This can remove any potentially irrelevant data from being brought over to the other program. 

Where to apply Filters

Filters can be applied to either a scheduled strategy (a strategy that runs automatically following a predefined schedule), or during an event-driven strategy (A strategy triggered by an event, such as user interaction or system generated due to a trigger). Filters applied to one type of strategy (Scheduled vs Event) will not apply to the other type of strategy.

Scheduled Strategy Filters

Scheduled strategy filters can be applied in the integration Schedules section. Each row in the schedules page relates to an instance of a scheduled strategy. 

Please make sure that the filter is applied to the correct direction and is applied to the correct table. (I.e.,  OnePlanPublish filters should be applied on the table that has data originating in OnePlan to be exported to the other program). 

Event-Driven Filters

Event-driven filters can be applied in the integration Mappings > Filters section. 

Filter Anatomy

Filters are broken down into four segments: Select Field, Select Operator, Value Field, and Logical Connector.

Select Fields are any fields mapped within the Mappings > Fields tables. Please note that the field mapping must match the table that the filter is being applied to (i.e., Epics - Plans). 

Select Operators enable you to define the type of comparison (or operation) to be performed on the Select Field. The set operators allow you to precisely specify how the field value should relate to the condition you are establishing. This selection determines the criteria for including or excluding data based on the chosen field, enhancing the flexibility and precision of your filters. 

Value Fields are where you input a specific value against the chosen field and will be compared during the filter process. Depending on the operator selected in the Select Operator field, this value defines the condition that the data in the chosen field must meet to be included in the result set. 

Logical Connector serves as the bridge for constructing sophisticated queries or filters by connecting multiple conditions. When you have more than one query condition, the logical connector lets you specify how these conditions should interact. You can choose between 'AND' and 'OR' to dictate whether all conditions must be met, or if at least one of the conditions should be satisfied.  To extend the current filter to apply the Logical Connector, click Add Filter. 

Once a suitable filter has been created, click Save. 

Filtering on and Comparing Date Fields

When directly comparing with a date field (e.g., Due Date = 12-31-2000), setting up the filter remains straightforward. However, when dealing with comparisons like Due Date >= 12-31-2000, the filter may not function as intended. This is because the dates are treated as string values in this scenario. For proper date field comparisons, please ensure the date value is enclosed within number signs (e.g., Due Date >= #12-31-2000#).

Filter Best Practices

Test Filters one at a Time

It is recommended to apply filters based on a single value at a time. Utilizing multiple filters might introduce unintended complexities, potentially resulting in the inclusion or exclusion of unexpected data during the transfer process. Keeping the filtering focused on a single value enhances precision and reduces the risk of unintended data being brought into OnePlan. 

Filter Limitations

Filters are not available to all strategies

Not all strategies have the filters capability applied to them.

For more information on if the strategy in question has the filter capability available, please review your integrations documentation. 

Filters only apply to fields that are mapped

For strategies that have the filters capability added to them, the filters can only be applied to fields that are mapped on the equivalent table within the Mappings > Filters page. Please note that the names in the dropdown will correspond to the source program field name.

Filters only apply to certain tables

Please note that filters are not applied to all the tables that are available for field mapping. If the filters capability is available on the strategy, please check your integration documentation to see what tables  filters can be applied to. 

Filters are limited to simple logical conditions

At this time, filters do not have the capability of going beyond simple logical conditions. This can be a pain point for those who wish to apply different logical operations within the same query.