Using Datasets and Reports

CONTENTS

Home

The reports feature in bipp provides the ability to view and visualize data corresponding to any data model created using bippLang. It offers an opportunity for data analysts to verify the data model they created for discrepancies. Reports also serve as visualization units that can be directly incorporated on bippDash dashboards. Thus, reports form an important link between the data model and the dashboard.

Reports for New Datasets

Reports corresponding to newly deployed data models or datasets can be created from the Datasets by clicking on the “Datasets” link on the main menu.

New Dataset Reports

A blank report creation screen will be displayed with tables from the selected dataset.

New Dataset Reports

Report Functions

Following are the features available when creating and managing reports using the report editor.

Visualization

The core function of reports is to visualize data. This is made possible by different types of visualizations that can be customized to view data in an easily consumable manner. Details of available visualizations types and settings can be found here.

Save

The Report may be saved and given a name. A unique report Id will be generated when the report is saved.

Download

Report data may be downloaded using the “Export to PDF” option. This is possible even without saving the report. The current visualization visible on the screen is downloaded as PDF.

Data corresponding to the report may be downloaded by clicking on the “Download Data” menu option from the report menu. This will provide options to select the number of rows to be downloaded, file format for download and an optional filename.

Tag Reports

You can tag reports so that similar reports can be found easily in the future. This can be achieved by using the “Add Tag” feature from the report menu. You can then search for all similarly tagged reports by keying in the tag text in the search box available inside the application header.

Threads

You can capture a screenshot of the report and annotate it or start a discussion about it with other members of your group/team by clicking on the “Create Thread” option in the reports menu. An email will be sent to all included members on the creation of the thread. You can also view all threads related to the report by clicking on the “View Threads” option.

Schedules

You can schedule reports by using the Schedule Delivery option from the reports menu. You can configure the title, frequency, timezone, recipients and delivery format for the report on the set schedule screen as shown below.

Scheduled Reports

Create Alerts

You can create alerts corresponding to the data on the report by using the “Alerts” option from the report menu. An alert may be triggered whenever there is a specific change in data that is displayed on the report. bipp provides the following method to define and create alerts.

You can use the condition builder that allows you to define the alert condition by selecting, table/columns, aggregation functions, comparison operators and user defined values as shown in the image below. The condition may be defined based on the row count in the resultset. Complexity of condition can be further increased by adding filters and nested filters and connecting them with the AND or OR operators.

Alerts

The alert may be configured by specifying the title, frequency, schedule and recipients. Alerts may also be configured to include a file attachment with data from the report.

Multiple alerts may be defined corresponding to the data on a report. The Alerts screen may be used to manage these alerts simultaneously. It lists down all the available alerts for the report. Selected alerts may be deleted, enabled or disabled from this screen by clicking on the corresponding buttons as shown below.

Alerts

Report Version Information

You can view the version of the dataset being referred to by the report. This is available under the “Report Version Info” option in the report menu.

Report Settings

Some customization is available at report level for caching results as well as whether queries should fetch count of the rows. This is available under the “Report Settings” option in the report menu. Following dialog box is shown when you access this option.

Report Settings

Access and Manage existing Reports

Existing reports can be accessed and managed from the Reports listing screen. This screen is shown when the “Reports” option is selected from the bipp main menu.

Manage Reports

You can search for reports corresponding to a specific project, dataset, or those that have been shared with a specific user. Free text search based on the report name is also available. All reports matching the filter criteria are listed on the screen. Following operations are available for every report listed on this screen.

  1. View/Edit: A report may be viewed or edited by clicking on the Report name or the “View” option corresponding to the report.

  2. Permissions: The report may be shared with other users by clicking on the “Permissions” option in the report menu. Email Id of the user with whom the report needs to be shared should be entered in the Permissions dialog box. Alternatively a group name may also be entered for sharing with all members of a specific group. Permissions for multiple reports may be edited simultaneously by selecting the reports and clicking on the “Update Permissions” button above the reports list.

  3. Delete: The report may be deleted by clicking on the “Delete” option in the report menu. You can also delete multiple reports by selecting them and clicking on the “Delete” button above the reports list. Reports will be deleted upon confirmation.

  4. Pin/Unpin: The report may be pinned for easy access. Links to all the pinned reports and dashboards will be available on the home page under the “Pinned” tab so that they may be accessed directly. Pinned reports may be unpinned later

  5. Export: You can export one or many reports to tar format which will be downloaded to your computer. For this select the reports and click on the “Export” button above the reports list.

Import Reports

You can import existing reports created by you or other users by uploading the exported tar file to bipp on the Reports screen. For this click on the Import notes at the top right of the screen. The Import Notes dialog box will be shown as follows.

Import Reports

Select the tar file to be imported. Check the Replace Resources option if you want to overwrite any existing resources like datasets or projects referred by the imported reports. Click on the Import button to import all the reports contained in the tar file.

Reports - Data model Version

New reports always refer to the latest version of the data model. All reports grouped together in the report editor refer to the same version of the data model. Subsequent revisions of the data model need to be explicitly applied to existing reports by using the Update Reports Version functionality on the Reports listing screen. This feature may be used to apply a specific version of the data model to existing reports.