• Print
  • Share

Widget Operations

  • Updated on 01 May 2018
  • 9 minutes to read
  • Contributors

This section helps you with using widgets in the BizTalk360 Analytics Dashboards. It is divided in the following sections:

  • What are the Different Types of Widgets In Analytics Service
  • How To Add A New Widget In Analytics Dashboard
  • What are the Editing Options in Analytics Widgets?
  • How To Delete A Widget In Analytics Dashboard
  • What are the Different Widget Sizes Available in BizTalk360 Analytics?

What are the Different Types of Widgets In Analytics Service

There are three different types of widgets that can be used in BizTalk360 Analytics . They are

  • Default/Basic Widgets
  • Static Widgets
  • Custom Widgets
  • You can create and customize the different types of widgets only under the Operations Dashboard and Analytics Dashboard. The process to perform these operations remains the same.

How To Add A New Widget In Analytics Dashboard

In this paragraph, we will take a comprehensive look into the steps involved to add a new widget into a analytics dashboard.

You can add a widget to both the Home (analytics) Dashboard (default dashboard) and a Custom Dashboard in BizTalk360.

Follow the steps as shown below to add a new widget to the dashboard. To understand the process better, we will show the example of adding the 'Suspended Instances (Group)' static widgets into the Analytics Home Dashboard.

Log in to BizTalk360 On the Analytics Home screen, click Add Widget You will notice the Add Widget blade on the right hand side of the screen. The Add widget blade will contain the list of Static Widgets that can be added to the dashboard. Since in this section, we are considering to add 'Suspended Instances (Group)' widgets to the dashboard, expand the 'Suspended Instances (Group)' section You will notice a + icon against each widget that can be added to the dashboard. Hover over the icon, and you will notice the icon changing. Click the icon to add the widget to the dashboard If the widget was successfully added to the dashboard, you will notice a confirmation message as "Widget Added to dashboard successfully". The + icon will change. Follow the same steps from 5 to 7 to add the remaining widgets to the dashboard Click the** Save** button to close the Add widget blade. Alternatively you can click the X on the Add/Remove widget blade to close the blade. Once the blade is closed, you will notice a confirmation message as Configuration Saved Successfully

BizTalk360-Analytics-Dashboard-Add-Widget.png

BizTalk360-Analytics-Dashboard-Suspended-InstancesGroup.png

BizTalk360-Analytics-Dashboard-All-Suspended-Instances.png

BizTalk360-Analytics-Dashboard-Widget-Added.png

What are the Editing Options in Analytics Widgets?

This paragraph lists the different editing operations that can be performed on a widget on the Analytics Dashboard.

  • Editing the widget title
  • Setting up the widget refresh interval
  • Re-sizing the widget

Editing the Widget Title

Follow the steps as shown below to edit the widget name:

  • Log in to BizTalk360
  • On the Analytics Home dashboard, click the Customize button. You will notice that all the widgets will be in a grayed out state.
  • Click on the widget for which you want to change the title. The widget will be activated with the controls required to edit the widget.
  • Next to the widget title, click the Edit icon (pencil)
  • You will notice the Edit Widget Title pop-in screen with the space to edit the widget title. Enter the new title for the widget in the space provided.
  • Click OK to save the new widget title
  • Click Done on the top right corner of the screen to save the dashboard customization

BizTalk360-Analytics-Dashboard-Edit-Widget-Customize.png

BizTalk360-Analytics-Dashboard-Edit-Widget-Title.png

BizTalk360-Analytics-Dashboard-Edit-Widget-Title-Popup.png

BizTalk360-Analytics-Dashboard-Edit-Widget-Save-New-Title.png

Setting up the widget refresh interval

By default, the widgets have a refresh interval count of 60 seconds. You will notice the refresh timer when you hover over the widget on the dashboard. After every refresh cycle, the widget values will be refreshed. The minimum interval value that can be configured is 1 second and the maximum is 99999 seconds. Follow the steps as shown below to configure the refresh interval for a particular widget. We will consider the 'Message Volume' widget as an example to understand the functionality better. The process will remain the same for the remaining widgets in BizTalk360 dashboard.

  • Log in to BizTalk360
  • On the Analytics Home dashboard, click the Customize button. You will notice that all the widgets will be in a grayed out state.
  • Click on the widget for which you want to change the title. The widget will be activated with the controls required to edit the widget.
  • Click the Refresh icon
  • You will notice the Configure Interval pop-in screen with the space to adjust the refresh interval. Enter the new refresh interval value in the space provided. Alternatively, you can use the up/down arrow marks to select a refresh interval value.
  • Click OK to save the new refresh interval configuration
  • Click Done on the top right corner of the screen to save the dashboard customization

-BizTalk360-Analytics-Dashboard-Edit-Widget-Customize.png

BizTalk360-Analytics-Dashboard-Edit-Widget-Refresh-Interval.png

BizTalk360-Analytics-Dashboard-Edit-Widget-Refresh-Interval-Popup.png

BizTalk360-Analytics-Dashboard-Edit-Widget-Save-Refresh-Interval.png

Re-sizing the widget

In BizTalk360, when a widget is added to the dashboard, it gets added at a best size where all the information will be visible to the user. However, we have provided a functionality to users where you can customize the size of the widgets according to your needs. Say, the widget for monitoring service, when it loads on the default dashboard, it is by default in the Normal size. But you can resize it to be Small to occupy less space in the dashboard grid and add more widgets. Before continuing reading this article, we recommend you to read this article that talks about the different widget sizes and the different sizes a widget can be resized.

