Network maps for projects

Permissions and access

Minimum role: Researcher

A network map is a data visualization framework to organize project data by research and experiment activities. A network map is structured like a treemap diagram using the following objects to organize data as they relate to various project activities:

In the CoBaseKRM web client, a network map is a visual framework for organizing data files and metadata by project activities and tasks. A network map is structured similarly a treemap diagram containing the following key objects:

• Nodes are objects that represent individual project activities, such as a research experiment that follows a prescribed set of process parameters. Data belonging to a single node is organized into records, which are saved when files are uploaded to the database. Other metadata and relevant details in relation to nodes are also saved. The following node types are supported:

  • A branch node represents a level within the data hierarchy of a network map. The main branch node at the top level of a network map is created when a network map is created. You can create other branch nodes at other levels of a network map.

  • A leaf node represents a successor node that is created from a predecessoar node within the same branch or level of the hierarchy.

• Connectors are connecting lines to show existing relationships between nodes.

You can create multiple network maps for a project. You can also create subprojects to represent meaningful groups of activities within a project.

Network Map view for a project

When you drill into a project from the Projects view, you are navigated by default to the Network Map tab, which displays one or more tree map structures for organizing and grouping project activities visually.

You have two options for creating a network map: either creating the first network map for a project or creating an additional network map.

Create a network map and first node

When you create a new project, the Network Map tab view is empty. Use the Create First Network Map button to create a first network map. If you want to create additional network maps, use the New Network Map (plus symbol) button.

To create a network map for a project:

1. Create either of the following:

   • a first network map by clicking or tapping the Create First Network Map button

     Create First Network Map button

   • an additional network map by clicking or tapping the New Network Map (plus symbol) button

     New Network Map button

   The New Node on Network Map dialog appears.

   New Node on Network Map dialog

2. In the Network Map Name field, type a name for the new network map.

3. In the Node Name field, type a name for the first node to be created in the new network map.

4. In the Node Category field, select a node category that you want the first node to belong to.

5. Optional: To assign a template to the first node for parameter matching, click or tap the Assign Template field and either select an existing template or create a new template.

6. Click the Create Node button.

   The network map and node are displayed in the Network Map view.

Create a new node within a branch

To create a new node within a branch:

1. Click or tap the new node button to the right of a predecessor node in a branch to display a menu, and select the New node option.

   New node button

   New node menu option

   The New Node dialog appears.

   New Node dialog

2. In the Node Name field, type a name for the new node.

3. In the Node Category field, select a node category that you want the new node to belong to.

4. Click or tap the Create Node button.

   The new node is created as a successor node to the right of the predecessor node of the same branch.

Create a new branch node

A branch node is the first node of a new branch that stems from from an existing branch of a network map.

To create a new branch node:

1. Click or tap the add button to the right of a predecessor node in a branch to display a menu, and select the New branch node option.

   The New branch node dialog appears.

   New branch node dialog

2. In the Node Name field, type a name for the new node.

3. In the Node Category field, select a node category that you want the new node to belong to.

4. Click or tap Create Branch Node button.

   The new branch node appears in the related network map, stemming from an existing branch.

   New branch node in a network map

Data tab for a node

The Data tab lists records of all of the existing observations in read-only format in a data table related to a node.

When you hover your cursor over a column heading for a parameter in the data table on the Data tab, a tooltip appears, showing more details and metadata about the parameter.

The main features on the Data tab for a node are:

• Upload data tables and supplementary files to the given node

• View record details for a parameter value in an observation

• Edit existing parameter values of observations

• Add a new observation to a record

• Export a spreadsheet of existing observations related to the given node

View record details for a parameter value in an observation

If you want to view record details for a parameter value in an observation, click or tap the cell containing a parameter value on the Data tab for a node.

The Data Point right panel appears, listing the following record details for the parameter value:

• the record ID assigned when the observation was uploaded to the database

• the related project name

