Tab

The tab component provides means to show the sub-resources(properties of type Array; For details on property types refer Meta Data (OpenAPI) specification in the HTTP API chapter of the Developer Guide) of an object.

JSON Template

{
  "tabs": [{
    "sequence": 1,
    "tabResource": {
      "listResource": "{the name of the list property that is displayed by the tab}",
    },
    "actions":[
      "add"
    ],
    "copy":true|false,
    "quickSearch": {
    },
    "advancedSearch": {
    },
    "sort": {
    },
    "results": {
    },
    "table": {
    ...
    },
   "initConditions": [

    ],
    "conditions":[{
    ...
    }],
    "pagination":{
      "pageSize":""
    }
  }]
}

Every tab can be configured using the following setting options:

• tabResource (mandatory)

• sequence (mandatory)

• actions(optional)

  • add; applicable only when results component is used.

• quick search component (optional)

• advanced search component (optional)

• sort component (optional)

• results component or table component

  • mandatory; Either of them can be specified

• pagination (optional)

Tab Resource

The tabResource setting consists of the following:

1. listResource

2. header

The listResource setting specifies the sub-resource (list) that should be shown in the tab. It is the anchor point, all other properties within the other components - sort, search, advanced search, and results are defined relative to it.

Quick Search, Advanced Search, and Sort Components

The quick search, advanced search and sort components are placed next to each other and are left aligned.

Copy

Setting copy to true enable action copy at results or table level.

Actions

Action 'Add; is shown at the same level as search and sort components, and is right aligned. The action 'Add' on details in case of tab with table is driven by table component configuration.

Pagination

This component supports pagination and is used to display the list. A maximum of rows as prescribed by the property pageSize are displayed.

Condition

The condition is an optional component. It can be used to control conditional display of fields within the table. For more details refer to Condition component page.

Examples

Tab Displaying List Resource Using Results Component

"tabs": [{
  "sequence": 1,
  "tabResource": {
    "listResource": "claimLineList"
  },
  results": {
    ...
    set1:{
      "properties":[
        { "name":startDate",
          "sequence":1
        }
       ...
      ]
    }
   }
 },
 "pagination":{
    "pageSize":"4"
 }
...
}