Edit the widget option schema

Widget instances allow users to uniquely configure each widget they add to a page. Edit the option schema to define basic parameters for your widget.

Before you begin

Role required: admin or sp_admin

Procedure

  1. Navigate to Service Portal > Service Portal Configuration > Widget Editor.
  2. Select the widget you want to configure the option schema for.
  3. Click the menu icon (Menu icon) and select Edit option schema.
    This option only appears for users that have the right to edit the widget.
  4. Click + to add a widget option.
  5. Define a label, name, type, and hint. More fields appear depending on the type you select.

    Adding flexible widget options allows you to create more reusable widgets. You can add default values to help users understand each widget option.

    Widget options schema form with fields completed as follows: label=time zone, name=zone, type=string, hint=blank, default value=America/Denver
  6. Click Save.
    The option schema you defined is stored in JSON format in the Option schema field in the sp_widget table. Based on this option schema, each instance of the widget can use individually defined instance options.
  7. Test the option schema by adding the widget to a page in the Service Portal Designer.
    1. Navigate to Service Portal > Service Portal Configuration > Service Portal Designer.
    2. Add the widget to a page and click the edit icon on the widget instance to view the instance options.
    3. Configure the widget instance options.
    4. View the configuration by navigating to the instance record in the sp_instance table.
      The instance options are stored in JSON format in the Additional options, JSON format field.