Overview of Custom Reports
Custom report is a feature provided in Cavisson Dashboard where user can design customized layouts of pages for report generation. User is facilitated with a Design mode interface where a mix of widgets, such as Graph widget, Tabular widget, Data widget, Image widget, and Text widget can be used. User can also import a file in which, columns are delimited with a separator, and plot a tabular widget from the file data. User can also separate pages using the Page breaker and insert further widgets page-wise.
- A toggle switch option is provided in web dashboard to make switches between design mode and normal mode.
- User can do any operation from web-dashboard, such as drag and drop graphs from tree and also perform tree operations for selection of graphs but cannot update data in design mode.
- In Design mode, user can divide the pages into different sections with the help of Text widget, Graph widget, Data type widget, Tabular type widget, File import tabular widget type, and Image widget.
- User can set different layout for different pages.
- User can save these layouts as a Favorite and use them at time of generation of reports.
- In Design mode, web dashboard will not update data and metrics.
- User can edit, delete, and update sections in a page layout.
In the subsequent sections, we are describing how design mode can be used to plot different widgets, how to save the layout as favorite, and how to generate reports. Apart from this, user can also use various other options, such as re-positioning of widgets, resizing of widgets, saving a layout, disable design mode, show / hide design toolbar, and clear all widgets.
Enable Design Mode
Design mode facilitates a user to create custom layout using various kinds of widgets. At the time when user creates custom layout in design mode, updating monitoring data is paused. Once it is saved, monitoring data resumes updating based on the sample interval.
To enable Design mode for adding different widgets on a panel and creating a custom layout, click the Enable Design Mode icon on the top-right corner of the Web Dashboard.
This displays a blank screen and a Design Toolbar from where user can initiate creating the custom layout using different widgets. How to create custom layout using various widgets is described in subsequent section.
Create Custom Layout using various Widgets
User can create a customized layout using various widgets provided in the Design Toolbar. User can plot any number of widgets on the panel. User can also customize the layout using page break and further plot widgets onto it. In extension to this, user can create custom reports page-wise for all pages as designed in the layout. In the subsequent section, we are describing about various widgets in Design toolbar and the way user can plot them on the panel. User can perform various other operations using the Settings icon on each widget.
This displays the outcome of the monitoring in the form of graphs. Graph can be of any type, such as normal, percentile, slab count, category, and so on. Based on the graph type, there are chart type, such as Line, Bar, Area, Percentile, Slab, Meter, Geo Map and so on.
To plot a graph widget, click the icon within the Design toolbar. This adds a graph widget on the panel.
This displays only one value of graph whether it is Average, Maximum, Minimum, Standard Deviation, Last Sample, or Sample count along with the graph name and display name. Different color icons represent different graphs. Vector count is also supported data widget.
To plot a data widget, click the icon within the Design toolbar. This adds data widget on the panel.
This displays monitoring data in tabular form. The data contains Average, Maximum, Minimum, Standard Deviation, Last Sample, and Sample Count by choice. In this widget, user can show stats of graphs. User can select graphs from tree using merge operation, drop operation, and advance setting.
To plot a tabular widget, click the icon within the Design toolbar. This adds tabular widget on the panel.
Tabular from File Widget
This facilitates user to create a tabular widget from a file data. The file should contain proper data and columns should be separated with a specific delimiter.
To plot a tabular from file widget, click the icon within the Design toolbar. This prompts the user to provide the file path and column delimeter.
Enter the file path or click the button to upload a file. User can upload a file from the server or from local machine. Upon clicking the button, File Manager window is displayed.
Selecting a File from Server
To select a file from server, locate the CSV file and click the Choose File button. The file path gets added in the Select File dialog box.
Select the column delimiter from the drop-down list. By default, we have space (), comma (,), pipe (|) as column delimeter. If any other comma delimeter needs to be specified, select ‘Other’ from the drop-down list and specify the delimeter.
Click the Get File Data button to get the file data in tabular format on the widget.
Selecting a File from Local
To select a file from server, click the Upload button. This displays the Upload Files dialog box.
Click the Choose button and select the file from local.
Then, click the Upload button (within the Upload Files dialog box) to upload the file. A message is displayed that file uploaded successfully. Close that dialog box. The file gets added and displayed on the Select File dialog box.
Select the column delimiter from the drop-down list and click the Get File Data button to get the file data in tabular format on the widget.
Apart from this, user can edit the panel caption by clicking the icon.
User can also change the file by clicking the icon. This displays the Select File dialog box from where user can select another file to be displayed on the widget.
To select another file, follow the same steps as mentioned earlier.
Text widget is used to specify any user defined text on the panel. To plot a text widget, click the icon within the Design toolbar. This displays a text widget adjacent to the previous widget.
User can specify any text (such as comments / description / observations) on this widget and can format it (such as font size, bold/italics/underline, alignment) based on the requirements.
Image widget is used to plot any image on the panel. Using this, user can add snapshots in reports for better understanding of data. To do this, click the icon within the Design toolbar. This displays an image widget without any image.
Click the icon within the Image widget and select an image from your computer. This displays the selected image within the panel.
User can edit the panel caption by clicking the icon.
To change the image, click the icon and select the image from your computer.
Apart from plotting widgets on the panel, user can perform several other operations, such as create page breaker, reposition widgets, resize widgets, save a layout, disable design mode, show/hide design toolbar, and clear all widgets. In the subsequent sections, details of all the operations are provided.
Create Page Breaker
Page breaker is used to split the pages into various sections. This helps to categorize widgets within a page and generate page-wise reports. To create page breaker, first align the widgets properly (as the same layout will reflect in the report) and then click the icon.
User can further add widgets on the panel. The widgets will be added on the new page (below page breaker).
User can reposition a widget on the panel by dragging a widget and dropping at the desired location. This can be done by using the icon or the icon.
User can resize a widget by clicking the Resize icon , which appears on mouse hover a widget.
Save a Layout
To save a layout, click the icon. This displays Design Mode dialog box. Click OK for saving the layout.
The Save Layout window is displayed. Provide the layout name, layout description, and click OK.
A confirmation message is displayed for successful saving of layout and navigates to Web Dashboard home page. To view the saved layout, go to Advance Settings > Layout Selection > Custom and select the custom layout.
This displays the saved layout.
Disable Design Mode
To disable design mode, click the icon. This displays the Design Mode dialog box. Click Cancel.
The design mode is disabled and normal mode is displayed.
Show / Hide Design Toolbar
User can enable the view / hide of Design toolbar by clicking the icon.
Upon clicking this icon again, the design toolbar is displayed.
Clear All Widgets
To clear all widgets, click the icon. This displays a dialog box prompting for deleting all widgets.
Click OK. All widgets will be deleted.
Save Layout as Favorite
Once the layout is designed with widgets on the panel, user needs to save it as a favorite for the report generation. To do this, follow the below mentioned steps:
- Click the icon on the top left corner of the window. This displays the Toggle menu Navigation Panel.
- Go to Favorites menu and click the Add Favorite menu item.
3. This displays the Add Favorite window.
4. Provide the favorite name and favorite description.
5. Browse the path where this favorite needs to be created.
- To create the favorite on root, just click OK.
- To create it within existing folder select that folder.
- To create it within a new folder, click the New Folder button and specify the folder name.
- On the Add Favorite window, click the Apply button.
* User can grant ‘public’ accessibility and ‘Read/write’ accessibility based on the requirements.
- This displays a message that favorite is saved successfully.
- Click OK.
Once the favorite is created, user can generate custom reports. This is explained in subsequent section.
Generate Custom Reports
After saving the layout as favorite, user can proceed to generate custom report. To do this, follow the below mentioned steps:
- Go to the Reports > Metrics > Stats Report.
2. This displays the new stats report.
- Enter the report name.
- Select Using Favorite radio button and select the favorite from the drop-down list.
- Select View Type as PDF.
4. Click the Generate PDF button. This generates the report in PDF format.
Page – 1
Page – 2