DOC0000697: Summary Widget

The Summary widget is used in 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.

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

*скрин примера виджета на форме

Add a widget to a form layout

Before adding the widget to a form, check that you can add it to the necessary table. To do this, complete the following steps:

1. Navigate to Portal Structure → Widgets.
2. Find the Summary widget record.
3. Check whether the Tables field refers to the necessary table. 
   • If not, select the table you need to add the widget to.
4. Click Save or Save and Exit.

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

1. Navigate to any table record you need to add the widget.
2. In the hamburger menu, select Configure → Form → Layout.
3. Move the Summary widget from the Available box to the Selected box.

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

4. Click Save to apply the changes.

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

If there are any attachments, they are displayed in the Additional information tab.

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 the field empty, the default values will be applied.

1. Define a reference to a record. Specify a column name and its type:
   

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

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

     {
     
     	 "tableId": "table_id"
     
     }

2. Enable the portal style for the widget:
   

   {
   
        "isPortal": "true"
   
   }

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

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

   {
   
        "viewName": "view_name"
   
   }

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

   {
   
        "widgetName": "Title"
   
   }

   
   

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

5. Exclude empty fields not to display in the widget:
   

   {
   
        "isShowEmptyField": "false"
   
   }

   
   

6. Exclude REM attributes not to display in the widget:
   

   {
   
        "isShowRemAttribute": "false"
   
   }