Manage Reports
  • 12 Dec 2019
  • 12 Minutes To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Manage Reports

  • Print
  • Share
  • Dark
    Light

This section provides detailed information about:

  • Creating a new report
  • Building the report with reporting widgets
  • Widget Sizes
  • Removing a Widget from the BizTalk360 Reporting Dashboard
  • Editing the Widget Title
  • Resizing the Widget
  • Restoring the Default Layout of the Dashboard
  • Additional Report Operations [Edit, Clone, Delete Report]
  • Download PDF
  • Live Reports and Historic Reports

Creating a New Report

To create a report in BizTalk360, navigate to Analytics -> Reporting -> Manage Reports -> Click Add New Report button. In the Add New Report blade, the fields in bold are required.

  1. Report Name  - Provide a friendly name for the report
  2. Reporting Schedule - Select the reporting schedule that you have already created (see Reporting Schedule to understand the steps to create a Reporting Schedule)
  3. Click Save to save the report

Sample Report
If no report is configured then you will see the sample report with dummy data. Once you configured the report then the sample report will be removed from your environment.

Configuring Dependencies 

After creating your first report, if you have not configured the dependencies, you will see a warning message as shown below asking you to configure the dependencies.

If you have already downloaded the dependency file once and for some reason, the file is not available in the C:\Program Files (x86)\Kovai Ltd\BizTalk360\Analytics folder, you will notice a Copy icon that will copy the file to the destination location.

Building the Report with Reporting Widgets

The first step is to configure the Reporting Widgets by click on the graph icon parallel to the respective report. You will see a warning message as shown below if no widget configured.

Reporting Widgets are not configured. Click Add Widget to configure the widgets.
  1. Click Add Widget button at the top right corner of the page to add widgets to your reporting dashboard. We have segregated the widgets based on certain performance metrics such as:

    • Predefined widgets 
      • BizTalk Hosts Performance
      • BizTalk Server Performance
      • SQL Server Performance
      • IIS Server Performance
      • Messaging Performance
      • Transmission Failure Rates
      • Monitoring
      • MessageBox KPI
    • Secure SQL Queries
    • Analytics Custom widgets 
  2. Click the + icon to expand the widgets under a category. To add the widget to the Dashboard, click the + icon. The widget will be added to the dashboard and you will see a confirmation message as "Widget added to Dashboard successfully". You will also notice that the + icon changes to x.

Secure SQL Queries

The BizTalk360 Reporting feature includes a widget called Secure SQL Queries, where you can map the Secure SQL Queries to such custom widgets (the SQL queries are created under Operation -> Data Access- > Secure SQL Queries). The custom SQL widgets hold the top 100 records of the mapped query and send that as a report on the scheduled time. This feature can be powerful as it enables you to automatically receive reports based on SQL queries, without the need to requesting it manually over and over again!

Let us consider a scenario, where you want to see the Suspended messages count. As a first step, you need to create a query and manually execute it every time to see the Suspended messages. For this, you may need to switch to multiple tools. This is simplified with SQL Query reports; instead of manually executing a query, just create the query and map it to a schedule according to your needs and you will start receiving the query output as a report in your email box.

Creating a Secure SQL Queries Widget

  1. In BizTalk360, navigate to Analytics and then Reporting
  2. Click Add Widget to add new widgets in the reporting dashboard
  3. Select Secure SQL Queries
  4. Provide a Widget Title and select a Secure SQL Query,
    Widget Title - Enter a friendly name for the widget
    Select a Query - Select the query for which you want to get the results as a report Queries can be created/maintained under Operation -> Data Access -> Secure SQL Queries
  5. Click the Save button
    The Secure SQL Query Widget will now be added to the dashboard.

Analytics Custom Widget 

Similar to the Analytics performance dashboard you can create custom widgets for performance metrics of the BizTalk environment such as Messaging Performance, Message Transmission failure rate, Server Performance, etc and get it as a report based on the schedule configuration.

Scenario 1 - Get BizTalk host instance details as a report  periodically 

You can get BizTalk host instance details with some metrics such as Host Queue Length, Number of instances and suspended instances of the particular host in a graphical view as a report based on the schedule configuration say daily, weekly, monthly to your email, by configuring the metrics in custom widget reporting 

Scenario 2 - Comparing two BizTalk Servers' performance 

There is a scenario where you would like to compare the performance of two BizTalk servers and see which one consumes more memory and CPU. This can be done by selecting the servers in the artifact section and corresponding metrics.

Below are some of the BizTalk performance metrics which you can configure as an analytics custom widget and get it as a report.