• the related node name

• the parameter value

• the date on which the observation was uploaded to the database

• the username of the user who uploaded the observation

• the method by which the observation was uploaded

Also supported in the right panel are the following functions:

• Download modfied file, to download the latest version of the modified file in CSV file format containing the observation

• Download original file, to download the original file in CSV format containing the observation.

To navigate to the record that is related to the given observation, click or tap the Go to Record button in the right panel, where the web client navigates to the Records tab and displays the corresponding record containing the observation.

Edit parameter values of observations

To edit parameter values of observations related to a node:

1. On the Data tab for a node, click the Edit Data button.

   The rows of observations in the data table become editable.

2. Edit parameter values, as needed.

   Note

   To cancel editing, click or tap Cancel.

3. To save your changes, click or tap Save Spreadsheet.

   The web client saves your edited values and the view becomes read-only once again.

Add a new observation to a record

To add a new observation to a record:

1. On the Records tab for a node, click or tap the Add Observation button.

   A right panel appears to let you input the parameter values of the new observation.

   

2. In the parameter fields, input numeric values.

3. Click or tap Save.

Export a spreadsheet of existing observations

To export a spreadsheet of existing observations from the Data tab for a node:

1. Click or tap the Export Spreadsheet button.

   A drop-down menu appears, where you can select the file format of the exported file as either:
   - Excel (.xlsx), or
   - comma-separated values (.csv)

2. Choose the preferred file format from the menu.

   The exported file in the selected file format is saved to your local Downloads directory.

Records tab for a node

The Records tab for a node contains in a list of records that indicate historical changes to uploaded observations and supplementary files.

When you hover your cursor over a column heading for a parameter in the data table on the Data tab, a tooltip appears, showing more details and metadata about the parameter.

In the left panel, a record card of the latest version of the modified list of observations is featured at the top of the list. Each record card in the left panel shows the username of the user who uploaded the files for the record, the upload date, a journal card icon for any related journal cards posted, a tag icon representing assigned tags.

When you select a record card in the left panel, its related observations, files, and other details are displayed in the right panel.

Delete an existing record for a node

The web client supports the ability to delete an existing record for a node, which is a permanent action. A deleted record cannot be discoverable through the Search view and cannot be recovered.

To delete an existing record for a node:

1. Navigate to the Records tab for a node,

2. In the list of records in the left panel, select a record card for the record that you want to delete.

3. In the right panel, click the Delete icon for the record that you want to delete.

   

   The Delete Record dialog appears.

   

4. In the input field, type the exact record ID to confirm that you want to delete the given record.

5. Click or tap Delete.

   The selected record is deleted permanently for the given node, and is removed from being displayed in the left panel of the Records tab.

Delete a file by related record

The web client supports the ability to delete an individual file related to a given record for a node.

To delete a file by related record:

1. Navigate to the Records tab for a node.

2. In the list of records in the left panel, select a record card for the record containing a file that you want to delete.

3. In the right panel, scroll vertically until you can view the Files Added in this Record section.

4. Click or tap the Delete file icon to the right of the file name to be deleted.

   

   The Delete Record File dialog appears.

   

5. In the input field, type the exact file name including the decimal separator and the file extension, and click or tap Delete.

   The selected file is deleted permanently for the given node and is removed from being displayed in the Files Added in this Record section of the Records tab.

Discussions tab

The Discussions tab displays the discussion threads of existing journal cards related a node.

The top section of the Discussions tab features a journal card input field, where you can create a journal card. Common formatting options and heading styles are featured for rich text editing.

Also, you can tag or mention the name of another team member in the journal card input field by first typing the at (@) symbol to display a menu of usernames assigned to the related project, and select a username. Once you have posted the journal card, the web client sends an automatic email notification to the mentioned user. You can also attach images by using the image icon.

Below the journal card input field is a list of existing journal cards. Each journal card displays the username of the user who created the journal card, the created date, comments, mentioned usernames (if applicable), and attached images.

