Versions Compared

Key

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

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

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

Code Block
languagejs
titleDefault Schema Option Values
"tableId": "",
"isPortal": false,
"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 the field empty, the default values will be applied.

  1. Define a

  2. table on which to display the widget
  3. reference to a record. Specify a column name and its type:

    Code Block
    {
    
         "columnName": "column_name"
    	 "
  4. tableId
  5. columnType": "
  6. table
  7. column_
  8. id
  9. type.title"
    
    }
  10. Add the widget to the portal forms

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

      Code Block
      {
      
      
  11.  
    • 	 
  12.    
    • "
  13. isPortal
    • tableId": "
  14. true
    • table_id"
      
      }


  15. Define a configured view name with a specific set of fieldsEnable the portal style for the widget:

    Code Block
    {
    
         "viewNameisPortal": "view.titletrue"
    
    }


  16. Define a

  17. reference to a record. Specify a column name and its type
  18. configured view name with a specific set of fields:

    Code Block
    {
    
         "
  19. columnName
  20. viewName": "
  21. column
  22. view_name
  23. " "columnType": "column_type.title
  24. "
    
    }


  25. 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 translations. 


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

    Code Block
    {
    
         "isShowEmptyField": "false"
    
    }


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

    Code Block
    {
    
         "isShowRemAttribute": "false"
    
    }