BizTalk and SQL Server Health

  • CPU Usage
  • Memory Usage
  • Disk Free Space
  • Average Disk Queue Length
  • Network Performance
  • IIS Request Per Sec
  • IIS Worker Process: CPU Usage
  • IIS Worker Process: Memory Usage

Host Performance

  • Host Instance performance by CPU
  • Host Instance Performance by Memory
  • CPU Consuming Host Instances
  • Top 10 Memory Consuming Host Instances

BizTalk Messaging Performance

  • BizTalk Host Performance
  • Documents Receive/Second
  • Documents Processed/Second
  • Inbound Latency (Sec)
  • Outbound Latency (Sec)
  • Outbound Adapter Latency (Sec)
  • Request -Response Latency

Throttling Performance

  • Message delivery Throttling State
  • Message Publishing Throttling State
  • Message Delivery Outgoing Rate
  • Message Delivery Incoming Rate
  • Active Instance Count
  • Database Size
  • Database Session
  • Database Session Threshold
  • In-Process message Count
  • In-Process Message Count threshold
  • Message publishing incoming Rate
  • Message Publishing Outgoing Rate

Steps to create a Custom Widget

  • Log in to BizTalk360, navigate to Analytics ->Reporting->Manage Reports
  • Open the respective report for widget configuration. Click on Add Widget
  • You will notice the Add Widget blade on the right-hand side of the screen. Click the 'Create Analytics custom widget' option in the bottom of the Add Widget blade.
  • In the 'Create Analytics custom widget ' blade, enter the widget title
  • Date Range - Select the date range for the chart. The options are Last 24 Hrs, Last 7 days, Last 30 days and Custom

    • Last 24 Hrs - Displays the data from the last 24 hours
    • Last 7 days - Displays the data from the last 7 days
    • Last 30 days - Displays the data from the last 30 days
    • Custom - To add a specific number of days, use the scroller to select the day
  • Compare with Previous Hour/Day/Month - Select this checkbox to compare the real-time data with previous hour/day/month

  • Compare with the previous option is allowed only for a single metric.

  • Select the Type of Chart and the legend options

  • Choose the performance metrics by selecting the various categories that want to generate as a chart

  • Click the Save button

Widget Sizes

The widgets on the dashboard are of specific sizes and can be customized to certain other sizes. The different widget sizes available in BizTalk360 Reporting (with the dimensions) are as follows:

  • Compact - 5x4
  • Wide - 4x2
  • Super wide - 8x4
  • Hero wide - 6x4

The below table lists the widgets that can be added to the reporting dashboard, their default sizes (when added to the dashboard), and the possible sizes into which they can be resized.

Widget NameDefault SizeCustomization Options
BizTalk Hosts Performance By CPUCompactSuper Wide
BizTalk Hosts Performance By MemoryCompactSuper Wide
BizTalk Server PerformanceCompactSuper Wide
SQL Server PerformanceCompactSuper Wide
MessageBox Database Disk Usage PerformanceCompactNo Customization
Tracking Database Disk Usage PerformanceCompactNo Customization
MessageBox Database Top 5 Tables (Reserved KB)Hero WideSuper Wide
Tracking Database Top 5 Tables (Reserved KB)Hero WideSuper Wide
IIS Servers PerformanceCompactSuper Wide
BizTalk Messaging PerformanceHero WideWide
Message Volume by SchemaHero WideWide
Transmission Failure Rate By Schema (Top 10)Hero WideSuper Wide
Transmission Failure Rate By Port (Top 10)Hero WideSuper Wide
Monitoring - Event Log Data CountHero WideSuper Wide
MessageBox KPI - biztalkmsgboxdbSuper WideHero Wide
Secure SQL QueriesSuper WideCustomizable

Removing a Widget from the BizTalk360 Reporting Dashboard

In this section, we will look at the steps to remove a widget from the BizTalk360 Reporting Dashboard. As mentioned in the earlier paragraphs, a widget can be added to the Reporting Dashboard. Similarly, a widget can be removed from the dashboard in three 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 the Dashboard.
  • Clicking the Customize button, hover over the widget and click the ellipses icon (...). Select the Remove from Dashboard option from the drop-down
  1. Deselecting an Already Added Widget through the Add Widget section
    Follow the steps as shown below to remove a widget from the reporting dashboard.
  • Click Add Widget, to add widgets to your reporting dashboard or to view the already added widgets to the dashboard
  • You will notice the Add Widget blade on the right-hand side of the screen. The Add widget blade will list the widgets that can be added to the dashboard.
  • Expand the section and click the X 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 +.
  • Click the X icon 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"
  1. 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 three other ways -
  • Customizing the dashboard and clicking the 'Remove from Dashboard' icon
  • Right-click on the widget and select 'Remove from Dashboard' from the list
  • Clicking the Customize button, hover over the widget and click the icon. Select the Remove from Dashboard option from the drop-down

