PubMan Func Spec Collection Administration

From MPDLMediaWiki
Revision as of 11:38, 5 January 2010 by Natasab (talk | contribs) (→‎General rules)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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_CA_01 create a collection[edit]

One or more organizational units need a new collection as an administrative container for managing their items. The organizational unit(s) are responsible for managing the items. This responsibility is defined as "context of responsibility".

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to create a new collection for one or more organizational units.

Actors[edit]

  • Local Administrator

Pre-Conditions[edit]

  • At least one publication workflow and one modification workflow are available.

Flow of Events[edit]

  • 1. The user chooses to create a collection.
  • 2. The system displays a list of all open organizational units and subunits for which the user has the privileges as local administrator.
  • 3. (Optionally) The user chooses to view the organizational unit description.
    • 3.1. The system displays the organizational unit description
  • 4. The user selects one or more organizational units and confirms the choice.
  • 5. The system creates a collection in the state “created” with the selected organizational unit(s) and the standard workflows predefined. By default all available genres are selected as “allowed genres”, all available submission methods are selected as “allowed submission methods”.
  • 6. Continue with use case UC_PM_CA_02 edit collection with the created collection as selected collection. The use case ends successfully.

Post-Conditions / Results[edit]

  • A new collection in the state “created” has been created.

Discussion[edit]

Talk:PubMan_Func_Spec_Collection_Administration#UC_PM_CA_01 create a collection

UC_PM_CA_02 edit collection[edit]

The user edits the collection attributes or the default metadata values.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to edit the collection attributes or the default metadata values.

Actors[edit]

  • Local Administrator

Pre-Conditions[edit]

  • One collection is selected.
  • The collection is in the state “created” or “opened”.

Flow of Events[edit]

  • 1. The user chooses to edit the selected collection or the collection was selected by a previous use case.
  • 2. The system displays the collection edit view.
  • 3. (Optionally) The user adds other open organizational units for which the user has the privileges as local administrator.
  • 4. (Optionally) The user edits the collection attributes or the default metadata values.
    • 4.1. The system checks if items in the selected collection exist with a genre not listed as an allowed genre.
      • a. No items exist.
      • b. At least one item exists. The system displays an error message (MSG_PM_CA_01). Continue with 4.
  • 5. (Optionally) The user specifies a Contact Email. Currently this doesn't have any effect. In the future it should be, that this address is being taken into account for contact moderator from view item version for logged in users. Currently only one address can be defined for all contexts, therefore we decided, that all mails should go to PubMan Support. --Nicole 10:23, 20 November 2009 (UTC)
  • 6. Extension point: configure workflows
  • 7. (Optionally) The user defines the rules for the validation points in the workflow definitions.
  • 8. (Optionally) The user chooses to assign account users to the roles of the collection’s workflows.
    • 8.1. The system displays a list of roles defined in the workflows of the collection.
    • 8.2. The user selects one role.
    • 8.3. The system displays a list of all account users.
    • 8.4. The user selects one or more account users and confirms the input.
    • 8.5. The system creates a privilege for each selected account user with the selected role and the collection as the object. The system updates the collection edit view.
  • 9. The user chooses to confirm the input.
  • 10. The system stores the data and displays a success message (MSG_PM_CA_02). The use case ends successfully.

Post-Conditions / Results[edit]

  • The collection data is saved.

Discussion[edit]

Talk:PubMan_Func_Spec_Collection_Administration#UC_PM_CA_02 edit collection

UC_PM_CA_03 open collection[edit]

Users should be able to submit items to a collection. For this reason the collection must be opened.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to open a collection for item submission.

Actors[edit]

  • Local Administrator

Pre-Conditions[edit]

  • One collection is selected.
  • The collection is in the state “created” or “closed”.

Flow of Events[edit]

  • 1. The user chooses to open a collection.
  • 2. The system prompts the user to confirm the opening of the collection.
  • 3. The user confirms to open the collection.
  • 4. The system changes the state of the collection to “opened” and displays a success message (MSG_PM_CA_03). The use case ends successfully.

Alternatives[edit]

  • 3a. The user does not confirm to open the collection.
    • 1. The selected collection is unaffected. The use case ends without success.

Post-Conditions / Results[edit]

  • The collection is in the state “opened”.

Discussion[edit]

Talk:PubMan_Func_Spec_Collection_Administration#UC_PM_CA_03 open collection

UC_PM_CA_04 close a collection[edit]

A collection should no longer be available for the submission of new items. Therefore the collection will be closed, thus no publication workflow can be further started. Anyway, items can be modified by triggering the modification workflow. Released items of a closed collection can still be searched and browsed.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to close a collection, because it should no longer be available for new submissions.

Actors[edit]

  • Local Administrator

Pre-Conditions[edit]

  • One collection is selected.
  • The collection is in the state “opened”.

