Feature #12650

Add the ability to upload a single digital object to an authority record and supplement search/browse result stubs for authority records with thumbnails and history snippets

Added by Dan Gillean 5 months ago. Updated about 1 month ago.

Status:VerifiedStart date:11/27/2018
Priority:MediumDue date:
Assignee:-% Done:

0%

Category:ActorEstimated time:84.00 hours
Target version:Release 2.5.0
Google Code Legacy ID: Tested version:
Sponsored:Yes Requires documentation:No

Description

This new feature for authority records will allow an authenticated (i.e. logged in) user with sufficient permissions to attach a single digital object to an authority record.

The functionality will be modeled on the "Link digital object" functionality currently available in AtoM for linking a single digital object to an archival description. In many cases the digital object will be a digital image of the person, place or institution described by the authority record, but other digital objects such as a map or video could also be attached.

One change that we will be introducing (currently ONLY for digital object uploads to authority records; this ticket does not cover adding this enhancement to the description digital object upload at this time) is the ability to add user-defined alt-text, for better screen reader support or in cases where the internet connection cannot load the object.

Finally, we will also be enhancing the authority record search/browse result stubs to include:

  • A digital object thumbnail, when one is available
  • The first few lines of the related actor's history, similar to how scope and content snippets are displayed on description search/browse results
User stories
  • As an archivist I would like to upload a digital object from my computer and attach it to an authority record so I can provide non-textual information about the entity described.
  • As an archivist I would like to provide a URL to link a digital object accessible from the world wide web to an authority record so I can link to external web resources that provide additional information about the entity described.
  • As an archivist I would like to add alternative text (“alt text”) describing an authority record image so a screen reader or other assistive technology can provide a textual or audio description of the digital object.
  • As an archivist I would like to delete an authority record digital object so I can remove or replace the digital object.
  • As an unauthenticated user* when viewing an authority record I would like see a digital image representing an attached digital object, when the digital object can be represented visually (e.g. a digital image, page of a PDF, a still frame of a video)
  • As an unauthenticated user* when viewing an authority record I would like to access the alternative text of the visual representation of an attached digital object via assistive technology so I can understand the visual content or purpose.
  • As an unauthenticated user* when viewing an authority record I would like to play, in my browser, a video or audio file when one is linked to the authority record.
  • As an unauthenticated user* when browsing or searching for authority records I would like to see thumbnail images for those authority records with related digital objects that can be represented visually (e.g. a digital image, a page of a PDF document, a still frame of a video file).
  • As an unauthenticated user* when browsing or searching for authority records I would like to access the alternative text for those authority records with related digital objects via assistive technology.
  • As an unauthenticated user* when browsing or searching for authority records, I would like to the first few lines of the the authority record’s history to be included in the results, to help me better distinguish between two entities with similar names and provide more context within the result list.

(*) The role of “unauthenticated user” is specific to authentication by the AtoM software access control system, and refers to users who are not logged into the application - aka public users.

Feature 2 - Limitations
  • Only one digital object at a time may be attached to an authority record to avoid the complexity of managing multiple linked files.
  • The thumbnail image will be automatically generated by the software. A manually created thumbnail can not be substituted via the user interface.
  • The ability to edit alternative text for a digital object will be limited to the authority record digital object feature; this feature does not include scope to add alternative text to other digital objects managed by AtoM (e.g. archival description digital objects, archival institution logos).
  • The media player used for this feature be the same Flash player currently used for archival descriptions and will only work with browser that support Adobe Flash. Switching to another media player would require additional scope and budget.

edit-do-2.png - delete digital object screen of same authority record-untitled (46.4 KB) Corinne Rogers, 03/29/2019 08:41 AM

edit-do-1.png - edit digital object screen of authority record-expected behaviour (201 KB) Corinne Rogers, 03/29/2019 08:41 AM

upload-do.png - upload screen reached through named authority record-untitled (27.4 KB) Corinne Rogers, 03/29/2019 08:41 AM


Related issues

Related to Access to Memory (AtoM) - Feature #12647: Add subject and place access points to authority records Verified 11/27/2018
Related to Access to Memory (AtoM) - Feature #12651: Add an advanced search interface for authority records Verified 11/27/2018

