Difference between revisions of "Imeji Collection Management"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Faces}}
<p style="color:white; background-color:#097FED;"> '''Outdated''' </p>
 
{{Imeji_Tech}}


== Scenarios ==
== Scenarios ==


==== Implemented in 1.0 ====  
==== Implemented (Beta Release) ====  
* '''Create collection:''' The user wants to create a collection with a corresponding metadata profile, upload pictures to this collection, assign/edit the metadata values of the pictures within the collection. During this process, the collection and the pictures should only be visible (and searchable) to the creator.
* '''Create collection:''' The user wants to create a collection with a corresponding metadata profile, upload pictures to this collection, assign/edit the metadata values of the pictures within the collection. During this process, the collection and the pictures should only be visible (and searchable) to the creator.
* '''Share collection:''' The user wants to work together with colleagues on a collection: the colleagues should be able to upload pictures to the collection, assign/edit metadata values to the images within the collection (but not change the metadata profile or the descriptive metadata of the collection). During this process, the collection and the pictures should only be visible (and searchable) to the creator and his contributors.
* '''Share collection:''' The user wants to work together with colleagues on a collection: the colleagues should be able to upload pictures to the collection, assign/edit metadata values to the images within the collection (but not change the metadata profile or the descriptive metadata of the collection). During this process, the collection and the pictures should only be visible (and searchable) to the creator and his contributors.
Line 22: Line 24:


