Difference between revisions of "Faces Browse and Display"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(136 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{ESciDoc Solutions}}
{{Faces}}


 
= Introduction =
== Introduction ==


A small glossary for the used terms can be found under [[Faces_Miscellaneous#Glossary|Miscellaneous]].<br/>
A small glossary for the used terms can be found under [[Faces_Miscellaneous#Glossary|Miscellaneous]].<br/>
Please enter all comments concerning the use cases on the [[Talk:Faces_Browse_and_Display|discussion page]].
Please enter all comments concerning the use cases on the [[Talk:Faces_Browse_and_Display|discussion page]].


As the current state of the spec focuses on R3, earlier states of the spec can be found in the history of this page:
As '''the current state of the spec focuses on a new release''', earlier states of the spec can be found in the history of this page:
* The [http://colab.mpdl.mpg.de/mediawiki/index.php5?title=Faces_Browse_and_Display&oldid=18602 spec for R2]
* The [http://colab.mpdl.mpg.de/mediawiki/index.php5?title=Faces_Browse_and_Display&oldid=18602 spec for R2]
* The [http://colab.mpdl.mpg.de/mediawiki/index.php5?title=Faces_Browse_and_Display&oldid=20448 spec for R3]
= Pictures =


== UC_FAC_BD_01 View picture list ==
== UC_FAC_BD_01 View picture list ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: implemented
* Status: Implemented
* Schedule: '''R1'''
* Schedule: '''R1'''


Line 22: Line 24:
** [[Faces_Searching#UC_FAC_SR_01_Search|UC_FAC_SR_01 Search]]
** [[Faces_Searching#UC_FAC_SR_01_Search|UC_FAC_SR_01 Search]]
** [[Faces_Searching#UC_FAC_SR_02_View_all_pictures_of_one_person|UC_FAC_SR_02 View all pictures of one person]]
** [[Faces_Searching#UC_FAC_SR_02_View_all_pictures_of_one_person|UC_FAC_SR_02 View all pictures of one person]]
** [[Faces_Browse_and_Display#UC_FAC_BD_04_View_album_details|UC_FAC_BD_04_View album details]]
** [[Faces_Searching#UC_FAC_SR_04_Do_simple_search|UC_FAC_SR_04 Do simple search]]
** [[Faces_Browse_and_Display#UC_FAC_BD_04_View_album_details|UC_FAC_BD_04 View album details]]


'''Steps''' <br/>
'''Steps''' <br/>
# The user chooses to view the whole list of available pictures or executed one of the above mentioned use cases.
# The user chooses to view the whole list of available pictures or executed one of the above mentioned use cases.
# The system displays the number of pictures and the list of pictures ('''list view'''). The defaults for the sorting order and the number of hits per page are given by the system (by default: sorted by emotion, number of hits per page:12).
# The system displays the pictures list in the default display type (Picture View) and the number of hits. The defaults for the sorting order and the number of hits per page are given by the system:
#* Sorted by Emotion (default)
#* sorted by Emotion (alphabetically: anger, disgust, fear, happiness, neutrality and sadness) - Person-ID (ascending) - Picture Set (ascending)
#: Emotion (alphabetically: anger, disgust, fear, happiness, neutrality and sadness) - Person-ID (ascending) - Picture Set (ascending)
#* number of hits per page: 12
# (Optionally) The user changes the sorting order of the first sorting criteria.
# (Optionally) The user changes the display type of the picture list.
#: 3.1 The system displays the picture list depending from the first sorting criteria in the following order (by default all sorting criteria are ascending):
#: 3.1 The system displays the picture list in the selected display type.
#::* by Age - Person ID - Emotion - Picture Set
# (Optionally) The user changes the sorting order by changing one or several sorting criteria, one or several ascending/descending arrows and confirms his choice.
#::* by Emotion - Person-ID - Picture Set
#: 4.1 The system displays the picture list depending on the selected sorting criteria.
#::* by Gender - Person-ID - Emotion  - Picture Set
# (Optionally) The user chooses another number of hits to be displayed per page (12, 24, 60, 90).
#::* by Person-ID - Emotion - Picture Set
#: 5.1 The system displays the picture list with the selected number of hits per page.
#::* by Picture Set - Person-ID - Emotion
# (Optionally) The user changes the sorting order of the second, third or forth sorting criteria.
#: 4.1 The system displays the picture list in the selected sorting order.
# (Optionally) The user changes the ascending/descending order of a sorting criteria.
#: 5.1 The system displays the picture list in the selected sorting order.
# (Optionally) The user chooses another number of hits to be displayed per page.
#: 6.1 The system displays the picture list containing the selected number of hits per page.
# (Optionally) The user goes to a special page, to the last page or to the first page.
# (Optionally) The user goes to a special page, to the last page or to the first page.
#: 7.1 The system displays the selected page.
#: 6.1 The system displays the selected page.
# Extension point: '''add pictures to album'''
#: 7.1 If the user wants to add pictures to one of his (shared) private albums, include [[Faces_Album_Management#UC_FAC_AM_02_Add_picture_to_album|UC_FAC_AM_02 Add picture to album]].
# The use case ends successfully.
# The use case ends successfully.


Line 59: Line 57:
'''Steps''' <br/>
'''Steps''' <br/>
# The user selects one picture.
# The user selects one picture.
# The system displays the picture in the web resolution ('''detailed view''') and all available attributes of the picture. The use case ends successfully.
# The system displays the picture in the web resolution ('''detailed view''') and all available attributes of the picture.
# Extension point: '''add pictures to album'''
#: 3.1 If the user wants to add pictures to one of his (shared) private albums, include [[Faces_Album_Management#UC_FAC_AM_02_Add_picture_to_album|UC_FAC_AM_02 Add picture to album]].
# The use case ends successfully.


'''Actors Involved''' <br/>
'''Actors Involved''' <br/>
Line 77: Line 78:
'''Steps''' <br/>
'''Steps''' <br/>
# The user chooses to view the picture for comparison (same image from the other picture set).
# The user chooses to view the picture for comparison (same image from the other picture set).
# The system displays the picture for comparison next to the selected one in the web resolution. The use case ends successfully.
# The system displays the picture for comparison next to the selected one in the web resolution.  
# Extension point: '''add pictures to album'''
#: 3.1 If the user wants to add pictures to one of his (shared) private albums, include [[Faces_Album_Management#UC_FAC_AM_02_Add_picture_to_album|UC_FAC_AM_02 Add picture to album]].
# The use case ends successfully.


'''Actors Involved''' <br/>
'''Actors Involved''' <br/>
* User
* User
= Albums =


== UC_FAC_BD_04 View album details ==
== UC_FAC_BD_04 View album details ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in design
* Status: implemented
* Schedule: '''''R3'''''
* Schedule: '''R3''' ''(without sharing and note pads)''


'''Motivation''' <br/>
'''Motivation'''  
* The user wants to view the details of an album.
* The user wants to view the details of an album.


'''Pre-Condition''' <br/>
'''Triggers'''
* This use case can be included by following use cases
:* [[Faces_Browse_and_Display#UC_FAC_BD_05_View_album_list|UC FAC BD 05 View album list]]
 
'''Pre-Condition'''
* One album is selected.
* One album is selected.
* Further pre-conditions are based on the state of the album:  
* Further pre-conditions are based on the state of the album:  
Line 97: Line 107:
: '''withdrawn:''' None.
: '''withdrawn:''' None.


'''Steps''' <br/>
'''Steps'''  
# The user chooses to view the selected album.
# The user chooses to view the selected album.
# The system displays the metadata of the album (see [[Faces_Application_Profile_Album|Application Profile Album]]) and following further information depending on the state of the album:
# The system displays:
#: '''pending:''' The created and last modified dates. If the user is an account user, include [[Faces_Browse_and_Display#UC_FAC_BD_01_View_picture_list|UC_FAC_BD_01 View picture list]].
#* the metadata of the album (see [[Faces_Album_Management#Album_Metadata_Set|Album Metadata Set]])
#: '''released:''' The affiliation of the album owner, the PID of the album and its publishing date. If the user is an account user, include [[Faces_Browse_and_Display#UC_FAC_BD_01_View_picture_list|UC_FAC_BD_01 View picture list]].
#* the pictures of the album (include [[Faces_Browse_and_Display#UC_FAC_BD_01_View_picture_list|UC_FAC_BD_01 View picture list]])
#: '''withdrawn:''' The affiliation of the album owner, the crossed out PID of the album, its publishing and withdrawn dates and the withdrawl comment. If the user is the owner of the item or has administrator rights, include [[Faces_Browse_and_Display#UC_FAC_BD_01_View_picture_list|UC_FAC_BD_01 View picture list]].
#* the number of pictures within the album together with an information when some of this pictures are private visible only (+ their number)
#* all available dates: created, last modified, published, withdrawn
#* the withdrawl comment (the PID of the album will be crossed out)
#* for shared albums: the user who has done the last modification of the album, all active shared users (user names) and user groups and the owner of the album
#* for shared albums the user is the owner: all shared users (user names for active users and e-mail address for inactive users) inclusive the state of the shared users and all user groups.
# Extension point: '''remove picture from album'''
# Extension point: '''remove picture from album'''
#: 3.1 If the album is in the state '''pending''' and the user wants to remove a picture from the album, include [[Faces_Album_Management#UC_FAC_AM_03_Remove_picture_from_album|UC_FAC_AM_03 Remove picture from album]].
#: 3.1 If the album is in the state '''pending''' or '''submitted''', the user is the '''owner''' of the album or a '''shared user''' of the album and wants to remove a picture from the album, include [[Faces_Album_Management#UC_FAC_AM_03_Remove_picture_from_album|UC_FAC_AM_03 Remove picture from album]].
# Extension point: '''edit album'''
# Extension point: '''edit album'''
#: 4.1 If the album is in the state '''pending''' and the user wants to edit the album, include [[Faces_Album_Management#UC_FAC_AM_04_Edit_album|UC_FAC_AM_04 Edit album]].
#: 4.1 If the album is in the state '''pending''' or '''submitted''', the user is the '''owner''' of the album or a '''shared user''' of the album and wants to edit the album, include [[Faces_Album_Management#UC_FAC_AM_04_Edit_album|UC_FAC_AM_04 Edit album]].
# '''Not implemented yet:''' Extension point: '''share album'''
#: 5.1 If the album is in the state '''pending''' and the user is the '''owner''' of the album, include [[Faces_Album_Management#UC_FAC_AM_09_Share_album|UC_FAC_AM_09 Share album]].
# '''Not implemented yet:''' Extension point: '''unshare album'''
#: 6.1 If the album is in the state '''submitted''', the user is the '''owner''' of the album and at least one shared user for the album exists, include [[Faces_Album_Management#UC_FAC_AM_11_Unshare_album|UC_FAC_AM_11 Unshare album]].
# Extension point: '''delete album'''
# Extension point: '''delete album'''
#: 5.1 If the album is in the state '''pending''' and the user wants to delete the album, include [[Faces_Album_Management#UC_FAC_AM_05_Delete_album|UC_FAC_AM_05 Delete album]].
#: 7.1 If the album is in the state '''pending''' or '''submitted''', no shared user exists and the user is the '''owner''' of the album and wants to delete the album, include [[Faces_Album_Management#UC_FAC_AM_05_Delete_album|UC_FAC_AM_05 Delete album]].
# Extension point: '''release album'''
# Extension point: '''release album'''
#: 6.1 If the album is in the state '''pending''' and the user wants to release the album, include [[Faces_Album_Management#UC_FAC_AM_06_Release_album|UC_FAC_AM_06 Release album]].
#: 8.1 If the album is in the state '''pending''' or '''submitted''', the user is the '''owner''' of the album and wants to release the album, include [[Faces_Album_Management#UC_FAC_AM_06_Release_album|UC_FAC_AM_06 Release album]].
# Extension point: '''export album'''
# Extension point: '''export album'''
#: 7.1 If the album is in the state '''pending''' or '''released''' and the user wants to export the pictures of the album, include [[Faces_Album_Management#UC_FAC_AM_08_Export_album|UC_FAC_AM_08 Export album]].
#: 9.1 If the album is not in the state '''withdrawn''' and the user wants to export the pictures of the album, include [[Faces_Album_Management#UC_FAC_AM_08_Export_album|UC_FAC_AM_08 Export album]].
# Extension point: '''withdraw album'''
# Extension point: '''withdraw album'''
#: 8.1 If the album is in the state '''released''', the user is the owner of the album and he wants to withdraw the album, include use case [[Faces_Album_Management#UC_FAC_AM_07_Withdraw_album|UC_FAC_AM_07 Withdraw album]].
#: 10.1 If the album is in the state '''released''', the user is the '''owner''' of the album and wants to withdraw the album, include use case [[Faces_Album_Management#UC_FAC_AM_07_Withdraw_album|UC_FAC_AM_07 Withdraw album]].
# ''Extension point: '''add picture to album'''''
# '''Not implemented yet:''' Extension point: '''create private note pad'''
#: ''9.1 If the album is in the state '''released''' and the user wants to add one of the pictures within the album to one or more of his own pending albums, include use case [[Faces_Album_Management#UC_FAC_AM_02_Add_picture_to_album|UC_FAC_AM_02 Add picture to album]].''
#: 11.1 If the user is the '''owner''' of the album or a '''shared user''' of the album and wants to create a private note pad for the album, include use case [[Faces_Note_Pads#UC_FAC_NP_01_Create_private_note_pad|UC_FAC_NP_01 Create private note pad]].
# '''Not implemented yet:''' Extension point: '''view note pad'''
#: 12.1 If a corresponding note pad in the state '''pending''' exists where the user is the '''owner''' or a '''shared user''' of the note pad and wants to view it, include [[Faces_Note_Pads#UC_FAC_NP_02_View_note_pad|UC_FAC_NP_02 View note pad]].
#: 12.2 If a corresponding note pad in the state '''released''' or '''withdrawn''' exists and the user wants to view it, include [[Faces_Note_Pads#UC_FAC_NP_02_View_note_pad|UC_FAC_NP_02 View note pad]].
# '''Not implemented yet:''' Extension point: '''view album event log'''
#: 13.1  If the user is the '''owner''' of the album or a '''shared user''' of the album and wants to view the event log of the album, include [[Faces_Versioning#UC_FAC_VS_01_View_album_event_log|UC_FAC_VS_01 View album event log]].
# The use case ends successfully.
# The use case ends successfully.


'''Actors Involved'''  
'''Actors Involved'''  
* User
* Account user


== UC_FAC_BD_05 View my albums ==
== UC_FAC_BD_05 View album list ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in design
* Status: implemented
* Schedule: '''R2'''
* Schedule: '''R3'''
 
'''Motivation'''
* The user wants to overview all his albums that are visible for him.


'''Motivation''' <br/>
'''Pre-Condition'''
* The user wants to overview all his albums ('''R4:''' or the administrator wants to overview all albums of a special user).
* One account user is selected.


'''Triggers''' <br/>
'''Triggers'''
* This use case can be included by following use cases
* This use case can be included by following use cases
:* [[Faces_Browse_and_Display#UC_FAC_BD_10_View_account_users|UC_FAC_BD_10 View account users]]
:* [[Faces_Searching#UC_FAC_SR_03_Public_Album_Search|UC_FAC_SR_03 Public Album Search]]


'''Steps''' <br/>
'''Steps'''
# The user chooses to overview his albums.
# The user chooses to overview all albums that are visible to him (all albums he is the owner of, all albums he shares and all published albums).
# The system displays the list of all albums the (selected) user is owner of and the number of list entries. In this list are displayed following information about each album: the name, the number of pictures, the description if available, the date last modified and the state. The defaults for the sorting order and the number of hits per page are given by the system (by default: sorted by name (alphabetically), number of hits per page:12).
# The system displays the list of all albums the selected user is allowed to see in the default display type (Grid View) and the number of list entries.
# (Optionally) The user changes the sorting order.
#* The defaults for the sorting order and the number of hits per page are given by the system (by default: date last modified (beginning with the newest date), number of hits per page: 10).
# (Optionally) The user changes the sorting order (each metadata can be used as sorting criteria).
#: 3.1 The system displays the album list in the selected sorting order.
#: 3.1 The system displays the album list in the selected sorting order.
# (Optionally) The user chooses another number of hits to be displayed per page.
# (Optionally) The user filters the displayed albums
#: 4.1 The system displays the album list containing the selected number of hits per page.
#: Following filter criteria are available:
#:* all my albums
#:* my private albums (incl. the ones I am sharing)
#:* my public albums
#:* all public albums
#:* my withdrawn albums
#: 4.1 The system filters the album list based on the selected filter criteria.
# (Optionally) The user chooses another number of hits per page (following numbers are available: 10, 25, 50, 75, 100).
#: 5.1 The system displays the album list with the selected number of hits per page.
# (Optionally) The user goes to a special page, to the last page or to the first page.
# (Optionally) The user goes to a special page, to the last page or to the first page.
#: 5.1 The system displays the selected page.
#: 6.1 The system displays the selected page.
# Extension point: '''view album details'''
# Extension point: '''view album details'''
#: 6.1 If the user wants to view the details of a selected album, include [[Faces_Browse_and_Display#UC_FAC_BD_04_View_album_details|UC_FAC_BD_04 View album details]].
#: 7.1 If the user wants to view the details of a selected album, include [[Faces_Browse_and_Display#UC_FAC_BD_04_View_album_details|UC_FAC_BD_04 View album details]].
# '''Not implemented yet:''' Extension point: '''copy album content'''
#: 8.1 If the user wants to copy the content of one album, include [[Faces_Album_Management#UC_FAC_AM_12_Copy_album_content|UC_FAC_AM_12 Copy album content]].
# The use case ends successfully.
# The use case ends successfully.
'''Alternatives'''
: 1.a '''R4:''' The administrator chooses to overview all albums of a selected user. Continue with Step 2.


'''Actors Involved'''  
'''Actors Involved'''  
* Account user
* Account user
== UC_FAC_BD_06 View released albums ==
'''Status/Schedule'''
* Status: in design
* Schedule: '''R2'''
'''Motivation''' <br/>
* The user wants to overview all released albums.
'''Steps''' <br/>
# The user chooses to overview all released albums.
# The system displays the list of all released albums and the number of list entries. In this list are displayed following information about each album: the name, the number of pictures, the description if available, the owner, the affiliation of the owner and the date published. The defaults for the sorting order and the number of hits per page are given by the system (by default: sorted by name (alphabetically), number of hits per page:12).
# (Optionally) The user changes the sorting order.
#: 3.1 The system displays the album list in the selected sorting order.
# (Optionally) The user chooses another number of hits to be displayed per page.
#: 4.1 The system displays the album list containing the selected number of hits per page.
# (Optionally) The user goes to a special page, to the last page or to the first page.
#: 5.1 The system displays the selected page.
# Extension point: '''search within album list'''
#: 6.1 If the user wants to search within the album list, include [[Faces_Searching#UC_FAC_SR_03_Search_within_list|UC_FAC_SR_03 Search within list]].
# The use case ends successfully.
'''Actors Involved''' <br/>
* User


== UC_FAC_BD_07 Resolve album by URL ==  
== UC_FAC_BD_07 Resolve album by URL ==  
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in design
* Status: implemented
* Schedule: '''R2'''
* Schedule: '''R2'''


Line 188: Line 198:
# The user requests an album by providing the URL assigned by the system for persistently citing the album.  
# The user requests an album by providing the URL assigned by the system for persistently citing the album.  
# The system displays the metadata of the album (see [[Faces_Application_Profile_Album|Application Profile Album]]) and following further information depending on the state of the album:
# The system displays the metadata of the album (see [[Faces_Application_Profile_Album|Application Profile Album]]) and following further information depending on the state of the album:
#: '''released:''' The affiliation of the album owner, the PID of the album and its publishing date.
#: '''released:''' The publishing date  
#: '''withdrawn:''' The affiliation of the album owner, the crossed out PID of the album, its publishing and withdrawn dates and the withdrawl comment.
#: '''withdrawn:''' The publishing and withdrawn dates and the withdrawl comment (the PID is crossed out)


'''Actors Involved'''  
'''Actors Involved'''  
Line 196: Line 206:
== UC_FAC_BD_08 View file metadata ==
== UC_FAC_BD_08 View file metadata ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: implemented
* Schedule: '''R3'''
* Schedule: '''R3'''


Line 216: Line 226:
* User
* User


== UC_FAC_BD_09 View administrator workspace ==
= Further =
 
== UC_FAC_BD_10 View statistics ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: implemented
* Schedule: '''R3'''
* Schedule: '''R3'''


'''Motivation'''
'''Motivation'''
* A user wants to have an overview about all tasks he can perform with his special rights as administrator.
* The user chooses view the usage statistics (see [[Faces_Statistics|Faces Statistics]]) for the Faces solution.


'''Steps'''  
'''Steps'''  
# The user chooses to view the administrator workspace.
# The user chooses to view the usage statistics for Faces.
# The system displays the administrator workspace, where all tasks that can be performed by an administrator are listed.
# The system displays the statistical data of the last 12 months (including the current month) which have been collected per month. The use case ends successfully.
# Extension point: '''view statistics'''
#: 3.1 If the user wants to view the Faces statistics, include [[Faces_Browse_and_Display#UC_FAC_BD_11_View_Statistics|UC_FAC_BD_11 View Statistics]].
# '''R4:''' Extension point: '''view account users'''
#: 4.1 If the user wants to get an overview about all account users of Faces, include [[Faces_Browse_and_Display#UC_FAC_BD_10_View_account_users|UC_FAC_BD_10 View account users ]].
# '''R4:''' Extension point: '''create account user'''
#: 3.1 If the user wants to create an account user, include [[Faces_User_Management#UC_FAC_UM_03_Create_account_user|UC_FAC_UM_03 Create account user]].
# The use case ends successfully.


'''Actors Involved'''
'''Actors Involved'''
* Administrator
* Administrator


== UC_FAC_BD_10 View account users ==
== UC_FAC_BD_11 Navigate within one picture ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: in design
* Schedule: '''R4'''
* Schedule: '''???'''


'''Motivation'''
'''Motivation'''
* The user wants to overview all account users.
* The user wants to analyze one picture. Therfore, the [[Digilib]] tool will be used.


'''Triggers'''  
'''Pre-Condition'''
* This use case is included by the use cases
* One picture is selected (in the detailed view).
:* [[Faces_Browse_and_Display#UC_FAC_BD_09_View_administrator_workspace|UC_FAC_BD_09 View administrator workspace]]


'''Steps'''  
'''Steps'''
# The user chooses to overview all account users.
# (Optionally) The user zooms in and out within the picture.
# The system displays the list of all account users and the number of list entries. In this list is following information displayed about each account user: the user-id, the name, the organization, the name of the study for which Faces is used, the state of the account user, the creation date of the account user and possible actions for each account user. The defaults for the sorting order and the number of hits per page are given by the system (by default: sorted by name (alphabetically), number of hits per page: 12).
# (Optionally) The user navigates left, right, up and down within the zoomed picture.
# (Optionally) The user changes the sorting order.
# (Optionally) The user switches back to see the whole picture.
#: 3.1 The system displays the account user list in the selected sorting order.  
# The use case ends successfully.
# (Optionally) The user chooses another number of hits to be displayed per page.
#: 4.1 The system displays the account user list containing the selected number of hits per page.  
# (Optionally) The user goes to a special page, to the last page or to the first page.
#: 5.1 The system displays the selected page.
# Extension point: '''search within list'''
#: 6.1 If the user wants to search within the list, include [[Faces_Searching#UC_FAC_SR_03_Search_within_list|UC_FAC_SR_03 Search within list]].
# Extension point: '''edit account user'''
#: 7.1 If the user wants to edit a selected account user, include [[Faces_User_Management#UC_FAC_UM_04_Edit_account_user|UC_FAC_UM_04 Edit account user]].
# '''R4:''' Extension point: '''view albums of account user'''
#: 8.1 If the user wants to view all albums of a selected account user, include [[Faces_Browse_and_Display#UC_FAC_BD_05_View_my_albums|UC_FAC_BD_05 View my albums]].
# Extension point: '''deactivate account user'''
#: 9.1 If the user wants to deactivate a selected account user, include [[Faces_User_Management#UC_FAC_UM_05_Deactivate_account_user|UC_FAC_UM_05 Deactivate account user]].  
# The use case ends successfully.  


'''Actors Involved'''
'''Actors Involved'''
* Administrator
* User


== UC_FAC_BD_11 View statistics ==
== UC_FAC_BD_12 View note pad ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: in design
* Schedule: '''R3'''
* Schedule: '''???'''


'''Motivation'''
'''Motivation'''
* The user chooses view the usage statistics (see [[Faces_Statistics|Faces Statistics]]) for the Faces solution.
* The user wants to view a note pad.
 
'''Pre-Condition'''
* One note pad is selected.
* Further pre-conditions are based on the state of the album:
*: '''pending:'''
*:* For private note pads: the user is the owner of the note pad.
*:* For shared note pads: the user shares the notepad or is the owner of the note pad.
*: '''released:''' None.
*: '''withdrawn:''' None.


'''Triggers'''  
'''Triggers'''  
* This use case is included by the use cases
* This use case can be included by following use cases
:* [[Faces_Browse_and_Display#UC_FAC_BD_09 View administrator workspace|UC_FAC_BD_09 View administrator workspace]]
:* [[Faces_Browse_and_Display#UC_FAC_BD_04 View album details|UC_FAC_BD_04 View album details]]


'''Steps'''  
'''Steps'''  
# The user chooses to view the usage statistics for Faces.
# The user chooses to view the selected note pad.
# The system displays the statistical data for each month (all finalized months and the current one) in a list. The use case ends successfully.  
# The system displays the note pad and its metadata (see [[Faces_Note_Pads#Note_Pad_Metadata_Set|Note Pad Metadata Set]]).
#: For '''shared note pads''', additionally following properties will be displayed
#:# For the '''owner''' of the note pad:
#:#* List of shared users (e-mail address, user name) and list of invited users (e-mail address)
#:# For the '''shared users''' of the note pad:
#:#* List of shared users (user name) and number of invited users
# Extension point: '''edit note pad '''
#: 3.1 If the note pad is in state '''pending''', the user is the '''owner''' or shares the the note pad and wants to edit it, include [[Faces_Note_Pads#UC_FAC_NP_02_Edit_note_pad|UC_FAC_NP_02 Edit note pad]].
# Extension point: '''delete note pad '''
#: 4.1 If the note pad is the state '''pending''', the user is the '''owner''' of the note pad and wants to delete it, include [[Faces_Note_Pads#UC_FAC_NP_04_Delete_note_pad|UC_FAC_NP_04 Delete note pad]].
# Extension point: '''release note pad '''
#: 5.1 If the note pad is in the state '''pending''', the user is the '''owner''' of the note pad and wants to release it, include [[Faces_Note_Pads#UC_FAC_NP_05_Release_note_pad|UC_FAC_NP_05 Release note pad]].
# Extension point: '''withdraw note pad '''
#: 6.1 If the note pad is in the state '''released''', the user is the '''owner''' of the note pad and wants to withdraw it, include [[Faces_Note_Pads#UC_FAC_NP_06_Withdraw_note_pad|UC_FAC_NP_06 Withdraw note pad]].
# Extension point: '''view album details'''
#: 7.1 If the user wants to view the album the note pad corresponds to, include [[Faces_Browse_and_Display#UC_FAC_BD_04_View_album_details|UC_FAC_BD_04 View album details]].
# The use case ends successfully.


'''Actors Involved'''
'''Actors Involved'''
* Administrator
* Account user
 
== Further Development ==
 
 
=== Identified Use Cases ===
 
==== UC_FAC_BD_ Navigate within one picture ====
'''Status/Schedule'''
* Status: in specification
* Schedule: '''R3.5'''
 
'''Motivation''' <br/>
* The user wants to analyze one picture.
 
'''Pre-Condition''' <br/>
* One picture is selected (in the detailed view).
 
'''Steps''' <br/>
# (Optionally) The user zooms in and out within the picture.
# (Optionally) The user navigates left, right, up and down within the zoomed picture.
# (Optionally) The user switches back to see the whole picture.
# The use case ends successfully.
 
'''Actors Involved''' <br/>
* User




[[Category:Faces|Browse and Display]]
[[Category:Faces_Functional_Specification|Browse and Display]]
[[Category:Functional_specification]]

Latest revision as of 11:27, 12 January 2012

FACES

Scope · Functionalities
Disclaimer and Copyright
Support

Application Profiles
Release Agreement

Specification:
Browse and Display · Search
Albums · Users
Note Pads · Versioning

Related Projects:
Imeji

edit


Introduction[edit]

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 a new release, earlier states of the spec can be found in the history of this page:

Pictures[edit]

UC_FAC_BD_01 View picture list[edit]

Status/Schedule

  • Status: Implemented
  • Schedule: R1

Motivation

  • The user wants to view several or all pictures of the collection in the list view.

Triggers

Steps

  1. The user chooses to view the whole list of available pictures or executed one of the above mentioned use cases.
  2. The system displays the pictures list in the default display type (Picture View) and the number of hits. The defaults for the sorting order and the number of hits per page are given by the system:
    • sorted by Emotion (alphabetically: anger, disgust, fear, happiness, neutrality and sadness) - Person-ID (ascending) - Picture Set (ascending)
    • number of hits per page: 12
  3. (Optionally) The user changes the display type of the picture list.
    3.1 The system displays the picture list in the selected display type.
  4. (Optionally) The user changes the sorting order by changing one or several sorting criteria, one or several ascending/descending arrows and confirms his choice.
    4.1 The system displays the picture list depending on the selected sorting criteria.
  5. (Optionally) The user chooses another number of hits to be displayed per page (12, 24, 60, 90).
    5.1 The system displays the picture list with the selected number of hits per page.
  6. (Optionally) The user goes to a special page, to the last page or to the first page.
    6.1 The system displays the selected page.
  7. Extension point: add pictures to album
    7.1 If the user wants to add pictures to one of his (shared) private albums, include UC_FAC_AM_02 Add picture to album.
  8. The use case ends successfully.

Actors Involved

  • User

UC_FAC_BD_02 View picture details[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R1

Motivation

  • The user wants to view one picture in detail (a higher resolution of the picture and its attributes).

Steps

  1. The user selects one picture.
  2. The system displays the picture in the web resolution (detailed view) and all available attributes of the picture.
  3. Extension point: add pictures to album
    3.1 If the user wants to add pictures to one of his (shared) private albums, include UC_FAC_AM_02 Add picture to album.
  4. The use case ends successfully.

Actors Involved

  • User

UC_FAC_BD_03 View picture for comparison[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R1

Motivation

  • The user wants to see both picture sets of one image to compare them with each other.

Pre-Condition

  • One picture is selected (in the detailed view).

Steps

  1. The user chooses to view the picture for comparison (same image from the other picture set).
  2. The system displays the picture for comparison next to the selected one in the web resolution.
  3. Extension point: add pictures to album
    3.1 If the user wants to add pictures to one of his (shared) private albums, include UC_FAC_AM_02 Add picture to album.
  4. The use case ends successfully.

Actors Involved

  • User

Albums[edit]

UC_FAC_BD_04 View album details[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R3 (without sharing and note pads)

Motivation

  • The user wants to view the details of an album.

Triggers

  • This use case can be included by following use cases

Pre-Condition

  • One album is selected.
  • Further pre-conditions are based on the state of the album:
pending: The user is the owner of the item or has administrator rights.
released: None.
withdrawn: None.

Steps

  1. The user chooses to view the selected album.
  2. The system displays:
    • the metadata of the album (see Album Metadata Set)
    • the pictures of the album (include UC_FAC_BD_01 View picture list)
    • the number of pictures within the album together with an information when some of this pictures are private visible only (+ their number)
    • all available dates: created, last modified, published, withdrawn
    • the withdrawl comment (the PID of the album will be crossed out)
    • for shared albums: the user who has done the last modification of the album, all active shared users (user names) and user groups and the owner of the album
    • for shared albums the user is the owner: all shared users (user names for active users and e-mail address for inactive users) inclusive the state of the shared users and all user groups.
  3. Extension point: remove picture from album
    3.1 If the album is in the state pending or submitted, the user is the owner of the album or a shared user of the album and wants to remove a picture from the album, include UC_FAC_AM_03 Remove picture from album.
  4. Extension point: edit album
    4.1 If the album is in the state pending or submitted, the user is the owner of the album or a shared user of the album and wants to edit the album, include UC_FAC_AM_04 Edit album.
  5. Not implemented yet: Extension point: share album
    5.1 If the album is in the state pending and the user is the owner of the album, include UC_FAC_AM_09 Share album.
  6. Not implemented yet: Extension point: unshare album
    6.1 If the album is in the state submitted, the user is the owner of the album and at least one shared user for the album exists, include UC_FAC_AM_11 Unshare album.
  7. Extension point: delete album
    7.1 If the album is in the state pending or submitted, no shared user exists and the user is the owner of the album and wants to delete the album, include UC_FAC_AM_05 Delete album.
  8. Extension point: release album
    8.1 If the album is in the state pending or submitted, the user is the owner of the album and wants to release the album, include UC_FAC_AM_06 Release album.
  9. Extension point: export album
    9.1 If the album is not in the state withdrawn and the user wants to export the pictures of the album, include UC_FAC_AM_08 Export album.
  10. Extension point: withdraw album
    10.1 If the album is in the state released, the user is the owner of the album and wants to withdraw the album, include use case UC_FAC_AM_07 Withdraw album.
  11. Not implemented yet: Extension point: create private note pad
    11.1 If the user is the owner of the album or a shared user of the album and wants to create a private note pad for the album, include use case UC_FAC_NP_01 Create private note pad.
  12. Not implemented yet: Extension point: view note pad
    12.1 If a corresponding note pad in the state pending exists where the user is the owner or a shared user of the note pad and wants to view it, include UC_FAC_NP_02 View note pad.
    12.2 If a corresponding note pad in the state released or withdrawn exists and the user wants to view it, include UC_FAC_NP_02 View note pad.
  13. Not implemented yet: Extension point: view album event log
    13.1 If the user is the owner of the album or a shared user of the album and wants to view the event log of the album, include UC_FAC_VS_01 View album event log.
  14. The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_BD_05 View album list[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R3

Motivation

  • The user wants to overview all his albums that are visible for him.

Pre-Condition

  • One account user is selected.

Triggers

  • This use case can be included by following use cases

Steps

  1. The user chooses to overview all albums that are visible to him (all albums he is the owner of, all albums he shares and all published albums).
  2. The system displays the list of all albums the selected user is allowed to see in the default display type (Grid View) and the number of list entries.
    • The defaults for the sorting order and the number of hits per page are given by the system (by default: date last modified (beginning with the newest date), number of hits per page: 10).
  3. (Optionally) The user changes the sorting order (each metadata can be used as sorting criteria).
    3.1 The system displays the album list in the selected sorting order.
  4. (Optionally) The user filters the displayed albums
    Following filter criteria are available:
    • all my albums
    • my private albums (incl. the ones I am sharing)
    • my public albums
    • all public albums
    • my withdrawn albums
    4.1 The system filters the album list based on the selected filter criteria.
  5. (Optionally) The user chooses another number of hits per page (following numbers are available: 10, 25, 50, 75, 100).
    5.1 The system displays the album list with the selected number of hits per page.
  6. (Optionally) The user goes to a special page, to the last page or to the first page.
    6.1 The system displays the selected page.
  7. Extension point: view album details
    7.1 If the user wants to view the details of a selected album, include UC_FAC_BD_04 View album details.
  8. Not implemented yet: Extension point: copy album content
    8.1 If the user wants to copy the content of one album, include UC_FAC_AM_12 Copy album content.
  9. The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_BD_07 Resolve album by URL[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R2

Motivation

  • A not logged in user follows a (published) link to a released album.

Steps

  1. The user requests an album by providing the URL assigned by the system for persistently citing the album.
  2. The system displays the metadata of the album (see Application Profile Album) and following further information depending on the state of the album:
    released: The publishing date
    withdrawn: The publishing and withdrawn dates and the withdrawl comment (the PID is crossed out)

Actors Involved

  • User

UC_FAC_BD_08 View file metadata[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R3

Motivation

Pre-Condition

  • One picture is selected.

Triggers

Steps

  1. The user chooses to view file metadata about the selected picture.
  2. The system displays the available resolutions (thumbnail, web resolution, original resolution) of the selected picture.
  3. The user chooses one resolution for which he wants to see the file metadata.
  4. The system displays the file metadata (in XML) of the selected resolution. The use case ends successfully.

Actors Involved

  • User

Further[edit]

UC_FAC_BD_10 View statistics[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R3

Motivation

  • The user chooses view the usage statistics (see Faces Statistics) for the Faces solution.

Steps

  1. The user chooses to view the usage statistics for Faces.
  2. The system displays the statistical data of the last 12 months (including the current month) which have been collected per month. The use case ends successfully.

Actors Involved

  • Administrator

UC_FAC_BD_11 Navigate within one picture[edit]

Status/Schedule

  • Status: in design
  • Schedule: ???

Motivation

  • The user wants to analyze one picture. Therfore, the Digilib tool will be used.

Pre-Condition

  • One picture is selected (in the detailed view).

Steps

  1. (Optionally) The user zooms in and out within the picture.
  2. (Optionally) The user navigates left, right, up and down within the zoomed picture.
  3. (Optionally) The user switches back to see the whole picture.
  4. The use case ends successfully.

Actors Involved

  • User

UC_FAC_BD_12 View note pad[edit]

Status/Schedule

  • Status: in design
  • Schedule: ???

Motivation

  • The user wants to view a note pad.

Pre-Condition

  • One note pad is selected.
  • Further pre-conditions are based on the state of the album:
    pending:
    • For private note pads: the user is the owner of the note pad.
    • For shared note pads: the user shares the notepad or is the owner of the note pad.
    released: None.
    withdrawn: None.

Triggers

  • This use case can be included by following use cases

Steps

  1. The user chooses to view the selected note pad.
  2. The system displays the note pad and its metadata (see Note Pad Metadata Set).
    For shared note pads, additionally following properties will be displayed
    1. For the owner of the note pad:
      • List of shared users (e-mail address, user name) and list of invited users (e-mail address)
    2. For the shared users of the note pad:
      • List of shared users (user name) and number of invited users
  3. Extension point: edit note pad
    3.1 If the note pad is in state pending, the user is the owner or shares the the note pad and wants to edit it, include UC_FAC_NP_02 Edit note pad.
  4. Extension point: delete note pad
    4.1 If the note pad is the state pending, the user is the owner of the note pad and wants to delete it, include UC_FAC_NP_04 Delete note pad.
  5. Extension point: release note pad
    5.1 If the note pad is in the state pending, the user is the owner of the note pad and wants to release it, include UC_FAC_NP_05 Release note pad.
  6. Extension point: withdraw note pad
    6.1 If the note pad is in the state released, the user is the owner of the note pad and wants to withdraw it, include UC_FAC_NP_06 Withdraw note pad.
  7. Extension point: view album details
    7.1 If the user wants to view the album the note pad corresponds to, include UC_FAC_BD_04 View album details.
  8. The use case ends successfully.

Actors Involved

  • Account user