Add `Operator` to `ValueListParameterIn`, `ValueListParameterInOut` to support passing an operator to a value help #375

PierreFritsch · 2025-03-14T11:11:19Z

We have the requirement of pre-filtering a value help programmatically to preselect valid values for the end users:

Valid From shall be on or after some date
Valid To shall be before or on some date

Currently, the OData vocabulary for ValueListParameterIn and ValueListParameterInOut only supports the eq (Equal to) operator. Suggesting we extend it so that it also supports at least le (Less than or equal to) and ge (Greater than or equal to).

Note: Passing operators to value list parameters is not available in FEv4 yet. The corresponding feature request is tracked internally under FIORITECHE1-8621. Our intention with this PR is to provide support from the vocabulary to move the discussions around the frontend support forward.

Side note: While these two options would be sufficient for our use case, we noticed that the enumeration of selection options contains the operators bt (Between) and nb (Not between). Supporting all operators would mean that a second value would need to be added to the value list parameters. That would speak for introducing ComplexTypes e.g. ValueListRangeIn, ValueListRangeInOut instead.

Hint: This is our first contribution to this repository and that we have a limited capacity for contributing, so feel free to edit/adjust the proposal. Thanks for your comprehension!

PierreFritsch · 2025-03-14T11:14:46Z

CC @d027132 FYI (See also the internal feature request FIORITECHE1-8621.)

CC @D041453 @jan-philip-zieher FYI

HeikoTheissen

You suggest a very broad generalization of the value help concept but give only a narrow use case as justification:

Valid From shall be on or after some date
Valid To shall be before or on some date

Do you really need the general case? And don't you need the rule "valid from shall be on or before valid to"? (This seems natural to me, but is not covered by your suggestion.)

HeikoTheissen · 2025-03-14T12:22:35Z

vocabularies/Common.xml

        </Property>
      </ComplexType>
      <ComplexType Name="ValueListParameterIn" BaseType="Common.ValueListParameter">
+        <Property Name="Operator" Type="UI.SelectionRangeOptionType" DefaultValue="0" Nullable="false">


Instead of extending the existing type, define a new subtype (suggested name ValueListRangeIn) of ValueListParameterIn and add the new properties to that subtype only.

=> 2e24e35

HeikoTheissen · 2025-03-14T12:24:07Z

vocabularies/Common.xml

+          <Annotation Term="Core.Description" String="Path to property that is used to filter the value list by applying the operator (Single value or lower interval boundary)" />
+          <Annotation Term="Core.LongDescription" String="In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators" />
+        </Property>
+        <Property Name="LocalDataPropertyHigh" Type="Edm.PropertyPath" Nullable="false">


Shouldn't this be nullable? For Operator = CP there is no upper boundary.

what is meant by operator CP, I have only them https://sapui5.hana.ondemand.com/#/api/sap.ui.model.FilterOperator in mind

CP = Contains Pattern

https://github.com/SAP/odata-vocabularies/blob/9c2dc33ba9913d8f1a2d41b3f8223ce204c598e7/vocabularies/UI.xml#L1337-1339

Removed the Between use case and the upper boundary with 2e24e35.

HeikoTheissen · 2025-03-14T12:25:55Z

vocabularies/Common.xml

+        </Property>
+        <Property Name="LocalDataPropertyHigh" Type="Edm.PropertyPath" Nullable="false">
+          <Annotation Term="Core.Description" String="Path to property that is used to filter the value list by applying the operator (Upper interval boundary)" />
          <Annotation Term="Core.LongDescription" String="In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators" />


A collection of values for the upper boundary makes no sense.

maybe we have here a misunderstanding ? this parameter only needs to be set if a developer wants to default the value to between, although I also don't have a meaningful use case for that, but when using the FE UI you are technically able to configure such scenario, therefore the vocabulary standard should not prohibit us to do so

Removed the Between use case and the upper boundary with 2e24e35.

