Reports

Reports is a reporting module available in the Cavisson products. These reports are generated using Templates. User can select reporting format as Word, HTML or Excel. It includes tabular data with or without graphical illustration.

Note: Report Access Permission: If a user is assigned with ‘No Permission’ in capabilities section to access ‘Report’ feature, then on accessing the Reports feature from TestRun / Session UI / Dashboard, the session logs out with a message “You are accessing unauthenticated links hence closing this session”. In addition, the user cannot access the Reports menu in Widgets settings. On having Read-only permissions for Reports, the user can only view the generated reports or template, but cannot create a new one from Report Management UI.

This is categorized into the following sections:

  • Metrics
  • Detailed
  • Ready
  • Templates

Metrics

This section is further categorized into following sub-sections:

  • All Reports
  • Performance Stats Report
  • Compare Report
  • Excel Report
  • Hierarchical Report
  • Summary Report

All Reports

This section displays all reports with the details, such as report type, report name, template name, created by, created on and action. The user can edit or delete a report from here. To add a new report, the user is required to click the  icon. The process for report creation is described in the subsequent sections.

Performance Stats Report

Performance Testing is defined as a type of software testing to ensure software applications will perform well under their expected workload. Once the performance test is executed, the user can generate its report by using the Cavisson Reporting feature. For this, first the user needs to define the configurations for the performance stats report and then needs to generate it. Once the performance stats report is generated, the user can view it for the detailed investigation of the results.

Cavisson performance stats report is broadly categorized into two sections, Performance Report and Metrics Report.

  • Performance Report is further categorized into Analysis Summary and Performance Summary. The Analysis Summary report contains details, such as overall analysis summary, executive summary, and statistics summary. The Performance Summary contains details, such as overview of the test, sessions, transactions, pages, network, and errors.
  • Metrics Report is further categorized into Metrics Summary and other charts, such as URL, Page, Transaction, Session.

Configuring Performance Stats Report

To define the configurations of a performance stats report and generating it, the user needs to follow the below mentioned steps:

  1. Go to Reports > Metrics > Performance Stats Report.

Note: The user can also open the performance stats report by clicking Reports > Metrics > All Reports. Within the All Reports(s) window, the user needs to click the  icon and select Performance Stats as the Report Type.

  1. Provide the inputs (as mentioned in the subsequent sections) and click the Generate Report

General Settings

  • Report Type: It is the type of report that is to be created. The available options are Stats, Compare, Excel, Hierarchical, Summary, and Performance Stats. Select Performance Stats from the drop-down list.
  • View Type: It is the view type of the report. For a Performance Stats Report, the view type is HTML. The user cannot change this option.
  • Report Name: It is the name of the report. Provide a valid report name.
  • Report Settings: Here, the user can select the reports that are required to be displayed, such as Analysis Summary, Performance Summary, Metrics Summary, and Metrics Charts.

Preset Options

  • Preset: The user can fetch the transactions for the whole test run or for a specified duration, such as last 1/2/4/6/12 hours and so on. User can also apply custom time on selecting the Custom option from the drop-down list.

  • Show Discontinued Metrics: This enables a user to get the data of discontinued metrics too while generating a Performance Stats report. Discontinued metrics are those metrics whose data is dropped in between of the test run. These metrics are skipped in the current view of graphs. It is neither displayed on the graph panel nor displayed in the tree structure. All such metrics can be displayed by selecting the Show Discontinued Metrics option.
  • Start Date / Time and End Date / Time: On selecting the Custom option, two options are displayed further for the selection of time – Absolute and Elapsed. Absolute time is the exact time. Elapsed time is simply the amount of time that passes from the beginning of an event to its end. In case of Absolute, enter start date, start time, end date and end time. In case of Elapsed, enter start time and end time. The specified date/time should be in range with current session.

‘View By’ Settings

  • View By: In the View by option, the user can specify the format of aggregated data (such as hours, minutes, and seconds) based on the selection of Preset option. For example, if user selects ‘Last 15 minutes’ in preset option, then ‘View by’ option contains ‘Seconds’ and ‘Minutes’ only. If user selects ‘Last 4 hours’ in preset option, then ‘View by’ contains ‘Seconds’, ‘Minutes’ and ‘Hours’. On selecting the Auto option, the view by value is automatically considered based on the progress interval defined in scenario settings.

  • Value: Based on the View By selected, the user needs to specify the value for View By option.

Metrics Option

Metrics are the source of capturing the report data.

There are various options available to select the metrics:

  • All Metrics: On this selection, all metrics are captured for reporting.
  • Selected Metrics: On this selection, the user needs to specify certain other details, such as chart type, graph type, Report set name, group metrics, and graph metrics.
  • Templates: On this selection, the user needs to select the template from the drop-down list.
  • Favorite: User can generate the report from a favorite also. To do this, select the Using Favorite option and select the favorite from the drop-down list for which the report is to be generated.
  • Include Charts: To include charts in the report, select this check box.
  • Override Charts: On selecting this, the original charts are replaced with the chart type selected from the drop-down list.

Filter by Value Option

The user can discard the un-desired graphs in the report by using the ‘Filter by Value’ option. To enable the filters, the user first needs to select the Enable Filter check box.

There are following filter options:

  • All Non- Zero: Upon enabling this, all non-zero graphs are involved in the report.
  • All Zero: Upon selecting this, all zero graphs are involved in the report.
  • Advanced: Upon selecting this, user can have some advance level options based on value, such as <, >, <=, >=, Top, Bottom, In between, which helps to achieve the desired output. User can filter graph values by Min, Max, and Avg value of its graph data. User can also use the Include or Exclude options to get the filtered results. Include/exclude options includes/excludes the graphs that lies within the specified values. For example – if we try to find the graphs that has values between 50-100, then on include, system displays such graphs that has values from 50-100 and exclude option skips those results that contains graph values from 50-100 and displays the rest graphs. To enable the filters, user needs to enable the toggle button.

Threshold File Option

  • Threshold Template: This is the default template created in csv format to define the threshold values for various fields of the report, such as Min, Max, Avg, standard deviation, and various percentile values. The color-coding of these fields in the report is defined based on the threshold values specified in this file. First, the user needs to select a template from the drop-down list, then download this template, and define the object name and module on which the color-coding is to be applied. Then, based on a field, such as Avg, Min, Max, the user can define the values for minor, major, and critical separated by a space (for example, 400 800 950). The color-coding is applicable in the below sequence.
    • First value is for Minor threshold and is represented by Green
    • Second value is for Major threshold and is represented by Yellow
    • Third value is for Critical threshold and is represented by Red

Here is a sample format of the threshold template:

Note:

    • The user can also use a regular expression (regex) pattern in the transaction name.
    • The user can specify operators, such as >, >=, <, <= for comparing data value with threshold values.
    • The column names in the threshold template should always be the same as mentioned: “Metric, Object, Module, Avg, Min, Max, P50, P80, P90, P95, P99, Operator”
    • An option is provided in scenario to select Threshold Template in auto generated html report after test completion.
  • Download: To define the values, the user first needs to download the threshold template.
  • Upload: Once the threshold values are specified in the template, the user needs to upload the threshold template.
  • Delete: The user can delete a template if this is not required.

