Skip to navigation
IntegrationIntegration HubGet Started with Integration HubField mapping tools overview

Filters in Integration Hub mapping

View as Markdown

Learn how to use payload and mapping-rule filters in Integration Hub to control whether entities are processed and which mapping rules build the target objects.

Filters control whether an entity is processed and which mapping rules are used to build the target object. The type of filter you choose determines what it evaluates.

  • Entire payload filters: Determine whether Integration Hub processes an input request. The result determines whether Integration Hub processes the request.
  • Partial payload filters: Include or exclude parts of the payload.

Payload filters

Exist-on-target filters:

Check whether a source entity already exists in the target system. Use this type of filter when you want to process an entity only if a matching entity is already present in the target. Existence filtering is available only for executors that support it.

Property-value filters:

Property-value filters evaluate fields on the source entity. They support these operations:

  • EQUAL and NOT_EQUAL
  • IN and NOT_IN
  • BIGGER and BIGGER_OR_EQUAL
  • SMALLER and SMALLER_OR_EQUAL
  • REGEX

Property-value filters do not evaluate individual items inside a collection. For example, you cannot use this filter to filter Salesforce order items.

Mapping-rule filters

Mapping-rule filters determine which mapping rules apply when building the target object.

Choice-based conditions

Choice-based condition selects a mapping branch based on source data. For example, an order action can use different mapping rules depending on its contract action:

  • If the contract action is New, use the rules for creating a subscription.
  • If the contract action is Renew, use the rules for renewing a subscription.
  • If the subscription is null and the action is New, use the order-line-item rules.

Partition filters

A partition filter selects which source rows are included in a target collection partition. This is useful when one target collection is built from multiple groups or subtypes of source rows. Each partition can use its own mapping rules.

For example, source order items can be separated into partitions for new subscription actions, renewal actions, and order line items. Each partition includes the rows that match its condition.

Choose the right filter

  • Use a payload filter to decide whether to process an entity.
  • Use a choice-based condition to select which mapping branch applies.
  • Use a partition filter to determine which source rows are included in a target collection partition.

Property-value payload filters do not filter collection items. To separate collection rows as part of mapping, use a supported choice or partition condition.