Add stub for super-user panel.

docs/more-information/db-2.0.html

@@ -395,6 +395,8 @@ <h2 id="toc-title">Table of contents</h2>
   </ul></li>
   <li><a href="#volume-interface" id="toc-volume-interface" class="nav-link" data-scroll-target="#volume-interface">Volume interface</a></li>
   <li><a href="#sessions-interface" id="toc-sessions-interface" class="nav-link" data-scroll-target="#sessions-interface">Sessions interface</a></li>
+  <li><a href="#super-useradmin-panel" id="toc-super-useradmin-panel" class="nav-link" data-scroll-target="#super-useradmin-panel">Super User/Admin panel</a></li>
+  <li><a href="#user-profile" id="toc-user-profile" class="nav-link" data-scroll-target="#user-profile">User profile</a></li>
   </ul></li>
   <li><a href="#scoping" id="toc-scoping" class="nav-link" data-scroll-target="#scoping">Scoping</a>
   <ul>
@@ -730,6 +732,15 @@ <h3 class="anchored" data-anchor-id="sessions-interface">Sessions interface</h3>
 <li>(<span class="discuss-feature">discuss</span>): “Download all files as zip”. With large sessions and/or large files, the zip files are also large and require application resources to create. Are there any third party libraries we could use that would off-load this process? <em>Note:</em> This problem is larger with the “Download all folders as zip” function on the volumes page.</li>
 </ul>
 </section>
+<section id="super-useradmin-panel" class="level3">
+<h3 class="anchored" data-anchor-id="super-useradmin-panel">Super User/Admin panel</h3>
+</section>
+<section id="user-profile" class="level3">
+<h3 class="anchored" data-anchor-id="user-profile">User profile</h3>
+<ul>
+<li>(<span class="discuss-feature">discuss</span>): Toggle volume view between short-name and long name.</li>
+</ul>
+</section>
 </section>
 <section id="scoping" class="level2">
 <h2 class="anchored" data-anchor-id="scoping">Scoping</h2>

docs/search.json

@@ -1405,7 +1405,7 @@
     "href": "more-information/db-2.0.html#requirements",
     "title": "Databrary 2.0",
     "section": "Requirements",
