User Manual

Create a project

---

In the Computational Pathology Portal, all available slides (images) are arranged and grouped in projects. All internal users can create new projects by following the steps below. External users cannot create projects, and can only be added to existing projects by the project administrator.

Steps to create a new project:

1. Click the Create project button

   • 
     

     Image: Top navigation bar, with functional elements highlighted

     Highlighted elements in the top navigation bar

   1. Project selection
   2. Create project
   3. Jobs panel
   4. Upload slides
   5. Browse platform drop-down
   6. Help
   7. Account

2. A Create project pop-up window will be shown

3. Enter a project name in the mandatory Project name field

4. Optionally, enter a description for the project

   • 

     Image: Create project pop-up dialog, with functional elements highlighted

     Highlighted elements in the pop-up dialog

   1. Project name entry field
   2. Project description entry field
   3. Create project button
   4. Cancel project creation button



 

Tip: Naming a new project

• For naming conventions regarding project names see the Nomenclature Guidlines for Portal Projects.



5. Click the Create button to create a project

   • Project name is unique across the CP Portal

   • If you enter a non-unique name in the Create project pop-up dialog you will get an error message

     • Example error message: Project name "CP Portal Demo" is in use. Choose another name
   • The pop-up dialog stays open and you can adjsut the project name and try again

6. Alternatively, click the Cancel button to cancel project creation

   • In this case, no project will be created

Switch projects

---

You can switch to a different project from any page in the CP Portal. Click on the project drop-down panel in the top navigation panel and select another project.

You can quickly find a project by using the quick-filter to filter for the desired project. Additionally, you can use the pre-filters on the left side of the panel to quickly filter for project categories.

After selecting a new project, you will be redirected to the slide list showing the contents of the selected project.

To switch to a new project:

1. In the top navigation bar, click on the project selection drop-down

   • The project panel is shown with Projects pre-filter selected by default
   • The Projects pre-filter will show you a list of all projects you have access to, regardles of your role in those projects
   • Additional to the Projects pre-filter, Project panel also contains the Home projects pre-filter
   • The Home projects pre-filter will show you a list of all projects marked as Home projects which you have access to, regardles of your role in those Home projects

2. From the project selection panel, click on a new project

   • You can find the project you are looking for by filtering for it using the Filter input box in the project panel
   • You can filter for the project by searching for any part of its name
   • Project description is not searchable
   • To quickly find Home project use the Home projects pre-filter, on the left hand side of the Project selection panel
3. The selected project will be opened, and you will be redirected to the new project

Image: Project selection drop-down panel

Highlighted elements in the Projects panel:

1. Projects pre-filter
2. Home projects pre-filter
3. Quick-filter input
4. List of projects, matching currently applied filters

Edit a project

---

Once you have created a project you can always edit its name, summary, or the project folder. Please note that you need to have project admin privileges to edit a project.

To edit a project:

1. Click on the Project settings link, from the left side bar
2. In the project settings tab, change the project name, summary, or folder ID
3. Click the Save button to save the changes
4. Alternatively, click the Cancel button to cancel, and not save the changes

Image: Project settings page, with functional elements highlighted

Highlighted elements in the Projects settings page:

1. Projects settings link, in the left side bar
2. Project settings tab
3. Project name input field
4. Folder ID input field
5. Project description input field
6. Mark project as Home
7. Save button
8. Cancel button

Nomenclature Guideline for Portal Projects

---

Note: modules in the same group are not exclusive, which means more than one module of the same group can be used.

Full examples: