Notebooks

If IBM® Cognos® Analytics for Jupyter Notebook is enabled in IBM Cognos Analytics, you can work with notebook documents.

You can work with notebook documents, also referred to as notebooks, much like other content in Cognos Analytics.

Note: Before working with notebooks in Cognos Analytics, you should know how to work with and develop notebooks in Jupyter Notebook. You should be familiar with the Jupyter Notebook Editor.

Cognos Analytics for Jupyter Notebook supports the following notebook functionality:

Create and upload notebooks

Create notebooks. Edit, save, copy, and move notebooks. When you open a notebook, you work in the Jupyter Notebook Editor.

Create a notebook from the New icon

Upload notebooks that were created outside of Cognos Analytics. For more information, see Uploading external notebooks.

Run and work with data in a notebook

The CADataConnector API provides the read_data() and write_data() methods to read Cognos Analytics data sources and write to a data source. For example, you can run a notebook that reads external data, produces output, and saves the output as a data source.

You can use the Python programming language in your notebooks.

For more information, see Reading data from a data source and Writing data to a data source.

Include notebook output in a dashboard, story, or report

Embed the output from a notebook code cell in a dashboard, story, or report. For example, you have a notebook that creates a visualization that is not available in Cognos Analytics. You can add this visualization to a dashboard or story by embedding the code cell that creates it.

For more information about adding notebook output to a dashboard or story, see Adding a Notebook widget.

For more information about adding notebook output to a report, see Including output from a notebook.

To ensure that the notebook visualizations display properly in dashboards, use some coding best practices.

Samples

The samples show you how to work with notebooks in Cognos Analytics. If the samples are installed, you'll see them in Team content > Samples > Notebooks. For more information, see Importing and configuring the Jupyter samples.

Note: Before you can work with notebooks, Cognos Analytics for Jupyter Notebook must be installed and configured in your Cognos Analytics environment. Contact your administrator to confirm that you have the capability to work with notebooks. If you don't have the notebook capability, you won't see any of the functionality described in the following sections.