Versions Compared

Key

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

The Summary widget is only used on approval forms to reduce the number of actions and the time required to get acquainted with the subject of approval. 

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

Configure the options schema


To configure the option schema of the widget, complete the following steps: 

  1. Navigate to an approval record.
  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 the option schema to override the default widget settings in the Schema Option Values field. Enter the widget options in JSON. 

  4. Click Save to apply the changes. 
Info

The default settings:

Code Block
languagejs
titleDefault Schema Option Values
linenumberstrue
"tableId": "",
"isPortal": true,
"viewName": "",
"columnName": "item",
"columnType": "Document ID",
"widgetName": "Summary",
"isShowEmptyField": true,
"isShowRemAttribute": true



Note

If there is no value in the Schema Option Values field, the widget is not displayed.


  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 that 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:

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