Faces Album Management

eSciDoc Solutions PubMan: Overview · Functionalities Interfaces · Support Faces: Overview · Functionalities Scope · Support ViRR: Overview · Functionalities Scope · Support imeji Digitization Lifecycle edit

Introduction

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:

• The spec for R2
• The spec for R3

UC_FAC_AM_01 Create album

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

• This use case can be included by the use cases
  • UC_FAC_AM_12 Copy album content

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. The user confirms the entries.
6. The system creates an album (container) with the given metadata in the state pending, a private notepad (item) for the album owner related to the album in the state pending and displays a message (MSG_FAC_AM_01). When the use case war triggered by UC_FAC_AM_12 Copy album content, also the content of the selected albums will be saved. The use case ends successfully.

Actors Involved

• Account user

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_01_Create_album

UC_FAC_AM_02 Add picture to album

Status/Schedule

• Status: in specification
• Schedule: R3.5

Motivation

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

Pre-Condition

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

Steps

1. The user selects one picture for adding.
2. 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

• Talk:Faces_Album_Management#UC_FAC_AM_02_Add_picture_to_album

UC_FAC_AM_03 Remove picture from album

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

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details

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

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_03_Remove_picture_from_album

UC_FAC_AM_04 Edit album

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

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details

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 and confirms the changes.
4. The system stores the changes and displays a message (MSG_FAC_AM_02). The use case ends successfully.

Actors Involved

• Account user

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_04_Edit_album

UC_FAC_AM_05 Delete album

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

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details

Steps

1. The user chooses to delete the album.
2. The system prompts for a confirmation of the deletion. When the album is shared with other users the system displays a message (MSG_FAC_AM_06) and lists all shared user names of the album.
3. The user confirms the deletion.
4. The system deletes the selected album, all related note pads and displays a message (MSG_FAC_AM_03). When the album was shared with other active users, they will get a notification of the deletion of the album via e-mail. The use case ends successfully.

Actors Involved

• Account user

Comments

• The deletion of albums is also available as batch operation. Therefore, the use case is also valid for several albums in one step.

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_05_Delete_album

UC_FAC_AM_06 Release album

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

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details

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

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_06_Release_album

UC_FAC_AM_07 Withdraw album

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

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details

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

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_07_Withdraw_album

UC_FAC_AM_08 Export album

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

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details

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

Status/Schedule

• Status: in specification
• Schedule: R3.5

Motivation

• The user wants to share one of his private albums with one or more Faces users.
• See more details below in the scenario "Sharing of an album".

Triggers

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details

Pre-Condition

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

Steps

1. The user chooses to share the selected album.
2. The system displays the share album entry mask. The user enters for each shared user an valid e-mail address and confirms his input.
3. The system saves each e-mail as inactive shared users to the album and sends each of them a notification. Further on, a shared note pad (item) in the state pending will automatically created by the system and related to the album. The use case ends successfully.

Actors Involved

• Account user

Remarks

• Based on the new concepts for the "institutional visibility", also pending containers should be able to share.
• Usage of user groups for the sharing of an album is discussed on the discussion page.

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_09_Share_album.

UC_FAC_AM_10 Confirm shared user

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 in the scenario "Sharing of an album".

Pre-Condition

• One user is selected.
• The selected user got an e-mail that another user wants to share one of his albums with him.

Steps

1. The selected user chooses to confirm the the sharing of the album by following the link provided in the e-mail.
2. Extension point: log on to the system

   2.1 If the user is not logged on to the Faces system, include UC_FAC_UM_01 Log on to the system.

3. Extension point: view my albums

   3.1 When the user is logged on to the Faces system, include UC_FAC_BD_05 View my albums.

4. The system changes the state of the user to active, creates a private note pad related to the album for the user and adds the shared user (name and affiliated organization) as "further authors" to the album metadata. From now on, the shared album is visible for the shared user. The use case ends successfully.

Actors Involved

• Account user

Remarks

• When a user does not want to share the album, he just ignored the mail invitation.

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_10_Confirm_shared_user.

UC_FAC_AM_11 Unshare album

Status/Schedule

• Status: in specification
• Schedule: R3.5

Motivation

• The owner of the album wants to remove one or more shared users of one of his albums.
• See more details below in the scenario "Sharing of an album".

Pre-Condition

• One pending album is selected.
• The user is the owner of the album.
• The album is shared at least with one shared user.

Triggers

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details

Steps

1. The user chooses to remove one or more shared users (active or inactive) of the selected album.
2. The system displays a list of all shared users with their states (for active users the user name is displayed and for inactive users the provided e-mail address as the user name is still not known).
3. The user deletes one or more of the shared users.
4. The system updates the shared users of the album and sends all deleted active users a notification via e-mail. The use case ends successfully.

Actors Involved

• Account user

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_11_Unshare_album.

UC_FAC_AM_12 Copy album content

Status/Schedule

• Status: in specification
• Schedule: R3.5

Motivation

• The user wants to copy/merge the content (pictures) of one or more albums to another (new created) album.

Pre-Condition

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

Triggers

• This use case can be included by the use cases
  • UC_FAC_BD_04_View album details
  • UC_FAC_BD_05 View my albums
  • UC_FAC_BD_06 View released albums

Steps

1. The user chooses to create a new album which already contains the content (= pictures) of the selected album(s).
2. Continue with UC_FAC_AM_01 Create album.

Actors Involved

• Account user

Comments

• It's not possible to extend an album with pictures of another album. For Copying the content of an album, always a new album has to be created.

Discussion

• Talk:Faces_Album_Management#UC_FAC_AM_12_Copy_album_content.

Additional Information

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

Album States

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

Share an album

• 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. But they can not edit the album itself (change the metadata), release, delete or withdraw it.
• Each shared user of the album gets a own note pad related to the album. Further on, a shared note pad for all shared users is available.
• 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.

Selecting an shared user

1. The owner of the album has to enter a valid e-mail address of the user he wants to share the album.
2. The inactive shared user will get a notification via e-mail.

Activation of the shared user role

1. The inactive shared user has to confirm the sharing of the album by following a link within the e-mail.
   • When the user is already logged in this link goes to the "my albums" list within Faces.
   • When the user is not logged in, he first has to log on to the system and will then come to his "my albums" list.
2. The confirmation is finished and the state of the user changes to active. 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).

Display of shared albums

1. "My albums" list
   1. Of the album owner: a remark that the album is shared, the owner of the album
   2. Of an shared user: a remark that the album is shared, the owner of the album
2. Detailed view of an album (only relevant for shares albums)
   1. Of the album owner: all shared users (user names for active users and e-mail address for inactive users)
   2. Of an shared user: active shared users (user names), owner of the album

Delete a shared album

• It can happen that the owner wants to delete an shared album. If he does so, all active shared users will get an e-mail notification from the system (via the e-mail address saved in the admin solution).

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)

Versioning of an album

• All shared users (incl. the owner) of an album will have the possibility to view the technical event log of the album.
• To save also the intellectual changes of an album, all users are recommended to comment their changes in the shared note pad.

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

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