Datalore 2024.3 Help

Work with interactive reports

This topic explains how to work with interactive reports. This type of report allows users to view the notebook output as a completed HTML page, interact with it, and edit the published notebook's copy collaboratively. Compared to static reports, interactive reports allow viewers to dynamically change data presentations (tables and charts) using interactive controls.

Before you open an interactive report

Refer to these topics to learn how to build, publish, and share a static report.

  • Build a report: describes the process of preparing the notebook as a report before publishing it.

  • Publish a report: describes the process of publishing the notebook as a report.

  • Invite report viewers: describes the process of inviting users to view a report with restricted access.

Open an interactive report

  1. Open the report. Your options depend on your access to the report or associated workspace.

    Do one of the following:

    • Use the link in the confirmation window right after publishing the report.

    • Open the report from the Reports list of the respective workspace on the Home page.

    You have access to the workspace associated with this report.

    1. On the Home page, expand the workspace.

    2. Select Reports.

    3. From the Reports list, click the report you want to open.

    You have the shareable link to a report with public access. To open the report, use the provided link.

    The invitation email is sent to you because the report owner specified your email address as a viewer they want to invite to view a report with restricted access.

    • Click the link in the invitation email.

    • On the Home page, go to Shared with you and open the report from the list of shared notebooks and reports.

    • If you're an invited collaborator, click the link in the invitation email.

    • If you're the report owner, you can use the link right after publishing the report or open the report from Reports on the Home page.

  2. After you open the report, expand the table of contents (if generated in the original notebook) on the right side of the screen.

    Published report

Interact with the report

Interactive reports allow viewers to manipulate data presentations (tables and charts) using the provided controls and table interactivity.

  1. Open the report and click the Recalculate button in the upper right corner to ensure report interactivity. In the image below, there is an interactive report containing a table and a chart.

    Unedited interactive report
  2. Use one of the provided controls to change the respective data presentation. If the Reactive mode is on, the report will update automatically. If Reactive mode is off, click Recalculate in the upper right corner.

    In the example below, the controls are:

    • A slider used to select a number of rows displayed in the table (changed from 5 to 8)

    • A dropdown used to select a column for the Y axis (changed from kernel_python 3.4 to kernel_python 3.6)

    Using controls to change data displays
  3. Manipulate with table content just as you would in the editor

  4. To recalculate the whole report, click Recalculate in the upper right corner.

Reset an interactive report

Perform this procedure to reset the interactive report to its initial state.

  1. Click the ellipsis in the upper right corner of the report. This will open a context menu.

    Report options for owner
  2. Select Reset report. Now the report is displayed as you first opened it in this session.

View emails of report running users

The REPORT_RUNNER_EMAIL environment variable is populated with the emails of those viewers who run interactive reports (initiators). This information can help you, as a report owner, modify the content of your report based on which user is viewing or running it. For example, you can change the options available in the interactive controls used in the report, or hide certain categories from the tables provided in it.

Cases of when the REPORT_RUNNER_EMAIL environment variable is populated are different in Enterprise and Cloud versions of Datalore.


Cloud Team plan

Other Cloud plans

For all types of authorized users:

  • Report owner

  • Regular type user

  • Viewer type user

For certain users:

  • Team owner

  • Team member

For one user type only:

  • Report owner

To access the environment value, you can use the os module:

import os os.environ.get('REPORT_RUNNER_EMAIL')

Related topics

Refer to these topics to learn about other actions with interactive reports.

Last modified: 16 July 2024