Difference between revisions of "PubMan Func Spec Basket"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(13 intermediate revisions by the same user not shown)
Line 5: Line 5:
===Status/Schedule===
===Status/Schedule===
*Status: '''implemented'''
*Status: '''implemented'''
''


===Triggers ===
===Triggers ===
* User wants to combine results of several resources for common reuse, like export.  
* User wants to combine results from several searches for common reuse, like export.  
* User (librarian) wants to collect entered/modified items to create a list.
* User (librarian) wants to collect entered/modified items to create a list.
===Actors ===
===Actors ===
*User
*User
Line 17: Line 15:
* None of the items that should be added are already included in basket.
* None of the items that should be added are already included in basket.
* Item can be in any status.
* Item can be in any status.
===Flow of Events ===
===Flow of Events ===
*1. The user chooses to open a list of items. This can happen by executing a search or by opening "My items" or "Import Workspace".
*1. The user chooses to open a list of items. This can happen by executing a search or by opening "My items" or "Import Workspace".
*2. The user marks all items that should be added to basket.
*2. The user marks all items that should be added to basket.
*3. The user clicks on button "add to basket" in list view.
*3. The user clicks on button "Add to Basket" in list view.
*4. The marked items are entered to basket. The counting of the included items is updated.  
*4. The marked items are entered to basket. The counting of the included items is updated.  
*5. The use case ends successfully.
*5. The use case ends successfully.
===Post-Conditions/Results===
*The added items are included in basket. When opening the basket all of the added items are displayed as list. The counting of included items is updated and shows the current number of items in basket.
==Add current item to basket==


===Status/Schedule===
*Status: '''implemented'''
''
===Triggers ===
* User wants to add an opened item to basket.
===Actors ===
*User
===Pre-Conditions ===
* Basket may be empty or filled with items.
* The item that should be added to basket is not already included in basket.
* Item can be in any status.
===Flow of Events ===
*1. The user chooses to open an item. User openes item view.
*2. The user clicks on button "Add to Basket".
*4. The opened item is entered to basket. The counting of the included items is updated.
*5. The use case ends successfully.
===Post-Conditions / Results===
===Post-Conditions / Results===
*The added items are included in basket. When opening the basket all of the added items are displayed as list. The counting of included items is updated and shows the current number of items in basket.
*The added item is included in basket. When opening the basket the item is displayed in list. The counting of included items is updated and shows the current number of items in basket.
 
==Add several item versions to basket==
==Add several item versions to basket==


===Status/Schedule===
===Status/Schedule===
*Status: '''implemented'''
*Status: not implemented
 


===Triggers===
===Triggers===
*The user wants to view the details of the item version.
* The user wants to add a new version of an item to basket. This can happen when user updates an item and wants to add the latest version to basket.  
===Actors===
===Actors===
*User
*User
===Pre-Conditions===
===Pre-Conditions===
 
* There is already a version of the item added to basket.
* User has rights to modify the item.


===Flow of Events===
===Flow of Events===
*1. The user chooses to view the selected item version.
*1. An item version is already added to basket. The status of the version is "pending" or "submitted".  
*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.
*2. The user updates the item. The status of the new version is "pending" or "submitted". The button "Add to 'Basket" is available.
*3. (Optionally) The user chooses to download a file.
*3. The user adds the latest version to basket.  
**3.1. The system provides the file for download.
*4. Current Result: The counting of the items included in basket counts every version. If user openes basket only one version is displayed. (Mostly the latest one). The version can't get moved from basket.
*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.
**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]].
*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 [[Researcher_Portfolio#UC_View_researcher_portfolio.2Fprofile|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 [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_05_view_release_history | UC_PM_BD_05 view release history]].  


*7. Extension point: '''''view item event log'''''
===Alternatives===
**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]].
*1a. An item version is already added to basket. The status of the version is "released".
 
**2. The user updates the item. The status of the new version is "pending" or "submitted". The button "Add to Basket" is available.
*8. Extension point: '''''view revisions of item'''''
**3. The use case continues with step 3.
**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]].  
*1b. An item version is already added to basket. The status of the version is "released".
 
**2. The user updates the item. The status of the new version is "released". The button "Add to Basket" is available.
*9. Extension point: '''''view item statistics'''''
**3. Use case continues with step 3.
**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]].
*1c. An item version is already added to basket. The status of the version is "released".
 
**2. The user updates the item. The status of the new version is "discarded". The button "Add to Basket" is not availalbe in item view.  
*10. Extension point: '''''create item from template'''''
**3. User openes list view with discarded item.
**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]].
**4. User marks and adds item to basket.
 
