Skip to main content

Brainspace

Notebooks

After searching for documents in a dataset, you can add the documents to an existing notebook or create a new notebook for the documents. These collections are very useful in organizing analyzed documents to be synchronized with review applications.

Notebooks Screen

You can create a Brainspace notebook to collect documents for a specific subject or for search results. You can also make notebooks public or private, include existing tags, and include trained classifiers in a notebook. Notebooks are not shared across datasets, but public notebooks are shared to all users of the dataset.

Note

When creating a new notebook, an option is provided to add documents to a notebook from a list of document IDs included in a *.csv file.

After opening a dataset in Brainspace, you can open the Notebooks screen from any screen in Brainspace. The Notebooks screen includes the following features:

Notebooks_Screen_Map.png

  1. View the current dataset name or click the dropdown menu to open a different dataset.

  2. View all private and public notebooks in the dataset. All Brainspace users can view and modify the contents of public notebooks in a dataset. Private notebooks can only be viewed and managed by the notebook creator and by Admins. Although you can change a private notebook to a public notebook at any time, you cannot change a public notebook to a private notebook.

  3. View all public and private notebooks created by the current Brainspace user. All Brainspace users can view and modify the contents of public notebooks in a dataset. Private notebooks can only be viewed and managed by the notebook creator and by Admins. Although you can change a private notebook to a public notebook at any time, you cannot change a public notebook to a private notebook.

  4. Click a notebook card to manage its settings and documents.

  5. Search for a notebook name in the dataset.

  6. Create a new notebook.

Notebook Card Information

After you create a notebook, Brainspace adds a notebook card to the Notebooks screen. A notebook card includes the following features:

Notebook_Card_Info.png

  1. View the notebook name.

  2. View the notebook creator, description, and Lucene query information. The Lucene query information is generated automatically in some cases and will be removed if any documents are added to or removed from the notebook.

  3. View the number of documents in the notebook and the date it was last modified.

  4. View the notebook’s status as PUBLIC or PRIVATE. All Brainspace users can view and modify the contents of public notebooks in a dataset. Private notebooks can only be viewed and managed by the notebook creator and by Admins. Although you can change a private notebook to a public notebook at any time, you cannot change a public notebook to a private notebook.

  5. Edit the notebook’s Settings. You may edit the Notebook's name and description, make a private Notebook public, and add Tags and Classifiers used in the Notebook selection in a version of the Create New Notebook dialog screen below.

    Notebook_Settings.png
    Notebook_Settings--Add_Tags_Used.png
    Notebook_Settings--Add_Classifiers_Used.png

    Adding Tags and Classifiers Used to Notebook settings.

    Notebook_Settings_with_Tag_and_Classifier_added.png

    The Tag and Classifier 'pills' may be removed by clicking an 'X' that appears the right of each when the pointer hovers over. Save Notebook to update.

  6. Delete the notebook from Brainspace. This will remove the notebook from the dataset, but the documents will remain in the dataset.

Create a New Notebook Dialog

After opening the Notebooks screen and clicking the New Notebook button, the Create a New Notebook dialog will open. The Create New Notebook dialog includes the following features:

Create_a_New_Notebook.png

  1. Enter the notebook name.

  2. Describe the purpose of and any additional important details about the notebook.

  3. You have the option to upload IDs from a *.csv file to add specific documents to the notebook. Notebooks may otherwise be created or added to using a search or a Focus.

  4. Change notebook status from private (default) to public to make the notebook generally accessible. All Brainspace users can view and modify the contents of public notebooks in a dataset. Private notebooks can only be viewed and managed by the notebook creator and by Admins. Although you can change a private notebook to a public notebook at any time, you cannot change a public notebook to a private notebook.

  5. Optionally select existing dataset tags to be highlighted in the notebook.

  6. Optionally select existing classifiers to sort the documents in the notebook.

Create Notebook to complete the process.

After creating the notebook, you can add documents to the notebook while using any of the Analytics features in Brainspace and after creating new classifiers. You can edit the notebook setting at any time, and you can remove documents from the notebook in the Notebook dialog.

View Documents in a Notebook

After creating a notebook, you can open it to view and manage its documents.

To view documents in a notebook:

  1. Open a dataset in the Analytics Dashboard.

  2. Click the Notebooks tab.

    Notebooks_tab.png

    The All Notebooks screen will open by default.

  3. Click a Notebook card.

    The notebook’s documents will display in the card viewer with the Overview chart displaying the number of documents included over a given period of time.

Notebook_content.png

After opening the notebook to view its documents, you can use the highlighted Notebook menu items to:

  • use any selected Classifier to sort the documents in the notebook,

  • open the Search to modify the Notebook's retrieval parameters,

  • open the Analysis pane to examine the timeline and status of any tags selected for display, and

  • update the Notebook Settings.

Within the individual document cards in the Notebook are several view and setting options as well:

Notebook_document_card__annotated_.png

  1. View the status of the document as an Original, Near Duplicate or Exact Duplicate.

  2. View the title and opening text of the document, with the option to open the Document Viewer.

  3. View or remove the document's current Tag(s).

  4. Select additional tag(s) to be associated with the document.

  5. Include Threads, Families, Related Documents and/or Exact Duplicates.

  6. Remove document; a warning will appear before the document is confirmed to be removed.

View Notebook List View

After creating a notebook, you can view its documents and sort them by specific fields, including metadata such as sent date.

Note

The date fields format displayed depends on the date format in the original data.

To view notebook cards in the list view:

  1. Open a dataset in the Analytics Dashboard.

  2. Click the Notebooks tab.

    Notebooks_tab.png

    The All Notebooks screen will open by default.

  3. Click a Notebook card.

    The notebook’s documents will display in the card view.

  4. Click the List View icon.

    Select_Notebooks_List_View.png
Notebook_List_view.png

You can change the order of the metadata fields displayed, change the column sizes, add metadata fields to or remove metadata fields from the display, and sort by any metadata field. These changes are not preserved when you exit the list view.

In this section:

A group of documents identified by the user using a search or filter that have been placed into a bucket or Notebook and provided with a label that describes the subset of documents. This was formerly called Collections in version 5.5.

Adds a label for the purpose of identification or to give other information.

Lucene is a full-text search library in Java which makes it easy to add search functionality to an application or website. It does so by adding content to a full-text index. It then allows you to perform queries on this index, returning results ranked by either the relevance to the query or sorted by an arbitrary field such as a document’s last modified date. The content you add to Lucene can be from various sources, like a SQL/NoSQL database, a filesystem, or even from websites. Lucene 5.4 is supported in versions 5.4 to current.