Versions Compared

Old Version 2

changes.mady.by.user Irina Grishina

Saved on

compared with

New Version Current

changes.mady.by.user Dina Baksheeva

Saved on

Key

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

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

Displaying

Add a widget on a record form

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

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

  1. Create a widget. Widget creating is described in the Widget Scripts articleSee the Widget Scripts article to learn how to create it.
    • Define the widget behavior and lookappearance of the widget, define its server and client logic.
    • Specify the tables on records of which this of the records where a widget should be displayedappear. These tables can be selected in the Tables field of the widget creation form. To denote that this widget should be displayed on display a widget on the records of the child tables, use the Inheritance Inherited attribute.
  2. Add a widget to a form using the Form Layoutform layout base functionality.
Info

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

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

Displaying

Add 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 Exitexit to apply the changes.

Widget Instance form fields

FieldMandatoryDescription
WidgetN

Click the magnifier icon Image Removed, and select a Widget you want to display from the listSelect the widget you need to display.

Page Column IDcolumnN

Click the magnifier icon Image Removed, and select a Page Column ID you want Select a page column you need 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 ValuesvaluesNFill in the field with widget overridden options overridden if it is necessary.
ActiveNSelect this checkbox to make activate this widget instance active or inactive.
PublicNSelect this checkbox if you want to make this widget instance to be available for non-authorized available to unauthorized users.
OrderN

This field specifies Specify the order of widgets location within a the widget in the 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 appears in the Related Lists area of the Widget record and the Portal Column record forms.

Tip

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 of the same widget, adjust their options to distinguish between them. For more information, see the Page Structure article to learn more.

Determining

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

You may also use another Another way to determine whether a widget is shown on the 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 columndefines 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 In the Related Lists area, select the Widget Instance tab. 
  3. Open the Widget Instance  record you need. 
    • If the Page Column ID column is populated, the widget is located on a portal page. 
Info

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 Page column record.
  2. On the Page Column ID column record form, find open the Page Row field and go to the defined recordrelated Page row record. 
  3. On the Page Row row record form, find open the Page Container field and go to the record. related Page container record.
  4. On the Page Container container record form, find open the related Page field and go to the record.


Table of Contents
absoluteUrltrue
classfixedPosition