[UXPROD-4536] Add support to dashboard for simple search widget that can use CQL syntax Created: 31/Oct/23  Updated: 30/Nov/23

Status: Draft
Project: UX Product
Components: None
Affects versions: None
Fix versions: None

Type: New Feature Priority: TBD
Reporter: Owen Stephens Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to UXPROD-3794 Dashboard app: Extend capabilities to... Open
Development Team: K-Int
PO Rank: 0

 Description   

Current situation or problem:

The dashboard widgets currently supported (aka simple search widgets) create searches (and display results) from the KIWT (K-Int Web toolkit) search syntax. This feature is to add support for a CQL based simple search widget.

As an exemplar widget a "receiving pieces" widget should be added

In scope

  • Add support for CQL simple search widget
    • This will be able to create a search and parse results obtained via CQL with a focus on supporting the receiving piece widget
  • Add receiving piece widget definition based on the appropriate type

Out of scope

  • Other widget types
  • Display of non-tabular data

Use case(s)

Receiving piece widget which should support:

  • Searching for a list of receiving pieces based on a limited set of criteria (see below)
  • Display fields from receiving piece records in the results (api endpoint `/orders/pieces`)
  • Display fields from order title record for each receiving piece (api endpoint `/orders/titles/<order title UUID>` - each receiving piece has a `titleId` property which contains the <order title UUID>)

Base URL

/orders/pieces

Resource

piece

Search fields

Label Path
tba  

 

Display Columns

 

Label Path Link?
tba    

Sort Columns

Label Path Sort types
tba    

Filters 

Label Path Type Comparators
tba      

Configurable properties

  • urlLink
    • Configurable: true
    • Default: tba
  • numberOfRows
    • Configurable: true
    • Default: 10

Proposed solution/stories

  • mod-service-interaction -> add CQL simple search widget definition
  • mod-orders -> add receiving piece widget type and support registering the widget type with mod-service-interaction

Additional info

Additionally it would be useful to be able to display/sort/filter on:

  • Vendor
  • Fund

But these may need to be investigated as a separate feature, as this may require us to make requests to multiple modules (Organisations, Finance) and it may not be possible to provide filter options as this information is linked to the Order (Vendor) and Order Line (Fund distribution) respectively, not to the piece or order-title

Questions


Generated at Fri Feb 09 00:40:40 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.