Faces Album Management

From MPDLMediaWiki
Jump to navigation Jump to search
eSciDoc Solutions

PubMan:
Overview · Functionalities
Interfaces · Support

Faces:
Overview · Functionalities
Scope · Support

ViRR:
Overview · Functionalities
Scope · Support

imeji
Digitization Lifecycle

edit


Introduction[edit]

NOTE: Albums have been called Study Sets or - technically - Bundles before.
A small glossary for the used terms can be found under Miscellaneous.
Please enter all comments concerning the use cases on the discussion page.

As the current state of the spec focuses on R3.5, earlier states of the spec can be found in the history of this page:

UC_FAC_AM_01 Create album[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

  • The user wants to create an album to save his own selection out of the Faces collection.

Triggers

Steps

  1. The user chooses to create a new album.
  2. The system displays the edit album mask (the metadate for an album is specified in the Faces Application Profile Album. The owner of the album and his affiliated organisation will automatically be pre-filled as creator for the metadata record assigned to the album.
  3. The user enters an album name.
  4. (Optionally) The user enters additional information about the album: further creators (family name, given name) together with their affiliated organisation and a description of the album.
  5. Extension point: share album
    5.1 If the user wants to share the album with one or more other users, include UC_FAC_AM_09 Share album.
  6. Extension point: merge album content
    6.1 If the user wants to merge the content of other albums to the album, include UC_FAC_AM_13 Merge album content.
  7. The user confirms the entries.
  8. The system creates following things and displays a message (MSG_FAC_AM_01):
    • a container for the album with its metadata and, if available its content, in the state pending
    • an item for a notepad related to the album (relation: belongs to) in the state pending
  9. The use case ends successfully.

Actors Involved

  • Account user

Discussion

UC_FAC_AM_02 Add picture to album[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

  • The user wants to add pictures to one or several of his private albums.

Pre-Condition

  • The user is the owner of at least one pending album.

Triggers

Steps

  1. The user selects one picture for adding.
  2. The user selects one of his pending albums or one pending album which he is sharing where he wants to add the selected picture.
  3. The system adds the selected picture to the selected album. The use case ends successfully.

Actors Involved

  • Account user

Constraints

  • Each picture can only be added once to each album. This means that it must be visible for the user, which pictures are already in which album and which are not.

Discussion

UC_FAC_AM_03 Remove picture from album[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

  • The user wants to remove one picture from one of his private albums.

Pre-Condition

  • A pending album is selected.
  • The user is the owner of the pending album or is sharing the pending album.

Triggers

Steps

  1. The user selects one picture within the album for removing it.
  2. The system removes the selected picture from the selected album. The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_AM_04 Edit album[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

  • The user wants to edit the details of one of his own private albums.

Pre-Condition

  • A pending album is selected.
  • The user is the owner of the selected album.

Triggers

Steps

  1. The user chooses to edit the selected album.
  2. The system displays the edit album mask.
  3. (Optionally) The user edits the metadata values, adds new metadata values or modifies existing metadata values.
  4. Extension point: share album
    4.1 If the user wants to share the album with one or more other users, include UC_FAC_AM_09 Share album.
  5. Extension point: merge album content
    5.1 If the user wants to merge the content of other albums to the album, include UC_FAC_AM_13 Merge album content.
  6. The user confirms the changes.
  7. The system stores the changes and displays a message (MSG_FAC_AM_02). The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_AM_05 Delete album[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

  • The user wants to delete one of his private albums because he doesn't need it any more.

Pre-Condition

  • A pending album is selected.
  • The user is the owner of the album.

Triggers

Steps

  1. The user chooses to delete the album.
  2. The system prompts for a confirmation of the deletion. When the album was shared with other users, an adequate hint will be displayed.
  3. The user confirms the deletion.
  4. The system deletes following items and displays a message (MSG_FAC_AM_03):
    • the pending album (When the album was shared with other users (active or inactive), they will get a notification.)
    • the note pad(s) related to the album
  5. The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_AM_06 Release album[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R2

Motivation

  • The user wants to publish one of his private albums. Afterwards, the album details will be accessible for the public and every account user can view the pictures in it.

Pre-Condition

  • A pending album is selected.
  • The user is the owner of the album.

Triggers

Steps

  1. The user chooses to release the album.
  2. The system prompts for a confirmation of the releasing.
  3. The user confirms the releasing.
  4. The system changes the state of the album to released (it automatically goes to submitted and then to released) and displays a message (MSG_FAC_AM_04). The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_AM_07 Withdraw album[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R2

Motivation

  • The user wants to withdraw one of his published albums because the album should no longer be accessible via the collection.

Pre-Condition

  • A released album is selected.
  • The user is the owner of the album.

Triggers

Steps

  1. The user chooses to withdraw the album.
  2. The system prompts for a reason for the withdrawal.
  3. The user enters a reason and confirms the withdrawal.
  4. The system changes the state of the item to “withdrawn” and stores the withdrawal comment. The system displays a message (MSG_FAC_AM_05). The use case ends successfully.

Alternatives

3a. The user canceled the withdrawal. The use case ends without success.

Actors Involved

  • Account user

UC_FAC_AM_08 Export album[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R2

Motivation

  • The user wants to export the pictures and/or the metadata of the pictures of one album.

Pre-Condition

  • An album is selected.

Triggers

Steps

  1. The user chooses to export the pictures of an album.
  2. The system displays the export album mask.
  3. The user selected one export format (plain CSV, CSV-file and pictures in ZIP-file, pictures only in ZIP-file, XML-file and pictures in ZIP-file, XML only).
  4. If the user chooses an export format which includes the pictures, the user selects one or more picture resolutions (thumbnail, web resolution 819x1024, original resolution 2835x3543).
  5. The user confirms his selection(s).
  6. The system displays the short version of the faces release agreement.
  7. The user accepts the release agreement.
  8. The system creates the required data in the required export format and puts all files together with the faces release agreement in a zip-file, which is made available for saving for the user. In addition, the system updates the export statistics. The use case ends successfully.

Actors Involved

  • Account user

Alternatives

8.a The user does not accept the release agreement. The use case ends without success.

UC_FAC_AM_09 Share album[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

Pre-Condition

  • One album is selected.
  • The user is the owner of the album.

Triggers

Steps

  1. The user chooses to share the selected album.
  2. The system displays the shared user entry mask (either via an exact nickname (user-id) search or via entering the email address of the user; for further details please see the discussion page).
  3. The user enters one or more users, decides if he wants to share the corresponding album, too (per default it will not be shared), and confirms his input.
  4. The system adds the selected users as inactive shared users to the album and sends each of them a notification. If the note pad shall be shared, too, the inactive shared users will be added to the note pad, too. The use case ends successfully.

Actors Involved

  • Account user

Comment

  • Based on the new concepts for the "institutional visibility", also pending containers should be able to share.

UC_FAC_AM_10 Confirm shared user[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

  • An album owner offers another Faces user the possibility to share one of his albums. Now the user has to decide if he wants to confirm this privileges or if he wants to refuse them. See more details below: Scenario Sharing of an album.

Pre-Condition

  • The user got a notification that another user wants to share one of his albums with him.

Steps

  1. The user chooses
  2. The user confirms the sharing of the album.
  3. The system changes the state of the user from inactive to active (for the album and the corresponding note pad), adds the shared user (name and affiliated organization) as "further authors" to the album and updates the album metadata. From now on, the shared album will be displayed in "My albums" of the shared user.

Alternatives

  • The user does not confirm the sharing.
  • The system removes the user from the list of inactive shared users of the album and, if the note pad shall be shared, too, also from the corresponding note pad. The use case ends without success.

Actors Involved

  • Account user

UC_FAC_AM_11 Unshare Album[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

Pre-Condition

  • One pending album is selected.
  • The user is the owner of the album.

Triggers

Steps

  1. The user chooses to remove one or more shared users of the selected album.
  2. The system displays the names of all shared users.
  3. The user deletes one or more of the shared users and confirms his choice.
  4. The system updates the shared user list of the album and the corresponding note pad (it's only possible to share the note pad when sharing the related album) and sends all deleted users a notification. The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_AM_12 Copy album content[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

  • The user wants to copy the content (pictures) of an album.

Pre-Condition

  • One album is selected.
  • The album is in the state released or pending (when the user is the owner of the album).

Triggers

Steps

  1. The user chooses to create a new album by copying the content of the selected album. The new album automatically contains the pictures of the selected album.
  2. Continue with UC_FAC_AM_01 Create album

Actors Involved

  • Account user

Comments

UC_FAC_AM_13 Merge album content[edit]

Status/Schedule

  • Status: in specification
  • Schedule: R3.5

Motivation

  • The user wants to merge the content (= pictures) of one or more album(s) to another (new created) album. Part of this is that he wants to create a new album with the content of several already available albums.

Pre-Condition

  • One pending album is selected.
  • The user is the owner of the album.

Triggers

Steps

  1. The user chooses to merge the whole content (= pictures) of one or more already existing albums to the selected album.
  2. The system displays a list with all pending albums the user is the owner of and all published albums.
  3. The user selects one or more of the displayed albums and confirms his choice.
  4. The system adds all pictures of the in step 3 selected albums to the selected album. Pictures which already exist in the album will not be added once again. The system displays a message (MSG_FAC_AM_06). The use case ends successfully.

Actors Involved

  • Account user

Comments

Additional Information[edit]

Further information about an album can be found in the Faces Application Profile Album.

Album States[edit]

An album can have three different states:

  • pending: The album is created, can be edited by the user himself and can be shared with other selected users.
  • released: The album is visible for all Faces users and can not be edited any more.
  • withdrawn: The album is only visible for users who know the exact URL.

Sharing of an album[edit]

Share an album

  1. Pending
    • Each user can share an own pending album with other users (for the states released and withdrawn sharing an album does not make sens).
    • Sharing an album means that next to the owner of the album also further selected users can add and remove pictures from it. Further on, based on a separate permission per album, these users are also allowed to edit the note pad of the album. But they can not edit the album itself (change the metadata), release, delete or withdraw it.
    • For sharing an album, the owner has to select one or more shared users. Now these users are inactive shared users, which will be communicated to them by the Faces system.
    • To work as a shared user, the still inactive shared user has to activate his privileges. During this activation, the shared user (with his affiliated organisation) will automatically be inserted as further author of the album (this data can be edited by the owner of the album). After that, he can work with the shared album.
    • The owner gets all information about which users in which state are sharing the album in his "My Albums" list.
    • The shared users will only see all active shared users (not the inactive ones, because they have not yet confirm their participation).
    • On the album view, also all active shared users will be displayed.
  2. Delete
    • It can happen that the author wants to delete an shared album. If he does so, all active and inactive shared users will get a notification from the system.
  3. Released / Withdrawn
    • When the album will be released (or later on withdrawn), all information of the shared authors is still visible for the owner (and the shared authors) in their "My albums" list.
    • On the album view, the owner is displayed as "Author" and the shared users are displayed as "Further Authors". More information is not available.

Working with a shared album

  • It could happen that more users are adding and removing pictures from the same album at the same time. In this situation, each step only needs a second.
    1. The system always saves the latest version. If an user try to remove a picture which has been previously removed by an other user, the FW will return an exception which can be handled as an error message.
      If another user wants to add a member to an older version of an album, then we have to provide the information that the album has been changed in a meantime by another user and /or ask the user to reload the latest version of the album. Once this is done, the image (if added by other user) will be marked as member of the album and will not be possible to add it again (as this is what Faces already takes care of).--Natasa 17:26, 4 November 2008 (UTC)
    2. In the "My Albums" list and in the album view, always the user who has done the last modification, is displayed.
    3. It will not be offered by the system to view older versions of the album. Therfore it would be good when for shared albums each user comments his changes in the note pad. But thats only a recommendation. It will not be controlled by the system.

Unshare an album

  • The owner of an album is possible to delete a shared user of his album. That action includes, that the prior shared user will get a notification by the system.
  • When a shared user will be deleted, he will not be visible any more on any lists as shared user. But he is still a "Further Author" of the album. If thats not correct any more, the owner of the album has to delete this, too.
  • It is not possible that shared users (after they have confirmed their participation), delete themselves from the list of shared users. If they really want this, they have to contact the owner, who can remove them.

Shared user states

  • A shared user can have following states:
  • inactive: The owner of an album offers the user the possibility to share his album.
  • active: The user has confirmed the invitation to share an album of another user. Now he has the privileges to add and remove pictures from the album.

Further Development[edit]

1. Controlled Vocabulary

  • perhaps in a later step, the adding of authors (with their corresponding affiliations) can be based on normed files like in PubMan.

Use Case

Comma-Separated Values

Extensible Markup Language

Uniform Resource Locator

Coordinated Universal Time

Publication Management

Retrieved from "https://colab.mpdl.mpg.de/mw010/index.php?title=Faces_Album_Management&oldid=25616"