Flow of Events[edit]

  • 1. The user chooses to close a collection.
  • 2. The system prompts the user to confirm the closing of the collection.
  • 3. The user confirms to close the collection.
  • 4. The systems changes the state of the collection to “closed” and displays a success message (MSG_PM_CA_04). The use case ends successfully.

Alternatives[edit]

  • 3a. The user does not confirm to close the collection.
    • 1. The selected collection is unaffected. The use case ends without success.

Post-Conditions / Results[edit]

  • The collection is in the state “closed”.
  • Already started publication workflows for this collection are unaffected.

Discussion[edit]

Talk:PubMan_Func_Spec_Collection_Administration#UC_PM_CA_04 close a collection

UC_PM_CA_05 delete a collection[edit]

A collection is no longer required in the system and should be removed from all administrative interfaces. For this action the collection is deleted. By deleting a collection, all items of the collection in state “pending” will be deleted as well. A collection can not be deleted if it contains items in any other state than “pending”.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3

Triggers[edit]

  • The user wants to delete a collection, because it is no longer used.

Actors[edit]

  • Local Administrator

Pre-Conditions[edit]

  • One collection is selected.

Flow of Events[edit]

  • 1. The user chooses to delete a collection.
  • 2. The system checks if the selected collection contains items in any other state than “pending”.
    • a. No item in any other state than “pending” exists.
    • b. One or more items in any other state than “pending” exist. The system displays an error message (MSG_PM_CA_05). The use case ends without success.
  • 3. The system displays a list of all “pending” items and prompts the user to confirm the deleting of the collection and the items.
  • 4. The user confirms to delete the collection and the “pending” items.
  • 5. The system deletes the items as well as the collection and displays a success message (MSG_PM_CA_06). .The use case ends successfully.

Alternatives[edit]

  • 4a. The user does not confirm to delete the collection and the items.
    • 1. The selected collection and the “pending” items are unaffected. The use case ends without success.

Post-Conditions / Results[edit]

  • The collection and all items in state “pending” are deleted and no longer available for any system action.

Discussion[edit]

Talk:PubMan_Func_Spec_Collection_Administration#UC_PM_CA_05 delete a collection

UC_PM_CA_06 configure workflows for collection[edit]

The user configures the publication and modification workflows for a collection.

Status/Schedule[edit]

  • Status: in specification
  • Schedule:to be defined (depends on workflow engine)

Triggers[edit]

  • The user wants to configure the workflows for a collection.
  • This use case is included by the use case UC_PM_CA_02 edit collection.

Actors[edit]

  • Local Administrator

Pre-Conditions[edit]

  • One collection is selected.
  • The collection is in state “created”
  • At least one publication workflow and one modification workflow are available.

Flow of Events[edit]

  • 1. The system displays the lists of available publication and modification workflows.
  • 2. (Optionally) The user changes the desired publication workflow.
  • 3. (Optionally) The user changes the desired modification workflow.
  • 4. The user chooses to confirm the selection.
  • 5. The system stores the selected workflows as defined for the collection and displays a success message (MSG_PM_CA_07). The use case ends successfully.

Alternatives[edit]

  • 4a. The user does not confirm the workflow selection for the collection.
    • 1. The selected collection is unaffected. The use case ends without success.

Post-Conditions / Results[edit]

  • A publication and a modification workflow for the collection is saved.

Discussion[edit]

Talk:PubMan_Func_Spec_Collection_Administration#UC_PM_CA_06 configure workflows for collection

UC_PM_CA_07 assign validation rules to a collection[edit]

The user assigns pre-defined validation rules to a collection.

Status/Schedule[edit]

  • Status: implemented
  • Schedule:R3.5

Triggers[edit]

  • The user wants to assigns pre-defined validation rules to a collection.
  • This use case is included by the use case UC_PM_CA_02 edit collection.

Actors[edit]

  • Local Administrator

Pre-Conditions[edit]

  • One collection is selected.
  • The collection is in state “created”
  • At least one publication workflow and one modification workflow are available.

Flow of Events[edit]

  • 1. The system displays the lists of available validation rules. Comment: Currently 2 sets of rules are available. One called Publications and one called grey material. The user can choose one of the sets and assign it to the collection.--Nicole 09:01, 19 June 2008 (UTC)
  • 2. The user chooses to confirm the selection.
  • 3. The system assigns the validation rules to the selected collection and displays a success message (MSG_PM_CA_07). The use case ends successfully.

Alternatives[edit]

  • 4a. The user does not confirm the validation rule selection for the collection.
    • 1. The selected collection is unaffected. The use case ends without success.

Post-Conditions / Results[edit]

  • The validation rules are assigned to the collection.

General rules[edit]

Action Created Open Closed
Open context (collection) x
Delete context(collection) x
Close context(collection) x
Edit context(collection) x x x
Configure workflow for context(collection) x x x
Configure validation schema for context(collection) x x x
Associate items x x

Discussion[edit]

Talk:PubMan_Func_Spec_Collection_Administration#Additional information