**5. System Messages: "0 item(s) were added to the basket. 1 of the selected items are already in the basket." occur. Counting of items is not updated.  
*11. Extension point: '''''create new revision of item'''''
*2a. The user updates the item. The status of the new version is "released". The button "Add to Basket" is '''NOT''' available. Latest version can't get added to basket.
**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===
*2a. The item is in state “withdrawn”.
**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, including the information how to cite this item.
*Current Result: The counting of the items included in basket counts every version. If user openes basket only one version is displayed. (Mostly the latest one).
 
===Future Developement===


===Discussion===
* Should it be possible to modify items that are in basket?
* Should it be possible to enter new versions to basket?
* Should versions in basket being updated automatically ?
* The following case is theoretically possible: User A enters version in Basket. User B modifies item while it is in basket. 




[[Category:PubMan_Functional_Specification|View]]
[[Category:PubMan_Functional_Specification|View]]

Latest revision as of 13:58, 27 October 2014

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


Add one or more item(s) to basket[edit]

Status/Schedule[edit]

  • Status: implemented

Triggers[edit]

  • User wants to combine results from several searches for common reuse, like export.
  • User (librarian) wants to collect entered/modified items to create a list.

Actors[edit]

  • User

Pre-Conditions[edit]

  • Basket may be empty or filled with items.
  • None of the items that should be added are already included in basket.
  • Item can be in any status.

Flow of Events[edit]

  • 1. The user chooses to open a list of items. This can happen by executing a search or by opening "My items" or "Import Workspace".
  • 2. The user marks all items that should be added to basket.
  • 3. The user clicks on button "Add to Basket" in list view.
  • 4. The marked items are entered to basket. The counting of the included items is updated.
  • 5. The use case ends successfully.

Post-Conditions/Results[edit]

  • The added items are included in basket. When opening the basket all of the added items are displayed as list. The counting of included items is updated and shows the current number of items in basket.

Add current item to basket[edit]

Status/Schedule[edit]

  • Status: implemented

Triggers[edit]

  • User wants to add an opened item to basket.

Actors[edit]

  • User

Pre-Conditions[edit]

  • Basket may be empty or filled with items.
  • The item that should be added to basket is not already included in basket.
  • Item can be in any status.

Flow of Events[edit]

  • 1. The user chooses to open an item. User openes item view.
  • 2. The user clicks on button "Add to Basket".
  • 4. The opened item is entered to basket. The counting of the included items is updated.
  • 5. The use case ends successfully.

Post-Conditions / Results[edit]

  • The added item is included in basket. When opening the basket the item is displayed in list. The counting of included items is updated and shows the current number of items in basket.

Add several item versions to basket[edit]

Status/Schedule[edit]

  • Status: not implemented

Triggers[edit]

  • The user wants to add a new version of an item to basket. This can happen when user updates an item and wants to add the latest version to basket.

Actors[edit]

  • User

Pre-Conditions[edit]

  • There is already a version of the item added to basket.
  • User has rights to modify the item.

Flow of Events[edit]

  • 1. An item version is already added to basket. The status of the version is "pending" or "submitted".
  • 2. The user updates the item. The status of the new version is "pending" or "submitted". The button "Add to 'Basket" is available.
  • 3. The user adds the latest version to basket.
  • 4. Current Result: The counting of the items included in basket counts every version. If user openes basket only one version is displayed. (Mostly the latest one). The version can't get moved from basket.

Alternatives[edit]

  • 1a. An item version is already added to basket. The status of the version is "released".
    • 2. The user updates the item. The status of the new version is "pending" or "submitted". The button "Add to Basket" is available.
    • 3. The use case continues with step 3.
  • 1b. An item version is already added to basket. The status of the version is "released".
    • 2. The user updates the item. The status of the new version is "released". The button "Add to Basket" is available.
    • 3. Use case continues with step 3.
  • 1c. An item version is already added to basket. The status of the version is "released".
    • 2. The user updates the item. The status of the new version is "discarded". The button "Add to Basket" is not availalbe in item view.
    • 3. User openes list view with discarded item.
    • 4. User marks and adds item to basket.
    • 5. System Messages: "0 item(s) were added to the basket. 1 of the selected items are already in the basket." occur. Counting of items is not updated.
  • 2a. The user updates the item. The status of the new version is "released". The button "Add to Basket" is NOT available. Latest version can't get added to basket.

Post-Conditions / Results[edit]

  • Current Result: The counting of the items included in basket counts every version. If user openes basket only one version is displayed. (Mostly the latest one).

Discussion[edit]

  • Should it be possible to modify items that are in basket?
  • Should it be possible to enter new versions to basket?
  • Should versions in basket being updated automatically ?
  • The following case is theoretically possible: User A enters version in Basket. User B modifies item while it is in basket.

Publication Management

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