Skip to content

Commit

Permalink
Update broken figures in more-information/software.qmd.
Browse files Browse the repository at this point in the history
  • Loading branch information
rogilmore committed Apr 26, 2024
1 parent 89f68b9 commit a504abc
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 6 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 8 additions & 2 deletions docs/more-information/software.html
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,13 @@ <h3 class="anchored" data-anchor-id="volume-sharing-levels">Volume Sharing Level
<li>Entire Volume Shared</li>
</ul>
<p>An <em>Authorized Investigator</em> has a private page that combines personal profile information and a dashboard with information about volumes, sponsors, and affiliates.</p>
<p><img src="../include/img/db-gilmore-private-profile-dashboard.png" class="img-fluid" alt="Rick Gilmore’s private profile and dashboard."> The Dashboard consists of two columns. The left column provides information about <em>Volumes</em> the <em>Authorized Investigator</em> has created or has access to.</p>
<div class="quarto-figure quarto-figure-center">
<figure class="figure">
<p><img src="../include/img/db-gilmore-private-profile-dashboard.png" class="img-fluid figure-img"></p>
<figcaption>Rick Gilmore’s <em>private</em> profile and dashboard.</figcaption>
</figure>
</div>
<p>The Dashboard consists of two columns. The left column provides information about <em>Volumes</em> the <em>Authorized Investigator</em> has created or has access to.</p>
<p>The following figure illustrates that the Volume has “Entire Volume Shared” status (unlocked lock icon; “Share Entire Volume” tooltip).</p>
<p><img src="../include/img/db-gilmore-dashboard-shared-vol.png" class="img-fluid"> Also, on this <em>Volume</em>, the user has “Investigator” status, meaning that the data can be fully edited and shared with others, as indicated by the tooltip and the crown icon):</p>
<p><img src="../include/img/db-gilmore-dashboard-shared-read-write-share.png" class="img-fluid"></p>
Expand All @@ -537,7 +543,7 @@ <h3 class="anchored" data-anchor-id="volume-sharing-levels">Volume Sharing Level
<p>This user also has volumes with <em>Volume Overview Shared</em> as indicated by the keyhole icon:</p>
<p><img src="../include/img/db-gilmore-dashboard-volume-overview.png" class="img-fluid"></p>
<p>Some other <em>Authorized Investigators</em> have also given this user read-write (pencil icon) status to their volumes that have <em>Volume Overview Shared</em> status:</p>
<p><img src="../include/img/db-gilmore-dashboard-volume-overview-read-only.png" class="img-fluid"></p>
<p><img src="../include/img/db-gilmore-dashboard-volume-overview-read-write.png" class="img-fluid"></p>
<p>And still other <em>Authorized Investigators</em> have given this user read-only (eyeglasses icon) privileges:</p>
<p><img src="../include/img/db-gilmore-dashboard-volume-read-only.png" class="img-fluid"></p>
<p>In this case, it looks like the volume has been fully shared (unlocked lock icon), so the user has full read access to the volume already. Prior to the volume being fully shared, the user had read-only access to the private data.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
"href": "more-information/software.html#databrary-1.0",
"title": "Software",
"section": "",
"text": "Frontend\n\nAngularJS 1.4\nCoffee Script 1.7.1\nJQuery 1.12.3\nStylus 0.54.5 + nib 1.1.2\n\n\n\nBackend\n\nGHC 8.0.2\nHaskell 2010\nSolr 6.6\nPostgreSQL 9.5\nFFmpeg 4.2.4\n\n\n\nApplication\nDatasets are organized into separate volumes with system-wide unique (integer) identifiers. Groups of data files related to a specific person or people (or non-human animal), a date, time, and location are grouped into sessions (slots) within a volume. Individual files (assets) of varying types are organized within a session (slot). Sessions (slots) and files (assets) are assigned system-wide unique (integer) identifiers.\nIndividual users and institutions (called parties) are assigned system-wide unique identifiers and have some overlapping data elements (e.g., prename, sortname). Access privileges are granted hierarchically in a parent/child organization. For example, Databrary is the parent of New York University (NYU); NYU is the parent of Karen Adolph and multiple other Authorized Investigators; Karen Adolph is the parent of multiple Affiliate investigators who have broad access to volumes Dr. Adolph has created. Further details about how Authorized Investigators assign access permission to Affiliates can be found in the System Roles section below.\n\n\nSharing Release Levels\nRestricted data and metadata are controlled by a specific set of sharing release levels. These levels apply at the session/slot and file/asset level. Newly uploaded files default to Private. The terminology associated with these levels, the icons used to identify the levels, and the level of user access permitted by the levels are deeply embedded in the Databrary policy framework.\n\n\nAPI\nAll Databrary frontend calls use the API. The volume/slot/asset identifier scheme described previously supports API calls of the following form:\nhttps://nyu.databrary.org/volume/1/slot/9807?asset=9200\nThis call accesses the Databrary “leaf” logo in volume 1, slot (session) 9807, with asset ID 9200. Similarly, https://nyu.databrary.org/party/12 returns information about all of the Authorized Investigators who are authorized through party 12, The Pennsylvania State University.\nMost, but not all of the Databrary API is documented. If it is necessary to change the API calls in the rewrite, then the API should be versioned, and the new system should support current API calls.\n\n\nBackend Services\nAll audio and video files uploaded automatically generate transcoding jobs that are handled by the NYU HPC.\nThe system mints a Digital Object Identifier (DOI) when a volume is shared. This must continue. Databrary piggybacks on the DOI account controlled by NYU Libraries.\nThe system generates and updates standard bibliographic citations for a volume based on volume data and metadata.\n\n\nSystem roles\n\nSuper user\nThe system supports a small number of Super User accounts. Only an existing Super User can grant Super User privileges to another account holder. Super User have the following privileges:\n\nEditing user (party) account information\nChanging a user’s parent (sponsor) and child (affiliate) links\nGranting or removing system-wide access privileges\nResetting user passwords\nMonitoring and managing the health of the system as a whole, including restarting stalled video transcoding jobs via an admin dashboard\nGenerating email related to the process for requesting authorization from an institution for specific users\n\n\n\nUser\nThe system supports user accounts with the following features and privileges:\n\nAccount creation\nRequesting authorization from an institution or individual (party)\nEditing user profile information (ORCID, web site, social media, additional email accounts, department)\nTwo tiers of access: Authorized Investigators and Affiliates.1.\n\nAuthorized Investigators are specifically linked to an authorizing institution (party) when the Super User establishes that link. Authorized Investigators can:\n\nCreate, edit, share, and unshare volumes\nCreate, edit, and delete sessions (slots) in volumes they own or co-own\nUpload, download, modify, and delete files (assets) in sessions in volumes they own or co-own\nModify which other users (Authorized Investigators or Affiliates) have access to a volume, session (slot), or file (asset); this includes removing access.\nWith regard to Affiliate, Authorized Investigators determine:\n\nThe Affiliate’s level of access to all of Databrary (no access or full access to shared data)\nThe Affiliate’s level of access to the Authorized Investigator’s data (no access; read-only access; read/write access; manager access)\n\nModify the level (sharing release level) assigned to a session (slot) or file (asset)\n\nAffiliates privileges to access restricted data on Databrary are specifically linked to one or more Authorized Investigators. The Authorized Investigator controls that link. Links should expire on a regular (timed) basis. When linked to an Authorized Investigator, Affiliates have the level of access granted by that Authorized Investigator to i) Databrary as a whole (default is none) and ii) to specific volumes owned by the Authorized Investigator.\n\n\n\n\n\nVolume Sharing Levels\n\nSee more-information/definitions.\nPrivate\nVolume Overview\nEntire Volume Shared\n\nAn Authorized Investigator has a private page that combines personal profile information and a dashboard with information about volumes, sponsors, and affiliates.\n The Dashboard consists of two columns. The left column provides information about Volumes the Authorized Investigator has created or has access to.\nThe following figure illustrates that the Volume has “Entire Volume Shared” status (unlocked lock icon; “Share Entire Volume” tooltip).\n Also, on this Volume, the user has “Investigator” status, meaning that the data can be fully edited and shared with others, as indicated by the tooltip and the crown icon):\n\nSome volumes are Private (locked lock icon), accessible only to the researcher and specific Affiliates (network icon).\n\n\nThis user also has volumes with Volume Overview Shared as indicated by the keyhole icon:\n\nSome other Authorized Investigators have also given this user read-write (pencil icon) status to their volumes that have Volume Overview Shared status:\n\nAnd still other Authorized Investigators have given this user read-only (eyeglasses icon) privileges:\n\nIn this case, it looks like the volume has been fully shared (unlocked lock icon), so the user has full read access to the volume already. Prior to the volume being fully shared, the user had read-only access to the private data.\n\n\nUser Access Privileges\n The Authorized Investigator determines what access an Affiliate has1. Other researcher’s (shared) data on Databrary and 2. the Authorized Investigator’s (shared and private) data.\nAffiliate access expires after a user-defined date.\n\nAffiliate access to other’s data\n\nNo access (default)\nAffiliate\n\n\n\nAffiliate access to an Authorized Investigator*’s data\nA user may be given privileges to a Volume by an Authorized Investigator.\n\nNo access (default) \nRead-only access\nRead/write access\nManager\n\nRead, write, create volumes, and change volume access (change sharing)",
"text": "Frontend\n\nAngularJS 1.4\nCoffee Script 1.7.1\nJQuery 1.12.3\nStylus 0.54.5 + nib 1.1.2\n\n\n\nBackend\n\nGHC 8.0.2\nHaskell 2010\nSolr 6.6\nPostgreSQL 9.5\nFFmpeg 4.2.4\n\n\n\nApplication\nDatasets are organized into separate volumes with system-wide unique (integer) identifiers. Groups of data files related to a specific person or people (or non-human animal), a date, time, and location are grouped into sessions (slots) within a volume. Individual files (assets) of varying types are organized within a session (slot). Sessions (slots) and files (assets) are assigned system-wide unique (integer) identifiers.\nIndividual users and institutions (called parties) are assigned system-wide unique identifiers and have some overlapping data elements (e.g., prename, sortname). Access privileges are granted hierarchically in a parent/child organization. For example, Databrary is the parent of New York University (NYU); NYU is the parent of Karen Adolph and multiple other Authorized Investigators; Karen Adolph is the parent of multiple Affiliate investigators who have broad access to volumes Dr. Adolph has created. Further details about how Authorized Investigators assign access permission to Affiliates can be found in the System Roles section below.\n\n\nSharing Release Levels\nRestricted data and metadata are controlled by a specific set of sharing release levels. These levels apply at the session/slot and file/asset level. Newly uploaded files default to Private. The terminology associated with these levels, the icons used to identify the levels, and the level of user access permitted by the levels are deeply embedded in the Databrary policy framework.\n\n\nAPI\nAll Databrary frontend calls use the API. The volume/slot/asset identifier scheme described previously supports API calls of the following form:\nhttps://nyu.databrary.org/volume/1/slot/9807?asset=9200\nThis call accesses the Databrary “leaf” logo in volume 1, slot (session) 9807, with asset ID 9200. Similarly, https://nyu.databrary.org/party/12 returns information about all of the Authorized Investigators who are authorized through party 12, The Pennsylvania State University.\nMost, but not all of the Databrary API is documented. If it is necessary to change the API calls in the rewrite, then the API should be versioned, and the new system should support current API calls.\n\n\nBackend Services\nAll audio and video files uploaded automatically generate transcoding jobs that are handled by the NYU HPC.\nThe system mints a Digital Object Identifier (DOI) when a volume is shared. This must continue. Databrary piggybacks on the DOI account controlled by NYU Libraries.\nThe system generates and updates standard bibliographic citations for a volume based on volume data and metadata.\n\n\nSystem roles\n\nSuper user\nThe system supports a small number of Super User accounts. Only an existing Super User can grant Super User privileges to another account holder. Super User have the following privileges:\n\nEditing user (party) account information\nChanging a user’s parent (sponsor) and child (affiliate) links\nGranting or removing system-wide access privileges\nResetting user passwords\nMonitoring and managing the health of the system as a whole, including restarting stalled video transcoding jobs via an admin dashboard\nGenerating email related to the process for requesting authorization from an institution for specific users\n\n\n\nUser\nThe system supports user accounts with the following features and privileges:\n\nAccount creation\nRequesting authorization from an institution or individual (party)\nEditing user profile information (ORCID, web site, social media, additional email accounts, department)\nTwo tiers of access: Authorized Investigators and Affiliates.1.\n\nAuthorized Investigators are specifically linked to an authorizing institution (party) when the Super User establishes that link. Authorized Investigators can:\n\nCreate, edit, share, and unshare volumes\nCreate, edit, and delete sessions (slots) in volumes they own or co-own\nUpload, download, modify, and delete files (assets) in sessions in volumes they own or co-own\nModify which other users (Authorized Investigators or Affiliates) have access to a volume, session (slot), or file (asset); this includes removing access.\nWith regard to Affiliate, Authorized Investigators determine:\n\nThe Affiliate’s level of access to all of Databrary (no access or full access to shared data)\nThe Affiliate’s level of access to the Authorized Investigator’s data (no access; read-only access; read/write access; manager access)\n\nModify the level (sharing release level) assigned to a session (slot) or file (asset)\n\nAffiliates privileges to access restricted data on Databrary are specifically linked to one or more Authorized Investigators. The Authorized Investigator controls that link. Links should expire on a regular (timed) basis. When linked to an Authorized Investigator, Affiliates have the level of access granted by that Authorized Investigator to i) Databrary as a whole (default is none) and ii) to specific volumes owned by the Authorized Investigator.\n\n\n\n\n\nVolume Sharing Levels\n\nSee more-information/definitions.\nPrivate\nVolume Overview\nEntire Volume Shared\n\nAn Authorized Investigator has a private page that combines personal profile information and a dashboard with information about volumes, sponsors, and affiliates.\n\n\n\nRick Gilmore’s private profile and dashboard.\n\n\nThe Dashboard consists of two columns. The left column provides information about Volumes the Authorized Investigator has created or has access to.\nThe following figure illustrates that the Volume has “Entire Volume Shared” status (unlocked lock icon; “Share Entire Volume” tooltip).\n Also, on this Volume, the user has “Investigator” status, meaning that the data can be fully edited and shared with others, as indicated by the tooltip and the crown icon):\n\nSome volumes are Private (locked lock icon), accessible only to the researcher and specific Affiliates (network icon).\n\n\nThis user also has volumes with Volume Overview Shared as indicated by the keyhole icon:\n\nSome other Authorized Investigators have also given this user read-write (pencil icon) status to their volumes that have Volume Overview Shared status:\n\nAnd still other Authorized Investigators have given this user read-only (eyeglasses icon) privileges:\n\nIn this case, it looks like the volume has been fully shared (unlocked lock icon), so the user has full read access to the volume already. Prior to the volume being fully shared, the user had read-only access to the private data.\n\n\nUser Access Privileges\n The Authorized Investigator determines what access an Affiliate has1. Other researcher’s (shared) data on Databrary and 2. the Authorized Investigator’s (shared and private) data.\nAffiliate access expires after a user-defined date.\n\nAffiliate access to other’s data\n\nNo access (default)\nAffiliate\n\n\n\nAffiliate access to an Authorized Investigator*’s data\nA user may be given privileges to a Volume by an Authorized Investigator.\n\nNo access (default) \nRead-only access\nRead/write access\nManager\n\nRead, write, create volumes, and change volume access (change sharing)",
"crumbs": [
"More information",
"Software"
Expand Down
Loading

0 comments on commit a504abc

Please sign in to comment.