HeikoTheissen · 2025-03-14T12:26:56Z

vocabularies/Common.xml

        </Property>
      </ComplexType>
      <ComplexType Name="ValueListParameterInOut" BaseType="Common.ValueListParameter">
+        <Property Name="Operator" Type="UI.SelectionRangeOptionType" DefaultValue="0" Nullable="false">


Define new subtype ValueListRangeInOut of ValueListParameterInOut.

=> 2e24e35

BerSie · 2025-03-14T13:25:16Z

Hi @PierreFritsch , can you pls. check BLI FIORITECHP1-29107, if it would support you, implementing your use case? I know it's quite old, but I was approached only 2 or 3 weeks ago with question wrt it. So, it looks like someone will take it up, Maybe approach the owner if you are interested.

cla-assistant · 2025-03-14T14:11:01Z

All committers have signed the CLA.

jan-philip-zieher · 2025-03-14T14:19:06Z

You suggest a very broad generalization of the value help concept but give only a narrow use case as justification:

Valid From shall be on or after some date

Valid To shall be before or on some date

Do you really need the general case? And don't you need the rule "valid from shall be on or before valid to"? (This seems natural to me, but is not covered by your suggestion.)

@HeikoTheissen thanks for your comments, I pushed how I thought it could be incorporated, please review again.

HeikoTheissen

First clarify if the requirement is needed in this generality.