-    "text": "Requirements\nThis section provides additional information about the requirements for specific aspects of the Databrary 2.0 application.\n\nSchema\nThe Databrary 1.0 schema can be found here.\nMontrose 1 recommends that we implement separate tables for individuals and institutions. These entities are combined into a single party table in the current schema.\n\n\nUser Access Privileges\n\nAffiliate access to an Authorized Investigator*’s data\nA user may be given privileges to a Volume by an Authorized Investigator.\n\n(remove) No access (default)\n\nThis is redundant for the UI. Remove it there. Retain for backend.\n\n(remove) View and access only public data (Level visible only to Super User; eliminate.)\n(remove) View and access only shared data (Level visible only to Super User; eliminate.)\nRead-only access\nRead/write access\nManager\n\nRead, write, create Private volumes ((new) with supervising Authorized Investigator as the owner)\n(remove) Manager ability to change volume access (change sharing)\n(remove) Manager ability to extend access to Affiliates\n\n\n\n\n\n\n\n\nNote\n\n\n\nPer 2024-05-08 meeting with Montrose, we are likely to implement separate categories for Affiliate privileges “Read”, “Write”, and “Create” and enable various combinations of these, such as “Create” only or “Create” plus “Read” but not write.\n\n\n\n\n\nRegistration workflow\nRegistration consists of multiple steps. The following shows requested modifications to the Databrary 1.0 workflow.\n\nCreate Account\nThe reference page for the Databrary 1.0 registration process is here:\n\nFields are as follows:\n\nFirst and Middle Name (required)\nLast Name (required)\nEmail (required)\n\nAdd instruction text that specifies an official institutional email must be used for this field (e.g., @psu.edu).\nImplement email validation (against existing database of valid institutional email, flag @gmail.com, etc.)\nPermit free-text email if validation fails\n\nAffiliation (required)\n\nType-ahead search of existing database of authorized Institutions.\nIf no matching institution exists, the user can enter a new institution, but should be notified.\nChange label to Institutional Affiliation.\n\n\n\n\nGet Started\n\n\n\nGet Started panel\n\n\n\nRequire user to confirm that they have read and agree to the Databrary Access Agreement.\nLink to the Terms and Conditions of Use.\n\n\n\nConfirm email\n\n\n\nConfirm Email panel\n\n\n\n\nSet Password\n\n\n\nDatabrary Set Password panel\n\n\n\nRequire strong password (increase number of required characters from 7 to 14 characters. 2\nValidate password to ensure that password is strong\n\n\n\nRequest Authorization\n\n\n\nDatabrary Request Authorization panel\n\n\n\nAdd new drop-down menu for new user_position field that requires users to enter their position at their institution. The acceptable values for this field are as follows:\n\nFaculty/Independent Researcher\nStudent\nStaff\nOther\n\nIf user_position is in {‘Student’, ‘Staff’, ‘Other’}\n\nShow research_sponsor text field\n\nAdd instruction text asking user to type the name of the person who is their research sponsor or supervisor; the entered text should use look-ahead search to match to Authorized Investigators currently active on Databrary at the user’s specified institution.\nIf the search succeeds, the user can select the name of their research sponsor.\n\nGenerate a request for authorization from the current user to the research sponsor; cc the current user.\nProvide the user feedback that this request has been sent.\n\nIf the search fails, the user can enter the name of their research sponsor, but warning text appears: “This research sponsor cannot be found.”\n\nAsk the user to enter their research sponsor’s institutional email address.\n\nValidate that address as above.\n\nConfirm that the user wants Databrary to send a request to register email to the user’s research sponsor.\n\nIf yes, send the email to the research sponsor and cc the current user.\nTO-DO: Draft this email.\n\n\n\n\nIf user_position is “Faculty/Independent Researcher”\n\nShow new text field user_institutional_profile and ask user to enter the URL for their institutional profile page.\n\nAdd explanatory text: “Databrary requires that we confirm a new user is eligible for Authorized Investigator status. Please provide a URL to your personal profile page at your institution to assist us in verifying your status.”\n\nIf user’s institution is not in Databrary’s database of authorizing institutions…\n\nAsk user to enter information into two new (optional) text fields: institution_authorizing_official_full_name for the full name of the institution’s authorizing official and institution_authorizing_official_email for that person’s email.\n\nIf user’s institution is in the Databrary database of authorizing institutions…\n\nShow text saying “institution has active users on Databrary. Here is a link to other users from institution on Databrary: . Our staff will work with you and your institution to expedite your authorization.”\n\n\n\n\n\n\nVolume interface\n\n(new): Create bibliographic contributor field. Allow sorting of authors.\n(new): New volumes have a single owner who must be an Authorized Investigator.\n\n\n\n(remove): “Does this valume correspond to a published paper…” and related look up published paper or resource; complete reference info. Will enter linked resources in Add Links tab below.\n(remove): “Add keywords” interface (push to >2.0)\n(future): Pull keywords from related/linked articles\n\n\n\n(change): Default Volume access to Private\n(change): Separate (single) volume owner from Collaborators. Allow transfer of ownership here.\n(remove): “Extend access to … affiliates” checkbox and related functionality.\n(remove): “Investigator (read/write/share)” option for collaborators.\n(change): Make “Read only” default access level for all added Collaborators.\n(discuss): Add expiration date for access to volume for all collaborators.\n\n\n\n(discuss): How to simplify\n\n\n\n(discuss): How to simplify\n\n2024-08-06: Required variables:\n\nFile name\nSharing release level\nFile type (from extension)\n\n\n\n\n\n(change): “Enter title or paper/dataset citation”\n(future): Way to search Databrary for related datasets.\n\n\n\n(change): Lookup existing funder, but permit user-entered value(s)\n\n\n\n(change): Merge FILE RELEASE LEVELS data with “added on”, “sessions”, “participants” panel\n(change): “HOW TO CITE” field has user editable authors, Databrary specific info is added by the system\n(new): OWNER sub-panel\n(change): Fix column size so that long names and affiliations aren’t cut-off\n\n\n\n(remove): “Create highlight” button and associated workflow. Re-implement in >2.0\n(remove): “Show saved display mode” dropdown and associated workflow. May re-implement some portion in >2.0.\n(remove): “Show summary” functionality. May re-implement some portion in >2.0.\n(remove): Save current display mode functionality.\n(new): Separate interface for Materials\n(discuss): Simpler tablular interface for spreadsheet display?\n\n\n\n(remove): Comments. Consider re-implementing in >2.0\n\n\n\nSessions interface\n\n\n(remove): Keywords and Tags.\n(remove): Bars that summarize spreadsheet metadata values.\n(remove): File names sort by timestamp uploaded.\n(remove): Video editing within viewer to create highlights.\n(discuss): Better interface layout for previewing videos.\n\n2024-08-06\n\n(change): Create pop-up window for previewing video/audio\n(discuss): Could pop-up viewer allow other file-type “previews”, e.g. PDF, docx, txt? Or push to later timepoint.\n\n\n(change): Make “set as highlight” feature more visible. This applies to a file.\n(change): Simpler tablular interface viewing files, release level, highlight status, etc.\n\nColumns include: File name, sharing release level, file type, size, last modified (optional)\n(discuss): Move button to downloading single file to table\n\n\n - (remove): Timeline.\n\n\n(discuss): “Download all files as zip”. With large sessions and/or large files, the zip files are also large and require application resources to create. Are there any third party libraries we could use that would off-load this process? Note: This problem is larger with the “Download all folders as zip” function on the volumes page.",
+    "text": "Requirements\nThis section provides additional information about the requirements for specific aspects of the Databrary 2.0 application.\n\nSchema\nThe Databrary 1.0 schema can be found here.\nMontrose 1 recommends that we implement separate tables for individuals and institutions. These entities are combined into a single party table in the current schema.\n\n\nUser Access Privileges\n\nAffiliate access to an Authorized Investigator*’s data\nA user may be given privileges to a Volume by an Authorized Investigator.\n\n(remove) No access (default)\n\nThis is redundant for the UI. Remove it there. Retain for backend.\n\n(remove) View and access only public data (Level visible only to Super User; eliminate.)\n(remove) View and access only shared data (Level visible only to Super User; eliminate.)\nRead-only access\nRead/write access\nManager\n\nRead, write, create Private volumes ((new) with supervising Authorized Investigator as the owner)\n(remove) Manager ability to change volume access (change sharing)\n(remove) Manager ability to extend access to Affiliates\n\n\n\n\n\n\n\n\nNote\n\n\n\nPer 2024-05-08 meeting with Montrose, we are likely to implement separate categories for Affiliate privileges “Read”, “Write”, and “Create” and enable various combinations of these, such as “Create” only or “Create” plus “Read” but not write.\n\n\n\n\n\nRegistration workflow\nRegistration consists of multiple steps. The following shows requested modifications to the Databrary 1.0 workflow.\n\nCreate Account\nThe reference page for the Databrary 1.0 registration process is here:\n\nFields are as follows:\n\nFirst and Middle Name (required)\nLast Name (required)\nEmail (required)\n\nAdd instruction text that specifies an official institutional email must be used for this field (e.g., @psu.edu).\nImplement email validation (against existing database of valid institutional email, flag @gmail.com, etc.)\nPermit free-text email if validation fails\n\nAffiliation (required)\n\nType-ahead search of existing database of authorized Institutions.\nIf no matching institution exists, the user can enter a new institution, but should be notified.\nChange label to Institutional Affiliation.\n\n\n\n\nGet Started\n\n\n\nGet Started panel\n\n\n\nRequire user to confirm that they have read and agree to the Databrary Access Agreement.\nLink to the Terms and Conditions of Use.\n\n\n\nConfirm email\n\n\n\nConfirm Email panel\n\n\n\n\nSet Password\n\n\n\nDatabrary Set Password panel\n\n\n\nRequire strong password (increase number of required characters from 7 to 14 characters. 2\nValidate password to ensure that password is strong\n\n\n\nRequest Authorization\n\n\n\nDatabrary Request Authorization panel\n\n\n\nAdd new drop-down menu for new user_position field that requires users to enter their position at their institution. The acceptable values for this field are as follows:\n\nFaculty/Independent Researcher\nStudent\nStaff\nOther\n\nIf user_position is in {‘Student’, ‘Staff’, ‘Other’}\n\nShow research_sponsor text field\n\nAdd instruction text asking user to type the name of the person who is their research sponsor or supervisor; the entered text should use look-ahead search to match to Authorized Investigators currently active on Databrary at the user’s specified institution.\nIf the search succeeds, the user can select the name of their research sponsor.\n\nGenerate a request for authorization from the current user to the research sponsor; cc the current user.\nProvide the user feedback that this request has been sent.\n\nIf the search fails, the user can enter the name of their research sponsor, but warning text appears: “This research sponsor cannot be found.”\n\nAsk the user to enter their research sponsor’s institutional email address.\n\nValidate that address as above.\n\nConfirm that the user wants Databrary to send a request to register email to the user’s research sponsor.\n\nIf yes, send the email to the research sponsor and cc the current user.\nTO-DO: Draft this email.\n\n\n\n\nIf user_position is “Faculty/Independent Researcher”\n\nShow new text field user_institutional_profile and ask user to enter the URL for their institutional profile page.\n\nAdd explanatory text: “Databrary requires that we confirm a new user is eligible for Authorized Investigator status. Please provide a URL to your personal profile page at your institution to assist us in verifying your status.”\n\nIf user’s institution is not in Databrary’s database of authorizing institutions…\n\nAsk user to enter information into two new (optional) text fields: institution_authorizing_official_full_name for the full name of the institution’s authorizing official and institution_authorizing_official_email for that person’s email.\n\nIf user’s institution is in the Databrary database of authorizing institutions…\n\nShow text saying “institution has active users on Databrary. Here is a link to other users from institution on Databrary: . Our staff will work with you and your institution to expedite your authorization.”\n\n\n\n\n\n\nVolume interface\n\n(new): Create bibliographic contributor field. Allow sorting of authors.\n(new): New volumes have a single owner who must be an Authorized Investigator.\n\n\n\n(remove): “Does this valume correspond to a published paper…” and related look up published paper or resource; complete reference info. Will enter linked resources in Add Links tab below.\n(remove): “Add keywords” interface (push to >2.0)\n(future): Pull keywords from related/linked articles\n\n\n\n(change): Default Volume access to Private\n(change): Separate (single) volume owner from Collaborators. Allow transfer of ownership here.\n(remove): “Extend access to … affiliates” checkbox and related functionality.\n(remove): “Investigator (read/write/share)” option for collaborators.\n(change): Make “Read only” default access level for all added Collaborators.\n(discuss): Add expiration date for access to volume for all collaborators.\n\n\n\n(discuss): How to simplify\n\n\n\n(discuss): How to simplify\n\n2024-08-06: Required variables:\n\nFile name\nSharing release level\nFile type (from extension)\n\n\n\n\n\n(change): “Enter title or paper/dataset citation”\n(future): Way to search Databrary for related datasets.\n\n\n\n(change): Lookup existing funder, but permit user-entered value(s)\n\n\n\n(change): Merge FILE RELEASE LEVELS data with “added on”, “sessions”, “participants” panel\n(change): “HOW TO CITE” field has user editable authors, Databrary specific info is added by the system\n(new): OWNER sub-panel\n(change): Fix column size so that long names and affiliations aren’t cut-off\n\n\n\n(remove): “Create highlight” button and associated workflow. Re-implement in >2.0\n(remove): “Show saved display mode” dropdown and associated workflow. May re-implement some portion in >2.0.\n(remove): “Show summary” functionality. May re-implement some portion in >2.0.\n(remove): Save current display mode functionality.\n(new): Separate interface for Materials\n(discuss): Simpler tablular interface for spreadsheet display?\n\n\n\n(remove): Comments. Consider re-implementing in >2.0\n\n\n\nSessions interface\n\n\n(remove): Keywords and Tags.\n(remove): Bars that summarize spreadsheet metadata values.\n(remove): File names sort by timestamp uploaded.\n(remove): Video editing within viewer to create highlights.\n(discuss): Better interface layout for previewing videos.\n\n2024-08-06\n\n(change): Create pop-up window for previewing video/audio\n(discuss): Could pop-up viewer allow other file-type “previews”, e.g. PDF, docx, txt? Or push to later timepoint.\n\n\n(change): Make “set as highlight” feature more visible. This applies to a file.\n(change): Simpler tablular interface viewing files, release level, highlight status, etc.\n\nColumns include: File name, sharing release level, file type, size, last modified (optional)\n(discuss): Move button to downloading single file to table\n\n\n - (remove): Timeline.\n\n\n(discuss): “Download all files as zip”. With large sessions and/or large files, the zip files are also large and require application resources to create. Are there any third party libraries we could use that would off-load this process? Note: This problem is larger with the “Download all folders as zip” function on the volumes page.\n\n\n\nSuper User/Admin panel\n\n\nUser profile\n\n(discuss): Toggle volume view between short-name and long name.",
     "crumbs": [
       "More information",
       "Databrary 2.0"