Follow the steps as shown below to edit the widget name:

  • Log in to BizTalk360
  • On the Analytics Home dashboard, click the Customize button. You will notice that all the widgets will be in a grayed out state.
  • Click on the widget that you want to resize. The widget will be activated with the controls required to edit the widget.
  • Next to the widget title, click the Ellipses icon (...)
  • You will notice the options to customize the widget with the different sizes. Click the size to which you want to resize the widget.
  • Click Done on the top right corner of the screen to save the dashboard customization. Alternatively, click the Ellipsis icon and select Done Customizing from the drop down.
  • The widget will be resized to the chosen size

-BizTalk360-Analytics-Dashboard-Edit-Widget-Customize.png

BizTalk360-Analytics-Dashboard-Edit-Widget-Ellipses.png

-BizTalk360-Analytics-Dashboard-Edit-Widget-Select-Hero-Wide.png

BizTalk360-Analytics-Dashboard-Edit-Widget-Resized.png

How To Delete A Widget In Analytics Dashboard

In this article, we will take a look at the steps to remove a widget from the BizTalk360 Analytics Dashboard. As mentioned in other articles, a widget can be added to the Analytics Home dashboard and Custom dashboard. A widget can be removed from the dashboard in two different ways

  • Clicking the Add Widget button, and deselecting an already added widget
  • Right clicking on the dashboard area and clicking Customize. This will change the dashboard into a customizable area. Select the widget to be deleted and either click the x on the widget or right click the widget and select Remove from Dashboard.

Deselecting an Already Added Widget through the Add Widget section Follow the steps as shown below to remove a widget from the dashboard. To understand the process better, please assume that all the static widgets under the 'Suspended Instances (Group)' are added into the Analytics Home Dashboard. We will see how to remove these widgets from the dashboard.

  • Log in to BizTalk360
  • On the Home screen, click Add Widget
  • You will notice the Add Widget blade on the right hand side of the screen. The Add widget blade will contain the list of Static Widgets that can be added to the dashboard.
  • Since in this section, we are considering to remove 'Suspended Instances (Group)' widgets to the dashboard, expand the 'Suspended Instances (Group)' section
  • You will notice a X icon against each widget. Hover over the icon, and you will notice the icon changing to X.
  • Click the icon to delete the widget from the dashboard
  • If the widget was successfully removed from the dashboard, you will notice a confirmation message as "Widget deleted successfully". The X icon will change as +.
  • Follow the same steps to remove the remaining widgets from the dashboard
  • Click the Save button to close the Add widget blade. Alternatively you can click the X on the Add widget blade to close the blade.
  • Once the blade is closed, you will notice a confirmation message as Configuration Saved Successfully

BizTalk360-Analytics-Dashboard-Add-Widget.png

BizTalk360-Analytics-Dashboard-Remove-Widget-Suspended-Instances.png

BizTalk360-Analytics-Dashboard-Remove-Widget-Suspended-Instances-Removed.png

Deleting a Widget From Dashboard Customization Area In addition to deleting the widget through the Add Widget section, you can also delete a widget from the dashboard in two other ways -

  • Customizing the dashboard and clicking the 'Remove from Dashboard' icon (X)
  • Right click on the widget and select 'Remove from Dashboard' from the list

The process remains the same for Normal BizTalk360 Users.

The below screenshots depict the two different ways to delete a widget from the Dashboard Customization area.

Method 1

BizTalk360-Analytics-Dashboard-Edit-Widget-Customize.png

BizTalk360-Analytics-Dashboard-Remove-Widget-From-Dashboard.png

BizTalk360-Analytics-Dashboard-Remove-Widget-Removed-From-Dashboard.png

Method 2

BizTalk360-Analytics-Dashboard-Remove-Widget-Right-Click-Widget-Area.png

BizTalk360-Analytics-Dashboard-Remove-Widget-Removed-Via-Widget-Menu.png

What are the Different Widget Sizes Available in BizTalk360 Analytics?

In BizTalk360, the widgets on the analytics dashboard are of specific sizes, and can be customized to certain other sizes. In this article, we will see the different size customization functionalities available with the analytics dashboard widgets.

Widget Sizes The different widget sizes available in Analytics Dashboard (with the dimensions) are as follows:

  • Normal - 2x2
  • Small - 2x1
  • Large - 4x4
  • Wide - 4x2
  • Hero Wide - 6x4

In the below table, we will list the widgets that can be added to the dashboard, their default sizes (when added to the analytics dashboard), and the possible sizes into which they can be resized.

Widget Name Refresh Default Size Other sizes
Message Volume by Schema Yes Hero Wide Wide
BizTalk Messaging Performance Yes Hero Wide Wide
Failure Rate by Schema Yes Hero Wide Super Wide
Failure Rate by Port Yes Super Wide Hero Wide
BizTalk Servers Performance Yes Super Wide Hero Wide
BizTalk Hosts Performance by Memory Yes Super Wide Hero Wide
BizTalk Hosts Performance by CPU Yes Super Wide Hero Wide
All Suspended Instances Yes Large Normal Wide
Suspended Service Class Yes Large Normal Wide
Suspended Service Name Yes Large Wide
Suspended Error Code Yes Large Wide
Suspended Host Name Yes Large Wide
Suspended Adapter Yes Large Wide
Suspended Application Yes Large Wide
Suspended URI Yes Large Wide
All Running Instances Yes Large Normal Wide
Running Service Class Yes Large Normal Wide
Running Service Name Yes Large Wide
Running Application Yes Large Wide
Analytics Service Yes Normal Small
biztalkmsgboxdb Yes Super Wide Hero Wide
GroupBy Results Yes Large Wide