Does the UI support this?
Are there alternatives (#375 (comment))?

HeikoTheissen · 2025-03-14T15:47:36Z

vocabularies/Common.xml

        </Property>
      </ComplexType>
      <ComplexType Name="ValueListParameterIn" BaseType="Common.ValueListParameter">
+        <Property Name="Operator" Type="Edm.PrimitiveType" DefaultValue="EQ" Nullable="true">


Use a concrete type that lists all allowed values (define one if necessary).

HeikoTheissen · 2025-03-14T15:48:56Z

vocabularies/Common.xml

+          <Annotation Term="Core.Description" String="Path to property that is used to filter the value list by applying the operator (Single value or lower interval boundary)" />
          <Annotation Term="Core.LongDescription" String="In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators" />
        </Property>
+        <Property Name="LocalDataPropertyBT" Type="Edm.PropertyPath" Nullable="true">


As I said before, do not clutter the type with additional properties. Define a new subtype.

=> 2e24e35

PierreFritsch · 2025-03-17T10:31:24Z

Hi @PierreFritsch , can you pls. check BLI FIORITECHP1-29107, if it would support you, implementing your use case?

Thanks for the hint @BerSie! I had a look at that requirement. The corresponding improvement request is also referenced externally: UI5 Fiori Elements: Semantic Date Range Filter in the SmartFilterBar for Date Interval eg Validity.

As the improvement request specifically mentions the filter bar, I'd assume that it wouldn't fit for our use case of prefiltering a value help.

- Focus on the narrow use case instead of the general case - Use a concrete type `ValueListRangeOperator` that lists all allowed values - Define new subtypes `ValueListRangeIn` and `ValueListRangeInOut` of `ValueListParameterIn` and `ValueListParameterInOut`, and add the new properties to those subtypes only, instead of cluttering the existing types with additional properties.

vocabularies/Common.xml

PierreFritsch · 2025-03-21T09:44:18Z

You suggest a very broad generalization of the value help concept but give only a narrow use case as justification:

Valid From shall be on or after some date

Valid To shall be before or on some date

Do you really need the general case? And don't you need the rule "valid from shall be on or before valid to"? (This seems natural to me, but is not covered by your suggestion.)

Thanks for the feedback @HeikoTheissen. Reduced the change to our concrete use case with 2e24e35.

PierreFritsch · 2025-03-21T09:52:49Z

First clarify if the requirement is needed in this generality.

Does the UI support this?

Are there alternatives (ValueListParameterIn, ValueListParameterInOut: Add operator parameter #375 (comment))?

Passing operators to value list parameters is not available in FEv4 yet. The corresponding feature request is tracked internally under FIORITECHE1-8621. Our intention with this PR is to provide support from the vocabulary to move the discussions around the frontend support forward.
At first sight, FIORITECHP1-29107 doesn't match the requirement of pre-filtering a value help programmatically.

HeikoTheissen

The main question is still: Does the UI support the new functionality?

HeikoTheissen · 2025-03-21T12:03:19Z

vocabularies/UI.xml

        </Member>
      </EnumType>

+      <EnumType Name="ValueListRangeOperator">


Why is this in UI if it is only used in Common?

Initially placed it here, as it felt like a subset of SelectionRangeOptionType above to me. Moved it to Common (and renamed to ValueListParameterOperator) with 7ff504d.

HeikoTheissen · 2025-03-21T12:03:39Z

vocabularies/Common.xml

        </Property>
      </ComplexType>
+      <ComplexType Name="ValueListRangeIn" BaseType="Common.ValueListParameterIn">
+        <Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="EQ" Nullable="false">


Suggested change

<Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="EQ" Nullable="false">

<Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="UI.ValueListRangeOperator/EQ" Nullable="false">

Thx for the hint! 395a11a

HeikoTheissen · 2025-03-21T12:03:55Z

vocabularies/Common.xml

        </Annotation>
      </ComplexType>
+      <ComplexType Name="ValueListRangeInOut" BaseType="Common.ValueListParameterInOut">
+        <Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="EQ" Nullable="false">


Suggested change

<Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="EQ" Nullable="false">

<Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="UI.ValueListRangeOperator/EQ" Nullable="false">

Thx for the hint! 395a11a

HeikoTheissen · 2025-03-21T12:07:51Z

vocabularies/Common.xml

      </ComplexType>
+      <ComplexType Name="ValueListRangeIn" BaseType="Common.ValueListParameterIn">
+        <Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="EQ" Nullable="false">
+          <Annotation Term="Core.Description" String="Operator applied to the property." />


Suggested change

<Annotation Term="Core.Description" String="Operator applied to the property." />

<Annotation Term="Core.Description" String="Comparison operator used to filter the value list by the property." />

HeikoTheissen · 2025-03-21T12:08:13Z

vocabularies/Common.xml

      </ComplexType>
+      <ComplexType Name="ValueListRangeInOut" BaseType="Common.ValueListParameterInOut">
+        <Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="EQ" Nullable="false">
+          <Annotation Term="Core.Description" String="Operator applied to the property." />


Suggested change

<Annotation Term="Core.Description" String="Operator applied to the property." />

<Annotation Term="Core.Description" String="Comparison operator used to filter the value list by the property." />

HeikoTheissen · 2025-03-21T12:14:30Z

vocabularies/Common.xml

          <Annotation Term="Core.Description" String="Initial value, e.g. empty string, is a valid and significant value" />
        </Property>
      </ComplexType>
+      <ComplexType Name="ValueListRangeIn" BaseType="Common.ValueListParameterIn">


The subtype is still called "range" but the functional scope is restricted to EQ, LE and GE. Are there plans to extend this in the future to CP and BT? If not, consider

changing the type name

whether a subtype is really needed.

One additional property whose default value reflects the current behavior does not necessitate a subtype. I asked for a subtype when it still had many more properties.

For our current use case, EQ, LE and GE would be sufficient. We currently don't have a need to extend it to CP and BT. Our initial suggestion was meant to match the (SelectionRangeOptionType?) values shown in the value list parameter drop-down.

In the sense of keeping the change simple and covering only our current use case, removed the new ComplexTypes ValueListRangeIn and ValueListRangeInOut with ae2bf15, and moved the Operator to ValueListParameterIn and ValueListParameterInOut instead.

and add the Operator to ValueListParameterIn, ValueListParameterInOut instead

PierreFritsch · 2025-03-31T09:04:32Z

The main question is still: Does the UI support the new functionality?

Passing operators to value list parameters is not available in FEv4 yet. The corresponding feature request is tracked internally under FIORITECHE1-8621. Our intention with this PR is to provide support from the vocabulary to move the discussions around the frontend support forward.

@HeikoTheissen: What do you think, would it make sense to schedule an alignment call on this requirement with you (the OData team) and with colleagues responsible for prioritizing the FEv4 backlog? We could organize it (CC @jan-philip-zieher 😉).

ValueListParameterIn, ValueListParameterInOut: Add Operator parameter

63da19e

HeikoTheissen requested changes Mar 14, 2025

View reviewed changes

jan-philip-zieher added 2 commits March 14, 2025 14:53

revert common json / md and adapt xml

15fe626

run build

85ead2b

HeikoTheissen requested changes Mar 14, 2025

View reviewed changes

PierreFritsch commented Mar 21, 2025

View reviewed changes

vocabularies/Common.xml Outdated Show resolved Hide resolved

PierreFritsch changed the title ~~ValueListParameterIn, ValueListParameterInOut: Add operator parameter~~ Add ValueListRangeIn, ValueListRangeOut to support passing an operator to a value help Mar 21, 2025

PierreFritsch requested a review from HeikoTheissen March 21, 2025 10:06

HeikoTheissen requested changes Mar 21, 2025

View reviewed changes

PierreFritsch added 9 commits March 31, 2025 10:33

Merge remote-tracking branch 'origin/main' into ValueListOperator

3e79e5d

UI.ValueListRangeOperator => Common.ValueListParameterOperator

7ff504d

Comparison operator used to filter the value list by the property.

6a4c5f0

Fix DefaultValue

395a11a

Remove ValueListRangeIn, ValueListRangeInOut

ae2bf15

and add the Operator to ValueListParameterIn, ValueListParameterInOut instead

npm run build

eb5aeaf

revert deleted line in UI.xml

bc80e4c

npm i && npm run build

eea08ef

revert space added in UI.xml

a4a8f8c

PierreFritsch changed the title ~~Add ValueListRangeIn, ValueListRangeOut to support passing an operator to a value help~~ Add Operator to ValueListParameterIn, ValueListParameterInOut to support passing an operator to a value help Mar 31, 2025

PierreFritsch requested a review from HeikoTheissen March 31, 2025 09:05

	<Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="EQ" Nullable="false">
	<Property Name="Operator" Type="UI.ValueListRangeOperator" DefaultValue="UI.ValueListRangeOperator/EQ" Nullable="false">

	<Annotation Term="Core.Description" String="Operator applied to the property." />
	<Annotation Term="Core.Description" String="Comparison operator used to filter the value list by the property." />

Add Operator to ValueListParameterIn, ValueListParameterInOut to support passing an operator to a value help #375

Are you sure you want to change the base?

Add Operator to ValueListParameterIn, ValueListParameterInOut to support passing an operator to a value help #375

Uh oh!

Conversation

PierreFritsch commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PierreFritsch commented Mar 14, 2025

Uh oh!

HeikoTheissen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PierreFritsch Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BerSie commented Mar 14, 2025

Uh oh!

cla-assistant bot commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jan-philip-zieher commented Mar 14, 2025

Uh oh!

HeikoTheissen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PierreFritsch commented Mar 17, 2025

Uh oh!

Uh oh!

PierreFritsch commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PierreFritsch commented Mar 21, 2025

Uh oh!

HeikoTheissen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Add `Operator` to `ValueListParameterIn`, `ValueListParameterInOut` to support passing an operator to a value help #375

Add `Operator` to `ValueListParameterIn`, `ValueListParameterInOut` to support passing an operator to a value help #375

PierreFritsch commented Mar 14, 2025 •

edited

Loading

PierreFritsch Mar 21, 2025 •

edited

Loading

cla-assistant bot commented Mar 14, 2025 •

edited

Loading

PierreFritsch commented Mar 21, 2025 •

edited

Loading