Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. 

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

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:

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. Move the In the Selected box, select the Summary widget from the Available box to the Selected box.to call the Widget Instance window.
    • Configure

    • 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.
Info

If you do not configure the option schema, the widget will have The default settings:

Code Block
languagejs
titleDefault Schema Option Values
"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  

Note

If there is no value in the field

empty

, the

 default values will be applied

widget is not displayed.


  1. Define a reference to a recordfield 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 is Reference, 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 has translationsis easier to localize it


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

    Code Block
    {
    
         "isShowEmptyField": "false"
    
    }


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

    Code Block
    {
    
         "isShowRemAttribute": "false"
    
    }


Example:

Code Block
languagejs
titleSchema Option Values
"tableId": "156873090301469473",
"isPortal": true,
"viewName": "",
"columnName": "employee",
"columnType": "Reference",
"widgetName": "Summary",
"isShowEmptyField": false,
"isShowRemAttribute": true