Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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:
- Create a widget. Widget creating is described in the Create a New 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 Table ID field of the widget creation form.
- To denote that this widget should be displayed on records of the child tables, use the Inheritance attribute.
- Add a widget to a form using the Form Layout base functionality.
| Info |
|---|
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 Table ID 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. These elements help to define a specific location for the widget according to the portal column specified and to customize the widget options with the option schema.
- Navigate to Portal Structure → Page Columns.
- Choose a page column where the widget should be located.
- Use a search bar in the title area or a Condition Builder to narrow down the selection.
- When the desired column is found, click on it and scroll down to the Related Lists area.
- In the Widget Instances tab, click New to create a new widget instance record.
- Click Save or Save and Exit to apply changes.
| Note |
|---|
You can also reach the Widget Instance form directly; for this, navigate to Portal Structure → Widget Instances. |
The Widget Instance form
| Field | Mandatory | Description |
|---|---|---|
| Widget | N | Click the magnifier icon, and select a Widget you want to display from the list. |
| Page Column ID | N | Click the magnifier icon, and select a Portal Column you want to add a widget to. This field will be pre-filled if you reach this form from the Widget Instances related list. |
| Option Schema Values | N | Fill in the field with widget options overridden if it is necessary. |
| Active | YN | Select this checkbox to make this widget instance active or inactive. |
| Public | YN | If selected, then this widget instance can be displayed on the Self-Service Portal. |
| Order | N | This field specifies the order of widgets location in a portal column. Fill in this field with the integer number to display the widgets by the value of this field increases. When displaying a simple widget in a column, the order value does not matter. |
| Table of Contents | ||||
|---|---|---|---|---|
|