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

The widget is based on query api, which 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

  • The query is 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 on the page.
    For example, to show group account products that are based on the given enrollment product query: q=enrollmentProduct.code.eq($\{context.code}).

When added to the enrollment products page, such a widget will show all the group account products in the context of the worked-upon enrollment product.

When configuring such a widget, the resource is set as groupaccountproduct and the context resource as enrollmentproduct.

Quick Search

  • Optional component.

  • Right aligned.

  • It can be customized to search on multiple attributes, including flex codes and reference fields.

  • If the widget is accessed from the object whose properties form some of the quick search criteria, then such a widget will show the data based on the context object when accessed from the object page. For example, if a widget is configured to show pended policies for a group where the search is based on group code, then opening such a widget from the group account page shows pended policies for that group by default. See Quick Search component for more details.

Advanced Search

  • Optional component.

  • Enables search on a combination of attributes.

  • If the widget is accessed 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 accessed from the object page. For example, if a widget is configured to show pended policies for a group where the search is based on group code, then opening such a widget from the group account page shows pended policies for that group by default. See Quick Search component for more details.

Sort

  • Optional component.

  • Can only have default sort criteria.

  • See Sort Component component for more details.

Table

  • Required component.
    Used to display the search results in the form of a table.

    If no results match the search criteria, the message indicating that no rows were found is shown by the results component.

For widgets, the 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, the user must click the expand arrow to display the overflow area.

  • Set 1 and Set 2: Sets display multiple properties 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 the 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 the 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 the action view is supported in the widgets. See Table component for more details.
To maintain optimal performance, the number of widgets configured in the system should not exceed 50 at any given time.