Data Table
This floor plan template can be used to create a query api based widget.
Use Cases
Few examples of widgets created by using this template:
-
Fetch business objects last worked by the logged in user
-
See the spread of membership based on enrollment type
-
Get the list of group accounts in Change status
-
Get the list of pended policies
Page Layout and Components
Presentation Configuration
Widget is based on query api and it queries the resource associated with the widget configuration. The query and the properties are specified in the widget floor plan.
- JSON Template (Payload Structure)
-
The following JSON outlines the structure of the foldout template
{
"floorplan_queryBasedWidgets":{
"title": "boilerplate key",
"query": "",
"resizingTileSize":"2:3",
"parameters":[{
"name" : "name of the substitution parameter",
"property":{
"The property on the current resource that contains the value to be substituted into the parameter."
}
}],
"quickSearch":{},
"advancedSearch":{},
"sort":{
},
"table":{
}
}
}
Components
This template can have the following components
Title
-
Optional Component
-
Shown as the title of the widget
-
The value of the boilerplate key shows up as the title
Query and Parameters
-
query supported by Oracle Health Insurance query API
-
it is possible to add filter criteria based on the object context by using parameters. The context object is the data object that is currently being used or worked upon in the page.
For example to show group account products that are based on the given enrollment product "query" :/groupaccountproducts?enrollmentProduct.code.eq($\{context.code}).
Such a widget when added on enrollment products page will show all the group account products in context of the worked upon enrollment product
When configuring such a widget, the resource is set as groupaccountproduct and context resource as enrollmentproduct.
Quick Search
-
Optional component
-
right aligned
-
Can be customized to search on multiple attributes including flex codes, reference fields
-
For more details refer Quick Search component
-
If the widget is access from the object which properties form some of the quick search criteria, then such a widget will show the data based on the context object when access from the object page. For example - if a widget is configured to show pended policies for a group where search is based on group code, then opening such a widget from the group account page, shows pended policies for that group by default.
Advanced Search
-
Optional component
-
Enables search on a combination of attributes
-
For more details refer Advanced Search component
-
If the widget is access from the object whose properties form some of the advanced search criteria, then such a widget will show the data based on the context object when access from the object page. For example - if a widget is configured to show pended policies for a group where search is based on group code, then opening such a widget from the group account page, shows pended policies for that group by default.
Sort
-
Optional component
-
Can only have default sort criteria
-
For more details refer Sort Component component page
Table
-
Required component
Used to display the search results in form of a tableIf no results match the search criteria, the message indicating that no rows were found is shown by the results component.
For widgets, table component supports the following sub components:
Rows
-
All the table properties are defined under rows and rows can be configured with the following components
Columns
-
Each property defined in this section forms a column in the table
Region
-
Used if additional properties need to be displayed in the row overflow region
-
Hidden by default, user is required to click on the expand arrow to display the overflow area
-
Set 1 and Set 2: Sets are used to display multiple propertied as a set. Each result can have up to 2 sets. It is recommended to use only Set 1 when using the filter component on the page.
Labels
-
It is used to display property values in form of a label and can take in exactly one property per label
-
Multiple labels can be added to the results
Action * Action View when configured, takes the user to object detail page. * The view action is currently possible in a widget when there is a view and edit page in the Oracle Health Insurance application based on that resource.
only action view is supported in the widgets. For more details refer Table component page |