'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: '''implemented'''
* Schedule:  
* Schedule: Beta Release


'''Description'''  
'''Description'''  
Line 32: Line 34:
*#* Creator (string, mandatory, many)
*#* Creator (string, mandatory, many)
*#* Creator.Organization (string, mandatory, many)
*#* Creator.Organization (string, mandatory, many)
*#* License for the pictures within the collection (string, optional, once)
# (Optional) The user can edit the collection ( see [[Imeji_Collection_Management#UC_IM_COL_02_Edit_collection|UC_IM_COL_02 Edit collection]]).  
# (Optional) The user can edit the collection ( see [[Imeji_Collection_Management#UC_IM_COL_02_Edit_collection|UC_IM_COL_02 Edit collection]]).  
# After saving, the system displays a success message (the collection is in the state private).
# After saving, the system displays a success message (the collection is in the state private).
Line 42: Line 43:


'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: '''implemented'''
* Schedule:  
* Schedule: Beta Release


'''Pre-Condition'''
'''Pre-Condition'''
* One collection is selected
* One collection in the state private or published is selected


'''Description'''  
'''Description'''  
# The user can modify the metadata of the collection.
# The user can modify the metadata of the collection.
# (Optionally) The user can change the default style sheet of the collection
#* Upload a logo for the collection
#* Define the content of the text fields of the collections start page
#* Change main color of the collection
#* Further details have to be specified by the GUI (based on how the start page of the collection will look like)
# After saving, the system displays a success message (the status of the collection does not change).
# After saving, the system displays a success message (the status of the collection does not change).


'''Actors Involved'''
'''Actors Involved'''
* Collection editor for the selected collection
* Collection editor for the selected collection
'''Further Ideas'''
* The user can change the default style sheet of the collection
* Upload a logo for the collection
* Define the content of the text fields of the collections start page
* Change main color of the collection


== UC_IM_COL_03 Delete collection ==
== UC_IM_COL_03 Delete collection ==


'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: '''implemented'''
* Schedule:  
* Schedule: Beta Release


'''Pre-Condition'''
'''Pre-Condition'''
Line 70: Line 72:


'''Description'''
'''Description'''
# A collection can only be deleted when it is not released. After that, only withdrawn is possible.
# A collection can only be deleted when it is not published yet. After that, only discard is possible.
# When deleting a collection, all pictures within the collection will automatically be deleted, too.
# When deleting a collection, all pictures within the collection will automatically be deleted, too.
# The deletion includes the deletion of the corresponding metadata profile if the profile is in the state private. When the MD profile is already released, it will not deleted.
# The deletion includes the deletion of the corresponding metadata profile.
# The deletion needs a confirmation, where the system makes it clear to the user, that he is not only deleting the collection, but also XX pictures and, if the metadata profile is in the state private also the corresponding metadata profile, and that this deletion can not be undone.
# The deletion needs a confirmation, where the system makes it clear to the user, that he is not only deleting the collection, but also XX pictures.
# After confirming, the system displays a success message.  
# After confirming, the system displays a success message.  


Line 82: Line 84:


'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: '''implemented'''
* Schedule:  
* Schedule: Beta Release


'''Pre-Condition'''
'''Pre-Condition'''
Line 89: Line 91:


'''Description'''
'''Description'''
# The user wants to release the whole collection.
# The user wants to publish the whole collection.
# If the corresponding metadata profile is still in the state private, it will be released, too (see [[Imeji_Metadata#UC_IM_MD_03_Release_metadata_profile|UC_IM_MD_03 Release metadata profile]]).
# For the publish a confirmation message is necessary.  
# For the release a confirmation message is necessary.  
# After confirming, the system displays a success message. The collection is now in the state published and gets a persistent URL.
# After confirming, the system displays a success message. The collection is now in the state released and gets a persistent URL.
# Published means that the collection and its pictures are:
# For the case an older released version of the collection already exists, this version will be overwritten.
# Released means that the collection and its public pictures are:
#* searchable
#* searchable
#* displayed in browsing lists
#* displayed in browsing lists
#* can only be edited when creating a new version of the collection
#* visible to all users  
#* are visible to all users  


'''Actors Involved'''
'''Actors Involved'''
Line 106: Line 105:


'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: '''in specification'''
* Schedule:  
* Schedule:  


'''Pre-Condition'''
'''Pre-Condition'''
* One collection in the state released is selected
* One collection in the state published is selected


'''Description'''  
'''Description'''  
Line 125: Line 124:


'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: '''implemented'''
* Schedule:  
* Schedule: Beta Release


'''Pre-Condition'''
'''Pre-Condition'''
* One collection in the state released is selected
* One collection in the state published is selected


'''Description'''  
'''Description'''  
# The discard needs to be explained by the user via a discard comment and needs a confirmation, where the system makes it clear to the user, that all pictures whiting the collection will be deleted from the system, that a discarded collection can not be edited any more, is not searchable or browsable and can only be found from other users via following the URL to one version of the collection.
# The discard needs to be explained by the user via a discard comment and needs a confirmation, where the system makes it clear to the user that  
#* all pictures whiting the collection will be deleted from the system
# After confirming, the system displays a success message. The collection is now in the state discard.
# After confirming, the system displays a success message. The collection is now in the state discard.
# Discard means that:
# Discard means that:
Line 145: Line 145:
* Collection editor for the selected collection
* Collection editor for the selected collection


[[Category:Imeji|Collections]]
== UC_IM_COL_07 Share collection ==
[[Category:Faces_Functional_Specification|Imeji Collections]]
 
'''Status/Schedule'''
* Status: '''implemented'''
* Schedule: Beta Release
 
'''Pre-Condition'''
* One collection in the state private or released is selected
 
'''Description'''
# To share a collection, the user has to choose one or several users or user groups which whom he wants to share the collection.
# (Optionally) When the user chooses one or more user groups, he can view the members of the selected group.
# The user has to define the concrete [[Imeji_User_Management#User_Roles|user rights]] he want to assign to the selected user (groups).
# Each new user will get an automated e-mail notification from the system.
 
'''Actors Involved'''
* Collection administrator for the selected collection
 
'''Constrains'''
* Share collection currently only works for users that already have a user account within imeji. In a next step it would be nice also to invite new users and include an account creation procedure within the sharing process.
 
[[Category:Imeji_Functional_Specification|Collections]]

Latest revision as of 13:54, 25 February 2016

Outdated

Imeji logo.png

Internal
Meetings
Cooperation

Specification
Architecture
Installer
Ingest
Functional Specification
Technical Specification

Metadata
RDF mapping
Metadata terms

edit


Scenarios[edit]

Implemented (Beta Release)[edit]

  • Create collection: The user wants to create a collection with a corresponding metadata profile, upload pictures to this collection, assign/edit the metadata values of the pictures within the collection. During this process, the collection and the pictures should only be visible (and searchable) to the creator.
  • Share collection: The user wants to work together with colleagues on a collection: the colleagues should be able to upload pictures to the collection, assign/edit metadata values to the images within the collection (but not change the metadata profile or the descriptive metadata of the collection). During this process, the collection and the pictures should only be visible (and searchable) to the creator and his contributors.
  • Publish collection: When the creator (and optional his contributors) thinks that the collection is on a level that should be visible for other users, he published it. That means that now the collection and all pictures are visible and searchable for all user.

Not implemented[edit]

  • Updating of a released collection (incl. versioning):
  1. Upload of new pictures
    • When the user uploads new pictures for a collection, he first want to upload them in a protected environment (where only he or optionally his colleagues can see them, where he can take his time to assign metadata values to each picture.
    • When he is finished with this work, he wants to publish the new version of the collection, so that now all pictures within the collection are visible to all user.
  2. Changes in the metadata values of a collection
    • When the user wants to change the metadata values of the pictures within a collection, that is normally more than one edit. So he wants to have a protected environment where he (and optionally his colleagues) can do the changes.
    • When he is finished with this work, he wants to publish the new version of the collection, so that all changes within the collection are visible to all user.
During the time when somebody is updating a collection, which is not released jet, all other users should always see the old version as last published version.
  • Citing a collection: When a user cites a collection, he want to cite exactly the current state of the collection. Therefore each version of a collection has to be marked persistent. So that when a user follows the cited URL, he always got the cited collection, and not the latest version of the collection (Permlink scenario: the user wants to cite the current state of the collection --> he can create a version with a citable URL). But of course a hint that a newer version of the collection exists, should be displayed.

UC_IM_COL_01 Create collection[edit]

Status/Schedule

  • Status: implemented
  • Schedule: Beta Release

Description

  • The creation contains following steps:
    1. Define collection metadate:
      • Title (string, mandatory, once)
      • Description (string, optional, once)
      • Creator (string, mandatory, many)
      • Creator.Organization (string, mandatory, many)
  1. (Optional) The user can edit the collection ( see UC_IM_COL_02 Edit collection).
  2. After saving, the system displays a success message (the collection is in the state private).

Actors Involved

  • Account user

UC_IM_COL_02 Edit collection[edit]

Status/Schedule

  • Status: implemented
  • Schedule: Beta Release

Pre-Condition

  • One collection in the state private or published is selected

Description

  1. The user can modify the metadata of the collection.
  2. After saving, the system displays a success message (the status of the collection does not change).

Actors Involved

  • Collection editor for the selected collection

Further Ideas

  • The user can change the default style sheet of the collection
  • Upload a logo for the collection
  • Define the content of the text fields of the collections start page
  • Change main color of the collection

UC_IM_COL_03 Delete collection[edit]

Status/Schedule

  • Status: implemented
  • Schedule: Beta Release

Pre-Condition

  • One collection in the state private is selected

Description

  1. A collection can only be deleted when it is not published yet. After that, only discard is possible.
  2. When deleting a collection, all pictures within the collection will automatically be deleted, too.
  3. The deletion includes the deletion of the corresponding metadata profile.
  4. The deletion needs a confirmation, where the system makes it clear to the user, that he is not only deleting the collection, but also XX pictures.
  5. After confirming, the system displays a success message.

Actors Involved

  • Collection editor for the selected collection

UC_IM_COL_04 Release collection[edit]

Status/Schedule

  • Status: implemented
  • Schedule: Beta Release

Pre-Condition

  • One collection in the state private is selected

Description

  1. The user wants to publish the whole collection.
  2. For the publish a confirmation message is necessary.
  3. After confirming, the system displays a success message. The collection is now in the state published and gets a persistent URL.
  4. Published means that the collection and its pictures are:
    • searchable
    • displayed in browsing lists
    • visible to all users

Actors Involved

  • Collection editor for the selected collection

UC_IM_COL_05 Rework collection[edit]

Status/Schedule

  • Status: in specification
  • Schedule:

Pre-Condition

  • One collection in the state published is selected

Description

  • For reworking a collection (its metadata or its content) a new version of the collection will automatically be created that is in the state private.
  • The latest released version will stay as is is (till a newer version of the collection will be released).
  • In this private version, the user can edit the collection (see UC_IM_COL_02 Edit collection).
  • After saving, the system displays a success message. The collection is still in the state private.
  • To release the collection, see UC_IM_COL_04 Release collection.

Actors Involved

  • Collection editor for the selected collection

UC_IM_COL_06 Discard collection[edit]

Status/Schedule

  • Status: implemented
  • Schedule: Beta Release

Pre-Condition

  • One collection in the state published is selected

Description

  1. The discard needs to be explained by the user via a discard comment and needs a confirmation, where the system makes it clear to the user that
    • all pictures whiting the collection will be deleted from the system
  2. After confirming, the system displays a success message. The collection is now in the state discard.
  3. Discard means that:
    • all pictures within the collection will be deleted from the system
    • the collection (and its pictures) are not searchable any more
    • the collection (and its pictures) are not displayed in any browsing context
    • the collection can not be edited any more (or shared)
    • the collection is only retrievable when knowing the exact URL of one version of the collection: here the discard comment is displayed together with the collection metadata
    • when following an exact URL to a picture within the discarded collection, here also all collection information are displayed together with the comment that the collection of the picture have been discarded and therefore the picture is no longer available.

Actors Involved

  • Collection editor for the selected collection

UC_IM_COL_07 Share collection[edit]

Status/Schedule

  • Status: implemented
  • Schedule: Beta Release

Pre-Condition

  • One collection in the state private or released is selected

Description

  1. To share a collection, the user has to choose one or several users or user groups which whom he wants to share the collection.
  2. (Optionally) When the user chooses one or more user groups, he can view the members of the selected group.
  3. The user has to define the concrete user rights he want to assign to the selected user (groups).
  4. Each new user will get an automated e-mail notification from the system.

Actors Involved

  • Collection administrator for the selected collection

Constrains

  • Share collection currently only works for users that already have a user account within imeji. In a next step it would be nice also to invite new users and include an account creation procedure within the sharing process.