Failed to execute template. Cause: [Access denied when checking [script] access to [xwiki:Collaboratory.UX.HbpSkin.WebHome] for user [xwiki:XWiki.Admin]]. Click on this message for details.

Coordination release - HBP Wiki

IAM21 instance, do not create collab nor modify a team, your changes will be lost


Wiki source code of Coordination release

Last modified by hbpadmin on 2023/05/15 21:13
Show last authors
1 The Coordination Release is the first step in the redesign of the Collaboratory.
2
3 It has several goals:
4
5 * bringing together the [[tools that form its core>>doc:Collabs.the-collaboratory.Technical documentation.Architecture.WebHome]], cristallising a vision into a base infrastructure for future improvements
6 * providing a set of features which can improve coordination workflows within the Human Brain Project
7
8 {{toc numbered="true"/}}
9
10 = Features =
11
12 == Organise your work with collabs ==
13
14 A collab is a **collaborative project**, with a clear scope. It contains a **wiki**, a **document repository** and has its own **team** that you manage. You decide if your collab is **private** and only your team can see it or if it is **public** and anyone can access it.
15
16 * [[Browse existing collabs>>doc:Collabs.WebHome]]
17 * [[Create your own collab>>doc:Collabs.WebHome||queryString="clbaction=create"]]
18
19 == Collaborate with teams ==
20
21 You decide who belongs to your team and their access rights using these 3 roles:
22
23 * **viewers** have read only permission on your collab content
24 * **editors** can contribute to your wiki and documents
25 * **admins** can edit your collab settings, manage its team and even delete it
26
27 You can use existing units of the Human Brain Project to share your collab with hundreds of people in a simple click.
28
29 See [[the dedicated page for more information>>doc:Collabs.the-collaboratory.Technical documentation.Architecture.Permissions.WebHome]]
30
31 == Document your work with your own wiki ==
32
33 A collab is organised around its own [[wiki>>https://en.wikipedia.org/wiki/Wiki]].
34
35 Unlike most wikis you are used to, like Wikipedia, your collab wiki has a **tree structure** which makes it **natural to organise it like folders** containing documents.
36
37 The Collaboratory uses XWiki to manage its wikis, an Open Source tool which brings you state-of-art wiki features, such as a complete **history of the changes** on your wiki documents, [[WYSIWYG>>https://en.wikipedia.org/wiki/WYSIWYG]] editors to help you design your documents intuitively and much more!
38
39 Check the [[XWiki user guide>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/]] to learn more.
40
41 == Manage your files with the Collaboratory drive ==
42
43 Each collab comes with its **own file repository** which we call the Collaboratory drive. Its permissions are **synchronised** with your **team's roles**, making it easy for you to share documents.
44
45 The Collaboratory drive uses Seafile, an Open Source solution, to bring you the best user experience: **drag'n drop** to upload files, **downloading entire folders**, **file revisions**, and even a desktop client to synchronise your collab documents to your computer!
46
47 See [[Seafile's documentation>>https://help.seafile.com/en/]] to learn more.
48
49 [[Download a desktop client>>https://www.seafile.com/en/download/]].
50
51 == Edit documents collaboratively ==
52
53 From your collab drive, click on a document, spreadsheet or presentation and start editing it directly in your browser!
54
55 OnlyOffice, the Open Source solution behind the scene, also supports collaborative edition: you can now open a document with your teammates and start working together instantly.
56
57 See [[OnlyOffice documentation>>https://helpcenter.onlyoffice.com/onlyoffice-editors/index.aspx]] to learn more.
58
59 = Use cases =
60
61 With the set of features brought by the Coordination release, many use cases can be fulfilled today:
62
63 == Personal private documentation ==
64
65 The Collaboratory combines the intuitivity of a document repository with online editing capabilities and the structural power of a wiki linking pages together, all within the comfort of your preferred browser.
66
67 You can create your own private collab to manage your work:
68
69 * organise your documentation in the **wiki**, using the navigation tree and the **search engine** to find your information
70 * upload and **edit the documents** that are valuable to your work in the **drive**
71 * **access** this convenient environment from your own laptop **at home**, your personal computer **at work** or even your mobile **in the public transport**
72
73 == HBP centric communication ==
74
75 You want to communicate with part to all off the HBP members? You can:
76
77 * create a private collab
78 * add (% class="mark" %)hbp/SGA2(%%) if you want to share with all HBP members or (% class="mark" %)hbp/SGA2/SPXX(%%) for a specific sub project
79 * create the documentation in the wiki or add the documents you want to share in your drive
80
81 You now have a **privileged channel** with **tens or hundreds of users** in just a few clicks.
82
83 == Public communication ==
84
85 Collabs can be a productive tool to structure information for a public event such as a workshop:
86
87 * create a private collab
88 * structure the information about your event in the wiki: add information about the location, the agenda and how to participate
89 * if you need to share documents, add them in the drive and create public links that you can add in your wiki pages
90 * when you are happy with your event mini website, edit your collab and set it to public
91
92 You can now freely **share the link to your collab** and create a news of a tweet that links to it: your audience will not need to have a user account to access it.
93
94 During your event, you can modify the provided information to your audience **without relying on an external communication team**.
95
96 == Collaborative reporting ==
97
98 Being responsible of a sub project, work package or a task implies regular reporting in collaboration with many individuals across the project.
99
100 A collab can be a convenient way to work collaboratively on such reporting:
101
102 * create a private collab
103 * add people you need to collaborate with as editors in your collab team
104 * upload or copy an existing template for your report in your collab drive
105 * open it and start **doing your reporting directly in your browser**
106 * when finished, you can change your collaborators permission to viewer so they cannot edit your report anymore
107
108 You can now easily download and **send your report by email** or even **share it** with a link.
109
110 = Limitations =
111
112 == Browser compatibility ==
113
114 Testing and support is done on Chrome and Firefox, latest version. There is a good chance you would have a good experience on any modern browser.
115
116 == Collaborating with users outside of the Human Brain Project consortium ==
117
118 Collaborating with external users is an important goal of the Collaboratory. It is not possible to register external users currently but it is planned for the next major release.
119
120 See [[the planned releases>>doc:Collabs.the-collaboratory.Technical documentation.Releases.WebHome]] for more details.
121
122 == Accessing the new Collaboratory with your HBP account ==
123
124 The new Collaboratory introduces a new Identity and Access Management (IAM v2) tool: KeyCloak.
125
126 User accounts with an SGA2 accreditation are synchronised every night from the previous IAM system (IAM v1).
127
128 The synchronisation does not copy your password, implying that you need to use the reset password feature in the IAM v2 system to gain access to it.
129
130 New comers need to go through several steps to gain access to Collaboratory v2:
131
132 1. [[Request an invitation>>https://services.humanbrainproject.eu/oidc/account/request]] from Collaboratory v1
133 1. When access is granted, create your account in Collaboratory v1
134 1. [[Request an accreditation>>https://collab.humanbrainproject.eu/#/me/accreditations]]
135 1. Once your accreditation is accepted by your sub project manager, your account will be synchronised to IAM v2 during the night
136 1. Navigate to Collaboratory v2 and try to log in
137 1. Use the "Forgot Password?" of the login form to set your IAM v2 password
138 1. You can now access both Collaboratory v1 and v2 through their respective IAM services
139
140