Wiki tab for a node

The Wiki tab for a node lets you create and edit content on a wiki page for a node of a project's network map. The wiki editor features an input field where you can add text and use common heading and text formatting styles. You can also add images and hyperlinks.

To create on the Wiki tab for a node:

1. Place your cursor inside the wiki editor and add text, images, and/or hyperlinks, as needed.

2. Click or tap Save.

Note

If you don't want to save any changes you have made in the wiki editor, click or tap Cancel.

Archive and restore functions

The web client supports the ability to archive network maps and nodes, which become inactive. Also supported is the ability to restore archived network maps and nodes so that they become reactivated.

Note

Because archived network maps and nodes are inactive, their names and IDs are not searchable in the Search view. If archived network maps and nodes are restored and become reactivated, their names and IDs become searchable once again.

More details about the archive and restore functions are outlined in the corresponding sections below.

Because nodes are connected by existing data object relationships, when a node is archived or restored, the web client will update affected relationships accordingly, as described in the corresponding sections below.

Archive a network map

When you archive a network map, all of its dependent objects also become archived and inactive. Therefore, details of an archived network map and its dependent objects will not be searchable in the Search view.

To archive a network map:

1. In the Network Map tab for a project, click the menu icon to the right of the name of the network map that you want to archive, and select the Archive network map option.

The Archive network map dialog appears, informing you of the resulting behavior if you proceed with the action.

- To cancel the archive action, click or tap **Cancel**.

- To proceed with archiving the given network map, click or tap **Archive**.

  The web client removes the given network map from the **Network Map** tab of a given project and becomes listed on the **Archived network maps** tab. In the listing, the name of the archived network map, created date, username of the user who created the network map, and the related node names are also displayed.

  ![Archived network map listed on the Archived network maps tab](img/archived_network_map_example.png)

Archive a node

When you archive a node, it and all of its dependent objects will be removed from the related network map of a project, will become inactive, and will not be searchable in the Search view.

To archive a node:

1. On the Network Map tab of a project, right-click on a node that you want to archive and from the menu, select Archive node.

The Archive node dialog appears.

1. In the input field, which is case sensitive, type the exact name of the node.

2. In the Reason field, type a reason for archiving the node.

3. Click or tap Archive.

The node is removed from the given network map and becomes listed on the Archived nodes tab for the project. It has become inactive and unsearchble in the Search view. A direct node relationship is created between the former predecessor node and former successor node.

Restore an archived network map

When you restore a network map to a project, all of its dependent objects will also become restored as active objects. The restored network map becomes searchable once again in the Search view.

To restore a network map:

1. On the Archived network maps tab for a project, select the checkbox beside the name of the archived network map to be restored.

2. Click or tap the Restore button.

The name of the network map is removed from the Archived network maps tab. The network map is restored to be displayed on the Network maps tag for the given project.

Restore an archived node

When you restore an archived node, all of its dependent objects will also become restored as active objects. You have the option of connecting the restored node to its former predecessor node and former successor node, if desired, or connect the restored node to different nodes.

To restore an archived node:

1. On the Archived nodes tab for a project, select the checkbox beside the name of the archived node to be restored.

The Node Restoration Check Connections dialog appears. The web client checks the node's history to determine the former node relationships that were in place before the node was archived, and presents the node relationships accordingly.

If the archived node was not related to a predecessor node, no node name is presented in the "Parent node" section. If the archived node was not related to a succesor node, no node name is presented in the "Child node" section.

1. If applicable, in the Parent Node section, select the checkbox for the node that had been the predecessor node before the given node was archived.

2. If applicable, on the Child Node section, select the checkbox for the node that had been the successor node before the given node was archived.

3. Click or tap the Restore * confirm button.

The archived node is removed from the Archived nodes tab, and is displayed in its former position and branch on the Network Maps tab of the given project.