Difference between revisions of "Talk:PubMan Func Spec Yearbook of the MPS"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==UC_PM_YB_01 Create yearbook container in PubMan==
:Note: on this page comments and proposals for revision of the specification --[[User:Natasab|Natasa]] 10:29, 23 November 2009 (UTC)
In PubMan a container (folder) per each institute has to be created by the development team manually. In such a container all data which has to be gathered for the MPS yearbook should be collected.
:Each institute creates an own yearbook which will relate all publication items that are candidates for the MPS yearbook.--[[User:Natasab|Natasa]] 10:29, 23 November 2009 (UTC)
===Status / Schedule===
'''Status: in specification''' <br>
'''Schedule: R 6.1 (February 2010)'''
===Actors===
*Yearbook manager of the institute (better role-name to be defined)--[[User:Natasab|Natasa]] 10:29, 23 November 2009 (UTC)
===Pre-Conditions===
*there is no other yearbook for the current year and institute already created
===Flow of Events===
* the respective institute informs the PubMan support team about the need of the yearbook container in PubMan
* support team begs dev team to create the yearbook container for the MPI ''XY''
* dev team creates the recommended yearbook container manually
** a container only holds the links to items
** containers will have metadata in the responsible institutes (OU) via the context
<br/>
:proposed flow of events
*the yearbook manager wants to create the new yearbook of the institute
*the yearbook manager defines the year and provides the institute id for which the yearbook has to be created
*the system saves the yearbook
*(optionally i.e. if the user chose auto-fill option during creation of the yearbook) the system makes a search based on the year and the institute and relates the results automatically to the yearbook
*the use case ends successfully
==Questions==
*Where and when will the validation for the Yearbook take place?
*Where and when will the validation for the Yearbook take place?
::can be done on PubMan (efforts middle-high)--[[User:Natasab|Natasa]] 17:11, 3 November 2009 (UTC)
::can be done on PubMan (efforts middle-high)--[[User:Natasab|Natasa]] 17:11, 3 November 2009 (UTC)
*What is the reason for not allowing imported items from eDoc to be added for the Yearbook? this might get problematic, as soon as we start to "batch migrate" data from eDoc. We cannot foresee, if there isnot an item relevant for an upcoming yearbook...
*What is the reason for not allowing imported items from eDoc to be added for the Yearbook? this might get problematic, as soon as we start to "batch migrate" data from eDoc. We cannot foresee, if there isnot an item relevant for an upcoming yearbook...
::it is an assumption that all items that need to be in the yearbook will actually be first in PubMan. Yearbook quantity has to be checked on PubMan first. --[[User:Natasab|Natasa]] 17:11, 3 November 2009 (UTC)
::it is an assumption that all items that need to be in the yearbook will actually be first in PubMan. Yearbook quantity has to be checked on PubMan first. --[[User:Natasab|Natasa]] 17:11, 3 November 2009 (UTC)
:::see also comment below, if yearbook is maintained in PubMan all items will be added via pubman. Items that are imported from eDoc as well, there is no reason to have 2 separate lists. Not certain where/how this came into the specification. --[[User:Natasab|Natasa]] 08:28, 23 November 2009 (UTC)
*What happens, if our genre-specific table demands different metadata than the yearbook validation? I.e are the mandatory fields for the Yearbook in synch with the genre-specific table?
*What happens, if our genre-specific table demands different metadata than the yearbook validation? I.e are the mandatory fields for the Yearbook in synch with the genre-specific table?
::should be checked and corrected in PubMan or clarified with Press --[[User:Natasab|Natasa]] 17:11, 3 November 2009 (UTC)
::should be checked and corrected in PubMan or clarified with Press --[[User:Natasab|Natasa]] 17:11, 3 November 2009 (UTC)
Line 16: Line 50:
==[[PubMan_Func_Spec_Yearbook_of_the_MPS#UC_PM_YB_02_Add_PubMan_items_to_yearbook_container|UC_PM_YB_02 Add PubMan items to yearbook container]]==
==[[PubMan_Func_Spec_Yearbook_of_the_MPS#UC_PM_YB_02_Add_PubMan_items_to_yearbook_container|UC_PM_YB_02 Add PubMan items to yearbook container]]==
*should there be one "yearbook moderator" for the whole institute? -> if yes, there has to be a moderator who have rights for all contexts of the whole institute (I have to add this under "constraints") -> if no, it has to be possible that serveral moderators are marking PubMan items of their respective context they are responsible for to add them to one yearbook container for the whole institute.
*should there be one "yearbook moderator" for the whole institute? -> if yes, there has to be a moderator who have rights for all contexts of the whole institute (I have to add this under "constraints") -> if no, it has to be possible that serveral moderators are marking PubMan items of their respective context they are responsible for to add them to one yearbook container for the whole institute.
::we can resolve it with several possibilities, simple is that all moderators in the institute have possibility to add/remove items to the yearbook; another possiblity is to have special yb context, and have all yearbook items/containers in this context. Moderators of this context are actually the yearbook managers.--[[User:Natasab|Natasa]] 09:52, 23 November 2009 (UTC)
* only PubMan origin items can be added to the yearbook; imported eDoc data therefore can't be added to the yearbook via PubMan
* only PubMan origin items can be added to the yearbook; imported eDoc data therefore can't be added to the yearbook via PubMan
** why? are there technical reasons to do so? for me it seems a little bit cumbersome and most natably error-prone to maintain two lists of records for the yearbook if the worst comes to the worst - one list with origin PubMan items in PubMan + one list in eDoc with items former maintained there
** why? are there technical reasons to do so? for me it seems a little bit cumbersome and most notably error-prone to maintain two lists of records for the yearbook if the worst comes to the worst - one list with origin PubMan items in PubMan + one list in eDoc with items former maintained there
:::This i would agree, and by reading the use-case was actually asking the same question. Once item is in PubMan, it is in PubMan and will be maintained further in pubMan. I think there has been a misunderstanding somewhere during some discussions. All items in pubman will be added to the yearbook (if the yearbook is done on pubman) - there is no difference if an item is manually created or imported from eDoc. --[[User:Natasab|Natasa]] 08:26, 23 November 2009 (UTC)
** bring those two lists together is extra amount of work for our dev team
** bring those two lists together is extra amount of work for our dev team
**as for the most institutes eDoc data will be migrated sooner or later to PubMan this workflow doesn't sound so applicable, or?
**as for the most institutes eDoc data will be migrated sooner or later to PubMan this workflow doesn't sound so applicable, or?
* my proposal would be (if it is technical feasible): all PubMan data, independently of where it has been come from, means also the imported eDoc data, should be possible to add to the yearbook container -> benefit: no alignment of the two lists with yearbook records (PubMan and eDoc) is required
* my proposal would be (if it is technical feasible): all PubMan data, independently of where it has been come from, means also the imported eDoc data, should be possible to add to the yearbook container -> benefit: no alignment of the two lists with yearbook records (PubMan and eDoc) is required
::completely agree--[[User:Natasab|Natasa]] 09:52, 23 November 2009 (UTC)


==[[PubMan_Func_Spec_Yearbook_of_the_MPS#UC_PM_YB_05_Export_content_of_yearbook_container_in_PubMan_to_eDoc|UC_PM_YB_05 Export content of yearbook container in PubMan to eDoc]]==
==[[PubMan_Func_Spec_Yearbook_of_the_MPS#UC_PM_YB_05_Export_content_of_yearbook_container_in_PubMan|UC_PM_YB_05 Export content of yearbook container in PubMan]]==
* I'm not really sure whether I understood the [[PubMan_Func_Spec_Yearbook_of_the_MPS#Basic_Considerations|basic considerations]], which were collected one year ago, in the right manner regarding that part of the MPS yearbook scenario?
* I'm not really sure whether I understood the [[PubMan_Func_Spec_Yearbook_of_the_MPS#Basic_Considerations|basic considerations]], which were collected one year ago, in the right manner regarding that part of the MPS yearbook scenario?
* I could also imagine that the batch operation "Release all items to MPS yearbook", described in [[PubMan_Func_Spec_Yearbook_of_the_MPS#UC_PM_YB_04_Release_content_of_yearbook_container_in_PubMan|UC_PM_YB_04]], triggers an export of the yearbook container and leads to the generation of an eSciDoc XML file
* I could also imagine that the batch operation "Release all items to MPS yearbook", described in [[PubMan_Func_Spec_Yearbook_of_the_MPS#UC_PM_YB_04_Release_content_of_yearbook_container_in_PubMan|UC_PM_YB_04]], triggers an export of the yearbook container and leads to the generation of an eSciDoc XML file
** the moderator saves that export file to her/his local personal computer and afterwards sends that file to the PubMan support team via email with the request to import the file in eDoc  
** the moderator saves that export file to her/his local personal computer and afterwards sends that file to the PubMan support team via email with the request to import the file in eDoc  
** doing so that usecase and the following one would be more user-driven
** doing so that usecase would be more user-driven
* please provide feedback! thank you :)
* please provide feedback! thank you :)


==[[PubMan_Func_Spec_Yearbook_of_the_MPS#UC_PM_YB_06_Import_content_of_yearbook_container_in_eDoc|UC_PM_YB_06 Import content of yearbook container in eDoc]]==
==[[PubMan_Func_Spec_Yearbook_of_the_MPS#UC_PM_YB_06_Import_content_of_yearbook_container_in_eDoc|UC_PM_YB_06 Import content of yearbook container in eDoc]]==
* I'm not really sure whether I understood the [[PubMan_Func_Spec_Yearbook_of_the_MPS#Basic_Considerations|basic considerations]] which were collected one year ago in the right manner regarding that part of the MPS yearbook scenario? -> is the import done by the dev team or by the eDoc user (local eDoc Administrator) her/himself?
* I'm not really sure whether I understood the [[PubMan_Func_Spec_Yearbook_of_the_MPS#Basic_Considerations|basic considerations]], which were collected one year ago, in the right manner regarding that part of the MPS yearbook scenario? -> is the import done by the dev team or by the eDoc user (local eDoc manager) her/himself?
** I do not know eDoc that much (until now), but as far as I know there is currently no possibility for the common user to import an eSciDoc XML file to eDoc, am I right?
** I do not know eDoc that much (until now), but as far as I know there is currently no possibility for the common user to import an eSciDoc XML file to eDoc, am I right?

Latest revision as of 14:17, 23 November 2009

UC_PM_YB_01 Create yearbook container in PubMan[edit]

Note: on this page comments and proposals for revision of the specification --Natasa 10:29, 23 November 2009 (UTC)

In PubMan a container (folder) per each institute has to be created by the development team manually. In such a container all data which has to be gathered for the MPS yearbook should be collected.

Each institute creates an own yearbook which will relate all publication items that are candidates for the MPS yearbook.--Natasa 10:29, 23 November 2009 (UTC)

Status / Schedule[edit]

Status: in specification
Schedule: R 6.1 (February 2010)

Actors[edit]

  • Yearbook manager of the institute (better role-name to be defined)--Natasa 10:29, 23 November 2009 (UTC)

Pre-Conditions[edit]

  • there is no other yearbook for the current year and institute already created

Flow of Events[edit]

  • the respective institute informs the PubMan support team about the need of the yearbook container in PubMan
  • support team begs dev team to create the yearbook container for the MPI XY
  • dev team creates the recommended yearbook container manually
    • a container only holds the links to items
    • containers will have metadata in the responsible institutes (OU) via the context


proposed flow of events
  • the yearbook manager wants to create the new yearbook of the institute
  • the yearbook manager defines the year and provides the institute id for which the yearbook has to be created
  • the system saves the yearbook
  • (optionally i.e. if the user chose auto-fill option during creation of the yearbook) the system makes a search based on the year and the institute and relates the results automatically to the yearbook
  • the use case ends successfully

Questions[edit]

  • Where and when will the validation for the Yearbook take place?
can be done on PubMan (efforts middle-high)--Natasa 17:11, 3 November 2009 (UTC)
  • What is the reason for not allowing imported items from eDoc to be added for the Yearbook? this might get problematic, as soon as we start to "batch migrate" data from eDoc. We cannot foresee, if there isnot an item relevant for an upcoming yearbook...
it is an assumption that all items that need to be in the yearbook will actually be first in PubMan. Yearbook quantity has to be checked on PubMan first. --Natasa 17:11, 3 November 2009 (UTC)
see also comment below, if yearbook is maintained in PubMan all items will be added via pubman. Items that are imported from eDoc as well, there is no reason to have 2 separate lists. Not certain where/how this came into the specification. --Natasa 08:28, 23 November 2009 (UTC)
  • What happens, if our genre-specific table demands different metadata than the yearbook validation? I.e are the mandatory fields for the Yearbook in synch with the genre-specific table?
should be checked and corrected in PubMan or clarified with Press --Natasa 17:11, 3 November 2009 (UTC)
  • Does the institute user (Jahrbuch-Verantwortlicher) and Press (Mr. Plehn) have an easy overview and concrete number on all data which will be in the Yearbook? (I did not quite understand the point with the lists provided by dev team...)
imho, this overview is coming from eDoc as long as data are handled on eDoc--Natasa 17:11, 3 November 2009 (UTC)
  • We still lack the description of MPG authors/not MPG authors (is needed for yearbook, right?)=> part of Cone?
this should actually now be clear for each author, as in PubMan affiliation is related to author and not to the publication like in eDoc--Natasa 17:11, 3 November 2009 (UTC)
  • Design
    • maybe for quick solution - it would be sufficient to have 1 item (cmodel=Yearbook) for being the yearbook, if we are able to put relations (of is-in-yearbook) to this item. (Pros: not dealing with containers in pubMan, feasible for February), (Cons: not possibility to add yearbook specific information to the yearbook items)--Natasa 17:14, 3 November 2009 (UTC)


UC_PM_YB_02 Add PubMan items to yearbook container[edit]

  • should there be one "yearbook moderator" for the whole institute? -> if yes, there has to be a moderator who have rights for all contexts of the whole institute (I have to add this under "constraints") -> if no, it has to be possible that serveral moderators are marking PubMan items of their respective context they are responsible for to add them to one yearbook container for the whole institute.
we can resolve it with several possibilities, simple is that all moderators in the institute have possibility to add/remove items to the yearbook; another possiblity is to have special yb context, and have all yearbook items/containers in this context. Moderators of this context are actually the yearbook managers.--Natasa 09:52, 23 November 2009 (UTC)
  • only PubMan origin items can be added to the yearbook; imported eDoc data therefore can't be added to the yearbook via PubMan
    • why? are there technical reasons to do so? for me it seems a little bit cumbersome and most notably error-prone to maintain two lists of records for the yearbook if the worst comes to the worst - one list with origin PubMan items in PubMan + one list in eDoc with items former maintained there
This i would agree, and by reading the use-case was actually asking the same question. Once item is in PubMan, it is in PubMan and will be maintained further in pubMan. I think there has been a misunderstanding somewhere during some discussions. All items in pubman will be added to the yearbook (if the yearbook is done on pubman) - there is no difference if an item is manually created or imported from eDoc. --Natasa 08:26, 23 November 2009 (UTC)
    • bring those two lists together is extra amount of work for our dev team
    • as for the most institutes eDoc data will be migrated sooner or later to PubMan this workflow doesn't sound so applicable, or?
  • my proposal would be (if it is technical feasible): all PubMan data, independently of where it has been come from, means also the imported eDoc data, should be possible to add to the yearbook container -> benefit: no alignment of the two lists with yearbook records (PubMan and eDoc) is required
completely agree--Natasa 09:52, 23 November 2009 (UTC)

UC_PM_YB_05 Export content of yearbook container in PubMan[edit]

  • I'm not really sure whether I understood the basic considerations, which were collected one year ago, in the right manner regarding that part of the MPS yearbook scenario?
  • I could also imagine that the batch operation "Release all items to MPS yearbook", described in UC_PM_YB_04, triggers an export of the yearbook container and leads to the generation of an eSciDoc XML file
    • the moderator saves that export file to her/his local personal computer and afterwards sends that file to the PubMan support team via email with the request to import the file in eDoc
    • doing so that usecase would be more user-driven
  • please provide feedback! thank you :)

UC_PM_YB_06 Import content of yearbook container in eDoc[edit]

  • I'm not really sure whether I understood the basic considerations, which were collected one year ago, in the right manner regarding that part of the MPS yearbook scenario? -> is the import done by the dev team or by the eDoc user (local eDoc manager) her/himself?
    • I do not know eDoc that much (until now), but as far as I know there is currently no possibility for the common user to import an eSciDoc XML file to eDoc, am I right?