Remove_Widget.gif

Editing the Widget Title

The widgets are loaded on the reporting dashboard with a predefined title. You can change the titles according to your preference by customizing the widget. Follow the steps as shown below to edit the widget name:

  • On the 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'
  • 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

Rename_Widget.gif

Resizing the Widget

In BizTalk360, when a widget is added to the dashboard, it gets added to the best size where all the information will be visible to the user. However, we have provided an additional functionality where you can customize the size of the widgets as per your requirement.

Before continuing reading this section, we recommend you to read this section that talks about the different widget sizes and the different sizes a widget can be resized.

Follow the steps as shown below to resize the widget. For a better understanding of the functionality, we will consider one widget 'BizTalk Hosts Performance By CPU' which can be found under Add Widget -> BizTalk Hosts Performance. By default, when this widget is added to the dashboard, it will be in the Compact mode (5x4). You can customize this widget to Super Wide mode (8x4).

  • In the Reporting dashboard, click the 'Customize' button. You will notice that all the widgets will be in a greyed out state.
  • Click on the widget (BizTalk Hosts Performance By CPU) 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 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 'ellipses' icon and select Done Customizing from the drop-down.
  • The widget will be resized to the chosen size

Resize_Widget.gif

BizTalk360 allows users to customize the dashboard according to your convenience. But, let's say, you accidentally removed a widget, or you want to clean up the dashboard, you can do so using the Restore Default Layout option on the dashboard.

Follow the steps as shown below to restore the default layout of the dashboard.

  • On the dashboard, click the 'Restore Default' button
  • You will notice a warning dialog box with the message as "All active changes will be reverted and any pending edits on these will be discarded. Are you sure you want to restore the layout of your dashboard? ". Click Yes if you want to go ahead and restore dashboard to the default state. Click No to retain the existing layout of the dashboard.
  • Once the restoration process is complete, you will see a confirmation message as "Widget added to dashboard successfully".
  • Clicking the Cancel button while customizing the dashboard will restore the dashboard to the previously saved configuration.

Additional Report Operations - Edit Report

To edit the report, follow the steps as shown below:

  1. Click the Report Actions button and select Edit this report. The fields in bold only can be edited.
  2. Dashboard Name - You cannot edit the dashboard name
  3. Reporting Schedule - Select the reporting schedule that you have already created
  4. Click Save to save the report

Edit_Report.gif

Additional Report Operations - Clone Report

BizTalk360 offers the capability for users to clone the report to easily take a copy of the existing report (widget configurations) and map it to a different reporting schedule.

Example: You have a schedule that executes at 9 AM everyday. You want another report with the same widgets but to execute at a different schedule - say, 15th of every month at 9 AM. In this case, you need not create a new report from the scratch. Instead, you can simply clone the existing report and choose the appropriate reporting schedule from the list.

To clone the report, follow the steps as shown below:

  1. Click the Report Actions button and select Clone this report. The fields in bold only can be edited.
  2. Dashboard Name - Provide a friendly name for the dashboard
  3. Reporting Schedule - Select the reporting schedule that you have already created
  4. Click Save to save the report
Clone Report
When you clone a daily report to a weekly or monthly report, the graph on the dashboard will be displayed according to the schedule peugeot (daily/weekly/monthly).

Clone_Report.gif

Additional Report Operations - Delete Report

Follow the steps as shown below to delete the report -

Click the Report Actions button and select Delete this report
You will notice a warning dialog box with the message as "Do you want to delete this report? You will lose all your changes. ". Click Yes if you want to go ahead and delete the report. Click No to retain the report.
Once the restoration process is complete, you will see a confirmation message as "Reports deleted successfully".
Clicking the Cancel button while customizing the dashboard will restore the dashboard to the previously saved configuration.

Delete_Report.gif

Download PDF

Follow the steps as shown below to download the PDF:

Download PDF
Downloading the PDF of the report is the same as taking a snapshot of the performance metrics (widgets) at that particular instant (Live Data). You can also download the PDF of Historic Reports by choosing the report from the "Select Historic Report" drop-down and downloading the PDF.
  • Click the PDF button. The current state of the widgets will be saved as a PDF document.

Download_PDF_Report.gif

Live Reports and Historic Reports

The Live Data Report shows the data at the current instant based on the System Time. Historic Reports contain the data that was sent in the PDF notification to users at the particular schedule execution.

Live_Report_Historic_Report.gif


Was This Article Helpful?