Feature #13388

FEATURE: Improve digital object metadata display for archival descriptions

Added by Peter Van Garderen almost 2 years ago. Updated 8 months ago.

Status:VerifiedStart date:08/27/2020
Priority:MediumDue date:
Assignee:-% Done:

50%

Category:Digital object
Target version:Release 2.7.0
Google Code Legacy ID: Tested version:
Sponsored:Yes Requires documentation:

Description

Problem statement: When viewing digital object metadata, the current AtoM user is not sure whether they’re viewing technical metadata for the original digital object, a preservation system (e.g. Archivematica) copy or an access copy. If a file has been uploaded from Archivematica, it has five representations:
  1. Archivematica original file
  2. Archivematica preservation copy
  3. AtoM master file
  4. AtoM reference copy
  5. AtoM thumbnail copy

In addition to it being unclear which representation the current digital object metadata is referring to, it also not obvious to the user whether they can access a given file representation.

Proposed solution: It is assumed that: neither an authenticated nor an unauthenticated (anonymous) user is able to download an Archivematica Preservation copy (if it exists). This functionality is not offered by AtoM.

An authenticated user is allowed to:
  • Download an Archivematica AIP or File (if they exist)
  • Access an AtoM Master file
  • Access the AtoM Reference and Thumbnail copy
An unauthenticated (anonymous) user:
  • May never download an Archivematica AIP or File
  • May only access an AtoM Master, Reference or Thumbnail file if the AtoM permissions have been set to allow it.
  • May be shown a conditional statement for any of the five representations they are not allowed to access. (e.g. “May be accessed onsite by an authorized user.”)

AtoM can display conditional access statements for Master files, Reference copies and Thumbnail copies using the existing AtoM Permissions module. A new “Preservation system access statement” section will be added to the Permissions module to display access statements for the Archivematica representations (see attached wireframe).

Information will be listed for each of the five digital object representations in the Digital Object Metadata section (assuming that two Archivematica copies exist). See the attached wireframes.

A black icon next to representation metadata indicates that the file is available for access (i.e. download from AtoM). A greyed out icon indicates that the user does not have permission to access the file in AtoM. If a file is available for download according to the Permission rules, its filename will be an active hyperlink (see attached wireframes).

The representations will be divided into a "preservation copies" (i.e. Archivematica) and "access copies" (i.e. AtoM) section. These will be inside a collapsible div.

To support these proposed UI enhancements for digital object representations display, AtoM will allow for an administrator to set visible elements display for each representation. There will be an on/off toggle option for each field shown for each representation in the UI wireframe examples. If there are zero field names enabled for a representation then that section and its section label are not displayed at all in the Digital Object Metadata section.

preservation-system-access-statement.png - Preservation system access statement (285 KB) Peter Van Garderen, 07/17/2020 06:25 PM

digital-object-display-authenticated-user.png - Digital object metadata display - authenticated user (266 KB) Peter Van Garderen, 07/17/2020 06:25 PM

digital-object-display-anonymous-user.png - Digital object metadata display - anonymous user (278 KB) Peter Van Garderen, 07/17/2020 06:25 PM

digital-object-display-anonymous-no-onsite-permissions.png - Digital object metadata display - anonymous user (no permission statements) (202 KB) Peter Van Garderen, 07/17/2020 06:25 PM

issue_13388_filename_link_bug.jpg (77.8 KB) David Juhasz, 09/18/2020 01:53 PM


Subtasks

Task #13410: Digital object display enhancements requires migration of...NewPeter Van Garderen

Bug #13417: Digital object preservation copy display uses UTC timestampsVerifiedDouglas Cerna


Related issues

Related to Access to Memory (AtoM) - Bug #13419: User group permissions for Authority Record digital objec... New 09/18/2020
Related to Access to Memory (AtoM) - Bug #13543: Regression - digital object metadata about remote digital... Verified 07/14/2021

History

#1 Updated by Peter Van Garderen almost 2 years ago

  • Description updated (diff)

#4 Updated by David Juhasz over 1 year ago

I just encounter a 500 error as a logged in user while attempting to view an Authority Record with a digital object.

PHP threw a Fatal Error trying to access the non-existent QubitActor->originalFileName property:

2020/09/17 22:53:25 [error] 4791#4791: *1 FastCGI sent in stderr: "PHP message: Unknown record property "originalFileName" 
on "QubitActor"" while reading response header from upstream, client: 10.10.10.1, server: _, request: 
"GET /juhasz-david-joseph HTTP/1.1", upstream: "fastcgi://unix:/var/run/php7.3-fpm.atom.sock:", host: "10.10.10.10", 
referrer: "http://10.10.10.10/juhasz-david-joseph" 

#5 Updated by David Juhasz over 1 year ago

  • Status changed from QA/Review to Code Review

