Page History

The Summary widget is only used in on approval forms. It is used to reduce the number of actions and the time required to get acquainted with the subject of approval. But it can also be added to other forms.

Set up the widget

The Summary widget can be added to any form. By default, it is displayed on approval forms. 

To display the summary of records, you need to add the widget to a form layout and configure the option schema.

Add a widget to a form layout

To add the widget on forms, complete the following steps:

Image Added

Configure the options schema

Use the Widget Instance window to specify the widget options. Click the widget while configuring the layout. 

1. Navigate to an approval recordNavigate to any table record you need to add the widget.
2. In the hamburger menu, select Configure → Form → Layout.
3. In the Selected box, select the Summary widget to call the Widget Instance window.

   • Configure

   Move the Timeline widget from the Available box to the Selected box.

   • You can configure the option schema to override the default widget settings. Learn how to do it below.

4. Click Save to apply the changes.

"tableId": "",
"isPortal": falsetrue,
"viewName": "",
"columnName": "item",
"columnType": "Document ID",
"widgetName": "Summary",
"isShowEmptyField": true,
"isShowRemAttribute": true

Configure the options schema

Use the Widget Instance window to specify the widget options. Click the widget while configuring the layout to call this window.

In the window, fill in the Schema Option Values field. Enter the widget options in JSON format. If you leave  

1. Define a field with the record that needs approval. Specify a column name and its type:
   

   Code Block
   {      "columnName": "column_name" "columnType": "column_type.title" }

   
   

   • If the column is of any reference type, specify the table to which the column refers to:
     

     Code Block
     { "tableId": "table_id" }

     
     

2. Enable the portal style for the widget:
   

   Code Block
   {      "isPortal": "true" }

   
   

   Tip
   Use this parameter if the widget is added to a portal form.

   
   

3. Define a configured view name with a specific set of fields:
   

   Code Block
   {      "viewName": "view_name" }

   
   

4. Change the default title of the widget by defining the new one: 
   

   Code Block
   {      "widgetName": "Title" }

   
   

   Tip
   It is better to use a title created in the Source Message (source_message) table, so that it is easier to localize it.

   
   

5. Exclude empty fields from the widget:
   

   Code Block
   {      "isShowEmptyField": "false" }

   
   

6. Exclude REM attributes from the widget:
   

   Code Block
   {      "isShowRemAttribute": "false" }

   
   

Example:

"tableId": "156873090301469473",
"isPortal": true,
"viewName": "",
"columnName": "employee",
"columnType": "Reference",
"widgetName": "Summary",
"isShowEmptyField": false,
"isShowRemAttribute": true