Talk:PubMan Func Spec View

Discussion on PubMan Func Spec Browsing and displays

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.

Status/Schedule

• Status: in specification
• Schedule:R3

Triggers

• 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

• 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.

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

• 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

The user browses by organizational unit.

Status/Schedule

• Status: implemented
• Schedule:R2

Triggers

• The user wants to browse by organizational unit.

Actors

• User

Pre-Conditions

• 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

• The organizational unit browse view is displayed.

UC_PM_BD_04 view item version

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

Status/Schedule

• Status: in specification
• Schedule:R3

Triggers

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

Actors

• User

Pre-Conditions

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

Flow of Events

• 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 File visibility).
• 3. (Optionally) The user chooses to download a file.
  • 3.1. The system provides the file for download.
• 4. Extension point: view release history
  • 4.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.

• 5. Extension point: view item event log
  • 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.

• 6. Extension point: view revisions of item
  • 6.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.

• 7. Extension point: view item statistics
  • 7.1. If the user wants to view the statistics for an item, include UC_PM_BD_08 view item statistics.

• 8. Extension point: create item from template
  • 8.1. If the user has the role “Depositor“ and wants to create a new item using the current item version as template, include UC_PM_SM_05 create item from template.

• 9. Extension point: create new revision of item
  • 9.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.
• 10. Extension point: modify item
  • 10.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.
• 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.
• 12. 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). The use case ends successfully.

Post-Conditions / Results

• 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

UC_PM_BD_05 view release history

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

Status/Schedule

• Status: in specification
• Schedule:R3

Triggers

• 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.

Actors

• User

Pre-Conditions

• One item is selected

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

Flow of Events

• 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

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

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.

See also Logging

Status/Schedule

• Status: in specification
• Schedule:R3

Triggers

• 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.

Actors

• Depositor

• Moderator

• Metadata-Editor

• Authority

Pre-Conditions

• One item is selected.

• The depositor is the owner of the item.

Flow of Events

• 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

• 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

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

• Status: in specification
• Schedule:R3

Triggers

• 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.

Actors

• User

Pre-Conditions

• 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

• 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

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

UC_PM_BD_08 view item statistics

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

See also Statistics

Status/Schedule

• Status: in implementation
• Schedule:R3

Triggers

• 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.

Actors

• User

Pre-Conditions

• One item is selected.

Flow of Events

• 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

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

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.

Status/Schedule

• Status: in specification
• Schedule:R3

Triggers

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

Actors

• User

Pre-Conditions

• None

Flow of Events

• 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

• 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

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

UC_PM_BD_11 view my items

The user wants to view her items.

Status/Schedule

• Status: in specification
• Schedule:R3

Triggers

• The user wants to overview all her items.

Actors

• Depositor

Pre-Conditions

• None

Flow of Events

• 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
  • 6.1. If the user wants to view the item version, include use case UC_PM_BD_04 view item version.

• 8. The use case ends successfully.

Post-Conditions / Results

• 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 UC_PM_BD_13 view current tasks for item.

Change default sorting for status of items from <pending> to <all> (Comment from Rupert).

Can be done as soon as item retrieval from Framework is performant enough.--Ulla 16:33, 26 February 2008 (CET)

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.

Status/Schedule

• Status: not implemented
• Schedule:to be defined

Triggers

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

Actors

• Account User

Pre-Conditions

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

Flow of Events

• 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
  • 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.
• 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

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

Comment DEV Team

• Natasa: Need bigger discussion within team depending on WF engine usage, not really in R3 --Natasa 12:25, 22 January 2008 (CET)

UC_PM_BD_13 view current tasks for item

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

Status/Schedule

• Status: not implemented
• Schedule:to be defined

Triggers

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

Actors

• Depositor

Pre-Conditions

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

Flow of Events

• 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

• 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". --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)

Additional information

File visibility

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

Please see Display types on PubMan

Sorting

Please see Sorting on PubMan

Help

Please see Helptexts

Item Action Matrix

PLease see Status of Pubman items

HTML Prototype Discussion

• Prototype for Browsing and Displays

We need to distinguish between list and page more clearly. UI Spec: 'list of items' means all records retrieved. A page means all items displayed.

Sorry, but I don't get your point. Is this a reminder or do you feel the need, that something in the UC has to be changed, which I personally would not suggest? --Nicole 09:35, 9 January 2008 (CET)

It is a reminder, see example below Rupert 16:00, 24 January 2008 (CET)

The system displays the first page of the item list ... Rupert

Seems to be rather terminology problem: functionality is clear, I think. Depending on the number of items retrieved, and depending on the default hits per page given, the system displays the first page, with a specific number of items. Important: total number of items should be clear to user.--Ulla 10:59, 1 February 2008 (CET)

Sort order, page and list: Sort is not performed because the user does not find an item in the current displayed list/page. Usually people sort all items with the intention to better find items with the new sort order. If we say 'sort list', the current page is useless and the system starts on the first page of the result.

Please specify your comment. I don't get the point. Does this mean it is not possible to realize this point of the UC? --Nicole 09:35, 9 January 2008 (CET)

Could be more precise: If the list spans more than one page, the system displays the first page of the selected sorting order. Rupert

Comment for Rupert: Alternatively, the option to create item from template would make sense in the easy submission (fetch Metadata scenario), by providing eSciDoc Id.--Ulla 17:10, 26 February 2008 (CET)

Needs clarification from Usability aspect/user expectations. See remarks below: Please clarify how this should work exactly: Should there only be links for next/previous or should there be links for first/last for faster navigation, too? What should be displayed when the user views an item and then chooses a revision or a release of this item? Then one can say he left the item list he originally wanted to navigate through. What should happen then? Should the system provide these previous/next links or not? If yes, should the system simply navigate to the previous/next item in the list?--Tschraut 15:55, 11 February 2008 (CET)

Tobias: According to view relaese history: Should the versions shown in the list be accessible (should it be able to view them in the view item version page to get a closer look on them)?--Tschraut 15:10, 30 January 2008 (CET)

Depends on final Gui design for listing released versions and listing revisions - how much information about the released version/revision is already displayed in the "overview"? If needed, user needs additional link to view more information on a released version/revision (additional click should be avoided to myunderstadnding)--Ulla 16:14, 26 February 2008 (CET)

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.

To be discussed with Natasa and Ulla. --Nicole 11:22, 9 January 2008 (CET)

Not scheduled for R3;-)...the remarks are all valid and have to be considered for workspace concept.--Ulla 17:20, 1 February 2008 (CET)

Nicole pls. can you rename this to 'View Versions'. Item versions are what users really get. The release history is an intellectual outcome - more abstract.Rupert 16:02, 6 December 2007 (CET)This UC can't be called "view versions", because not only released items are item versions. Also pending and submitted items are/have versions. This UC is meant for viewing released versions of items only, because this is what an external user can see, where as UC_PM_BD_06 view item event log (where all versions of an item can be seen) can be only seen by certain users. --Nicole 11:17, 9 January 2008 (CET)

I stumbled upon the word 'history' View released Versions would be fine, too. Rupert 16:14, 24 January 2008 (CET)

Renaming the use case is not necessary to my understanding. Definition of labels is another issue...iam fine with label "view released versions"--Ulla 17:02, 1 February 2008 (CET)

Publication Management

Use Case

Uniform Resource Locator

Central European Time

Workflow

Hypertext Markup Language

Enhanced Scientific Documentation