Filters Used with Fetch and Delete

Filters

Filters

Filter definitions for selecting data in fetch and delete operations.

When to Use

Rules

• Filter ID MUST match file name without .filter.xml (e.g., fetch-products.filter.xml → id="fetch-products.filter")

• PX/CX fetch MUST include <criterion fieldName="name" operator="equals" value="{TableName}"/>

• Dynamic values MUST use simple: prefix: value="simple:${header.myHeader}" — without it, the value is literal

• Use equals operator (NOT equal — common mistake)

• Delta filters: use BOTH bounds (greaterThan lower + lessOrEqual upper) to prevent missing records

• Filter file format: <filters> root element, no pfx: namespace prefix, no <?xml> declaration

Filter Structure

<filter>

The root filter element. It may contain at most one top-level logical combinator (<and>, <or>, or <not>).

Attributes

Child Elements (choice, 0..1)

Logical Combinators

<and>

All child criteria/combinators must be true for a record to match.

<or>

At least one child criterion/combinator must be true for a record to match.

<not>

Negates all child criteria/combinators. A record matches if the children evaluate to false.

All combinators share these attributes:

All combinators may contain: <criterion>, <and>, <or>, <not> (0..unbounded).

Criterion Element

<criterion>

Defines a single condition on a field.

All Operators

Equality Operators

Comparison Operators

String Matching Operators (Case-Sensitive)

String Matching Operators (Case-Insensitive)

Null-Check Operators

Set Operators

Custom Operator

resultFields

The resultFields attribute is available on <filter>, <and>, <or>, and <not> elements. It specifies a comma-separated list of field names to include in the fetch result. When omitted, all fields are returned.

Using resultFields improves performance by reducing the data transferred from the Pricefx server.

sortBy

The sortBy attribute is available on the <filter> element.

• Plain field name for ascending order: sortBy="sku"

• Prefix with - for descending order: sortBy="-modifiedDate"

Examples

Simple Filter -- Single Criterion

One filter per file, wrapped in <filters>:

<filters>
    <filter id="active-products-filter" resultFields="sku,label,attribute1">
        <and>
            <criterion fieldName="attribute1" operator="equals" value="ACTIVE"/>
        </and>
    </filter>
</filters>

AND Filter -- Multiple Criteria

<filters>
    <filter id="expensive-electronics-filter" sortBy="-attribute2">
        <and>
            <criterion fieldName="attribute1" operator="equals" value="Electronics"/>
            <criterion fieldName="attribute2" operator="greaterThan" value="500"/>
            <criterion fieldName="attribute3" operator="notNull"/>
        </and>
    </filter>
</filters>

OR Filter -- Match Any Condition

<filters>
    <filter id="multi-region-filter">
        <or>
            <criterion fieldName="attribute1" operator="equals" value="EMEA"/>
            <criterion fieldName="attribute1" operator="equals" value="NA"/>
            <criterion fieldName="attribute1" operator="equals" value="APAC"/>
        </or>
    </filter>
</filters>

Combined AND/OR -- Nested Logic

<filters>
    <!-- Products that are Electronics AND (in EMEA or NA region) -->
    <filter id="electronics-by-region-filter" resultFields="sku,label,attribute1,attribute2">
        <and>
            <criterion fieldName="attribute1" operator="equals" value="Electronics"/>
            <or>
                <criterion fieldName="attribute2" operator="equals" value="EMEA"/>
                <criterion fieldName="attribute2" operator="equals" value="NA"/>
            </or>
        </and>
    </filter>
</filters>

NOT Filter -- Exclusion

<filters>
    <filter id="non-obsolete-filter">
        <not>
            <criterion fieldName="status" operator="inSet" value="OBSOLETE,DELETED"/>
        </not>
    </filter>
</filters>

Usage with Commands

Filters are referenced by their id in fetch, delete, and mass-edit commands.

Common Pitfalls

• One filter per file — each file must have the <filters> wrapper element around the filter definition. Do NOT use <beans>, <beans:beans>, or XML declarations.

• Multiple top-level combinators — a <filter> may only contain ONE top-level <and>, <or>, or <not>. Wrap multiple conditions in a single combinator.

• Missing value for binary operators — all operators except isNull and notNull require a value attribute.

• Using inSet with spaces — values in inSet/notInSet are comma-separated with no spaces (e.g., value="A,B,C" not value="A, B, C").

• Filter IDs must match the filter= parameter in route URIs.

• For dynamic values use value="simple:${header.myValue}".

Common Errors

• HTTP 400 on fetch: Invalid operator name, non-existent field, or missing pricingParameterName for LTV/MLTV2

• Empty results for PX/CX: Missing fieldName="name" criterion — PX/CX requires it to identify the extension table

• Dynamic value not resolving: Missing simple: prefix — value="${header.X}" is treated as literal string

• Filter bean not found: Filter ID doesn't match file name, or file is not in filters/ directory