Working with widgets - HxGN SDx - Update 64 - Help

HxGN SDx Help

Language
English
Product
HxGN SDx
Search by Category
Help
SmartPlant Foundation / SDx Version
10

When a widget is displayed in a home screen, its default scope will be your create scope. If it is displayed in a dashboard, its default scope will be the selected object's scope. The default scope may be overridden by the administrator.

Some widgets are configured to show data for a specified scope which you can then change. To change this scope, click at the top of the widget, and select the scope required.

If the Query by selected configurations only setting is set to False, when you select a project or sub-configuration that exists under a plant, the query returns objects found in both the selected item and the scope above. For example, if you select Project 2 of PlantA, then the widget displays data for both Project 2 and PlantA. If the Query by selected configurations only setting is set to True, when you select a project or sub-configuration that exists under a plant, the query returns only objects found in the selected item.

Some widgets can be related to another widget on the dashboard and may not display data until a selection is made in the other widget. These are indicated by Link_widgets in the bottom right of the widget. Select an object in the linked widget to display related information. When you select a different object in the linked widget, the related information is updated.

Data displayed in a grid widget can be filtered in the same way as a results grid. For more information, see Filter or sort the results. If the widget is connecting to a remote system, the remote system may require the filter to be case-sensitive.

  • You cannot use Is equal to or Is not equal to to filter a column containing both date and time information.

  • The number of objects displayed in each page of a widget grid may differ from the number of objects displayed in each page of the results grid depending on how it has been configured by your administrator.

Hover over the widget to display a popup menu:

  • Click Expand to expand the widget. Click Shrink to return it to its original size.

    You can also double-click the widget title to expand and collapse it. On an Apple iPad, double-tap automatically zooms in as well as expands or collapses the widget.

  • Click to reload the data in the widget.

  • Click to open the iframe widget in a new window.

On a tablet, the above items are only available when you click .

How do I view the status of a widget?

When viewing the dashboard, either from the home screen dashboard or from the Actions menu of the related object, click to see the status of a widget.

  • If any of the widgets do not display correctly, possible solutions can be found in InsightView dashboard issues.

  • You can also preview a widget when creating or updating a dashboard. To do this, hover over the widget and select eye.

The status details returned depend on the type of widget, and can include the entries shown in the following table.

Name

Displays

API

The Web API used to access the data.

Timer

The time taken to return the results.

Records

The number of items returned for the widget.

Status

Whether or not the widget successfully returned data.

Query

The selected scope for the widget.

Query by selected configurations only

Whether this option is set to restrict the scope to just that selected. For more information, see Query by selected configurations only.

Error

An explanation for the error, if one occurred.

Information on why the widget may not display its contents correctly can be found in the troubleshooting topic Widget content is not displayed.

  • indicates that an error has occurred.

  • A user name and password might be required to log on to an external web page in an iframe widget. If the widget contents don't display, and you aren't prompted for these details, click to log on to the external web page in a new window.

  • Click Expand to expand the widget. Click Shrink to return it to its original size.

    You can also double-click the widget title to expand and collapse it. On an Apple iPad, double-tap automatically zooms in as well as expands or collapses the widget.

  • Click to reload the data in the widget.

Why has my widget been disabled?

A widget is disabled if, the last time the dashboard was displayed, the widget request either took too long to return the results or returned too many results. The amount of time, and number of results allowed, are configured by your administrator.

You can manually enable the widget by clicking Refresh. However, if the widget continues to run slowly, it will be disabled again, and you should ask your administrator to look into the issue.