Select Page

How to Build a Composite Report in Entuity Network Analytics (ENA)?

Building Composite Reports in Entuity Network Analytics (ENA)

An Introduction

This article is going to show you how to build a Composite Report made up of system or custom sub-reports in Entuity Network Analytics to have better control of your network management as you navigating around your network.

What you’ll Learn

  • Composite Reports
  • Report Builder
  • Entuity Network Analytics
  • Network Management

Time

9 min

Report Builder

As we have illustrated how a pair of basic reports (such as a Multi Chart and Table report; a Device Metrics Chart and Table displays a chart and table that each Device in a View; a Port Utilization Charts displays separate charts for each operational enabled Ports in a View) can be built in readiness for a composite reports in the previous blogs. The report builder allows sophisticated reports to be constructed by assembling them from multiple sub-reports using the composite report template. You can even include composite reports within other composite reports to achieve the desired result.

For this blog, we are going to build a report:

    • For each device in a view will display a chart of the CPU and memory utilization over time;
    • Along with a tabular presentation of the mean and maximum values of the CPU utilization and the manufacturer, model, version and serial number;
    • For each device, there will also be a separate chart showing the inbound and outbound utilization for each port that’s operationally enabled.

This requirement implies that some of the charts contain Device level metrics and others contain information relating to Ports. The basic report templates that can display details of multiple components. All require that all of them are of the same type, so Devices and Ports can’t be intermixed. The Composite Report template allows reports based on different component types to be combined and that’s why we are going to use it in this example. Let me show you the two basic reports that have already built for this purpose. Learn how to build those reports from our previous blog.

The first report will apply the Multi Chart and Table template and lists all of the Devices in a View and displays the required Device level metrics in both chart and tabular formats. Each Device is clearly identified by name in the chart title.

The second report also uses the Multi Chart and Table template and lists all the operational enabled Ports in a View and displays their Inbound and Outbound Utilization in the form of a chart per Port. But this time, without any corresponding tabular information, there is a separate tutorial covering how these basic reports were built for this purpose.

Now it’s time to combine both these basic reports into the final composite report. The Report Builder is accessed from the Main Menu Reports page and from here we are going to select the Composite Report template.

Device Metrics Sub-report

In this example, we are going to add the Device level report as the first sub-report by clicking the Add Sub Report button. To define which sub-report will be used, click the value in the sub-report column. This dialogue lists all the reports in the user-defined reports folder and we are going to choose two previously built devices metrics report.

    • The setting in the repetition column controls whether this sub-report will be displayed just once for the whole report or repeated once per component in the report. We’ll need it repeated for each and every Device, so I recommend to leave it set to the default repeat setting.
    • The alignment setting allows you to control whether sub-reports are placed side by side or one above the other and I will leave it in the vertical mode in this case.
    • The position setting affects whether the sub-reports go into title band up at the top the details band in the middle or the summary band at the end of the report. However, repeated sub-reports must go in the details band and others cannot. In practice, it defines their relative positions to each other within the band.
    • The height setting controls the space. Let’s leave the space allocated for this report to be automatically calculated rather than fixing it to a predefined value.
With this one sub-report installed, you can go ahead and select a View having chosen to ignore the selection and preview the result. There are two devices in this View and they’re both being displayed with their charts and their tables.

Port Utilization Charts Sub-report

To add the port utilization charts sub-report, I’ll use the add sub-report button again and this time select the previously built port report.

If I were to preview the report at this stage, it would display an error. This would be because the Composite Report which is based on Devices would be passing the ID of a Device to the Port Report and that one is configured to work with Ports. What the sublet port really needs is the list of Ports belonging to the Device, there are a few steps needed to configure this mechanism.

Hidden Property Fields

One of the underlying mechanisms is how the identity of the component or components to be included in the report is using a hidden parameter. When you check the Show Advanced Options control, another part of the Composite Report template called the Hidden Property Fields is revealed. If there are no hidden properties listed you’re going to need to add one as follows.

Find Attributes

We are going to select the hyperlink from the value column. Hit the Find Attributes button, expand Types – Device – Attributes and explicitly select StormWorks ID. Remember to select it before you hit okay.

Define Attributes

Let’s create another one to allow us to compute the list of Ports for each Device. Use the Add Property button and then click where it says none, which is the default in the value column. Click on it and it would bring up the Static Attribute Selection dialog that allows you to define your own attribute.  Click on Define Attribute button and then make up a name for it by calling it portServerObjectids. The expression will be written using the StormWord’s statement language like this.

The script is called in the context of a device. The ref ports statement returns a list of all of the ports associated with the current device, then using the server object ID string function. This list is turned into a list where each comma-separated entry contains the ID of the
intuitive server on which the device has been managed and the ID of the port with a colon separating the two IDs. This allows it to fully work in a multi-server installation. Having defined the new attribute, let’s select it before clicking okay.

Parameter Setting

Just creating the new property alone doesn’t cause it to be passed to any of the sub-reports. That’s where this control in the parameters column comes into play. It’s currently showing that it is passing all the default parameter values to the sub-report and we need to change that the server object IDs parameter which holds the list of component IDs.

This will require to be represented as a field and let’s enter the name of my newly defined property, which was port server object IDs. Although that parameter contains a list of all the ports on the current device including those that are operationally disabled the sub-report was configured to filter them out. So only charts for the operationally enabled ports will be displayed.

Preview

Now let’s take another preview of the report. Here’s the first device chart with its table and below it our charts for each of the operationally enabled ports on it. Moving to the next page and you’ll see another chart for yet another port. Here is its table and then we’ve got more charts underneath. Each one representing a port.

Publishing

Before saving the report we are going to give it a name and here’s the result in the user-defined reports folder. Now try to build your own Composite Report! If you have any questions regarding Composite Reports, please view our totuiral video How to Build a Composite Report in ENA or our Knowledge Base.

ENA Tips:

The idea of combining multiple sub-reports into a higher-level report can be taken to yet another level if you build sub-reports by combining other sub-reports together. The main point to remember would be that when placing sub-reports side-by-side, their combined widths which are defined. So when you build a sub-report, pay attention to not exceed the width allocated in the final report. Another point you should remember that when you build a rapport and you’re considered to be its owner, which allows you to modify its configuration at a later date via this icon.

Share This