Summary

  • Executive Summary (Optional): It is a short document or section of a document, produced for business purposes, that summarizes a longer report or proposal or a group of related reports in such a way that readers can rapidly become acquainted with a large body of material without having to read it all.
  • Conclusion (Optional): A conclusion is not merely a summary of the main topics covered or a re-statement of your research problem, but a synthesis of key points and, if applicable, where you recommend new areas for future research.

Viewing Performance Stats Report

The Performance Stats report or Analysis report enables a user to have a detailed investigation about the test based on the configuration applied while creating the performance stats report. It also provides transaction summary where the user can view the summary of all or individual transactions in tabular and graphical format. The color-coding on the fields in the transaction summary report (tabular) is based on the threshold values applied for each category (minor / major / critical).

To view the performance stats report, go to Reports > Metrics > Performance Stats Report.

Select a performance stats report from the list. This displays a window where the user can view the detailed performance report with various aspects. This window is divided into two panels. From the left panel, the user can select the report type and its corresponding details is displayed on the right.

On the left panel, this window is further categorized into two sections – Performance Report and Metrics Report. The description of these topics is provided in the subsequent sections.

Performance Report

Performance report displays the overall performance of the test. It is further categorized into two sections:

  • Analysis Summary
  • Performance Summary
Analysis Summary

The Analysis summary is used for analyzing the test results. This displays various type of summary of the test that includes summary of configurations applied for the report generation, executive summary, statistics summary, and conclusion of the performance test.

  • Analysis Summary: This section displays the summary of analysis with the below details:
    • Scenario Name
    • Test Name
    • Test Run Number
    • View By
    • Report Time Period
    • Phase Name
    • Test Run Start Date Time
    • Test Run End Date Time
    • Duration (hh:mm:ss)

  • Executive Summary: This displays the executive summary provided at the time of specifying inputs for generating the performance stats report.

  • Conclusion: This displays the conclusion provided at the time of specifying inputs for generating the performance stats report.

  • Statistics Summary: This section displays the statistical summary of the performance stats report with the following details:
    • Max Running Virtual Users
    • URL Average Time (ms)
    • URL Total
    • URL Success
    • URL Failures
    • Average Session/Minute
    • TCP Received Throughput (Kbps)
    • TCP Sent Throughput (Kbps)

Performance Summary

This section is further divided into following sub-sections:

  • Overview
  • Sessions
  • Transactions
  • Pages
  • Network
  • Errors

The details of each is provided in the subsequent topics:

Overview: This section displays the overall summary of the test that includes the sections, such as Load Profile, Test comment, General information, Performance summary, and Network.

  • Load Profile: This section displays two sub-sections, the first section contains Scenario type and Schedule type (group name, user profile, script name, users/session rate, percentage, and arrival rate) and second section contains scenario phases (start, ramp-up, stabilization, duration, ramp-down, and session pacing).

Note: In case of FCU, the User(s) column is displayed and in case of FSR, the Session(s) column is displayed.

  • Page Think Time: The user can view page think time for all scenario types if added in the scenario.

  • Test Comment: This displays the test name and test notes.

  • General Information: This displays the test duration, stat time of test, and end time. It also displays certain graphs, such as graphs of concurrent users, request per second, and transaction errors. One graph is displayed as line with all samples and second is for 95th percentile or which is configured.

  • Performance Summary: This displays total count, count per second, count per hour, and count per day for URL, Pages, Transactions, and Sessions.

The description of fields are as follows:

FieldDescription
URL Count TotalSample count of HTTP Response Time (Secs)
URL Count 1/sAvg of HTTP  Complete / Sec
URL count 1/h3600*HTTP  Complete / Sec
URL count 1/d24*3600*HTTP  Complete / Sec
URL Total ErrorsHTTP Request Completed  –  HTTP Request Successful
URL Errors %(URL Total Errors / URL Count Total) * 100
URL Runtime (ms) mean, min, max and std devHTTP Response Time (Secs) need to convert to milliseconds.
URL Runtime Percentile (ms) P50, P95, P99, P99.9Percentiles of  HTTP Response Time (Secs)
Transaction Count TotalSample count of Transaction Response Time (Secs)
Transaction Count 1/sAvg of Transaction  Complete / Sec
Transaction count 1/h3600*Transaction  Complete / Sec
Transaction count 1/d24*3600*Transaction  Complete / Sec
Transaction Total ErrorsTransaction Completed – Transaction Successful
Transaction Errors %(Transaction Total Errors/Transaction Count Total) * 100
Transaction Runtime (ms) mean, min, max and std devTransaction Response Time (Secs) need to convert to ms
Transaction Runtime Percentile (ms) P50, P95, P99, P99.9Percentiles of  Transaction Response Time (Secs)
Sessions Count TotalSample count of Session Response Time (Secs)
Sessions Count 1/sAvg of Session Complete / Sec
Sessions count 1/h3600*Session Complete / Sec
Sessions count 1/d24*3600*Session Complete / Sec
Sessions Total ErrorsSession Completed  – Session Successful
Sessions Errors %(Sessions Total Errors/Sessions Count Total) * 100
Sessions Runtime (ms) mean, min, max and std devSession Response Time (Secs) need to convert to ms
Sessions Runtime Percentile (ms) P50, P95, P99, P99.9Percentiles of  Session Response Time (Secs)

Note: The user can configure the percentile from Dashboard. For this, go to Configurations > Configuration Settings > Dashboard Settings and click the Percentile tab in the Configuration Settings window.

  • Network: This displays the total numbers, numbers per second, per hour, and per day of Requests, Bytes sent and Bytes received. This data is generated from Send/Received Throughput (VUser), Total = (Rate * Duration (Sec)) /8.

Sessions: A session is an executed and completed test case. Each Session consists of one or more transactions. Session Summary Includes session wise statistic within the particular test, sessions per sec, Errors, runtime (ms), Runtime Percentiles (ms). The Summary chart section comprises all data across sessions to allow for a quick overview on session problems and performance. In the following, all chart sections below visualize this information:

  • Overview: Sessions Response Time, 95th Percentile and Errors.
  • Averages: Sessions Response Time, 95th Percentile and Errors.
  • Counts/s: number of completed Sessions per second
  • Arrival Rate: Arrival rate per hour, 95th Percentile
  • Concurrent Users: number of Active Users

The description of fields are as follows:

FieldDescription
Session NameGroup Name
Sessions Count TotalSample count of Session Response Time (Secs) (5.3.NA/Overall)
Sessions Count 1/sSessions Completed/Minute/60
Sessions count 1/hSessions Completed/Minute*60
Sessions count 1/dSessions count 1/h * 24
Sessions Total ErrorsSample count of “Session Failure Response Time (Secs)
Sessions Errors %(Sample count of “Session Failure Response Time (Secs)”/sample count of  ”Session Response Time ”)*100
Sessions Runtime (ms) mean, min, max and std devSession Response Time (Secs) (5.3.NA/Overall) need to convert to milliseconds
Sessions Runtime Percentile (ms) P50, P95, P99, P99.9Percentiles of  Session Response Time (Secs)  (5.3.NA/Overall)

