Configure widget instance options

When you add a widget to a page using the Service Portal Designer, it creates a widget instance. A widget instance is a reference to a widget that contains a location, properties, and CSS specific to that instance. Adding the same widget multiple times to the same page creates multiple instances. Each instance of the widget you configure remains unique, so you can have several instances of the same widgets on a page. For example, each instance of the cool clock widget on a page shows a different time zone. Configure a widget on a page by adjusting the instance options.

Before you begin

Role required: admin or sp_admin

About this task

Each time you add a widget to a page it creates a record on the sp_instance table with the following information:
  • Reference to the column where the widget is located
  • Reference to a widget
  • Configuration for a widget in the form of pre-defined form fields and an Additional Options field in JSON format

For example, the icon link widget displays as many different versions of itself as you add to a page.

Figure 1. Icon link widgets
Icon link widgets from the Service Portal homepage with different icons and titles for each instance

All widget instances point to a widget. If you make changes in that specific widget, all of the widget instances receive that change as well. You can also make changes specifically to a widget instance and only the widget instance will be affected.

Procedure

  1. On a page in the Service Portal Designer, point to the Edit icon (Edit icon) in a widget to open the widget instance options. You can also access widget instance options using the control + right-click menu.
  2. From the Instance Options window, make the selections you want to configure your widget.
    Instance options vary depending on which widget you select.

Result

Figure 2. Configure widget instance options

What to do next

Advanced users can configure the available options for a widget. For more information, see Widget option schema.