Datatable

A datatable is a:

"...way to translate data into information by interpreting data attributes through column header and information links next to them"

To manage datatables, go to Configuration -> Datatable

Features

Datatable provides various features such as

  1. Full table search

  2. Field sorting

  3. Pagination

  4. Export

  5. Column reordering & resizing

Datatable Metadata

Datatable configuration metadata is retrieved by frontend via API - {/table/metadata/:<objectname>}

Datatable Attributes

Following table consist of datatable attributes

Key Column
Type
Description

ID

Integer

Unique ID of a datatable

Name

Varchar

Unique Name of datatable

Created Date

Datetime

Date on which datatable is created

ID User Created By

Integer

Unique ID of user who created the datatable

ID Organization

Integer

Unique ID of an organization

Last Date Updated

Datetime

Last date on which datatable is updated

Short Description

Varchar

Short explanation regarding datatable

Long Description

Varchar

Detail explanation regarding datatable

Datatable Key Attributes

Following table consist of datatable key attributes

ID

Integer

Unique ID of table column

Column Key

Varchar

Unique name of table column. This is the key in API.

Datatable Name

Varchar

Unique Name of Datatable

Order By

Integer

Determines the order in which the column will appear in the datatable

Caption

Varchar

Display name of column

Show In View

Flag

To display the column in the datatable

Is Drilldown

Flag

To enable drilldown

Drilldown Field

Varchar

The ID field to drill down to another object.

Drilldown Table

Varchar

The object where the drill down will navigate to

Display Type

Varchar

Possible values: flag to show Tick or Cross icon, date to format date

Is Score Highlight

Flag

To format score field

Enable Tree View

Flag

To enable tree view enable this flag for the child field. Table ID is always the parent

Is Highlight

Flag

To highlight any field which LOV. Icon and color should be setup for the LOV Type mentioned in the LOV attribute #6 above

Width

Integer

Width of the field. Default is 150

LOV

Varchar

LOV Type to obtain list of values from API

Info

Flag

To show info icon in the column header

Data Type

Read only

Data type of table column. For information purposes

Status

Flag

Status of the field. If the field is deleted the status will be Inactive and the field will not appear in the datatable metadata API

Action

Icons

Edit and Delete icons. Only soft delete is allowed.

Datatable Configuration

To configure a new datatable

  1. Go to Configuration -> Datatable

  2. Click Add New button

To update an existing table

  1. Go to Configuration -> Datatable a table will open

  2. Click datatable name to be modified or select Edit from action column

Last updated

Was this helpful?