I created https://github.com/artefactual/atom/pull/1191 with a fix for the 500 error viewing an actor with a digital object.

#7 Updated by David Juhasz over 1 year ago

Douglas, I noticed one other minor issue with the Authority Record DO metadata display - As an unauthenticated user I can't view the master digital object (correct behaviour), but the Digital object metadata > File name displays as a hyperlink, with an "href" of "http://10.10.10.10/?". See attached screenshot.

#8 Updated by Douglas Cerna over 1 year ago

David, I tested this and noticed that the default Read permission of the anonymous group on authority records is Grant. I've been assuming this is what protects access to actor related DOs.

But after looking at some of the parts involved:

I'm starting to think we might need to change https://github.com/artefactual/atom/blob/3fd98a458c973d52473c11b00c7076289ddd0182/apps/qubit/modules/digitalobject/actions/metadataComponent.class.php#L67 to:

$this->canAccessMasterFile = sfContext::getInstance()->user->isAuthenticated();

or viceversa?

#9 Updated by Peter Van Garderen over 1 year ago

  • Subject changed from FEATURE: Improve digital object metadata display to FEATURE: Improve digital object metadata display for archilval descriptions

#10 Updated by Peter Van Garderen over 1 year ago

  • Subject changed from FEATURE: Improve digital object metadata display for archilval descriptions to FEATURE: Improve digital object metadata display for archival descriptions

#11 Updated by Peter Van Garderen over 1 year ago

@david @douglas I realize that Authority Records are using the same digital object templates that we enhanced for archival descriptions and which are now causing this bug. It's good that we found this early but for the feature on this particular ticket only archival descriptions were ever in scope. All the QA tests for archival descriptions have passed successfully. Part of the issue is that user configurable permissions for Authority Records are not as fine-grained as they are for archival descriptions. Eg, we can't set Authority Records > "Access Master" to "Deny" to hide this problem. Of course, even if we could we should still fix the fact that it is using a bogus hyperlink when the user does have access to the Authority Record Master. This is a long way of saying I think we should split this issue into a separate one for Authority Record DO display so that we can move on with QA for Archival Description DO display. I've renamed this ticket accordingly and will move the bug report into a separate but related ticket.

