Difference between revisions of "PubMan Func Spec View"

From MPDLMediaWiki
Jump to navigation Jump to search
m (added category)
 
(179 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{PubMan_Funtional_Specification}}
==UC_PM_BD_02 view item list ==
==UC_PM_BD_02 view item list ==
The user views the search result list of one or more items. The user is able to modify the display of the item list by changing the sorting order, the number of displayed items or the display type.
The user views the search result list of one or more items. The user is able to modify the display of the item list by changing the sorting order, the number of displayed items or the display type.
===Status/Schedule===
===Status/Schedule===
*Status: '''implemented'''
*Status: '''implemented'''
*Schedule:'''R2'''
*Schedule:'''R3'''


===Triggers ===
===Triggers ===
• This use case is included by the use cases UC_PM_SR_01 do simple search, UC_PM_SR_03 do advanced search and UC_PM_BD_03 browse by organizational unit.
*This use case is included by the use cases  
===Actors ===
[[PubMan_Func_Spec_Search#UC_PM_SR_01 Do simple search|UC_PM_SR_01 do simple search]],
• User
===Pre-Conditions ===
• A search result list is available.
===Flow of Events ===


*1. The user chooses to view a list of items by executing one of the above mentioned use cases.
[[PubMan_Func_Spec_Search#UC_PM_SR_03_Do_advanced_search|UC_PM_SR_03 do advanced search]],
*2. The system displays the number of items and the list of items. The defaults for the display type (see FE_PM_02 Display types), the sorting order (see FE_PM_03 Sort item list) and the number of hits per page are given by the system or are taken from the users preferences if available.
*3. (Optionally) The user changes the sorting order.
**3.1. The system displays the item list in the selected sorted order.
*4. (Optionally) The user chooses another number of hits to be displayed per page.
**4.1. The system displays the item list containing the selected number of hits per page.
*5. (Optionally) The user changes the display type.
**5.1. The system displays the item list in the selected display type.
*6. (Optionally) The user changes the display type for one item.
**6.1. The system displays the item in the selected display type.
*7. The use case ends successfully.


===Post-Conditions / Results===
[[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_03_browse_by_organizational_unit|UC_PM_BD_03 browse by organizational unit]] and  
• The item list is displayed in the selected sorting order containing the defined number of hits per page and the items are displayed in their selected display type.


== UC_PM_BD_03 browse by organizational unit ==
[[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_11_view_my_items | UC_PM_BD_11 View my items]]
The user browses by organizational unit.
===Status/Schedule===
*Status: '''implemented'''
*Schedule:'''R2'''


===Triggers===
===Actors ===
• The user wants to browse by organizational unit.
*User
===Actors===
===Pre-Conditions ===
• User
*A search result list is available.
===Flow of Events ===


===Pre-Conditions===
*1. The user chooses to view a list of items by executing one of the above mentioned use cases.
*2. The system displays the number of items and the list of items. The defaults for the display type (see [[PubMan_Display | PubMan Display]]), the sorting order (see [[PubMan_Sorting | PubMan Sorting]]) and the number of hits per page are given by the system (= by default: 10 hits per page)  or are taken from the users preferences if available.
*3. (Optionally) The user changes the sorting order.
**3.1. The system displays the item list in the selected sorted order.
*4. (Optionally) The user chooses another number of hits to be displayed per page.
**4.1.The system displays the item list containing the selected number of hits per page.
*5. (Optionally) The user changes the display type.
**5.1. The system displays the item list in the selected display type.
*6.(Optionally) The user changes the display type for one item.
**6.1.The system displays the item in the selected display type.
*7. The use case ends successfully.


• None
===Flow of Events===
*1. The user chooses to browse by organizational unit.
*2. The system displays an organizational unit browse view.
*3. (Optionally) The user chooses to view the child organizational units of an organizational unit.
**3.1. The system displays all child organizational units of the selected organizational unit.
*4. (Optionally) The user chooses to view the items of an organizational unit.
**4.1. The system searches for items where the organization of a creator is linked to the selected organizational unit or any child organizational unit in the structure and displays the result list. Include use case UC_PM_BD_02 view item list.
**4.2. (Optionally) The user chooses to view detailed information of the selected organizational unit.
***4.2.1. The system displays an organizational unit detail view.
*5. The use case ends successfully.
===Post-Conditions / Results===
===Post-Conditions / Results===
• The organizational unit browse view is displayed.
*The item list is displayed in the selected sorting order containing the defined number of hits per page and the items are displayed in their selected display type.


==UC_PM_BD_04 view item version==
==UC_PM_BD_04 view item version==
The user views the details of a selected version of an item.
The user views the details of a selected version of an item.
===Status/Schedule===
===Status/Schedule===
*Status: '''partly implemented R2'''(only last version visible).
*Status: '''implemented'''
*Schedule:'''R3'''
*Schedule:'''R5'''


===Triggers===
===Triggers===
• The user wants to view the details of the item version.
*The user wants to view the details of the item version.
===Actors===
===Actors===
• User
*User
===Pre-Conditions===
===Pre-Conditions===
• One item  version is selected.
*One item  version is selected.
* See matrix for actions on versions/releases of an item under [[PubMan_Action_Matrix]]
 
===Flow of Events===
===Flow of Events===
*1. The user chooses to view the selected item version.
*1. The user chooses to view the selected item version.
*2. The system displays the data of the item version and the files. The possibility for download is offered for all files the user has privileges to access (for details see 13.1).
*2. The system displays the data of the item version and the files. The possibility for download is offered for all files the user has privileges to access (for details see [[PubMan_Visibility|PubMan Visibility]]). The possibility to view detailed information about each organization related to the item is offered, providing that information on this organization is stored in the system.
*3. (Optionally) The user chooses to download a file.
*3. (Optionally) The user chooses to download a file.
**3.1. The system provides the file for download.
**3.1. The system provides the file for download.
*4. Extension point: view release history
*4. (Optionally) The user (only logged in users of the corresponding context) chooses to send an E-Mail to the moderator of the context, the item is administrated at.
**4.1. If the user wants to view all released versions of the item, include use case UC_PM_BD_05 view release history.
**4.1 A Link from view item version is displayed. When the user clicks on the link, a new window opens with to prefilled with the contact address of the moderator of the responsible context and with the escidoc Id prefilled as subject. Further more the user can write a text and then send the Mail. ''Currently we took the pubman-support@gwdg.de mail address, as the contact address can't be defined per context yet.''
*5. Extension point: view item event log
*4.    (Optionally) The user chooses to view detailed information about an organization related to the item.
**5.1. If the user is in any role defined in the workflows for the item’s collection.and wants to view the log entries for the item versions, include use case UC_PM_BD_06 view item event log.
**4.1.  The organizational unit detail view ("description") (see [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_03_browse_by_organizational_unit|UC_PM_BD_03 Browse by organizational unit, step 4]] ) is displayed, including the description and related affiliations (with Start_Date/End_Date) of the organizational unit. See [[PubMan_History_of_affiliations#History_of_affiliations_linked_from_item_view|scenario for history of affiliations linked from item view]].
*6. Extension point: view revisions of item
*5.    (Optionally) The user chooses to view the researcher profile of an author related to the item.
**6.1. If the user wants to view all related revisions of the item, include use case UC_PM_BD_07 view revisions of item.
**5.1.  The researcher profile, including a list of publications and person information stored in the CoNE service (see [[Researcher_Portfolio#UC_View_researcher_portfolio.2Fprofile|UC View researcher portfolio]]), is displayed, if the respective author has an authorized CONE person ID.
*7. Extension point: view item statistics
*6. Extension point: '''''view release history'''''
**7.1. If the user wants to view the statistics for an item, include UC_PM_BD_08 view item statistics.
**6.1. If the user wants to view all released versions of the item and there is at least one released version of the item, include use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_05_view_release_history | UC_PM_BD_05 view release history]].  
*8. Extension point: create item from template
 
**8.1. If the user has the role “Depositor“ and wants to create a new item using that item as template, include UC_PM_SM_05 create item from template.
*7. Extension point: '''''view item event log'''''
*9. Extension point: create new revision of item
**7.1. If the user is in any role defined in the workflows for the item’s collection and wants to view the log entries for the item versions, include use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_06_view_item_event_log |UC_PM_BD_06 view item event log]].
**9.1. If the user has the role “Depositor”, at least one item version is in state “released” and the user wants to create a new revision to that item, include use case UC_PM_SM_11 create new revision of item.
 
*10. Extension point: modify item
*8. Extension point: '''''view revisions of item'''''
**10.1. If  the user is allowed to start the modification workflow for the item, the last item version is in state “released” and the user wants to modify that item, include UC_PM_QA_11 modify item.
**8.1. If the user wants to view all related revisions of the item and if there is at least one related revision of the item, include use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_07_view_revisions_of_item |UC_PM_BD_07 view revisions of item]].  
*11. Extension point: withdraw item
 
**11.1. If the user is the owner of that item, the last item version is in state “released” and the user wants to withdraw that item, include use case UC_PM_QA_09 withdraw item.
*9. Extension point: '''''view item statistics'''''
*12. The use case ends successfully.
**9.1. If the user wants to view the statistics for an item, include [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_08_view_item_statistics|UC_PM_BD_08 view item statistics]].
 
*10. Extension point: '''''create item from template'''''
**10.1. If the user has the role “Depositor“ and wants to create a new item using the current item version as template, include [[PubMan_Func_Spec_Submission#UC_PM_SM_05_create_item_from_template|UC_PM_SM_05 create item from template]].
 
*11. Extension point: '''''create new revision of item'''''
**11.1. If the user has the role “Depositor”, and the current item version is in state “released” and the user wants to create a new revision for that released version, include use case [[PubMan_Func_Spec_Submission#UC_PM_SM_11_create_new_revision_of_item |UC_PM_SM_11 create new revision of item]].
*12. Extension point: '''''modify item'''''
**12.1. If  the user is allowed to start the modification workflow for the item, the last item version is selected and in state “released” and the user wants to modify that item version, include [[PubMan_Func_Spec_Quality_Assurance#UC_PM_QA_11_modify_item | UC_PM_QA_11 modify item]].
*13. Extension point: '''''withdraw item'''''
**13.1. If the user is the owner of that item, the last item version is in state “released” and the user wants to withdraw that item, include use case [[PubMan_Func_Spec_Quality_Assurance#UC_PM_QA_09_withdraw_item|UC_PM_QA_09 withdraw item]].
*14. Extension point: '''do simple export'''
** 14.1 If the user wants to do a simple export of the item, include [[PubMan_Func_Spec_Export#UC_PM_EX_02_Do_simple_export|UC_PM_EX_02 Do simple export]].
*15. Extension point: '''grant or revoke audience privileges for files'''
** 15.1 If the user as allowed to grant or revoke audience rights for files of an item , include [[PubMan_Func_Spec_User_Management#UC_PM_UM_11_Grant_or_revoke_audience_privileges_for_files|UC_PM_UM_11_Grant_or_revoke_audience_privileges_for_files]].
*16. The use case ends successfully.
 
===Alternatives===
===Alternatives===
*2a. The item is in state “withdrawn”.
*2a. The item is in state “withdrawn”.
*1. The system displays the withdrawal comment, the withdrawal date and the item data. The use case ends successfully.
**1. The system displays the withdrawal comment, the withdrawal date and the item data (see [[PubMan_Display | PubMan Display]]). The use case ends successfully.
 
===Post-Conditions / Results===
===Post-Conditions / Results===
• The details of the item are displayed.
*The details of the item are displayed, including the information how to cite this item.
 
===Future Developement===
* offer alternative 2b for navigating from previous/next single item view:
 
2b. The item was opened from a item list.
**1. The system gives the possibility to go to the next or previous item in the list.
**2. The system displays the previous/next item version
 
* Link with "Cite this file as...."
* automatically sending of private PDFs (The idea is that someone provides his email address - some mechanism shoud ensure that it is actually a person - and then the website should send the pdf.)


==UC_PM_BD_05 view release history==
==UC_PM_BD_05 view release history==
The user chooses to get an overview on the released versions of an item.
The user chooses to get an overview on the released versions of an item.
===Status/Schedule===
===Status/Schedule===
*Status: '''implemented'''
*Status: '''implemented'''
*Schedule:'''R2'''
*Schedule:'''R3'''


===Triggers===
===Triggers===
• The user chooses to see the released versions of an item.
*The user chooses to see the released versions of an item.
• This use case is included by the use case UC_PM_BD_04 view item version.
 
*This use case is included by the use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|UC_PM_BD_04 view item version]].
 
===Actors===
===Actors===
• User
*User
===Pre-Conditions===
===Pre-Conditions===
• One item is selected
*One item is selected
• At least one item version in status “released” exists.
 
*At least one item version in status “released” exists.
 
===Flow of Events===
===Flow of Events===
*1. The user chooses to view the release history for the selected item.
*1. The user chooses to view the release history for the selected item.
*2. The system displays a list of all released versions of the item. For each entry, the version number and the date of release is displayed. The list is sorted descending by the date of release. The item with the most recent date of release is listed first.  
*2. The system displays a list of all released versions of the item. For each entry, the version number and the date of release and the release comment is displayed. The last released version of the revision is displayed. ''Note: In simple publication and simple modification workflow, the release comment is actually the submission comment.'' The list is sorted descending by the date of release. The item with the most recent date of release is listed first.  
*3. The use case ends successfully.
*3. The use case ends successfully.
===Post-Conditions / Results===
===Post-Conditions / Results===
• A list of the released item versions is displayed, sorted in descending order.
*A list of the released item versions is displayed, sorted in descending order.
 
 


==UC_PM_BD_06 view item event log==
==UC_PM_BD_06 view item event log==
The user chooses to view the log entries for the item versions, i.e. detailed information on all events. Events include creation of new item versions as well as status changes and their correlating action comments. For each log entry the user who executed the event, the date of this event and the version number is provided.
The user chooses to view the log entries for the item versions, i.e. detailed information on all events. Events include creation of new item versions as well as status changes and their correlating action comments. For each log entry the user who executed the event, the date of this event and the version number is provided.
See also [[PubMan Logging|Logging]]


===Status/Schedule===
===Status/Schedule===
*Status: '''not implemented'''
*Status: '''implemented'''
*Schedule:'''to be defined'''
*Schedule:'''R3'''
 
===Triggers===
===Triggers===
• The user wants to see the log of an item.
*The user wants to see the log of an item.
• This use case is included by the use case UC_PM_BD_04 view item version.
 
*This use case is included by the use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|UC_PM_BD_04 view item version]].
 
===Actors===
===Actors===
• Depositor
*Depositor
• Moderator
 
• Metadata-Editor
*Moderator
• Authority
 
*Metadata-Editor
 
*Authority
 
===Pre-Conditions===
===Pre-Conditions===
• One item is selected.
*One item is selected.
• The depositor is the owner of the item.
 
*The depositor is the owner of the item.
 
===Flow of Events===
===Flow of Events===
*1. The user chooses to see the item log.
*1. The user chooses to see the item log.
*2. The system displays all item versions and their corresponding log entries (see FE_PM_09 Logging). The list is sorted descending by the date of event. The most recent event is listed first.
*2. The system displays all item versions and their corresponding log entries (see [[PubMan_Logging | Logging]]). The list is sorted descending by the date of event. The most recent event is listed first.
*3. (Optionally) The user chooses to view the differences between two item versions. Include UC_PM_BD_10 View differences between two item versions.
 
*4. The use case ends successfully.
*4. The use case ends successfully.


===Post-Conditions / Results===
===Post-Conditions / Results===
• The event log of the item is displayed.
*The event log of the item is displayed.
 
===Future Developments===
add optional step 3:
*3. (Optionally) The user chooses to view the differences between two item versions. Include UC_PM_BD_xx View differences between two item versions.
 
 


==UC_PM_BD_07 view revisions of item==
==UC_PM_BD_07 view revisions of item==
The user chooses to display all items for which a relation of type IsRevisionOf/HasRevision to/from the selected item exists. The selected item can be source or target of the relation.
The user chooses to display all items for which a relation of type IsRevisionOf/HasRevision to/from the selected item exists. The selected item can be source or target of the relation.
'''[R2]'''Only the relation of type “IsRevisionOf” will be implemented.
 
===Status/Schedule===
===Status/Schedule===
*Status: '''partly implemented R2''' (hasRevisions not implemented, revision comments not implemented)
*Status: '''implemented'''
*Schedule:'''R3'''
*Schedule:'''R3'''
===Triggers===
===Triggers===
• The user wants to display the related revisions of a selected item.
*The user wants to display the related revisions of a selected item.
• This use case is included by the use case UC_PM_BD_04 view item version.
 
*This use case is included by the use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|UC_PM_BD_04 view item version]].
 
===Actors===
===Actors===
• User
*User
===Pre-Conditions===
===Pre-Conditions===
• One item is selected.
*One item is selected.
• At least one revision of the item exists, which is in state “released”.
 
*At least one revision of the item exists, which is in state “released”.''Note: this is valid for both sides of relation''
 
===Flow of Events===
===Flow of Events===
*1. The user chooses to view the revisions of a selected item.
*1. The user chooses to view the revisions of a selected item.
*2. The system displays a list of all former and a list of all later revisions of the item. Former revisions are items which have a relation of type “HasRevision” pointing to the selected item or items to which the selected item has a relation of type "IsRevisionOf". Later revisions are items which have a relation of type “IsRevisionOf” pointing to the selected item or items to which the selected item has a relation of type “HasRevision”. If a relation description exists, the system displays it. The lists are sorted descending by the date of release of the last released version. The item with the most recent date of release is listed first. The use case ends successfully.
*2. The system displays a list of all former and a list of all later revisions of the item. Only immmediately related items are displayed (= first level of relation).
 
Former revisions are items which have a relation of type “HasRevision” pointing to the selected item or items to which the selected item has a relation of type "IsRevisionOf".  
 
Later revisions are items which have a relation of type “IsRevisionOf” pointing to the selected item or items to which the selected item has a relation of type “HasRevision”.  
 
If a relation description (comment) exists, the system displays it. The lists are sorted descending by the date of release of the last released version. The item with the most recent date of release is listed first. The use case ends successfully.


===Post-Conditions / Results===
===Post-Conditions / Results===
• The system displays a list of existing revisions of an item.
*The system displays a list of existing revisions of an item.
===Future development===
As semantic relations will be extended in future, better visualisation of related items needed. Details to be crosschecked with users:
*increase visibility of OA revisions (e.g if revision of item exists, which is OA, highlight it)
*increase visibility of chronological order of revisions (i.e. make understandable which is "latest"/most current revision)


==UC_PM_BD_08 view item statistics==
==UC_PM_BD_08 view item statistics==
The user chooses to display the usage statistics for an item.
The user chooses to display the usage statistics for an item.
See also [[PubMan Statistics|Statistics]]
===Status/Schedule===
===Status/Schedule===
*Status: '''in implementation'''
*Status: '''implemented'''
*Schedule:'''R3'''
*Schedule:'''R3'''
===Triggers===
===Triggers===
• The user wants to view the usage statistics for an item.
*The user wants to view the usage statistics for an item.
• This use case is included by the use case UC_PM_BD_04 view item version.
 
*This use case is included by the use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|UC_PM_BD_04 view item version]].
 
===Actors===
===Actors===
• User
*User
===Pre-Conditions===
===Pre-Conditions===
• One item is selected.
*One item is selected.
===Flow of Events===
===Flow of Events===
*1. The user chooses to view the usage statistics for the selected item.
*1. The user chooses to view the usage statistics for the selected item.
*2. The system displays the statistical data (see FE_PM_10 Usage Statistics). The use case ends successfully.
*2. The system displays the statistical data (see [[PubMan Statistics|Statistics]]). The use case ends successfully.
===Post-Conditions / Results===
===Post-Conditions / Results===
• The system displays the statistical data for the selected item.
*The system displays the statistical data for the selected item.


==UC_PM_BD_09 resolve item by PID==
==UC_PM_BD_09 resolve item by URL==
The user wants to view a specific item or item version by providing an URL assigned by the system for persistently citing the item or the item version.
The user wants to view a specific item or item version by providing an URL assigned by the system for persistently citing the item or the item version.
===Status/Schedule===
===Status/Schedule===
*Status: '''partly implemented''' (resolution via URL is possible, but not yet via PID. TODO:UC should  be renamed or reworked)
*Status: '''implemented'''  
*Schedule:'''R3'''
*Schedule:'''R3'''


===Triggers===
===Triggers===
• The user wants to resolve a specific item or item version.
*The user wants to resolve a specific item or item version.
===Actors===
===Actors===
• User
*User
===Pre-Conditions===
===Pre-Conditions===
• None
*None
===Flow of Events===
===Flow of Events===
*3. The user requests an item by providing the URL assigned by the system for persistently citing the item or the item version.
*1. The user requests an item by providing the URL assigned by the system for persistently citing the item or the item version.
*4. The system displays the item version details. If no explicit version is requested the last released version is displayed. The use case ends successfully.
*2. The system displays the item version details. If no explicit version is requested the last released version is displayed. The use case ends successfully.
 
===Alternatives===
===Alternatives===
*4a. No item was found.
*2a. No item was found.
*1. The system displays an error message (MSG_PM_BD_01). The use case ends without success.
**1. The system displays an error message ([[PubMan_System_Messages|MSG_PM_BD_01]]). The use case ends without success.
 
===Post-Conditions / Results===
===Post-Conditions / Results===
• The details of the item or a message is displayed.
*The details of the item or a message is displayed.
 
 


==UC_PM_BD_11 view my items==
==UC_PM_BD_11 view my items==
The user wants to view his items.
The user wants to view her items.
===Status/Schedule===
===Status/Schedule===
*Status: '''not implemented'''
*Status: '''implemented'''
*Schedule:'''R3'''
*Schedule:'''R3'''
===Triggers===
===Triggers===
• The user wants to overview all his items.
*The user wants to overview all her items.
 
===Actors===
===Actors===
• Depositor
*Depositor
===Pre-Conditions===
===Pre-Conditions===
• None
*None
===Flow of Events===
===Flow of Events===
*1. The user chooses to overview his items.
*1. The user chooses to overview his items.
*2. The system displays the list of the last versions of all items the user is owner of and the number of list entries. The defaults for the sorting order (see FE_PM_03 Sort item list) and the number of hits per page are given by the system.
*2. The system displays the list of the last versions of all items the user is owner of and the number of list entries.
*3. (Optionally) The user changes the sorting order of the item version list.
The defaults for the sorting order (see [[PubMan_Sorting | PubMan Sorting]]) and the number of hits per page are given by the system (= 10 hits per page are default).
**3.1. The system displays the item version list in the selected sorted order.
*3. (Optionally) The user changes the sorting order of the item list.  
**3.1. The system displays the item list in the selected sorted order.
*4. (Optionally) The user chooses another number of hits to be displayed per page.
*4. (Optionally) The user chooses another number of hits to be displayed per page.
**4.1. The system displays the item version list containing the selected number of hits per page.
**4.1. The system displays the item list containing the selected number of hits per page.
*5. (Optionally) The user chooses to filter the item version list according to one item state or to all states.
*5. (Optionally) The user chooses to filter the item list according to one item state or to all states. Default sorting is by pending status.  
**5.1. The system displays the list of the last versions of all items in the selected state or all states and the number of list entries.
**5.1. The system displays the list of the last versions of all items in the selected state or all states and the number of list entries.
*6. Extension point: view item version  
*6. Extension point: '''''view item version'''''
**6.1. If the user wants to view the item version, include use case UC_PM_BD_04 view item version.
**6.1. If the user wants to view the item version, include use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|UC_PM_BD_04 view item version]].
*7. Extension point: view current tasks for item
 
**7.1. If the user wants to view the current tasks for the item, include use case UC_PM_BD_13 view current tasks for item.
*8. The use case ends successfully.
*8. The use case ends successfully.
===Post-Conditions / Results===
===Post-Conditions / Results===
• The filtered item version list is displayed in the selected sorting order containing the defined number of hits per page.
*The filtered item list is displayed in the selected sorting order containing the defined number of hits per page.
 
===Future developments===
*add another extension point:
7. '''Extension point: '''''view current tasks for item'''''
7.1. If the user wants to view the current tasks for the item, include use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_13_view_current_tasks_for_item|UC_PM_BD_13 view current tasks for item]].
 
*Change default sorting for status of items from <pending> to <all>, as soon as item retrieval from Framework is performant enough.
 
 


==UC_PM_BD_12 view my tasks==
==UC_PM_BD_12 view my tasks==
The user wants to view the tasks in state “processing” assigned to him. From the task list the user is able to start the corresponding workflow actions.
The user wants to view the tasks in state “processing” assigned to him. From the task list the user is able to start the corresponding workflow actions.
===Status/Schedule===
===Status/Schedule===
*Status: '''not implemented''' (TODO: needs rework)
*Status: '''not implemented'''  
*Schedule:'''R3'''
*Schedule:'''to be defined'''
 
===Triggers===
===Triggers===
• The user wants to view his tasks in state “processing”.
*The user wants to view his tasks in state “processing”.
===Actors===
===Actors===
• Account User
*Account User
===Pre-Conditions===
===Pre-Conditions===
• The user has at least one privilege in a publication or a modification workflow.
*The user has at least one privilege in a publication or a modification workflow.
===Flow of Events===
===Flow of Events===
*1. The user chooses to view his tasks in state “processing”.
*1. The user chooses to view his tasks in state “processing”.
Line 246: Line 320:
*3. (Optionally) The user changes the sorting criterion and order of the task list.
*3. (Optionally) The user changes the sorting criterion and order of the task list.
**3.1. The system displays the task list in the selected sorting criterion an order.
**3.1. The system displays the task list in the selected sorting criterion an order.
*4. Extension point: edit item  
*4. Extension point: '''''edit item'''''
**4.1. If the task is categorized as “editable”, the associated object is an item and the user wants to edit that item version, include use case UC_PM_SM_02 edit item.
**4.1. If the task is categorized as “editable”, the associated object is an item and the user wants to edit that item version, include use case [[PubMan_Func_Spec_Submission#UC_PM_SM_02_edit_item|UC_PM_SM_02 edit item]] .
*5. Extension point: view item version  
*5. Extension point: '''''view item version'''''
**5.1. If the associated object is an item and the user wants to view the item version, include use case UC_PM_BD_04 view item version.
**5.1. If the associated object is an item and the user wants to view the item version, include use case [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|UC_PM_BD_04 view item version]].
*6. (Optionally) The user chooses one workflow action, include the corresponding use case.
*6. (Optionally) The user chooses one workflow action, include the corresponding use case.
**6.1. The system sets the state of task to “finished”.
**6.1. The system sets the state of task to “finished”.
*7. The use case ends successfully.
*7. The use case ends successfully.


''Comment Rupert:I would agree to have a task list which does not add additional management efforts for tasks. So maybe one extension point would be enough and - unless we face the situation were hundreds of task must be handled - I would keep the sorting out for now and keep the list simple. If we should go for work flows I would suggest to start as simple as possible.''
 


===Post-Conditions / Results===
===Post-Conditions / Results===
• The tasks in state “processing” for this user are displayed
*The tasks in state “processing” for this user are displayed
 
 


==UC_PM_BD_13 view current tasks for item==
==UC_PM_BD_13 view current tasks for item==
The user wants to view the tasks for a selected item.
The user wants to view the tasks for a selected item.
===Status/Schedule===
===Status/Schedule===
*Status: '''not implemented''' (TODO: needs rework)
*Status: '''not implemented'''  
*Schedule:'''R3'''
*Schedule:'''to be defined'''
 
===Triggers===
===Triggers===
• The user wants to view the tasks for a selected item.
*The user wants to view the tasks for a selected item.
===Actors===
===Actors===
• Depositor
*Depositor
===Pre-Conditions===
===Pre-Conditions===
* One item is selected.
* One item is selected.
Line 276: Line 353:
*2. The system displays all the tasks in state “processing” to which the selected item is associated to. The use case ends successfully.
*2. The system displays all the tasks in state “processing” to which the selected item is associated to. The use case ends successfully.
===Post-Conditions / Results===
===Post-Conditions / Results===
• The tasks for the selected item are displayed.
*The tasks for the selected item are displayed.
 
===Comment DEV Team===
*''Natasa: maybe we can rework this use case as at one time there can be only one task in state "processing" for an item. Again, workflow dependent, but probably view the item "position" in the workflow would be better i.e. not limit to state "processing".'' --[[User:Natasab|Natasa]] 12:27, 22 January 2008 (CET)
 
''However we name the use case...the functionality should provide to a user to see, "where" in the workflow loop the item is currently...so it is indeed the position in the workflow. Agree to rework for future release.
''--[[User:Uat|Ulla]] 17:25, 1 February 2008 (CET)
 
==UC_PM_BD_14 Moderator Workspace (QA Workspace)==
 
===Scenario===
As we currently don't have a workflow engine, we decided to have a so called "moderator workspace" for now.
 
In the moderator workspace the moderator sees all items, which have been submitted in the collection(s) where s/he is moderator. Only the moderator can release items after s/he has checked them.
 
===Specification===
'''Status: implemented'''
 
'''Schedule: R3.5'''
 
===Pre-conditions===
*Extended publication and modification workflow (e.g. depositor can only submit an item when s/he creates it)
*the following is only true for users, which have only moderator privileges (if they also have depositor rights, they have two workspaces a depositor one and a moderator one)
 
===Moderator Workspace===
 
*moderator can see all items, which s/he has privilege as moderator
*the default sorting is descending by date of creation/last change of the item, so that the newest entry is listed first
 
===Send back for re-work===
See: [[PubMan_Func_Spec_Quality_Assurance#UC_PM_QA_04_send_item_back_for_rework|Func. Spec. QA]].
 
===Prototype===
* [https://subversion.mpdl.mpg.de/repos/smc/tags/public/PubMan/Concepts/Moderator_workspace/index.html Moderator Workspace]
 
===Future Development===
* the user name of the depositor should be visible within the QA workspace
 
===Discussion===
[[Talk:PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_14_Moderator_Workspace]]


==Additional information==
==Additional information==
===File visibility===
===File visibility===
The possibility of downloading a file depends on the visibility of the file or the privilege of the user to edit the item version.
The possibility of downloading a file depends on  
*the access level set to a file
*the organisational unit a user is assigned to
*the status of the item. Files attached to items in status <withdrawn>, cannot be downloaded.
 
Files with the visibility  
Files with the visibility  
*“Private” can be downloaded by the owner,
*“Private” can be downloaded by the owner,
Line 286: Line 406:
*“Public” can be downloaded by all users of the system including the “anonymous user”.
*“Public” can be downloaded by all users of the system including the “anonymous user”.


[[Category:PubMan]]
See [[PubMan_File_Properties|PubMan File Properties]] for more information.
[[Category:Functional_specification]]
 
===Display===
Please see [[PubMan Display | Display types on PubMan]]
 
===Sorting===
Please see [[PubMan Sorting | Sorting on PubMan]]
 
===Help===
Please see [[PubMan Help | Helptexts]]
 
===Actions possible on versions/releases of items ===
PLease see [[PubMan_Action_Matrix | PubMan Action Matrix]]
 
==HTML Prototype ==
 
* The publicly available '''HTML prototype for browsing and displays''' and for other functionalities can be accessed from here: [[ESciDoc_Prototyping#PubMan_Prototype|eSciDoc Prototyping]].
 
[[Category:PubMan_Functional_Specification|View]]

Latest revision as of 13:08, 20 April 2012

PubMan Functional Specification

View · Browse
Full Submission · Easy Submission
Import · Export
Quality Assurance · Search
Collaboration · Copyright
Collection Administration
Organizational Unit Management
User Management
Feeding local webpages
History of affiliations


edit


UC_PM_BD_02 view item list[edit]

The user views the search result list of one or more items. The user is able to modify the display of the item list by changing the sorting order, the number of displayed items or the display type.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • This use case is included by the use cases

UC_PM_SR_01 do simple search,

UC_PM_SR_03 do advanced search,

UC_PM_BD_03 browse by organizational unit and

UC_PM_BD_11 View my items

Actors[edit]

  • User

Pre-Conditions[edit]

  • A search result list is available.

Flow of Events[edit]

  • 1. The user chooses to view a list of items by executing one of the above mentioned use cases.
  • 2. The system displays the number of items and the list of items. The defaults for the display type (see PubMan Display), the sorting order (see PubMan Sorting) and the number of hits per page are given by the system (= by default: 10 hits per page) or are taken from the users preferences if available.
  • 3. (Optionally) The user changes the sorting order.
    • 3.1. The system displays the item list in the selected sorted order.
  • 4. (Optionally) The user chooses another number of hits to be displayed per page.
    • 4.1.The system displays the item list containing the selected number of hits per page.
  • 5. (Optionally) The user changes the display type.
    • 5.1. The system displays the item list in the selected display type.
  • 6.(Optionally) The user changes the display type for one item.
    • 6.1.The system displays the item in the selected display type.
  • 7. The use case ends successfully.

Post-Conditions / Results[edit]

  • The item list is displayed in the selected sorting order containing the defined number of hits per page and the items are displayed in their selected display type.

UC_PM_BD_04 view item version[edit]

The user views the details of a selected version of an item.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R5

Triggers[edit]

  • The user wants to view the details of the item version.

Actors[edit]

  • User

Pre-Conditions[edit]

  • One item version is selected.
  • See matrix for actions on versions/releases of an item under PubMan_Action_Matrix

Flow of Events[edit]

  • 1. The user chooses to view the selected item version.
  • 2. The system displays the data of the item version and the files. The possibility for download is offered for all files the user has privileges to access (for details see PubMan Visibility). The possibility to view detailed information about each organization related to the item is offered, providing that information on this organization is stored in the system.
  • 3. (Optionally) The user chooses to download a file.
    • 3.1. The system provides the file for download.
  • 4. (Optionally) The user (only logged in users of the corresponding context) chooses to send an E-Mail to the moderator of the context, the item is administrated at.
    • 4.1 A Link from view item version is displayed. When the user clicks on the link, a new window opens with to prefilled with the contact address of the moderator of the responsible context and with the escidoc Id prefilled as subject. Further more the user can write a text and then send the Mail. Currently we took the pubman-support@gwdg.de mail address, as the contact address can't be defined per context yet.
  • 4. (Optionally) The user chooses to view detailed information about an organization related to the item.
  • 5. (Optionally) The user chooses to view the researcher profile of an author related to the item.
    • 5.1. The researcher profile, including a list of publications and person information stored in the CoNE service (see UC View researcher portfolio), is displayed, if the respective author has an authorized CONE person ID.
  • 6. Extension point: view release history
    • 6.1. If the user wants to view all released versions of the item and there is at least one released version of the item, include use case UC_PM_BD_05 view release history.
  • 7. Extension point: view item event log
    • 7.1. If the user is in any role defined in the workflows for the item’s collection and wants to view the log entries for the item versions, include use case UC_PM_BD_06 view item event log.
  • 8. Extension point: view revisions of item
    • 8.1. If the user wants to view all related revisions of the item and if there is at least one related revision of the item, include use case UC_PM_BD_07 view revisions of item.
  • 10. Extension point: create item from template
  • 11. Extension point: create new revision of item
    • 11.1. If the user has the role “Depositor”, and the current item version is in state “released” and the user wants to create a new revision for that released version, include use case UC_PM_SM_11 create new revision of item.
  • 12. Extension point: modify item
    • 12.1. If the user is allowed to start the modification workflow for the item, the last item version is selected and in state “released” and the user wants to modify that item version, include UC_PM_QA_11 modify item.
  • 13. Extension point: withdraw item
    • 13.1. If the user is the owner of that item, the last item version is in state “released” and the user wants to withdraw that item, include use case UC_PM_QA_09 withdraw item.
  • 14. Extension point: do simple export
  • 15. Extension point: grant or revoke audience privileges for files
  • 16. The use case ends successfully.

Alternatives[edit]

  • 2a. The item is in state “withdrawn”.
    • 1. The system displays the withdrawal comment, the withdrawal date and the item data (see PubMan Display). The use case ends successfully.

Post-Conditions / Results[edit]

  • The details of the item are displayed, including the information how to cite this item.

Future Developement[edit]

  • offer alternative 2b for navigating from previous/next single item view:

2b. The item was opened from a item list.

    • 1. The system gives the possibility to go to the next or previous item in the list.
    • 2. The system displays the previous/next item version
  • Link with "Cite this file as...."
  • automatically sending of private PDFs (The idea is that someone provides his email address - some mechanism shoud ensure that it is actually a person - and then the website should send the pdf.)

UC_PM_BD_05 view release history[edit]

The user chooses to get an overview on the released versions of an item.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user chooses to see the released versions of an item.

Actors[edit]

  • User

Pre-Conditions[edit]

  • One item is selected
  • At least one item version in status “released” exists.

Flow of Events[edit]

  • 1. The user chooses to view the release history for the selected item.
  • 2. The system displays a list of all released versions of the item. For each entry, the version number and the date of release and the release comment is displayed. The last released version of the revision is displayed. Note: In simple publication and simple modification workflow, the release comment is actually the submission comment. The list is sorted descending by the date of release. The item with the most recent date of release is listed first.
  • 3. The use case ends successfully.

Post-Conditions / Results[edit]

  • A list of the released item versions is displayed, sorted in descending order.


UC_PM_BD_06 view item event log[edit]

The user chooses to view the log entries for the item versions, i.e. detailed information on all events. Events include creation of new item versions as well as status changes and their correlating action comments. For each log entry the user who executed the event, the date of this event and the version number is provided.

See also Logging

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to see the log of an item.

Actors[edit]

  • Depositor
  • Moderator
  • Metadata-Editor
  • Authority

Pre-Conditions[edit]

  • One item is selected.
  • The depositor is the owner of the item.

Flow of Events[edit]

  • 1. The user chooses to see the item log.
  • 2. The system displays all item versions and their corresponding log entries (see Logging). The list is sorted descending by the date of event. The most recent event is listed first.
  • 4. The use case ends successfully.

Post-Conditions / Results[edit]

  • The event log of the item is displayed.

Future Developments[edit]

add optional step 3:

  • 3. (Optionally) The user chooses to view the differences between two item versions. Include UC_PM_BD_xx View differences between two item versions.


UC_PM_BD_07 view revisions of item[edit]

The user chooses to display all items for which a relation of type IsRevisionOf/HasRevision to/from the selected item exists. The selected item can be source or target of the relation.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to display the related revisions of a selected item.

Actors[edit]

  • User

Pre-Conditions[edit]

  • One item is selected.
  • At least one revision of the item exists, which is in state “released”.Note: this is valid for both sides of relation

Flow of Events[edit]

  • 1. The user chooses to view the revisions of a selected item.
  • 2. The system displays a list of all former and a list of all later revisions of the item. Only immmediately related items are displayed (= first level of relation).

Former revisions are items which have a relation of type “HasRevision” pointing to the selected item or items to which the selected item has a relation of type "IsRevisionOf".

Later revisions are items which have a relation of type “IsRevisionOf” pointing to the selected item or items to which the selected item has a relation of type “HasRevision”.

If a relation description (comment) exists, the system displays it. The lists are sorted descending by the date of release of the last released version. The item with the most recent date of release is listed first. The use case ends successfully.

Post-Conditions / Results[edit]

  • The system displays a list of existing revisions of an item.

Future development[edit]

As semantic relations will be extended in future, better visualisation of related items needed. Details to be crosschecked with users:

  • increase visibility of OA revisions (e.g if revision of item exists, which is OA, highlight it)
  • increase visibility of chronological order of revisions (i.e. make understandable which is "latest"/most current revision)

UC_PM_BD_08 view item statistics[edit]

The user chooses to display the usage statistics for an item.

See also Statistics

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to view the usage statistics for an item.

Actors[edit]

  • User

Pre-Conditions[edit]

  • One item is selected.

Flow of Events[edit]

  • 1. The user chooses to view the usage statistics for the selected item.
  • 2. The system displays the statistical data (see Statistics). The use case ends successfully.

Post-Conditions / Results[edit]

  • The system displays the statistical data for the selected item.

UC_PM_BD_09 resolve item by URL[edit]

The user wants to view a specific item or item version by providing an URL assigned by the system for persistently citing the item or the item version.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to resolve a specific item or item version.

Actors[edit]

  • User

Pre-Conditions[edit]

  • None

Flow of Events[edit]

  • 1. The user requests an item by providing the URL assigned by the system for persistently citing the item or the item version.
  • 2. The system displays the item version details. If no explicit version is requested the last released version is displayed. The use case ends successfully.

Alternatives[edit]

  • 2a. No item was found.
    • 1. The system displays an error message (MSG_PM_BD_01). The use case ends without success.

Post-Conditions / Results[edit]

  • The details of the item or a message is displayed.


UC_PM_BD_11 view my items[edit]

The user wants to view her items.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to overview all her items.

Actors[edit]

  • Depositor

Pre-Conditions[edit]

  • None

Flow of Events[edit]

  • 1. The user chooses to overview his items.
  • 2. The system displays the list of the last versions of all items the user is owner of and the number of list entries.

The defaults for the sorting order (see PubMan Sorting) and the number of hits per page are given by the system (= 10 hits per page are default).

  • 3. (Optionally) The user changes the sorting order of the item list.
    • 3.1. The system displays the item list in the selected sorted order.
  • 4. (Optionally) The user chooses another number of hits to be displayed per page.
    • 4.1. The system displays the item list containing the selected number of hits per page.
  • 5. (Optionally) The user chooses to filter the item list according to one item state or to all states. Default sorting is by pending status.
    • 5.1. The system displays the list of the last versions of all items in the selected state or all states and the number of list entries.
  • 6. Extension point: view item version
  • 8. The use case ends successfully.

Post-Conditions / Results[edit]

  • The filtered item list is displayed in the selected sorting order containing the defined number of hits per page.

Future developments[edit]

  • add another extension point:

7. Extension point: view current tasks for item 7.1. If the user wants to view the current tasks for the item, include use case UC_PM_BD_13 view current tasks for item.

  • Change default sorting for status of items from <pending> to <all>, as soon as item retrieval from Framework is performant enough.


UC_PM_BD_12 view my tasks[edit]

The user wants to view the tasks in state “processing” assigned to him. From the task list the user is able to start the corresponding workflow actions.

Status/Schedule[edit]

  • Status: not implemented
  • Schedule:to be defined

Triggers[edit]

  • The user wants to view his tasks in state “processing”.

Actors[edit]

  • Account User

Pre-Conditions[edit]

  • The user has at least one privilege in a publication or a modification workflow.

Flow of Events[edit]

  • 1. The user chooses to view his tasks in state “processing”.
  • 2. The system displays the list of tasks and the corresponding workflow actions. The list can be sorted by start date (default descending), label or object information.
  • 3. (Optionally) The user changes the sorting criterion and order of the task list.
    • 3.1. The system displays the task list in the selected sorting criterion an order.
  • 4. Extension point: edit item
    • 4.1. If the task is categorized as “editable”, the associated object is an item and the user wants to edit that item version, include use case UC_PM_SM_02 edit item .
  • 5. Extension point: view item version
  • 6. (Optionally) The user chooses one workflow action, include the corresponding use case.
    • 6.1. The system sets the state of task to “finished”.
  • 7. The use case ends successfully.


Post-Conditions / Results[edit]

  • The tasks in state “processing” for this user are displayed


UC_PM_BD_13 view current tasks for item[edit]

The user wants to view the tasks for a selected item.

Status/Schedule[edit]

  • Status: not implemented
  • Schedule:to be defined

Triggers[edit]

  • The user wants to view the tasks for a selected item.

Actors[edit]

  • Depositor

Pre-Conditions[edit]

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

Flow of Events[edit]

  • 1. The user chooses to view the tasks for the selected item.
  • 2. The system displays all the tasks in state “processing” to which the selected item is associated to. The use case ends successfully.

Post-Conditions / Results[edit]

  • The tasks for the selected item are displayed.

Comment DEV Team[edit]

  • Natasa: maybe we can rework this use case as at one time there can be only one task in state "processing" for an item. Again, workflow dependent, but probably view the item "position" in the workflow would be better i.e. not limit to state "processing". --Natasa 12:27, 22 January 2008 (CET)

However we name the use case...the functionality should provide to a user to see, "where" in the workflow loop the item is currently...so it is indeed the position in the workflow. Agree to rework for future release. --Ulla 17:25, 1 February 2008 (CET)

UC_PM_BD_14 Moderator Workspace (QA Workspace)[edit]

Scenario[edit]

As we currently don't have a workflow engine, we decided to have a so called "moderator workspace" for now.

In the moderator workspace the moderator sees all items, which have been submitted in the collection(s) where s/he is moderator. Only the moderator can release items after s/he has checked them.

Specification[edit]

Status: implemented

Schedule: R3.5

Pre-conditions[edit]

  • Extended publication and modification workflow (e.g. depositor can only submit an item when s/he creates it)
  • the following is only true for users, which have only moderator privileges (if they also have depositor rights, they have two workspaces a depositor one and a moderator one)

Moderator Workspace[edit]

  • moderator can see all items, which s/he has privilege as moderator
  • the default sorting is descending by date of creation/last change of the item, so that the newest entry is listed first

Send back for re-work[edit]

See: Func. Spec. QA.

Prototype[edit]

Future Development[edit]

  • the user name of the depositor should be visible within the QA workspace

Discussion[edit]

Talk:PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_14_Moderator_Workspace

Additional information[edit]

File visibility[edit]

The possibility of downloading a file depends on

  • the access level set to a file
  • the organisational unit a user is assigned to
  • the status of the item. Files attached to items in status <withdrawn>, cannot be downloaded.

Files with the visibility

  • “Private” can be downloaded by the owner,
  • “Organizational unit” can be downloaded by any user who is member of any of the organizational units the file is visible by or their subunits,
  • “Public” can be downloaded by all users of the system including the “anonymous user”.

See PubMan File Properties for more information.

Display[edit]

Please see Display types on PubMan

Sorting[edit]

Please see Sorting on PubMan

Help[edit]

Please see Helptexts

Actions possible on versions/releases of items[edit]

PLease see PubMan Action Matrix

HTML Prototype[edit]

  • The publicly available HTML prototype for browsing and displays and for other functionalities can be accessed from here: eSciDoc Prototyping.

Publication Management

Use Case

Control of Named Entities

Control of Named Entities

Identifier

Portable Document Format

Open Access

Uniform Resource Locator

Central European Time

Quality Assurance

Hypertext Markup Language

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