History

#2 Updated by Dan Gillean 5 months ago

  • Related to Feature #12647: Add subject and place access points to authority records added

#3 Updated by Dan Gillean 5 months ago

  • Related to Feature #12651: Add an advanced search interface for authority records added

#4 Updated by Mike Cantelon 4 months ago

  • Status changed from New to Feedback

Looks great! You are a trooper for making that change... whew! Found one minor issue with a comment (and some nitpicks relating to Symfony's model generation).

#5 Updated by Steve Breker 4 months ago

  • Status changed from Feedback to Code Review
  • Assignee changed from Steve Breker to Mike Cantelon

Thanks Mike!! :) I've addressed the feedback items - ready for a re-review.

https://github.com/artefactual/atom/pull/833

#6 Updated by Mike Cantelon 4 months ago

  • Status changed from Code Review to Feedback
  • Assignee changed from Mike Cantelon to Steve Breker

Looks good to me!

#7 Updated by Steve Breker 3 months ago

  • Status changed from Feedback to Code Review
  • Assignee changed from Steve Breker to Mike Cantelon

Hi Mike

The second half is ready for code review!

https://github.com/artefactual/atom/pull/836

#8 Updated by Mike Cantelon 3 months ago

  • Status changed from Code Review to Feedback
  • Assignee changed from Mike Cantelon to Steve Breker

Thanks for making those changes... the PR looks good to me!

#9 Updated by Steve Breker 3 months ago

  • Status changed from Feedback to QA/Review
  • Assignee changed from Steve Breker to Dan Gillean

Hi Dan

This is now merged to qa/2.5.x.

Commit: 77f91b2909f276950ae295b55cbb8fdce589dbdc

Authority record digital obj linking, refs #12650

Allow authority records to link a single digital object. This
functionality matches the current "Link Digital Object" functionality
currently available for descriptions. This feature includes the ability
to set the alt text for the digital object - the alt text field can be
set on the digital object edit page.

Access control behaves differently from information objects. There are
no PREMIS rules for authorities. Access to these digital objects is
controlled via the existing authority record ACL controls. Editing the
digital object requires authority update permissions etc.

- Must have read privileges to view
- PDF master is always accessible to view as with Descriptions
- Create permission is needed to create an actor
- Update privileges are needed to add or update an actor linked digital object as this is technically updating the actor
- Delete privileges are needed to delete

#10 Updated by Steve Breker 3 months ago

One small fix already code reviewed by Mike:

https://github.com/artefactual/atom/pull/837

Merged to qa/2.5.x.

#11 Updated by Corinne Rogers about 1 month ago

  • Assignee changed from Dan Gillean to Corinne Rogers

#12 Updated by Corinne Rogers about 1 month ago

  • Status changed from QA/Review to Verified

this is so awesome!

#13 Updated by Corinne Rogers about 1 month ago

I have just noticed that when a digital object is uploaded to or deleted from an authority record, the upload or delete screen identifies the related authority record as "Untitled". The name of the authority record is present on the "edit digital object" screen.

Expected behaviour: name of authority record appears on upload digital object or delete digital object screens. (This is the case for archival descriptions as well.)

#14 Updated by Dan Gillean about 1 month ago

  • Status changed from In progress to Feedback

#15 Updated by Corinne Rogers about 1 month ago

  • Requires documentation changed from Yes to No

Documentation updated in 2.5 docs.

#16 Updated by Steve Breker about 1 month ago

I have created a PR to address the issue where the actor was displaying as 'Untitled' when adding or deleting digital objects.

PR: https://github.com/artefactual/atom/pull/866

Ready for code review.

#17 Updated by Mike Cantelon about 1 month ago

Other than commit header nitpick looks good to go!

#18 Updated by Steve Breker about 1 month ago

Merged to qa/2.5.x. Ready for qa.

#19 Updated by Steve Breker about 1 month ago

  • Status changed from Feedback to QA/Review
  • Assignee deleted (Steve Breker)

#20 Updated by Dan Gillean about 1 month ago

  • Status changed from QA/Review to Verified

Also available in: Atom PDF