Skip to Content

Wiki source code of 3.1 Project Canvas Layout

Last modified by publicadmin on 2025/12/16 13:04
Show last authors
1 = General Layout =
2
3 The Project Canvas has seven main components:
4
5 1. Main Menu
6 1. Left Sidebar
7 1. Project Title bar
8 1. File Statistics card
9 1. Recent File Stream card
10 1. File Explorer card
11
12 [[image:VRE UI Diagrams for User Manual - Project Canvas.png]]
13
14 {{info}}
15 **Note: **Cards with a blue directional arrow icon [[image:VRE User Manual Release 1.0.0 2021-02-12 no numbering_html_50b26f5087895791.png||height="19" width="19"]] can be rearranged by clicking the icon and dragging the card to a new location on the canvas. Refresh your browser window to restore the card configuration to the default layout.
16 {{/info}}
17
18 ===== 1. Main Menu =====
19
20 The Main Menu is used to navigate to the main sections of the site:
21
22 (% style="width:849px" %)
23 |(% style="width:846px" %)(((
24 [[image:container.png||height="19" width="19"]]** Project Landing Page**
25
26 This is the main page that is visible upon login. The Project Landing Page shows My Projects and All Projects on the VRE.
27 )))
28 |(% style="width:846px" %)(((
29 **Dataset Explorer**
30
31 This will take you to the Dataset Feature where you can build, annotate, validate, and version your datasets
32 )))
33 |(% style="width:846px" %)(((
34 [[image:file-text.png||height="19" width="19"]] **Files Status**
35
36 Opens the //Files Status// panel within the current page. This displays the status of files that are currently uploading, downloading, or being moved, as well as the status of previously uploaded files.
37 )))
38 |(% style="width:846px" %)(((
39 **Support**
40
41 Clicking Support opens up a content drawer with links to the VRE User Guide, FAQ, and Contact Us form.  Scroll to the bottom of the Support drawer to submit a request to get help with the platform tools and services, to report a bug, or submit other general questions.​
42 )))
43 |(% style="width:846px" %)(((
44 [[image:user.png||height="19" width="19"]]** User Profile**
45
46 Clicking your username on the right side of the Main Menu allows you to access your //Profile//, where you can log out or reset your password.
47 )))
48
49 ===== 2. Left Sidebar =====
50
51 The Left Sidebar is used to access Project tools:
52
53 |(% style="width:61px" %)(((
54 (% style="text-align:center" %)
55 [[image:Dashboard.png||height="38" width="40"]]
56 )))|(% style="width:569px" %)(((
57 **Canvas**
58
59 Homepage of a VRE Project. Displays //Project Information//, //General Statistics//,// File Statistics//, and //File Explorer//.
60 )))
61 |(% style="width:61px" %)(((
62
63 )))|(% style="width:569px" %)(((
64 **Search**
65
66 Opens the //Search// page where users can query files in the Project based on file attributes and metadata. 
67 )))
68 |(% style="width:61px" %)[[image:Annoucement-Black.png]]|(% style="width:569px" %)(((
69 **Announcement**
70
71 Opens the //Announcement //page where users can see past Project announcements and Administrators can create new announcements. 
72 )))
73 |(% style="width:61px" %)(((
74 (% style="text-align:center" %)
75 [[image:VRE User Manual Release 1.0.0 2021-02-12 no numbering_html_d6712dc9d6e55fdd.png||height="41" width="40"]]
76 )))|(% style="width:569px" %)(((
77 **Members**
78
79 Navigates to the //Members //page where Administrators can view all Project Team Members, add Members, change Member’s roles, and delete Members from the Project.
80 )))
81 |(% style="width:61px" %)(((
82 (% style="text-align:center" %)
83 [[image:VRE User Manual Release 1.0.0 2021-02-12 no numbering_html_a3179a6fb35af360.png||height="42" width="40"]]
84 )))|(% style="width:569px" %)(((
85 **Settings**
86
87 Opens the [[//Project Settings//>>doc:Main.user_guide.Managing Projects.Project Settings.WebHome]] page where the Project details and settings can be edited.  The Settings page can also be used to manage [[Attribute Templates>>doc:Main.user_guide.Managing Data.File Properties.4\.2\.1 File Attributes.WebHome]] and configure [[Workbench Tools>>doc:Main.user_guide.Analyzing Data.WebHome]]. 
88 )))
89 |(% style="width:61px" %)(((
90 (% style="text-align:center" %)
91 [[image:VRE User Manual Release 1.0.0 2021-02-12 no numbering_html_59c8baba523b024.png||height="73" width="40"]]
92 )))|(% style="width:569px" %)(((
93 **Guacamole**
94
95 When configured in a project, allows access to __[[Apache Guacamole>>doc:Main.user_guide.Analyzing Data.Guacamole.WebHome]]__, a clientless remote desktop gateway to facilitate workbench analyses with, for example, containerized pipelines//.//
96 )))
97 |(% style="width:61px" %)(((
98 (((
99
100 )))
101
102 (((
103 [[image:SuperSet-Black-2.png]]
104 )))
105 )))|(% style="width:569px" %)(((
106 **Superset**
107
108 When configured in a project, allows access to __[[Apache Superset>>doc:Main.user_guide.Analyzing Data.Superset.WebHome]]__, a web application that allows database connections, visualization creation, and dashboard design.
109 )))
110 |(% style="width:61px" %)(((
111 (% style="text-align:center" %)
112 [[image:Jupyter.png||height="53" width="50"]]
113 )))|(% style="width:569px" %)(((
114 **JupyterHub**
115
116 When configured in a project, allows access to __[[JupyterHub>>doc:Main.user_guide.Analyzing Data.JupyterHub.WebHome]]__, providing access to data science computational environments with pre-installed project resources.
117 )))
118 |(% style="width:61px" %)(((
119 (% style="text-align:center" %)
120 [[image:VRE User Manual Release 1.0.0 2021-02-12 no numbering_html_ae5f1fbdaf3ffa1f.png||height="40" width="40"]]
121 )))|(% style="width:569px" %)(((
122 **XWiki**
123
124 Allows// //project members to access __[[XWiki>>doc:Main.user_guide.Managing Projects.Project Wiki.WebHome]]__, an online content management tool for project documentation.
125 )))
126
127 ===== 3. Project Title Bar{{id name="project_title_bar"/}} =====
128
129 The //Project Title bar //provides the Project Title, the Project Code, and your [[user role>>doc:Main.user_guide.Managing User Accounts.User Roles.WebHome]] in the Project.
130
131 When expanded using the [[image:Panel-Expansion-Down.png||height="24" width="23"]] Panel Expansion button, the// Project Title bar// displays basic information about the Project:
132
133 * **Project Administrators:** Displays the Project Administrator(s) for the Project. Click a name to open an email and submit an inquiry to the Project Administrator.
134 * **Description:** A longer, more informative description of the study. This information can be edited by the Project Administrator on the //Settings //page.
135 * Numbers of users who belong to the various user roles: Administrator, Contributor, and Collaborator.
136
137 ===== 4. File Statistics =====
138
139 //Visible only to Project Administrators. //Eight statistics are displayed:
140
141 1. Number of **Green Room** files in the Project
142 1. Number of **Core** files in the Project
143 1. **Uploaded (today)**: Number of files uploaded to the Project today
144 1. **Downloads (today)**: Number of files downloaded from the Project today.
145 1. **Approved (today)**: Number of files approved to be copied from one folder to another today.
146
147 ===== 5. Recent File Stream =====
148
149 A list of recent file actions can be seen in the Recent File Stream card. Search and view detailed file activity logs by clicking Advanced Search. For additional information, see [[File Stream>>doc:Main.user_guide.Navigating the Project Canvas.File Statistics - Advanced Search.WebHome]].
150
151 {{info}}
152 **Note: **Information displayed in the Recent File Stream card depends on a user’s role.
153 {{/info}}
154
155
156 ===== 6. File Explorer =====
157
158 The [[//File Explorer//>>doc:Main.user_guide.Navigating the Project Canvas.File Explorer.WebHome]] offers many features to view, upload, manage, search, and sort files. For additional information, see [[File Explorer>>doc:Main.user_guide.Navigating the Project Canvas.File Explorer.WebHome]].
159
160 ----
161
162 **See Also:**
163
164 [[File Stream>>doc:Main.user_guide.Navigating the Project Canvas.File Statistics - Advanced Search.WebHome]]
165
166 [[File Explorer>>doc:Main.user_guide.Navigating the Project Canvas.File Explorer.WebHome]]
167
168 [[Finding Projects in the VRE>>doc:Main.user_guide.Accessing the VRE.Finding Projects in the VRE.WebHome]]
169
170 ----
171
172 {{box}}
173 (% style="text-align:center" %)
174 image:https://i.creativecommons.org/l/by-sa/4.0/88x31.png
175
176 (% style="text-align: center;" %)
177 Copyright © 2022, Indoc Research. This work is licensed under a [[Creative Commons Attribution-ShareAlike 4.0>>http://creativecommons.org/licenses/by-sa/4.0/ ||rel="noopener noreferrer" target="blank"]] International License.
178 {{/box}}