Create a widget - HxGN SDx - Update 64 - Administration & Configuration

eLearning is available for this topic. Check it out here: HxGN SDx® | InsightViews - Create a Widget

Widgets are created as part of the procedure for creating a new dashboard. For more information, see Create a dashboard. Once you have created a widget, you can preview the widget by hovering over it and selecting . Widgets aren't previewed if they rely on an object to be selected first.

Some example widgets are also provided and can be added to a dashboard as described in Create a dashboard.

What types of widget can be created?

How do I create a widget that connects to a remote SDx site using Smart API Manager (SAM)?

How do I create a widget using a new API entry point group?

You can have only one To Do List widget and one 3D Quick Access widget created in the system at a time. If a To Do List widget or a 3D Quick Access widget already exists, you cannot create another one.

Widgets are created in the Create Widget wizard, which displays the items used to configure the widget in separate tabs.

1. Complete the tabs to create the widget as follows:

   The tabs displayed vary depending on the type of widget you are creating.

   1. Properties

      • Type a name and title for the widget. The Title is displayed at the top of the widget box.

      You can't modify the widget name once the widget is created. The widget name can't contain spaces. If you plan to link to this widget from another widget, or you are creating a chart widget with related data displayed in a second page, you can use only alphanumeric characters (and underscores) in the widget name.

      You can also enter a description to help identify this widget.

   2. Control

      • Select the type of widget to create.

      The tabs that are available in the remainder of the wizard will change to suit the type of widget selected.

   3. Form Properties

      This tab is only available if you are creating a form widget.

      • Select whether to initially display the information in a tile or a list layout.

      Tile layout example		List layout example

   4. API

      1. Select the required Web API.

      2. If a local Web API is used, and you want the user to be able to change the scope for this widget, select Allow SDx scope selection to be changed. The default scope will be the user's create scope in a home screen, or the object's scope in a dashboard.

         You can force a widget to use a specific configuration using a request header. For an example, see Example request headers. We recommend using a request header to control the configuration when connecting to a remote site.

   5. Headers

      • If required, search for the request header to use with this widget.

      For information about request headers, see Create a request header.

   6. Custom Variables

      • If required, use the Build URL using variables control to use a variable to build the URL.

        You have two options:

        • Define a variable to use in a URL

        • Retrieve a URL from a property (available for iframe widgets only)

      

      • With the exception of CURRENT_OBJECT_ID, HxGN SDx environment variables are not supported in widgets.

      • Variables should always use upper case.

      Define a variable to use in a URL

      Variables defined in this way can be used only in the widget they are defined in. Variables are always defined against the local data source and not the Web API selected in the widget.

      1. Select Define a variable to use in a URL.

      2. Type a name for the variable in Variable alias. For example, TAGNAME.

         You cannot include WIDGET_ in your variable name as this is reserved for use in widget dependencies.

      3. Type the value to assign to the variable in Variable definition. For example, Tags({{CURRENT_OBJECT_ID}})?$select=Name.

      4. Use the Variable alias in the URL to return the required data. For example, Tags?$filter=Name eq '{{TAGNAME}}'.

         For more information on the parameters you can use in this URL, see Supported URL parameters.

      Retrieve a URL from a property

      This option is available only for iframe widgets.

      1. Select Retrieve a URL from a property.

      2. Type the location of the property that will return the required URL.

         For more information on the parameters you can use for this, see Supported URL parameters.

   7. URL

      This functionality was modified in an update. For more information, see Create a widget (modified in an update).

      • Either type the suffix for the URL to return the required data, or click to use a wizard to complete the URL. For more information on the wizard, see Complete the URL using a wizard. If required, you can reference another widget on the dashboard in the URL, see Make a widget dependent on another widget. For more information on the parameters you can use in the URL, see Supported URL parameters.

      

      • With the exception of CURRENT_OBJECT_ID, HxGN SDx environment variables are not supported in widgets.

      • Variables should always use upper case.

      • For a count or grid widget using a local Web API, the Actions menu will be available if the Name, Config, and ID are all returned, and the widget is displayed in a full page dashboard (rather than a pop-up window). The ID column is hidden by default in the results.

      • If you want to filter using an enumerated property, for example the document type, use the Name of the property and not the Display Name in the URL.

      • As the URL is completed, it is checked to ensure it is syntactically valid. A warning is shown if there are any issues. You can still finish creating the widget as the error may be due to permissions issues, which will not affect the widget when it is used. However, you cannot finish creating the widget if the URL is blank, groupby is not set for a chart widget, or the defined custom variable has not been used.

   8. Todo List

      This tab is only available if you are creating a To Do List widget.

      • Select the tab to show when the widget is first displayed. The default is Configuration.

   9. Chart Options

      This tab is only available if you are creating a chart widget.

      1. If you are creating a chart that groups data by a date or YMD property:

         1. Use Aggregate by to group the data by day, month, or year.

         2. Select Show Cumulative Line to add a line to your chart showing the total number of objects in each group.

            A cumulative line is only displayed for bar charts.

      2. Select the type of chart to use when the widget is first displayed. The available chart types depend on the options selected:

         Chart option selected	Chart types available
         Aggregate by	Line and Bar
         Show Cumulative Line	Bar
         None	Doughnut, Line, and Bar

         Unless a cumulative line is used, the user can change the chart type when they are viewing the widget.

   10. Drill Down URL

       This tab is only available if you are creating a chart widget.

       • To configure the chart widget so that clicking on a section of the chart displays the related data in a grid in a second page, select Configure a drill down URL.

       You can click to use a wizard to modify the URL. For more information on the wizard, see Complete the URL using a wizard.

2. On the Summary tab, check the details selected in the widget.

   To update a setting, click on the applicable tab and update the setting, as necessary.

3. Click Finish to save the widget.