See [[https://projects.artefactual.com/issues/13420]] -- Authorty record digital objects have broken hyperlink for Master records

#12 Updated by Peter Van Garderen over 1 year ago

  • Related to Bug #13419: User group permissions for Authority Record digital objects don't exist added

#13 Updated by Peter Van Garderen over 1 year ago

  • Status changed from Feedback to Document
  • Assignee changed from Douglas Cerna to Peter Van Garderen

QA passed on all enhancements for archival description digital object display:

When an AtoM user links a digital object to an archival description:

Then the "Digital object metadata" section on the archival description view page will include an "Access Copies" subsection.

And an unauthenticated user will not see a digital object and its "Access copies" metadata if the archival description it is attached to has a "draft" instead of "published" status.

And Clicking on the "Access copies" subsection label link will collapse or expand the subsection.

And the "Access Copies" subsection will include metadata about the "Master file", "Reference copy", and "Thumbnail copy" representations of the digital object. Specifically: filename, media type, mime-type, filesize, and uploaded.

And an administrator user can toggle the display of specific "Digital object metadata" section fields on or off in the Admin > Settings > Visible Elements section. This only affects display for unauthenticated users. Any authenticated users will see all metadata elements in each section as long as those fields contain a value.

And when the Reference representation or Thumbnail representation is deleted via the "Edit digital object" page, then the "Reference copy" and/or "Thumbnail copy" metadata is no longer displayed on the archival description view page. Additionally, the thumbnail is not show on Browse pages and the reference copy is not displayed on view pages.

And filename for each representation is either shown as plain text or as a hyperlink. If it is a hyperlink, it indicates that this user has access to this representation. Clicking on the hyperlink will load this representation.

And if the filename is in hyperlink format, the icon underneath the "Master file", "Reference copy", and "Thumbnail copy" label is coloured black. It is coloured grey if the user does not have access and the hyperlink is not shown.

And access to the "Master file", "Reference copy", and "Thumbnail copy" can be configured per user group. The "Access master", "Access reference", and/or "Access thumbnail" permission can be set to "Grant" or "Deny" for any user group, including unauthenticated ("anonymous") users.

And access to the "Master file", "Reference copy", and "Thumbnail copy" may be overridden by actionable PREMIS rights configured for individual archival descriptions and their digital object. If a PREMIS right is added to an archival description where the "Act" is "Disseminate" and the "Restriction" is "Disallow", then the hyperlinks in the Digital object metadata section are no longer active, all the document icons are coloured grey, and the reference copy of the digital object is no longer displayed on the archival description view page. Instead the customizable text of the "Disallow statement" is displayed at the top of the page as well as in a "Permissions" field for each Access copy representation (e.g. "Access to this record is restricted because it contains personal or confidential information. Please contact the Reference Archivist for more information on accessing this record.").

And if the "Restriction" is changed to "Conditional" and the default permission settings are enabled then the "Reference copy" and "Thumbnail copy" become available again as hyperlinks and these representations are once again displayed on the AtoM templates. The customizable text for the "Condition Statement" is displayed in a "Permissions" field for the "Master file" representation (e.g. "This record has not yet been reviewed for personal or confidential information. Please contact the Reference Archivist to request access and initiate an access review.").


When a user of a preservation system (e.g. Archivematica) has sent a DIP upload to an archival description slug in AtoM.

Then an authenticated user is able to see thumbnails of the digital objects from the DIP in the digital object carousel when navigating to this AtoM slug.

And an unauthenticated user will not see a digital object and its metadata if the archival description it is attached to has a "draft" instead of "published" status.

When selecting one of the digital objects included in the DIP upload,
Then the "Digital object metadata" section on the archival description view page will include a "Preservation Copies" and "Access Copies" subsection.

And clicking on either of these subsection label links will collapse or expand the subsection.

And the "Preservation Copies" subsection will include metadata about the "Original file" and "Preservation copy" representations that are stored in the preservation system.

And if the preservation system did not generate a preservation copy then only "Original file" metadata is shown.

And the "Preservation copy" metadata elements include filename, filesize, and normalized.

And if the preservation action system statement option is enabled then the user will also see a "Permissions" field with custom text that is populated by an Administrator (e.g. "Access only provided on research room computer.")

And the "Original file" metadata may includes filename, file format name, file format version, format registry key, format registry name, filesize, and ingested.

And if the preservation action system statement option is enabled, the user will also see a "Permissions" field with custom text that is populated by an Administrator (e.g. "Access only provided on research room computer.")

And an administrator user can toggle the display of specific "Digital object metadata" section fields on or off in the Admin > Settings > Visible elements section. This only affects display for unauthenticted users. Any authenticated users will see all metadata elements in each section as long as those fields contain a value.

And if the user is logged in and belongs to the "authenticated" group, then they will also see the File UUID and AIP UUID for the Original file.

And if the preservation copies came from the Archivematica preservation system and AtoM has enabled the "arStorageServicePlugin" then authenticated users with Download AIP permissions will also see a "Download file" and "Download AIP" link next to each UUID. Clicking on them will fetch the file or the full AIP from the preservation system.

And if the user has "Download file" and "Download AIP" permissions then the box icon under the "Original file" label will be coloured black. Otherwise it is coloured grey.

And since access to the preservation copy is only available via the preservation system, the box icon under the "Preservation copy" label is always coloured grey.

When the preservation system uploads a DIP with digital objects to AtoM, it will generate "Master file", "Reference copy", and "Thumbnail copy" representations with metadata displayed in the "Access copies" subsection.

#14 Updated by Peter Van Garderen over 1 year ago

  • Status changed from Document to Verified

#15 Updated by Dan Gillean over 1 year ago

  • Category set to Digital object

#16 Updated by Peter Van Garderen over 1 year ago

  • Status changed from Verified to In progress
  • Assignee changed from Peter Van Garderen to Douglas Cerna

The links added to the Reference copies section enable users to download high-quality audio and visual reference copies without first having to acknowledge a copyright usage statement, as is done with Master files. For this reason, the link to Reference copies will be removed from the digital object metadata section. If the user has permission to view a copy of the Reference copy (e.g. at the top of the archival description view page) the icon for in the Reference copy metadata section will remain black to indicate that the user is able to access it (just not download it directly via a hyperlink).

#17 Updated by Douglas Cerna over 1 year ago

PR submitted https://github.com/artefactual/atom/pull/1207

Instead of removing the link to the reference copy altogether we decided to make it available only if the user is authenticated.

#18 Updated by Douglas Cerna over 1 year ago

  • Status changed from In progress to QA/Review

#19 Updated by Peter Van Garderen over 1 year ago

  • Status changed from QA/Review to Document
  • Assignee changed from Douglas Cerna to Peter Van Garderen

I've tested this change with images, audio and video files and it's working as expected for all three.

An unauthorized user is able to see the reference copy at the top of the archival description but the hyperlink to the reference copy is gone from the digital object metadata section. The icon is black to indicate that the unauthorized user is able to play/see the file in the archival description view.

For an authorized user, the link to the reference copy becomes active in the digital object metadata section. As well, for audio and video files a "Download movie" or "Download audio" link appears below the file in the HTML5 player, but only for authorized users.

#21 Updated by Dan Gillean 10 months ago

  • Related to Bug #13543: Regression - digital object metadata about remote digital objects no longer displayed added

#23 Updated by Dan Gillean 8 months ago

  • Status changed from Document to Verified

Also available in: Atom PDF