Role Required: SDAdmin
You can manage the custom widgets by enabling/disabling widgets, editing widget details, or by managing their display locations from the list view.
- Enable/Disable Custom Widgets - You can disable custom widgets temporarily to prevent users from accessing the widgets while you update them. Use the Toggle button next to a custom widget on the Status column to enable or disable the widget.
- Edit/Delete Custom Widgets - Click
beside a custom widget name to edit or delete the custom widget. Note that you cannot delete custom widgets that are associated with custom menu or dashboards.
- View Widget Details - Click
beside a custom widget to expand the quick view where you can view the widget details. You can also click anywhere on the widget name row to expand a widget.
- Authorize Connections - Click a connection name to authorize or revoke the connection.
- Edit Variables - Expand a widget and click
beside the variable field name. You can view variables only if you have configured them in the widget package.
Connections and variables cannot be configured for configuration widgets from UI. You can configure them using JS APIs.
- Manage Display Locations - After you upload the widget package, all widget items and their available locations will be displayed. You can configure the widget items to be accessible only in specific locations by switching the Toggle button beside the Display Location of the custom widget.
- You can customize the display location of custom widgets based on roles and conditions.
- Click Configure beside Display Location.
- For role-based conditions, choose one of the options below against the Associated Roles.
- All Roles: Select this option to display the widget for all users irrespective of their role.
- Selected Roles: Select this option and use the combo box to choose specific roles to restrict displaying the widget only to users with those roles.
- Show to Requester: Select this option to display widgets to requesters. This option is available across modules except for the Assets module.
- For field-based conditions, choose one of the options below against Criteria:
- Based on Condition: Configure conditions using specific field values and display the widget to users when the condition matches.
- To add multiple criteria, click
.
- Click
to sort the order of evaluation of criteria.
- Use the Template option from the Select Column drop-down to choose templates where the custom menu is supported.
- No condition: Select this option to configure the display location for the widgets without applying any field-based criteria.
The Critieria field is not supported for Dashboard and Web Tab display locations.
In addition to the above location configurations, you can also configure display location based on the specific parameters depending on the module.
- Assets: You can configure the display location based on Product Types for the Asset Details - Tab and Asset Details - Right Panel locations.
- Changes: You can configure the display location based on Stages for the Change Details - Stage Subtab location.
- Releases: You can configure the display location based on Stages for the Release Details - Stage Subtab location.
These parameters can be selected using the respective combo box.
You can configure conditions for certain display locations in a custom menu or form rules based on the module.
The conditions for the display locations request custom menu, change custom menu, release custom menu, and asset custom menu can be configured using the
Criteria field in the custom menu for which the custom widget is configured as the action. To learn more about configuring custom widgets, click
here.
Request Form -
Right Panel - Configure conditions using
request form rules. Based on form rule conditions, you can configure
Show Widget or
Hide Widget actions to display or hide widgets. If the form rule condition is not configured for this display location, then the widget will be available for both requesters and technicians irrespective of the templates upon explicit call to SDP.showWidget() function. To learn more how to use this function with your widgets,
click here.
Change Form -
Right Panel - Configure conditions using
change form rules. Based on form rule conditions, you can configure
Show Widget or
Hide Widget actions to display or hide widgets. If the form rule condition is not configured for this display location, then the widget will be available for both requesters and technicians irrespective of the templates upon explicit call to SDP.showWidget() fucntion. To learn more how to use this function with your widgets,
click here.
Manage Widget Items - You can disable specific widget items from the uploaded package by switching the Toggle button beside the widget item name.