Datalore 2024.2 Help

Static reports

You can publish notebooks as a static report with a shareable link. This allows you and other users to view the notebook output as a completed HTML page and edit its copy collaboratively. Compared to interactive reports, static reports allow viewers to only leave comments.

Publish a static report

  1. Open the notebook in the editor.

  2. Open the Report builder in one of the two ways:

    • Click the Build report button in the upper right corner of the editor screen.

    • Select Main menu | File | Build report

  3. Do one of the following:

    • Publish a report using the original structure of the notebook

    • Prepare a report using the Report builder before publishing

    Refer to the Build and publish reports topic for more details about the tool.

The newly published notebook is added to the Reports list on the Home page.

Manage published static reports

After you publish a static report, you have the following options to manage it:

  • Update a report after editing the respective notebook, editing the report itself, or changing the publishing settings. For all these cases, open the Report builder and click the Update report in the lower left corner. For more details about changing publishing settings, refer to Build and publish reports.

  • Manage published static reports from your Home page:

    1. On the Home page, select Reports to view all your published reports.

    2. Click the ellipsis for the static report that you want to manage.

    3. Select the following actions from the context menu:

      • Open: to open the report

      • Share: to open the sharing dialog and revoke access to the report or copy the link to its page

      • Edit copy: to open a copy of the respective notebook in the editor

      • Download: to download the respective notebook as an .ipynb file

      • Remove: to unpublish the report (without deleting the respective notebook)

Work with static reports

As a collaborator with access to a static report, you can leave comments, share the published notebook's cells, and edit code in its copy.

View a static report

  1. Open a static report:

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

    • If you're the report owner, you can use the link roght 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

Leave comments

  1. Hover over the cell that you want to comment.

  2. Click the Add comment icon next to the upper right corner of the cell. If there are no comments left to the cell yet, the icon is grayed out; if there are comments, the icon is green.

  3. In the comment view, click Add comment. A text field will appear in the comment view.

  4. In the text field, type your comment.

  5. After the comment is written, click the Post button.

After a comment is added:

  • A separate thread is created that will contain the original comment and all replies to it. Multiple comments form a stack of threads, all displayed in the same comment view for the respective cell.

  • If added to a cell in the report, such a comment will be marked with a REPORT label.

In the image below, you can see a comment view with two threads. One of the comments was added in the report and marked accordingly.

Comment view with two threads

Share and embed cells

  1. Hover over the input or the output of the cell that you want to share. A toolbar will appear in the upper left corner of the cell.

  2. Click the Share cell icon to open the sharing dialog.

  3. Do one of the following:

    • Copy the link for sharing the cell. Users with the link can view the respective part of the published notebook in a separate tab.

    • Copy the code for embedding the cell. The respective part of the published notebook can be used in another web page.

    Share cell dialog
  4. Close the Share cell dialog to continue your work on the page.

Edit code

As a report owner, you can quickly go to the original notebook and edit the code of a specific cell.

  1. Hover over the input cell that you want to edit. A toolbar will appear in the upper left corner of the cell.

  2. Click the Go to code icon on the toolbar. This will open a copy of the notebook in the editor.

    Go to code icon
  3. Alternatively, report viewers and report owners can edit a copy of the original notebook. To use the option, clock the Edit copy button in the upper right corner of the report.

Manage static report content

Use the report menu (located in the upper right corner) to manage the content of the report. The options will vary based on your access.

Option

Report owner

Report viewer

Details

Edit copy

Available

Available if allowed by the owner (Share all content setting)

Opens a copy of the original notebook used for this report in the editor.

Comment settings

Available

Unavailable

Opens the dialog for enabling or disabling comments for the report.

Open original

Available

Unavailable

Opens the original notebook used for this report in the editor.

Download

Available

Available if allowed by the owner (Share all content setting)

Downloads a copy of the original notebook used for this report in the editor.

Print .pdf

Available

Available

Prints or saves the report as a .pdf file.

This is how the report menu looks when viewed by the report owner.

Report menu viewed as a report owner
    Last modified: 17 May 2024