Sortable in TableList component

nhat-round-cloud · November 25, 2024, 8:06am

Hi there,

In SME tools, we can enable the option Sortable in the binding overview models, including SelectedItemsOverview or AvailableItemsOverview. But when the client renders UIs, users cannot choose the Sorting option for each column.

We would like to have binding overview components that include all the same features as regular overview components.

What @Nam Hoang Le and I can find in the libraries:

No possibility to overview the eventHandlers in component: LinkTableFooter called TableList. If we want to enable this feature we have to copy all internal stuff and override ComponentMap
Sorting is not implemented in the LIST_LINKS RPC method from DS.
Sorting is implemented in LIST_CANDIDATES RPC method from DS.

My question would be:

Are you considering this feature?
Are you considering filter options as well? we would have one to many relationships, It would be nice if users could filter the results.

image821×780 38 KB

Versions:

    "@com.mgmtp.a12.client/client-core": "14.7.1",
    "@com.mgmtp.a12.dataservices/dataservices-access": "36.3.10",
    "@com.mgmtp.a12.formengine/formengine-core": "36.7.5",
    "@com.mgmtp.a12.overviewengine/overviewengine-core": "36.5.1",

Regards!

felix-blazing-river · November 25, 2024, 9:40am

Hey @nhat-round-cloud,

The feature sets for the Available and the Selected Items (Links) lists are a bit different:
For the Available Items list, the enduser can sort, search and filter (if the modeler allowed it). This works in both, “regular” and CDM forms.

For the Selected Items, there is no backend sorting and filtering available yet. With dataservices’ new Query API in 2025.06, this will be possible and we are working on making this modelable.

Since 2023.06-ext9 and 2024.06-ext2 it is possible to sort the entries in the Selected Items list on client side. This can be achieved by a developer. However, the sorting will be “hardcoded”, that means, it can not be changed by the enduser.
There was a bug prior to the versions listed above. From now on, (if there is no sorting code), the elements are shown as they were added. If the Relationship Model specifies “Orderable”" for the specific Role, the enduser can reorder the entries in a tree. The ordering in the tree will be the ordering in the Selected Items list.

Filtering is generally a bit more tricky for CDMs, as this raises conceptual questions (eg if you calculate the sum of values of all the line items, do you expect it to change with the filtering?)

So yes, we are working on this feature. I will contact you directly to gather your use case.

Let us know, if you need help in implementing the Sorting of Selected Items in the CDM form.

nhat-round-cloud · November 26, 2024, 2:21am

Hi @felix-blazing-river ,
Thanks for your info!

For the Selected Items, there is no backend sorting and filtering available yet. With dataservices’ new Query API in 2025.06, this will be possible and we are working on making this modelable. => As I can see in the CDM form, the selected available items UI is using the LOAD_CANDIDATES rpc method which supports the sorting, am I correct?

felix-blazing-river · November 26, 2024, 8:02am

Hey @nhat-round-cloud,

no, LOAD_CANDIDATES loads the Available Items (the items that are candidates for a possible link creation, but not linked yet.) (Load_Document_Graph loads the Selected Items and the Links.)

nhat-round-cloud · November 27, 2024, 3:38am

Hi @felix-blazing-river,

According to the information you mentioned, we couldn’t make it ourselves, right? Only hardcoded sorting in code is possible.

Could you provide the A12 tickets related to this topic next year?

felix-blazing-river · November 27, 2024, 10:59am

Hey @nhat-round-cloud,

yes you can:

sort and filter items in the Available Items list as an enduser (both in CDM and Regular Forms)
apply a specific sorting to the Selected Items list in CDM form as a developer (A12-16010)
apply a specific Ordering to the linked entries as an enduser, when creating the links in the right order or reordering them in a tree (Relationship Model has “Orderable” set to true)

what is missing until 2025.06 (there will be an experimental version available in 2024.06-ext4, February 2025, A12-15821)

modeler/enduser can not change the sorting in the Selected Items lists in CDM forms
Selected Items are not sortable in regular forms

nhat-round-cloud · November 27, 2024, 11:15am

Hi,

The problem here is the Selected items table is more important for us. I assume that we can’t do it via modeling in 2023.06-ext(x)

Is this mean the sorting and filtering will not be supported even in next release?

Regards!

felix-blazing-river · November 27, 2024, 4:25pm

Hey,
yes, none of this will come to the 2023.06 release line.
Some experimental support will be available in the 2024.06-ext4 release (namely the new dataservices API which give the possibility to sort links/Selected Items), but this will not be modelable.
Model-ability will probably come with the 2025.06 release line. Also with 2025.06 we plan to make the Binding UIs customizable.

tri-sheer-boulder · November 28, 2024, 4:13am

Hi @nhat-round-cloud,

Regarding this point,

This feature is delivered in 2023.06-ext9 according to the ticket, but as a developer-only API. You could give it a try if you can’t upgrade to a later release yet.

nhat-round-cloud · November 28, 2024, 4:30am

Hi a @tri-sheer-boulder , @felix-blazing-river ,

Thanks for your information!

We would consider that option and decide next steps.

Regards!

sebastian-long-chasm · February 20, 2026, 1:44pm

With A12 2025.06 it is still not possible to sort or filter the selected items in a composed form model.

Here you see the CFM settings:

Here the related OM settings (columns sortable = yes)

result in the browser:

After having it analyzed i came to the following result:

The component DualPaneSelection.tsx renders two tables: `CandidateTable` (available items) and `LinkTable` (selected items).

**CandidateTable** - Sorting is wired:
```tsx
<DualPaneOverviewTable
    {...candidateOverviewProps}
    sorting={props.availableItemsSorting}
    onSortingChange={props.onAvailableItemsSortingChange}
/>
```

**LinkTable** - Sorting is **not** wired:
```tsx
<DualPaneOverviewTable
    {...linkOverviewProps}
    onToggleState={...}
    onEdit={...}
    // NO sorting prop
    // NO onSortingChange prop
/>
```

also the column click is not wired since onSortingChange is not passed:

```tsx
eventHandlers={{
    onColumnClick: this.props.onSortingChange ? this.handleColumnClick : undefined,
}}
```

MultiSelectionProps API - No sorting prop for selected items:

Redux Action - Only candidate sorting is implemented

The `MultiSelectionProps` interface only defines:

```ts
readonly availableItemsSorting?: OverviewEngineState["sorting"];
onAvailableItemsSortingChange?(sorting: Relationship.SortClause): void;
```

There is no `assignedItemsSorting` and no `onAssignedItemsSortingChange`.


```ts
export interface SortChangedPayload {
    readonly type: "candidate";  // hardcoded - no "link" type
    readonly activityId: string;
    readonly instanceId: string;
    readonly sort?: Relationship.SortClause;
}
```

The corresponding saga sortChangedSaga only reloads candidate data.

is there a reason for that / is this feature planned for the future?