Widgets contain client and server logic, template, and styles, and for the real interaction, it is required to place an implemented widget on a specified object. In SimpleOne, you can place a widget on a record form or on a portal page.

Displaying a widget on a record form

Forms generally display a set of fields of various types, occasionally split for the sake of clarity. Forms also can include widgets.

Before a widget can be displayed on some form, it should be pre-configured for this. To pre-configure a widget, you need to:

  1. Create a widget. Widget creating is described in the Create a widget article.
    • Define the widget behavior and look, define its server and client logic.
    • Specify the tables on records of which this widget should be displayed. These tables can be selected in the Tables field of the widget creation form. To denote that this widget should be displayed on records of the child tables, use the Inheritance attribute.
  2. Add a widget to a form using the Form Layout base functionality.

For example, you are creating a widget to be displayed on records of all tables of the ITSM Task type (for example, Incidents, Change Requests, Problems, and so on). These tables are child tables for the ITSM Tasks table.

So, when you are creating a widget, select the ITSM Tasks table in the Tables field and mark the Inheritance checkbox, and the widget will be available on records of all the tables child for the ITSM Tasks table (including this table itself).

Displaying a widget on a portal page

To place a widget on a portal page, use the Widget Instances (sys_widget_instance) table. These elements help to define a specific location of widgets according to the portal column specified and to customize the widget options with the option schema.

To configure widget displaying, please complete the steps below:

  1. Navigate to Portal Structure → Widget Instances.
  2. Click New to create a new widget instance record.
  3. Fill in the fields.
  4. Click Save or Save and Exit to apply changes.

Widget Instance form fields

FieldMandatoryDescription
WidgetN

Click the magnifier icon , and select a Widget you want to display from the list.

Page ColumnN

Click the magnifier icon , and select a Page Column ID you want to add a widget to. This field will be pre-filled if you reach this form from the Related Lists area of a Page Column record.

Option ValuesNFill in the field with widget options overridden if it is necessary.
ActiveNSelect this checkbox to make this widget instance active or inactive.
PublicNSelect this checkbox if you want this widget instance to be available for non-authorized users.
OrderN

This field specifies the order of widgets location within a portal column.

Fill in this field with the integer number to display the widgets by the value of this field increases. 

The new widget instance record will be shown in the Related Lists area of the Widget record and the Portal Column record forms.

If you have similar widgets on multiple instances and you need to differentiate them, you can configure their options. Refer to the Creating a portal widget options article to learn more.

Determining the location of a widget

To determine whether a widget is shown on a record form, please perform the following steps:

  1. Navigate to Portal Structure → Widgets and open the widget you need.
  2. If the Tables field is populated, then the widget is displayed on record forms within the specified table. 

You may also use another way to determine whether a widget is shown on record forms. To do it, please complete the steps below:

  1. Open the Widget Instance record you need.
  2. Scroll down to the Related Lists area and open the UI Form Element tab.
    • The Form Section.Form.Table column specifies the table
    • The Form Section.Form column defines the form layout name. 

To define whether a widget is displayed on a portal page, please complete the steps below:

  1. Navigate to Portal Structure → Widgets and open the widget record you need.
  2. Scroll down to the Related Lists area. 
  3. Open the Widget Instance record. 
    • If the Page Column ID is populated, the widget is located on a portal page. 

To go to the page settings where a widget is located, please complete the following steps:

  1. On the Widget instance record form, find the Page Column ID field and open the related record.
  2. On the Page Column ID record form, find the Page Row field and go to the defined record. 
  3. On the Page Row record form, find the Page Container field and go to the record. 
  4. On the Page Container record form, find the Page field and go to the record.

  • No labels

© 2019-2023, SimpleOne

https://simpleone.ru