Publishing custom widgets

You can publish a custom widget individually or collectively to an Engine instance and to one or more Engine User Groups. You can modify the published details of an already published custom widget to add or delete user groups. You can also unpublish widgets.

About this task

Users with a Menu Administrator role, System Administrator role, or Publisher role can publish widgets, modify the published details of an already published custom widget, or unpublish widgets.
Note: You cannot publish a template widget or a multi-chart widget independently.

Procedure

Publishing custom widgets.

  • To publish a custom widget, complete the following steps:
    1. In the left navigation pane of Dashboard Designer, click Custom Widgets > Manage Widgets.

      An All Widgets page opens in a new tab. The page displays all the already created widgets and templates.

    2. Select a custom widget or select multiple custom widgets, and click Publish.
    3. In the Publish Widget(s) window, from the User Group(s) pane, select one or more user groups, and click Move to selected to add the user groups to the Selected User Group(s) pane.

      Only the selected user groups can access the published widgets.

    4. Optional: To delete a user group from the Selected User Group(s) pane, click the Delete Delete icon that is displayed next to the user group.
    5. Click Publish.

      A message confirming whether the selected widgets must be published is displayed.

    6. Click Ok.

      The custom widgets are published to the selected user groups, and the Published to column on the All Widgets page displays the number of users groups that can access the published widgets.

Modifying the published details of an already published custom widget or unpublishing a widget.

  • To modify the published details of an already published custom widget or to unpublish widgets, complete the following steps:
    1. For an already published widget, click the user groups that are displayed in the Published to column on the All Widgets page.

      The Published to column on the All Widgets page displays the number of users groups that can access the published widgets.

    2. In the Edit Published Details window, complete any or all of the following steps:
      • To add new user groups, select one or more user groups, and click Move to selected to add the user groups to the Selected User Group(s) pane.
      • To delete the already selected user groups, in the Selected User Group(s) pane, click the Delete Delete icon that is displayed next to the user groups.

        For every user group that you delete, a message confirming whether you want to delete the selected user group is displayed. Click Ok to delete the selected user group.

      • To unpublish a widget, you must delete all the already selected user groups. In the Selected User Group(s) pane, click the Delete Delete icon that is displayed next to each user group.

        For every user group that you delete, a message confirming whether you want to delete the selected user group is displayed. Click Ok to delete the selected user group.

    3. Click Update Published Details.
      Based on addition or deletion of user groups, any of the following messages are displayed:
      • If you added or deleted user groups, then a message confirming whether you want to publish the widget to the selected user groups is displayed.
      • If you deleted all the user groups, then a message confirming whether you want to unpublish the widget from Engine is displayed.
    4. Click Ok.
      • If you added or deleted user groups, then a message indicating that the widgets are published successfully is displayed, and the Published to column displays the updated number of users groups that can access the published widgets.
      • If you deleted all the user groups, then a message indicating that the custom widget is unpublished successfully is displayed.

What to do next

After you publish a widget, you must log in to Engine and view the published widgets.