Dynamic Part Filtering

Dynamic filtering allows you to filter datastore-based selection fields using the value of another part within the same object. This makes your selection lists context-aware: the options shown to the user automatically update based on earlier inputs.

How dynamic filtering works

To reference the value of another part, use the placeholder syntax:

#REPLACE-PARTVALUE-<InternalName>||#
  • <InternalName> is the internal name of the part whose value you want to use.

  • The system replaces the placeholder with the actual value entered by the user.

This allows your filter to adapt based on user input.

Dynamic filtering example

Imagine a datastore with two fields:

Datastore field

Description

City

The city name shown as selection options

Country

The country the city belongs to

Example entries:

City

Country

Bruges

Belgium

Brussels

Belgium

Amsterdam

The Netherlands

Frankfurt

Germany

Now imagine your object template has a part:

  • Country — where the user selects a country

  • City — a dropdown where cities must be filtered based on the country selected above

Dynamic filter configuration

If you create another part named Country, you can filter using its value:

[{ "fieldname": "Country", "filtervalue": "#REPLACE-PARTVALUE-Country||#" }]

What this filter does

  • fieldname: "Country" → filter the datastore on its Country field

  • filtervalue: "#REPLACE-PARTVALUE-Country||#" → use the value selected in the Country part

This means:

  • If the user selects Belgium, only Bruges and Brussels appear

  • If the user selects Germany, only Frankfurt appears

  • If the user selects The Netherlands, only Amsterdam appears

The dropdown updates dynamically based on the user's input.


Important notes

  • Do not add quotes around dynamic values.

    • Correct: "filtervalue": #REPLACE-PARTVALUE-Country||#

    • Incorrect: "filtervalue": "#REPLACE-PARTVALUE-Country||#"

  • Dynamic filtering works in all filter types, but Plain text is typically sufficient.

  • Make sure the referenced part (e.g. Country) is placed before the filtered part (e.g. City) in the form for the best user experience.

Last updated

Was this helpful?