Within this summary table, there are multiple tabs with different charts.

  • Overview: This displays different graphs for Session Time with 95th Percentile, Session Time with all samples, Session Error count, and Session Error % and Slab count chart.

Field Description
Sessions Runtime with  P95 95th Percentile of  Session Response Time (Secs)
Sessions RuntimeSession Response Time (Secs) need to convert to milliseconds
Sessions Total ErrorsSample count of “Session Failure Response Time (Secs)
Sessions Errors %((sample count of “Session Failure Response Time (Secs)”/sample count of  ”Session Response Time ”)*100
Slab count graph Slab count graph of  Session Response Time (Secs)  with auto slabs
  • Average: This displays the 95th Percentile, Median, and Mean graph of Session time.

  • Count / s: This displays the 95th Percentile and per second Session count.

  • Arrival Rate: This displays the current Sessions Per hour and its 95th

  • Concurrent Users: This displays the active Vusers.

Note: The user can see the stats of each session, such as overview, average, count/s, arrival rate, and concurrent users by clicking a transaction name.

Transactions: Transaction is part of a session and usually consists of one or more pages. When testing web applications, an action resembles a page view. The data shown here reflects the time spent on the execution routine of a transaction. Therefore, the transaction’s runtime includes the runtime of a page (an HTTP operation, for instance) and the time required to prepare, send, wait for, and receive the data. The error count defines the number of errors detected for a particular transaction such as timeouts or connection resets.

The Summary chart section comprises all data across Transactions to allow for a quick overview on transaction problems and performance. The tabs in this chart section contain single charts that refer to one transaction.

In the following, all chart sections below visualize this information:

  • Overview: Transactions Response Time, 95th Percentile and Errors
  • Averages: Transactions Response Time, 95th Percentile and Errors.
  • Counts/s: Number of completed transactions per second.

This section displays transaction name, total count, count per second, per hour, per day, total errors, errors %, runtime in millisecond, and runtime percentile in milliseconds.

Within this summary table, there are multiple tabs with different charts.

  • Overview: This displays different graphs for Transaction Time with 95th percentile, Transaction Time with all samples, and Transaction Error count as bar chart.

  • Average: This displays 95th percentile, Median, and Mean graph of Transaction time.

  • Count/s: This displays 95th percentile and per second transaction count.

Pages: This displays Page name, Total Page count, Page count per seconds, per hour, per day, Errors, Runtime in milliseconds, Runtime Percentiles in milliseconds and Runtime Segmentation in milliseconds. This section if further divided into three sub-sections: Overview, Bandwidth, and Network Timing.

  • Overview: This displays count, errors, runtime, runtime percentiles (ms), and runtime segmentation (ms).

  • Bandwidth: This displays Total, 1/second, 1/hour, 1/day, avg, min, and max of bytes sent and bytes received of each page.

  • Network Timing: This section displays DNS Time, Connect Time, Send Time, Server Busy Time, Receive Time, Time to First, and Time to Last.

  • Network: This displays Total number, numbers/seconds, numbers/hour, and numbers/day of Requests, Bytes Sent, and Bytes Received. In case of Byte Sent and Bytes Received, Total = (Rate * Duration (Sec)).

This section also displays certain charts, such as requests per second, TCP send throughput, and TCP receive throughput.

  • Hosts: This displays host name, count, and percentage.

  • HTTP Response Code: This displays HTTP Response codes, count, and percentage.

  • Errors: This displays URL Errors, Sessions Errors, Transaction Errors, and Page Errors in a chart for a time period.
FieldDescription
URL ErrorsHTTP Failure  Response Time
Session ErrorsSessions  Failure  Response Time
Transaction ErrorsTransactions  Failure  Response Time
Page ErrorsPages  Failure  Response Time
  • URL Errors

  • Sessions Error

  • Transaction Errors

  •  Page Error

Metrics Report

This section displays the metrics summary report and individual description of each reports (with separate link) based on the configurations. Here is an example of reports created based on certain metrics, such as Generator CPU Utilization (%), Generator Available Memory (MB), Generator Ethernet Throughput, Generator Load Average Over 1 Min, and Generator TCP Stats.

Note: By clicking on an individual report, the user can view its details.

The fields that are displayed are as follows:

  • Min: This is the minimum value of graph in a particular metrics.
  • Max: This is the maximum value of graph in a particular metrics.
  • Avg: This is the average value of graph in a particular metrics.
  • Dev: This is the standard deviation value of graph in a particular metrics.
  • Last: This is the last value of graph in a particular metrics.
  • Samples: This is the total number of samples.

Key Points

The user can navigate to the graphical representation of any individual transaction by clicking the transaction name.

The user can navigate to the table by clicking the Back to table link.

Any failed transaction is represented with Red color in the Errors column.

The user can also generate the performance stats report from Scenario after the test completion. For this, open the Scenario, go to Logs and Reports and provide the inputs in Reports section.

The user can show / hide the left panel by clicking the  button at the top left corner.

The user can search a string by using the Search section. This is applicable in case of Sessions, Transactions, and Pages within the Performance Report section.

Note:

Display of ‘Data’ Value and ‘Percentage’ Value

Data value and percentage value is displayed with legend in case of ‘Pie’ and ‘Donut’ chart.

‘Last’ Option in Report Management Window

A ‘Last’ option is displayed in the drop down list of Formula Type for Pie and Donut chart type while creating Template from Template UI and from Report Management UI using Select Metrics.

Compare/Trend Report

Compare Report compares two or more Test runs or releases. Trend Report shows the trends of configured monitors over a specific time period. Compare/Trend Report gives an insight about how a particular website or application has performed during a particular trend period chosen by user.

Creating a Compare Report

Follow the below mentioned steps for creating a compare report:

  1. On the Compare report, click the  icon.

  1. Enter the report name.
  2. Specify the View Type, such as Tabular/Word/HTML (same as mentioned in the Stats report).
  3. Specify the View by
  4. Select the template from the drop-down list.
  5. Enter the measurement name. Measurement name is a unique name which is assigned for the test run measurement.
 noteUser can also set the Preset value and Time format.
  1. Then, click the Add button, a new row will be added.

  1. Specify the Measurement name, select the test run (for which comparison needs to be done), and specify other options, such as Preset, time format. Click the Add button.
noteUser can add multiple test runs for comparison by following this process (Step 6).

Measurement which is selected will include in report.

User can update/delete a measurement also.

  1. Click the Generate Report button, the report gets generated as displayed.User can add further columns, such as Minimum and Maximum Value and Max sample timestamp in Compare Report.

In Compare Report, a heading named ‘Selection Mode’ is provided with a check box. This appends a check box preceding to each metric name, so that the user can perform further operations, such as view selected graphs, show selected, hide selected and so on.

noteUser can apply filter on the report.User can download the report in PDF, Excel, and Word format.

Creating a Trend Report

Follow the below mentioned steps for creating a trend report:

  1. On the Compare report, click the icon.

  1. Select the Trend Compare check box.
  2. Enter the report name and select a template from the drop-down list.
  3. Next, select the project, sub-project, and scenario. Click the Apply The measurement details will be filled automatically.

  1. Select the measurement name for compare, and click the Generate Report button. The report gets generated and displayed.

Output

Transaction Time (Secs) Trend

Tabular View of Trend Report

Trend Report for Data of 95th Percentile

Note: The trend compare report is generated with 95th Percentile value in case of Avg, Min, and Max data values. Table in the generated report displays all the selected percentile values but chart is formed based on 95th value. Earlier, chart of only normal graphs was coming, and now in case of percentile graphs, data values that displays in graph is of 95th percentile.

For graph type as ‘percentile graph’, the values are 95th percentile.

Percentile Values:

One Page View

Excel Reports

An Excel template is a report layout that you design in Microsoft Excel for retrieving and formatting your enterprise reporting data in Excel. Excel templates provide a set of special features for mapping data to worksheets and for performing additional processing to control how your data is output to Excel workbooks.

Creating Excel Based Templates

To create a template, create two sheets, one for Formula and another for Actual Report and save them as template. The formula sheet captures the data from graphs, perform mapping with report sheet, and post the data on the reports sheet. User needs to create certain columns and specify the formula for respective columns. A formula is a collection of Graph instances. The report sheet is called when scheduling is performed via portal.

User can change the layout of the Report sheet in the template also, such as color coding, setting labels, setting threshold values and so on based on requirements.

In a template, some headers are optional, such as Page Name, Metrics, Competitor, and Browser while others are mandatory to create, such as DC, Formula, Type, Graph Type, Decimal, Value 1, Value 2…., and so on.

Creating a Formula

User can get a formula either from derived graph feature of dashboard or navigating to the tree structure of the graph manually i.e. tier>server>instance in the left pane of the Dashboard GUI.

Creating a Formula Manually

To create a formula manually, use the following syntax:

  • Group ID.Graph ID.[Vector Name] For example – 107.9.[Cavisson>NDAppliance]
  • {Group Name}{Graph Name}[Vector Name] For example – {SysStats Linux Extended}{Process Waiting For Run Time}[Cavisson>NDAppliance]

Getting Formula from Derived graph

  1. Open the Dashboard GUI, right-click on Custom Metrics and click Add Derived Graph. The Derived graph window is displayed.

  1. Select the Group name, Graph name, and Indices.
  2. Click Add Graph. The formula is displayed.
  3. Copy the same and paste on the Formula sheet under Formula column.

noteThe graphs can also be added via providing Group ID and Graph ID. Format: Group ID.Graph ID.[Vector Name]

Working with Formula Sheet:

  1. Mention the User name, current date time, report time period, and Aggregate.
  2. Create the column headers as Page name, Metrics, Competitor, Browser, and DC.
  3. Next, specify the Formula In this column, specify the Graph path.

Group ID.Graph ID.[Vector Name] or {Group Name}{Graph Name}[Vector Name]

  1. Create the Type This stores the type of value required (i.e. Min/Max/Avg and so on). Enter the value based on your requirement.
  2. Create the Graph Type Mention ‘Derived’ by default.
  3. Create the Decimal It specifies up to what decimal places, result is required.
  4. Create the columns in which the graph result is stored. These columns are prefixed with ‘Value’, such as Value1, Value2, Value3, and so on. The Value columns are created based on the specification of Aggregation.

For example, if user wants to see the data of last one week and aggregated it by one day. So, seven value columns need to be created. Each value column will capture the aggregated data of one day.

 noteSpecify the column name in sequence.There can be multiple formula sheets, each formula sheet is mapped with one report sheet.

 


Working with Report Sheet

Report sheet contains the mapped results from formula sheet. Suppose, the data of last one week needs to be captured and it is aggregated by one day. So, seven value columns are created and mapped with the value columns in the report sheet.

Creating an Excel Report

Follow the below mentioned steps for creating an Excel report:

  1. On the Excel Report window, click the icon.

  1. Enter the report name, specify the preset options, and select the template from the drop-down list.
 noteTo upload a template, click the Upload button.To download a template, click the 120 icon.

To delete a template, click the 121 icon.

  1. To aggregate the entire report in a single column, select the Aggregated over the entire Report Time Period check box. For example, if user want to capture the data of last one week and select this check box, then the aggregated data will be displayed in a single column.
  1. If Show Last week’s data day-wise option is selected and user needs graph data for two weeks aggregated by week-wise, then 8 value columns will be created one for a complete week data and rest seven for other week data day-wise.
  1. To show reports in either Column or Tab, select the same from Show report in If user selects the column option, then graph data will be captured in columns and if user selects the tab option, the graph data will be displayed in separate sheets/tabs.
  1. Click the Generate Report button, the report gets generated and displayed on the Report Management

  1. To view the report, click on the report link. The report gets displayed.

User can now generate excel Report for more than two DCs. For this, user needs to use configuration with IP and DC name, such as <IP>: <DC Name>.

Following settings need to be done in $NS_WDIR/webapps/sys/config.ini

netstorm.executivedashboard.ndclient.datacentername = MOSAIC

dashboard.excelReport.ip=65.49.37.719:MosaicAccount,65.49.37.71:MosaicCNC,65.49.37.71:Mosaic_Solr,209.51.175.196:SCS,209.51.175.196:PKY

dashboard.excelReport.port=4431,4431,4431,4469,4470

netstorm.dashboard.KPIClient.UseSecureConnection=1

The excel report can be generated with Last value of the graph. The user can generate this by selecting ‘LastValue’ in ‘Type’ column of excel template.

Note: The default status of ‘Show Discontinued Metrics’ check box is enabled/selected in Excel report. This enables a user to get the data of discontinued metrics too (by default) while generating an Excel report.

Hierarchical Reports

This report is based on the meta data component. There will be multiple drop-downs up to maximum level of hierarchy in test run. For example, if there are maximum 5 levels of meta data in test run, then there will be 5 drop-downs. Each drop-down will be filled by unique list of specific level of meta data component. Also drop-down should be filtered by the previous selection. Next drop-down is enabled only after selecting any value in the current drop-down.

Creating a Hierarchical Report

Follow the below mentioned steps for creating a hierarchical report:

  1. On the Hierarchical Report window, click the  icon.

  1. Enter the report name and specify the preset options.
  2. Select a template along with other options (if required).
  3. Select the meta data details (such as Tier > Server > Instance) and click Generate Report The report gets generated and displayed.

Summary Report

Summary report contains the summarized information of the test, such as test summary, transaction details, HTTP status code details, and other important information. Summary report contains some predefined sections and headers which are more relevant.

Generating a Summary Report

Follow the below mentioned steps for generating the summary report:

  1. On the Report Management window, right-click on Summary, and then click New Report.

  1. Enter the report name and specify the report percentile from the drop-down list.
  2. Specify the preset options.User can select multiple duration in summary report.
  3. Click the Generate Report button. The report gets generated.Click the report name to view its details

There are following section in the Summary report:

  • Test Information: This section contains information on test run, scenario, machine, and so on.
  • Test Summary: This section contains information on URL, page, transaction, and session.
  • Other Information: This section contains information on TCP connections, SSL Sessions, HTTP hit rate, and throughput.
  • Detail Transaction Report: This section contains transaction details, such as Min, Max, Avg, success, Failure, and so on.
  • HTTP status Codes: This section contains HTTP status code that are occurred in the test run.

Summary Report with multiple selection presets

There’s a provision to generate Summary Report for multiple presets. Example: if user wants to generate Summary Report of all duration phases of Test Run like Duration1, Duration2, and so on, then user needs to select multiple duration from preset drop down list and generate Report.

For example, in below screen, we have selected three durations, such as Duration 3, 4, and 5 of Group-1.

Generated Report: Upon clicking the Generate Report button, the stats for the selected duration is generated and displayed in a report.

Detailed

This section displays some detailed reports, such as Drill down reports, UX general reports, and Log reports. The description of each topic is provided in the subsequent sections.

Drill Down

Here, the user can view the available drill down reports, such as:

  • URL
  • Session
  • Transaction
  • DB Requests
  • Exception
  • Method Timing
  • FlowPath
  • Page

URL

This report displays URL summary, such as URL name, number of tries, number of success, number of failures, minimum duration, average duration, maximum duration, median, 80th percentile, 90th percentile, 95th percentile, 99th percentile, percentage fail, and script count.

Further Reports in this Section

The user can view further reports from this window by clicking the specified links.

  • To view URL instance report for tried attempts, click the Tried link
  • To view URL instance report for successful attempts, click the Success link
  • To view URL instance report for failed attempts, click the Fail link
  • To view URL Component details, click the Average link
  • To view URL Session Summary, click the Script Count link

Session

This report displays Session summary, such as Script name, number of tries, number of success, number of failures, minimum duration, average duration, maximum duration, median, 80th percentile, 90th percentile, 95th percentile, 99th percentile, and fail percentage.

Further Reports in this Section

The user can view further reports from this window by clicking the specified links.

  • To view the script file in script manager, click the Script Name link
  • To view Session instance report for tried attempts, click the Tried link
  • To view Session instance report for successful attempts, click the Success link
  • To view Session instance report for failed attempts, click the Fail link
  • To view Session details report, click the Average link

Transaction

This report displays Transaction summary, such as transaction name, minimum duration, average duration, maximum duration, median duration, 8th percentile, 90th percentile, 95th percentile, 99th percentile, script count, number of tries, success, fails attempts, and fail percentage.

Further Reports in this Section

The user can view further reports from this window by clicking the specified links.

  • To view Transaction details report, click the Average link
  • To view the Transaction session summary, click the Script Count link
  • To view the transaction instance for successful transactions, click the Tried link
  • To view the transaction instance for failed transactions, click the Fail link

DB Requests

This report provides details on the database query. To view the database query results, click the DB Requests link on the Drill-Down Queries page or click the DB Call Count link on the Flowpath window (for particular flowpath instance). The Database query report is displayed.

This report displays details, such as DB query, query count, error count, minimum count, maximum count, minimum time, maximum time, and average time (in ms) taken by the query. It also displays tier, server, and instance. On clicking the query name, the complete query is displayed in the Query text area.

Further Reports in this Section

The user can view further reports from this window by clicking the specified links.

  • To view the flowpath report, click the Query Count link.

Exception

Exception instance report displays detailed information on the exception occurred, such as exception trend, aggregate exceptions (exception class, throwing class, throwing method, and exception count), exception details (tier, server, instance, integration point, time, exception class, message, throwing class, throwing method, line method, and cause), stack trace, and source code.

Note: The exceptions are captured for .NET, Java, and NodeJS agents.

Exception Stats

This section displays two sub-sections. One for group by exceptions where percentage of exception groups (such as PSQLException and NumberFormatException) is displayed and another is exceptions where exception stats (exception by time at X-axis and exception by count at Y-axis) is displayed.

Aggregate Exception(s)

This section provides aggregated details of the exception(s), such as exception class, throwing class, throwing method, and exception count.

Exceptions

This section displays details of an exception. To view details of a particular exception class, click the exception counts within the Aggregate Exception(s) section. The details include tier, server, instance, integration point, time, exception class, message, throwing class, and throwing method.

Stack Trace

This section displays stack trace that contains stack data. On clicking a record from the left, source data is displayed at the right.

User can perform further actions from this section:

  • To view recorded variables, click the  icon.
  • To copy source code, click the  icon.
  • To download method body, click the  icon.
  • To download class file, click the  icon.

Method Timing

This report provides an intuitive view of the methods with their execution timings. This helps in getting the information, such as which methods is taking more time in the execution and causing an issue in the overall execution of the query or business transaction.

To view the method timing report, click the method timing link on the drill-down queries page or the response time in flowpath window (for particular flowpath instance). The Method Timing Report window is displayed:

This report displays the details of method timings in the form of Pie chart. It also displays the summary of methods that contains package, class, methods and their associated time of execution. Here, user can identify which method is taking huge amount of time to execute.

Description of terms in the method timing report:

  • Percentage: Percentage of total time taken to execute all invocations of method
  • Self-time: Time taken for invocation of a method excluding the time taken by inner methods
  • AvgSelfTime: Average self-time taken for single invocation of method
  • CumSelfTime: Total self-time taken for all invocations of method
  • CumWallTime: Total time taken for all invocations of method
  • AvgWallTime: Average time taken for all invocations of method
  • CumCpuTime: Total CPU time taken for all invocations of method
  • AvgCpuTime: Average CPU time taken for all invocations of method
  • CumCpuSelfTime: Total CPU self-time taken for all invocations of method
  • AvgCpuSelfTime: Average CPU self-time taken for all invocations of method
  • WaitTime(ms) : Any thread consuming time on wait method
  • SyncTime(ms) : Any thread stuck before synchronized block or synchronized method due to lock not available
  • IOTime(ms) : Thread pause time due to input/output operations.
  • SuspensionTime(ms) : Thread pause time due to java GC.
  • Count: Number of invocations of a method

From this window, user can perform following operations:

  • View summary of all methods
  • View summary of all classes
  • View summary of all packages
  • View compare report
  • View dashboard

FlowPath

Click the FlowPath link on System Queries window to view the FlowPath report.

This window contains information, such as Business Transaction, URL, Category, Start Time, Response Time (ms), Methods, URL, Status code, number of CallOuts, CallOut Errors, Category, CPU Time (ms), Parent FlowpathInstance, Total CPU Time (ms), and others.

Description of terms used in FlowPath Report:

  • Tier: This denotes the name of the tier.
  • Instance: This denotes the instance running on that tier.
  • Business Transaction: This denotes the name of the business transaction executed on the instance, such as purchasing an item, transferring funds, or tracking an order. On clicking this link, user can view Flowpath details/ method calling tree.
  • URL: It denotes the page URL of the business transaction. On clicking this link, user can view HTTP report.
  • Category: It denotes the category of business transaction, such as normal, slow, very slow. On clicking this link, user can view HotSpot report.
  • Start Time: This denotes the start time of the business transaction or method
  • Response Time: This denotes the time taken in the execution of business transaction. It is in MM/DD/YY HH:MM:SS format. On clicking this link, user can view Method Timing report.
  • CPU Time: Time spent by CPU to execute method or transaction.
  • Methods: It denotes the number of methods executed for that business transaction.
  • CallOuts: It denotes the number of calls for that method. On clicking this link, user can view transaction flow map.
  • CallOutErrors: It denotes the number of errors occurred in the method invocation. On clicking this link, user can view exceptions for error callout.
  • DB Call Count: This denotes the database call counts. On clicking this link, user can view DB request report.
  • Status: This denotes the status/response code of the business transaction, such as 200, 500.
  • CorrID: This denotes the correlation ID.
  • WaitTime(ms) : Any thread consuming time on wait method.
  • SyncTime(ms) : Any thread stuck before synchronized block or synchronized method due to lock not available.

Further Reports from this Window

  • To view IP Summary, click the Business Transaction link
  • To view HTTP Report, click the URL link
  • To view Hotspot report, click the Category link
  • To view Method Timing report, click the Response Time link
  • To view Method Call details, click the Methods link
  • To view End-to-end transaction FlowMap, click the Callout link
  • To view DB report, click the DB Callouts link

Apart from this, flowpath window displays various icons through which a user can perform various functions:

SR. No.IconDescription
1Copy flowpath link
2Show all flowpaths of selected flowpath’s session
3Show all flowpaths of selected flowpath’s NV session
4Open NV Session
5Open End to End Application View
6Open aggregate flowpaths of selected flowpaths
7Download as PDF report
8Download as Word report
9Download as Excel report
10Start auto instrumentation
11View Metadata
12Compare flowpaths
13Delete Cached Data

Copy FlowPath Link

The user can copy flowpath link of the selected flowpath by clicking the  icon.

A message is displayed for successful copy of the flowpath link.

Show All FlowPaths of Selected Flowpath’s Session

The user can view all the flowpaths of the selected flowpath session by clicking the  link.

Show All Flowpaths of Selected Flowpath’s NV Session

The uses can view all flowpaths of selected flowpath’s NV session by clicking the  link.

Open Application End-to-End View

On clicking the button, the user can view the Application End-to-End View for the selected business transaction. For more details on Application End-to-End View, refer the later sections.

Open Aggregate Flowpaths of Selected Flowpaths

This operation is used to aggregate the method timing of Flowpaths. To perform this operation, select two or more Flowpaths and click the Aggregate Method Timing icon . The Aggregated method timing report is displayed.

The information of method timing is displayed in the form of a pie chart.

The user can also view the summary of methods in tabular format at the lower pane of the window. It contains package, class, methods and their associated time of execution. To view the details of an individual method in tabular format, click that method on the pie chart.

Description of terms in the method timing report:

  • Percentage: Percentage of total time taken to execute all invocations of method
  • Self-time: Time taken for invocation of a method excluding the time taken by inner methods
  • AvgSelfTime: Average self-time taken for single invocation of method
  • CumSelfTime: Total self-time taken for all invocations of method
  • AvgCpuSelfTime: Average CPU self-time taken for all invocations of method
  • WaitTime(ms) : Any thread consuming time on wait method
  • SyncTime(ms) : Any thread stuck before synchronized block or synchronized method due to lock not available
  • IOTime(ms) : Thread pause time due to input/output operations.
  • SuspensionTime(ms) : Thread pause time due to java GC.
  • Count: Number of invocations of a method

The user can view following other reports via this window:

Icon Description
To start Auto instrumentation
To exclude Level1 Flowpaths
To view summary of all packages
To view summary of all classes
To view summary of all methods

Start Auto Instrumentation

On clicking the  icon, the user can start auto instrumentation. The details of auto instrumentation is provided in the later sections.

View Metadata

When a user clicks the View Metadata  icon, metadata report is displayed. This report contains the details of all metadata and mapping of Tier, Server, and Instance as per the topology in tabular form. The mapping section is displayed by default.

Mapping

This section contains three tables that have the mapping of Tier, Server, and Instance as per the topology.

Metadata

This section contains 10 tables, which have the following details:

  • Tier
  • Server
  • Instance
  • Package
  • Class
  • Method
  • Backend
  • Tables Records
  • BT
  • Query

A user can update the tables from DB by clicking the Refresh  icon.

Compare Flowpaths

This operation is used to perform comparison between two Flowpaths. To do this, select two Flowpaths for which the comparison is to be done, and click the Compare Flowpaths icon .

This window displays Flowpaths details, such as tier, instance, business transaction, start time, response time, number of methods, URL, Status, CallOuts, CallOut Errors, Category, and CPU time.

In the Flowpath comparison section, user can view the comparison of various entities, such as transaction flow, method timing, DB report, sequence diagram, Hotspot, method calling tree, and exception.

Delete Cached Data

On clicking the  icon, the user can deleted the cached data for the following components:

Exception Instance Report for Selected Flowpath

Exception instance report displays detailed information on the exception occurred, such as exception trend, aggregate exceptions (exception class, throwing class, throwing method, and exception count), exception details (tier, server, instance, integration point, time, exception class, message, throwing class, throwing method, line method, and cause), stack trace, and source code. To view the exception instance report for a particular flowpath, select the flowpath, and click the  icon in Flowpath report window.

There are various sections in this window:

Exception Trend 

Aggregate Exceptions 

Exception Details

Stack Trace

 

Source Code

User can download the source code also. All these reports can be downloaded in Word, Excel, and PDF format.

Open NV Session

In this section, user can view the NetVision session of the selected flowpath. To view NV session, select a flowpath and click the  icon. This displays the NV session along with various details:

Page

The user can also view the Page Summary report from Drill Down Queries window. This window displays the following page summary details: Page name, number of tries, success, and failures. It also displays minimum, maximum, average, and median duration of the page along with 80th percentile, 90th percentile, 95th percentile, 99th percentile, fail percentage, and script count.

Other Reports from this Window

  • To view the page instance report, click the Tried link
  • To view the page failure report, click the Fail link
  • To view the page component detail report, click the Average link
  • To view the page session summary report, click the Script Count link

Hotspot Report

This report is used to find out a thread that is taking more time in execution or was stuck in the processing. This may cause a spike in the graphical representation of the processing. To view the Hotspot thread details, click the Category link on the flowpath report window. The Hotspot thread details window is displayed.

Following details are displayed in this window:

  • Thread ID: Unique Id of the thread
  • Hotspot Entry Time: Start time of the hotspot
  • Hotspot Duration: Duration of the hotspot in seconds
  • Thread State: Current state of thread, such as runnable, timed_waiting, blocked, running etc.
  • Thread Priority: It is the priority of thread, such as 1, 2, 3 and so on. Threads with priority 1 are executed first and so on by JVM.
  • Stack Depth: Number of methods within the stack defined the depth of the stack trace captured for hotspot.

Another section in this window displays the detailed stack trace, this displays the method execution time.

At the bottom of Hotspot report, there is Integration Point Calls section that displays integration point call details, such as IP name, discovered IP name, type of IP, start time, duration, status, and query.

Clicking on the IP name navigates the user to Integration point health section.

This window displays various information on integration points, such as average response time (ms), maximum response time(ms), response time trend, Calls per second (CPS), CPS trend, total number of calls, total errors, and error trend.

It also displays expanded view of response time trend, CPS trend, and error/sec trend.

HTTP Report

HTTP report displays details on various sections, such as http details, request header, condition headers, response headers, session attributes, and derived data. To view the HTTP report, click the URL link on the Flowpath report window. The HTTP Report is displayed.

Ready Reports

Ready reports are those reports that do not require any process for generation. The user just need to click the respective report on the Reports menu and corresponding report is displayed:

  • Page Detail Report
  • Lighthouse Report
  • Detailed Report
  • Failure Report
  • Page Dump Report
  • Page Breakdown Report
  • Progress Report
  • Detailed User
  • Scheduler

Page Detail Report

Click the Page Detail menu item on the Report menu. The Page Detail Report is displayed.

Lighthouse Report

On clicking the Light House Report, the following window is displayed:

This window displays following details:

  • Page name
  • Host name
  • Group
  • Session Count
  • Performance Score (%)
  • Accessibility Score (%)
  • Best Practice Score (%)
  • First Meaningful Paint (sec)
  • Time to Interact (sec)
  • First CPU Idle (sec)
  • Speed index (ms)

On clicking the page name link, a detailed report is displayed.

Failure Report

Click the Failure Report icon on the left pane. The Failure report is displayed.

Page Dump Report

Click the Page Dump Report on the left pane. The Page dump report is displayed.

Page Breakdown Report

Click the Page Breakdown Report menu item to view this report.

Progress Report

Click the Progress Report icon on the left pane. The Progress report is displayed.

Detailed User Report

On clicking this link, page average report is displayed where the user can see the page name, host name, group, session count, DOM content load time in seconds, onload time in seconds, page load time, number of requests, browser cache, bytes received and sent.

Scheduler

User can schedule a report by specifying certain information. Scheduling is performed to generate reports on continuous intervals.

  1. In the Reports window, go to Ready Reports and click Scheduler. This displays a window, which contains the generated reports.
  2. Click the icon, the Scheduled Tasks window is displayed.

3. Click the icon to add a task, this navigates to the first step of task creation.

Step – 1: Select the Report Type and Template

 

  1. Select the Report Type (for example, Excel/Custom/Alert Digest Report). By default, it is EXCEL.
  2. Enter the Report name. By default, it is ExcelReport.
  3. Select the Template from the drop-down list.
 After template creation, user needs to upload it to the system. The uploaded templates are displayed in the list. Refer upload a template to know how to upload a template.If the user selects the Report Type as CUSTOM, the default Report Name changes to CustomReport. Further, the user can choose from Using Template or Using Favorite to add a task.
  1. Click the Next button to navigate to the next step.

Step – 2: Select Preset Option

 

  1. Select the Preset option from the drop-down list. It is the time period for which the report needs to be generated. For example – Last 15 minutes, Last 8 hours and so on. The date and time are filled automatically.
 If user selects the Custom option, then needs to specify the Start date/time and End date/time.
  1. In the View by option, user can specify the format of aggregated data (such as hours, minutes, seconds) based on the selection of Preset option. For example, if user selects ‘Last 15 minutes’ in preset option, then ‘View by’ option displays ‘Seconds’ and ‘Minutes’ only. If user selects ‘Last 4 hours’ in preset option, then ‘View by’ displays ‘Seconds’, ‘Minutes’ and ‘Hours’.
  2. To aggregate the entire report in a single column, select the Aggregated over the entire Report Time Period check box. For example, if user want to capture the data of last one week and select this check box, then the aggregated data will be displayed in a single column.
  3. If Show Last week’s data day-wise option is selected and user needs graph data for two weeks aggregated by week-wise, then 8 value columns will be created one for a complete week data and rest seven for other week data day-wise.
  4. To show reports in either Column or Tab, select the same from Show report in If user selects the column option, then graph data will be captured in columns and if user selects the tab option, the graph data will be displayed in separate sheets/tabs.

Step – 3: Schedule the Report

Hourly

For Report generation on hourly mode, follow the below mentioned steps.

  1. Specify the report generation frequency in hours. For example – 4 hours, 8 hours, and so on.

OR

  1. Specify the time for the report generation.
  2. Specify the schedule expiry date and time.
  3. Enter task description.
  4. Click the Next button to navigate to the next step.

Weekly

For Report generation on weekly mode, follow the below mentioned steps.

  1. Select the day of the week on which report needs to be generated.
  2. Specify the start time.
  3. Specify the schedule expiry date and time.
  4. Enter task description.
  5. Click the Next button to navigate to the next step.

Monthly

For Report generation on monthly mode, follow the below mentioned steps.

  1. Specify a day of a month on which reports need to be generated.
  2. Specify the start time.
  3. Specify the schedule expiry date and time.
  4. Enter task description.
  5. Click the Next button to navigate to the next step.

Step – 4: Enter Mailing Information

Note: A predefined variable is provided in Scheduler Report as ‘GenerationDateTime = $genDateTime’, which is used to pass the Date and Time when the report is generated. This predefined variable can be used in Subject or Body of the mail and is available in Hints section in Scheduler Report window. The date time format is in MM-DD-YYYY HH:mm:ss.

  1. Enter the mail subject.
  2. Enter recipients of the mail.
  3. Enter the description in the Body section.

User can pick Report name, Start date, and End date from the Hints section. This automatically fills the specified information in the mail body.

  1. Click the Next button to navigate to the next section.

Step – 5: Report Scheduling Summary

  1. This step shows the summary of the report specified by the user. It contains following specification user mentioned in earlier steps.
    • Report name
    • Template name
    • Report type
    • Report format
    • Report duration
    • Schedule
    • Schedule expiry time
    • Mail to
    • Mail subject
    • Mail body
  1. Click Finish, the task is added in the Scheduled Tasks Page.

There are following headers in Schedule Tasks page:

  • Task Type: This denotes the type of the task. For example – Word/Excel/HTML report
  • Description: This denotes the description of the task.
  • Schedule Time: This denotes the schedule time for the task execution
  • Schedule Expiry Time: This denotes the schedule expiry time for the task
  • Status: This denotes the status of the task, either enabled or disabled
  • Actions: User can delete /update/disable the task.

Viewing Generated Reports

User needs to follow the below mentioned steps for viewing the generated reports.

  1. Click the Available Reports icon [] under Reports The Generated Reports page is displayed.

  1. Next, click the Report name that needs to be viewed. A dialog box to open/save the report is displayed. Save and open the report.

Sample Alert Digest Report Link

Alert Digest Report represents the count of all the alerts, which are generated within the provided time period of a test run based on grouping option i.e. Vectors or Alert Rule Name. Along with this, Alert Digest Report is also supported for Tier-Wise Alert count. The user needs to mention ‘$$Tier$$’ for Group By value in Alert Digest Template.

Sample Alert Digest Report

Uploading/Downloading Templates

User can upload the created template to the system and can download the uploaded template from the system. User needs to click the  icon under the Reports tab.

To Upload a Template

  1. Click Browse button under Upload Options section.

  1. Locate the template from the system.
  2. Click Upload.
 If user selects the “Overwrite if exists” check box, the template will be overwritten if it already exists in the system

To Download a Template

  1. Select the template from the drop-down list under the Download Options section.

  1. Click Download.
  2. A dialog box is displayed to open/save the template.
 User can make changes in the downloaded template and re-upload it after making changes.

Templates

A template is a well-defined structure of information gathered from graphs.  User do not need to recreate the file each time. Once a template is created, it can be reused further. Therefore, if user finds creating similar reports repeatedly, it might be a good idea to save one of them as a template. Then, the user does not have to format reports each time to make a new one. Just use the template and start from there.

Layout of Template Management Window

Template Management window consists of two panes – left pane and right pane. Left pane consists of System templates and User templates. Right pane consists of description of the templates.

Left Pane

  • System Templates: These are system defined templates. User cannot add/edit/delete such templates, but can view them only.
  • User Templates: These are user defined templates. User can add/edit/delete/view such templates and can create a report(s) under them.

Right Pane

  • Template Name: Name of the template.
  • Report Sets: Number of reports under the template.
  • Last Modification Date: Date and time when the template was last modified.
  • Owner: Owner of the template.
  • Template Description: Description of the template.
  • Action: Actions that can be performed on the template, such as adding report ( 108), edit the template ( 109), and delete the template ( 110).

Creating a Template

User can create a template by following the below mentioned steps:

  1. On the Report Template Management window, click the icon next to available template. The New Template page is displayed.

  1. Enter the following Template details:
    • Template Name: Name of the template.
    • Template Description: Description of the template.
  1. Enter the following Report details:
    • Graph Type: Select the graph type, such as Normal graph, percentile graph, or slab count graph from the list. Then, select the chart type based on the selected graph type.
    • Chart Type: Graphs are most important part of any report. They need to be selected in all type of templates. All graphs are time X-axis based graphs.
      • Simple: Simple graphs have graph data on Y axis. Simple graphs have single graph on each panel.
      • Multi: Multi graphs are also called merged graphs. Multi graphs have multiple graphs on Y axis with same X axis.
      • Tile: Tile graphs have multiple simple graphs in tiled form. Tile graphs can have two or more graphs’ graphical view of data at same time in multi panel from top to bottom.
      • Correlated: These graphs show correlation with other graphs.
      • Percentile: A percentile is the value of a variable below which a certain percent of observations fall. So, the 20th percentile is the value (or score) below which 20 percent of the observations may be found. The pth percentile is a value so that roughly p% of the data is smaller and (100-p) % of the data is larger. Percentiles can be computed for ordinal, interval, or ratio data.
      • Slab count: Slab count graph is used to count number of samples in a particular time interval. User can change all graphs to Slab Count Graph. Earlier, user was able to convert only those graphs which have Percentile Data File (PDF) file associated with them.
      • Frequency Distribution: This chart is similar to slab count chart, but instead of bars, system represents the data points via dots.
      • Multi with Layout: This is similar to multi graphs, but instead of displaying all graphs on the same panel, system displays them in separate panels based on the reports. It is applicable for Word report only.
      • Bar: In this case, line chart is converted to Bars.
      • Pie: It is useful in case of multiple graphs. If one graph is converted into Pie, then a simple circle filled with one color is displayed. It is needed to take average value or Last value of graph. If graph type is cumulative then system displays sample value otherwise average value.
      • Area: An area chart displays graphically quantitative data. The area between axis and line are commonly emphasized with colors and textures. Area chart is used to represent cumulative data using numbers or percentages over time. Use the area chart for showing trends over time among related attributes. The area chart is like the plot chart except that the area below the plotted line is filled in with color to indicate volume.
      • Stacked Area: Stacked Area chart means area chart of each graph is stacked on each other.
      • Stacked Bar: In this case, graph is converted to Stacked Bar chart. Stacked bar chart means bar of each graph is stacked on each other. It is useful in case of multiple graphs. If one graph is converted into Stacked Bar, then it looks like normal Bar graph.
      • Donut: Donut chart is represented in the form of a donut. User needs to specify the criteria either last or average.
      • Line Stacked Bar: If user wants to see combined graphs of a stacked bar and line chart, then Line Stacked chart is used. In Line Stacked chart, first selected graph displays as line graph and other displays as Stacked bar graph.
      • Dual Axis Stacked Bar: This chart provides the data in the widget as one of the data being Dual axis line and another being Stacked bar.
 noteUser can select scaling on graphs, such as Multi, Tile, Percentile, Slab count, Frequency distribution, Multi with layout, Bar, Area, Stacked Area, and Stacked Bar.
  • Graph Type
    • Normal: If user selects Normal graphs, then graphs are selected as it is from the Graph metrics and user cannot perform arithmetic operations on the graphs.
    • Derived: If user selects Derived graphs, then user can perform arithmetic operations on the graphs
    • Report Set: Enter a valid report set name. Report name must start with alphabet. Maximum length should be 128. Allowed characters are Alpha, numeric, space and special characters (/%()_;:,.-).
  • Group Metric(s): Select the Group metrics from the drop-down list. All the available graphs are displayed under Graph metrics .
  • Graph Metric(s):
    • In case of Graph type as Normal: Select one or more graphs and click the icon 112, the selected graphs are added on the right side under Selected Graphs area.
 noteTo remove the selected graph, first select the graph from the Selected Graphs area and then click the 113 icon.

In case of Graph type as Derived: Select a graph from the graph metrics and click the 114 icon. Then, add any arithmetic operation (that needs to be performed) and select another graph with the same process.

This process can be repeated and user can perform any arithmetic operation (from the available operations) and create a derived graph.

 noteTo clear the selected graphs, click the  116  icon.
  1. Click Add Report, the report gets added.

 noteUser can add any number of reports under a template by following the above mentioned process.To Edit a report, click the 109 icon.

To Delete a report, click the 110 icon.

  1. Filter by Value Options: User can discard the un-desired graphs in the report by using the ‘Filter by Value’ option. There are following filter options:
    • All Non- Zero: Upon enabling this, all non-zero graphs are involved in the report.
    • All Zero: Upon selecting this, all zero graphs are involved in the report.
    • Advanced: Upon selecting this, user can have some advance level options based on value, such as <, >, <=, >=, Top, Bottom, In between, which helps to achieve the desired output. User can filter graph values by Min, Max, and Avg value of its graph data. User can also use the Include or Exclude options to get the filtered results. Include/exclude options includes/excludes the graphs that lies within the specified values. For example – if we try to find the graphs that has values between 50-100, then on include, system displays such graphs that has values from 50-100 and exclude option skips those results that contains graph values from 50-100 and displays the rest graphs. To enable the filters, user needs to enable the toggle button.

6. Click the Save button, to save the template. The saved template is displayed on the Report Template Management window.