Difference between revisions of "Talk:PubMan Submission"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(25 intermediate revisions by 5 users not shown)
Line 4: Line 4:


* Submission very important, decision-making criterion for/ against PubMan. (Submission sehr wichtig, Entscheidungskriterium für/gegen PubMan)
* Submission very important, decision-making criterion for/ against PubMan. (Submission sehr wichtig, Entscheidungskriterium für/gegen PubMan)
: The edit mask should be more aligned to the 'item version view', to make the user more familiar with the order of the metadata (Basic, Persons/org., ...) [[User:Rkiefl|Rupert]] 12:03, 21 December 2007 (CET)


==Easy submission==
==Easy submission==
Line 9: Line 11:
For ideas on easy submission, please visit the [[PubMan_Easy_Submission]] page.
For ideas on easy submission, please visit the [[PubMan_Easy_Submission]] page.


==Mandatory Fields/Validation (Pflichtfelder/Validierung)==
==Mandatory Fields/Validation==
 
* The limits for the submission criteria should not be set too low. Each institute should be able to define the mandatory fields of the input mask.
 
(Hürde für die Submissionkriterien sollten nicht zu tief angesetzt werden. Pflichtfelder für die Eingabemaske müssen vom Institut definiert werden können.)
 
* Mandatory fields of the input mask do make sense; only, however, if the user receives online help-texts and tips (context sensitive).


(Pflichtfelder für die Eingabe sind sinnvoll, allerdings unter der Bedingung, dass man Online Hilfetexte und Erläuterungen (kontextsensitiv) bekommt.)
* The hurdle for the submission criteria should not be set too low. Each institute should be able to define the mandatory fields of the input mask.
:: ''Comment Nicole: For my unerstanding, this can be done via the validation rules for the validation point submit item. --[[User:Nicole|Nicole]] 09:29, 10 January 2008 (CET)''


* Mandatory metadata should not be specified only according to collection level, but also according to user roles and preferences.  
* Mandatory fields of the submission mask do make sense; but only if the user receives online help-texts and tips (context sensitive).
:: ''Comment Nicole: already considered in the specificaiton/implementation.--[[User:Nicole|Nicole]] 09:29, 10 January 2008 (CET)''


(Obligatorische Metadaten sollten nicht nur auf Collection-Ebene festgelegt werden können, sondern auch für Nutzerrollen und auf Preferenzes-Ebene.)
* Obligatory metadata should not be specified only according to collection level, but also according to user roles and preferences.  


* Publication workflow for Release I should be configurable in such a way, that „validate item version“ function could have restrictive as well as informative character.  
* Publication workflow should be configurable in such a way, that "validate item version" function could have restrictive as well as informative character.  
 
( Publikationsworkflow für Release I muß so konfigurierbar sein, dass Funktion „validate item version“ sowohl restriktiv als auch informativ ausgeführt werden kann.)


* There should be different validation types with different validation rules. (e.g. for catalogs, BibTeX files, different Genre types, different users).  
* There should be different validation types with different validation rules. (e.g. for catalogs, BibTeX files, different Genre types, different users).  


(Es muß versch. Validierungstypen mit versch. Validierungsregeln geben (z.B. für Catalogs, BibTeX files, versch. Genre types, versch. Nutzer).
* minimal data for Repository Managers should be configurable (mandatory fields, "warning fields", fields that can be hidden)


* Min. data for Repository Managers should be configurable (mandatory fields, "warning fields", fields that can be hidden)  
* After the user has saved for the first time, he should be given system "warnings" as to which data are still missing. But it should also be possible to save without this check. The warnings should be graded according to their importance (example: traffic-lights-system)


(Minimalangaben für Repository Manager konfigurierbar (Pflichtfelder, „Warnfelder“, Felder ausblendbar).)
: If the validation failed and the user has to change/add something it would make sense to show the relevant fields below the message for fast entry. [[User:Rkiefl|Rupert]] 12:09, 21 December 2007 (CET)


* After the user has saved for the first time, he should be given system "warnings" as to which data are still missing. But it should also be possible to save without this check. The warnings should be graded according to their importance (example: traffic-lights-system)
== Allowed Genre as collection setting ==
Discussion on genres transfered from [http://zim01.gwdg.de:8080/browse/AS-269 Jira AS-269]


(Nachdem man das erste Mal auf „save“ gedrückt hat, sollte das System dem Nutzer in Form von „warnings“ anzeigen, welche Datenangaben noch fehlen. Es sollte jedoch auch möglich sein ohne diese Überprüfung zu speichern. Die Warnungen sollten nach Wichtigkeit abgestuft sein. (Beispiel Ampelsystem))
Kiefl Rupert - [12/Dec/07 11:53 PM]


==Full texts/Files (Volltexte/Files)==
The collection defines genres available for submission. Is this done to block explicitly all other genres?


* Files should be compressed automatically when uploaded. (Addition after checking with SMC: the zipping of files is a technical, not a functional requirement. Questions concerning the concrete functional requirements will be forwarded to the pilot list).  
Lets walk through the case: The user wants to create a new revision. He chooses a different collection and wants to submit. The system states he has a wrong genre and can not submit.


(Files sollten vom System beim Hochladen automatisch komprimiert werden (Nachtrag nach Validierung mit SMC: Das Zippen von Files ist keine funktionale Anforderung, sondern eine technische. Die Frage nach konkreten funktionaler Anforderung wird noch mal separat an Pilotliste gerichtet).)
The user has the following options:
# Change the genre (just to be able to submit?)
# Contact the administrator to add a new genre to the collection?


* Content type „supplementary material“ will be used as it is for the moment and it will eventually be further modified after the system has been put to use.
Both ways seem to be not satisfying. Can we add a genre to the collection automatically if an item was added with an unknown/not allowed genre?


( Content type „supplementary material“ wird vorerst so verwendet werden und erst nach einer ersten Nutzung des Systems eventuell weiter differenziert.)
Tschida, Ulla - [13/Dec/07 09:47 AM ]


== Input of Data (Dateneingaben)==
see my answers to your questions below:


* Basic submission should check the minimum input for each genre. But power users should in any case be able to use all metadata fields (expert view), as well as to configurate which metadata can be filled in for a specific genre. If the document type is changed at a later point, no data should be lost. (Problem eDoc: When a Genre type is later changed, metadata belonging to fields that are no longer provided are lost.)
The collection defines genres available for submission. Is this done to block explicitly all other genres?
=> It is due to the reason, that some institutes are not at all interested in our 15(?) genres, but just in some of them. By defining allowed genres for a collection, they have a "customized" drop down list, for their mostly relevant publication types.


(Basic submission sollte Mindestangaben für ein Genre abfragen. Aber Poweruser sollte in jedem Fall alle Felder aus dem Metadatenset zur Verfügung  haben (expert view) bzw. konfigurieren können, welche Metadaten für ein bestimmtes Genre gefüllt werden können. Bei nachträglicher Änderung des Dokumenttyps dürfen keine Angaben wegfallen. (Problem eDoc: Bei nachträglicher Genretyp Änderung fallen Metadaten weg, die über die vorgesehenen Felder hinausgehen))
use case create new revision: indeed a critical point...background is, we have the feature that genres are "allowed" for a collection (see comment above). but when creating revisions, you might want to change the genre, and you might want to create the revision in a new collection, and then the collection and the genre are not compatible.


* A flexible input mask is very important.  
I know that proposed solution is not optimal. Alternatively, we could say: when creating a revision, the item data are pre-filled (from source item), except genre. Therefore, user would have to state the genre again, when creating a revision. Not sure what is "muehsamer".


(Ein flexible Eingabemaske ist wichtig)
The option 2 you mention, is of course not possible. Option 1 neither, he would have to change the collection (collection policies...rules are always mühsam)


* Option "genre type" is missing in UC_PM_SM_01 create item. Edit view depends on the selected genre type. (Addition after checking with SMC: it is covered by No. 4 in Basic course of events).
: We identified when creating a new revision that there may be problems with the genre and in this case we have the following options having in mind genre is "inherited" as a default metadata of the revision.
Reference to use case step 9, options a and b.
Option a: if genre is allowed in the collection, genre is inherited
Option b: (in my opinion should be): if genre is not allowed in the collection, genre is not inherited
Would doubt that creation of a new revision is always a same genre as the previous revision, but may be :)
--[[User:Natasab|Natasa]] 11:11, 21 December 2007 (CET)


(Auswahl „genre type“ fehlt im UC_PM_SM_01 create item. Edit view ist abhängig vom ausgewählten genre type (Nachtrag nach Validierung mit SMC: Ist abgedeckt durch Punkt 4 in Basic course of events).)
::OK, agreed [[User:Rkiefl|Rupert]] 11:58, 21 December 2007 (CET)


* The connection between persons and affiliations is important. Idea: after an affiliation has been chosen for the first author, it should be used as default for all additional authors (noted in UC_PM_CM_02).
==Full texts/Files==


(Verknüpfung von Personen und Affiliation wichtig. Idee: nach der Auswahl der Affiliation für den ersten Autor sollte diese defaultmäßig für alle weiteren Autoren voreingestellt sein (in UC_PM_CM_02 vermerkt).)
* Files should be compressed automatically when uploaded. (Addition after validation with SMC: the zipping of files is a technical, not a functional requirement. Questions concerning the concrete functional requirements will be forwarded to the pilot list).


* The option to run a checksum is not relevant for Release I.  
* Content type "supplementary material" can be used for the moment, but will potentially be revised after the system has been put to production.


(Möglichkeit für den Nutzer, eine checksum einzutragen, wird als nicht relevant für Release I gesehen )
== Data input==


**  Addition after checking with SMC: All references to user-run checksums were completely removed from the specification.
* Basic submission should check the minimum input for a genre. But power users should in any case be able to use all metadata fields (expert view), as well as to configure which metadata can be filled in for a specific genre. If the document type is changed at a later point, no data should be lost. (Problem eDoc: When a Genre type is later changed, metadata belonging to fields that are no longer provided get lost.)


(Nachtrag nach Validierung mit SMC: Das Angeben von checksums für Nutzer wurde komplett aus der Spezifikation genommen.).)
* A flexible submission mask is very important.


* Input should be supported by classifications/controlled vocabulary, as well as import interfaces from literature management programs.  
* The connection between persons and affiliations is important. Idea: after an affiliation has been chosen for the first author, it should be used as default for all additional authors (noted in UC_PM_CM_02).


(Unterstützung der Eingabe durch Klassifikationen /kontrolliertes Vokabular sowie durch Importschnittstellen aus Literaturverwaltungssysteme)
* The option to enter a checksum is not relevant for Release I.


* Data should be temporarily saved during input, without the need for the depositor to save them explicitly / actively.  
::Addition after checking with SMC: All references to user-run checksums were completely removed from the specification.


(Die Daten sollten während der Eingabe temporär mitgespeichert werden, ohne dass der Depositor explizit/aktiv speichern muss.)
* Input should be supported by classifications/controlled vocabulary, as well as import interfaces from reference management programs.


* Logical connections between metadata should be reflected on the input mask. E.g: if the external publication status is "submitted", the field "Publication Date" should not be displayed.
* Data should be temporarily saved during input, without the need for the depositor to save them explicitly / actively.
::This would not be very nice as the user will after finalization have many versions and system does not know when to triger certain actions after saving the item. Clarify please what is meant with temporary?  --[[User:Natasab|Natasa]] 16:51, 21 December 2007 (CET)


(Logische Abhängigkeiten der Metadaten sollten sich in der Eingabemaske widerspiegeln. Z.B. wenn der external Publication Status "submitted" ist, sollte das Eingabefeld "Publikationsdatum" nicht angezeigt werden.)
* Logical constraitns between metadata should be reflected on the input mask. E.g: if the external publication status is "submitted", the field "Publication Date" should not be displayed.
::''Comment Nicole: This Feedback was also given by Wolfang during the interview on easy submission. Problem: we don't have publication status in our MD set.''


*  The context-sensitive help texts of the input mask should be configurable by the institute.
*  The context-sensitive help texts of the input mask should be configurable by the institute.


(Die kontextsensitiven Hilfetexte in der Eingabemaske sollten pro Institut konfigurierbar sein.)
* During the input, the user should also be given not standardized data, that are already in the system, so that the input mass will be reduced (e.g. set up of a local data pool with conference dates).


* During the input, the user should also be given not standardized data, that are already in the system, so that the input mass will be reduced (e.g. construction of a local data pool with conference dates)
* It sould be possible to enter persons via using the autopsi principle.


( Während der Eingabe sollten dem Benutzer auch nicht normierte Daten, die bereits im System enthalten sind, zugespielt werden, um die Eingabemasse zu verringern (Z.B. Aufbau eines lokalen Datenpools mit Konferenzdaten).)
* Initials should be generated automatically by the system. Letters following the first capital letter should be "cut".


* Input of personal data should be made according to a template (autopsy- principle).
* Data on creator should be: Name, Surname, Institution.
::''Comment Nicole: already implemented.''


(Eingabe der Personenangaben nach Vorlage (Autopsie-Prinzip).)
* The input of groups (as a creator) should be offered further on. The group name is sufficient information.
::''Comment Nicole: already implemented.''


* Initials should be automatically system-generated. Letters following the first capital letter should be "cut" out.
* It should be possible to copy and paste multiple author names into an input field. The system should be able to structure and translate this information into the input mask by means of specific separators.
::''Comment Nicole: Will be considered.''


(Initialen sollten vom System automatisch generiert werden. Nach dem ersten Großbuchstaben im Vornamen sollte "abgeschnitten" werden.)
* Setup of user groups, should be specified by the input formats.
::''Comment Nicole: Should be re-checked with the pilots. Don't understand the requirement.''


* Personal Data: Name, Surname, Institution.
* It should be possible to change the order of creators
::''Comment Nicole: Will be considered.''


(Angaben pro Person: Vorname, Nachname, Institution.)
==IP-Submission==
 
'''Status:''' IP Submission is currently out of scope --[[User:Inga|Inga]] 16:40, 14 September 2007 (CEST)
* The input of groups (as a creator) should be offered further on. The group name is sufficient information.


( Die Eingabe von Gruppen (als creator) sollte weiterhin angeboten werden. Als Angabe genügt der Gruppenname.)
* IP- Depositor should provide following additional data, when he  wants to make a submission: Name, e-mail, telephone, affiliation (provision of affiliation information should not be mandatory.)


* It should be possible to copy and paste multiple author names into an input field. The system should be able to structure and translate this information into the input mask by means of specific separators.  
* A very simple input mask is needed for the IP-Depositors; the input mask should be customizeable by the institutes.


(Für die Eingabe von mehreren Autoren sollte es möglich sein, dass man selbige per copy and paste in ein Eingabefeld einfügen kann. Anhand bestimmter Trennzeichen sollte das System dann die Angaben strukturieren und in die Eingabemaske übersetzen.)
* Users outside the IP-Range of the MPS should be able to make submissions as well.


* Setup of user groups, (should be?) specified by the input formats.
* The option to upload files should be configurable for the IP-based submission.


(Einrichten von Benutzergruppen, durch die Eingabeformate bestimmt werden.)
* Checking / restriction on IP- Range should be given as an option, and should be administrated by the institute via "access list".


* changing the order of creators - Requirements? (Anforderungen?)
* In addition to the IP-based submission it should also be possible to send suggestions via E-Mail.


==IP-Submission==
* As a lot of scientists manage their publications in BibTeX, the web form for suggesting entries for the IR should allow to attach BibTeX files.
Status: IP Submission is currently out of scope --[[User:Inga|Inga]] 16:40, 14 September 2007 (CEST)


* IP-Depositor muss folgende (zusätzliche) Angaben machen, wenn er eine Submission vornehmen möchte: Name, E-Mail, Telefon, Affiliation (Affiliation sollte keine Pflichtinformation sein.
* Configurability of the IP-Depositor submissin mask: should be configurable from a "single-field" form to more complex forms.
* Eine sehr simple Eingabemaske ist nötig für den IP-Depositor; Eingabemaske sollte durch Institute anpassbar sein.
* Auch User außerhalb der IP-Range sollten Einträge vornehmen können.
* Bei der IP-basierten Eingabe sollte die Möglichkeit zum Datei-Upload konfiguriert werden können.
* Affiliation des IP-Depositors sollte bei IP-based submission kein Pflichtfeld sein.
* Prüfung/Restriktion auf IP- Prange sollte als Option gegeben sein, soll vom Institut  mittels "access Liste" administriert werden.
* Komplementär zu IP-basierten Submission sollten Vorschläge per eMail zugelassen werden.
* Konfigurierbarkeit des Inputformulars des IP-depositor: von einem "Einfeld-Formular" bis zu komplexeren konfigurierbar.
* Wissenschaftler verwalten ihre eigenen Daten mit bibTex => Webform für "Vorschläge" sollte Mitschicken von bibTeX Dateien ermöglichen


==Sonstiges==
==Miscellaneous==


* automatische Wiedervorlage für den Prozess bis zur Veröffentlichung (submitted, accepted und published) für den Depositor. Depositor möchte einstellen, dass ihm der item in bestimmten zeitabständen noch mal vorgelegt wird, um zu prüfen, ob sich der Publikationsstatus beim Journal geändert hat.
* Automatism for publications that are not yet published: the automatism should put the item on a regular basis into the workspace of the depositor or should send reminders, that the depositor should check the publication status (submitted, accepted and published). It should be possible to switch on /of this automatism.

Latest revision as of 08:50, 10 January 2008

This page gathers feedback by the pilots and early adoptors, that was given so far and that will be given for future releases. Please feel free to add your own feedback here and sign your comments with a signature (see menu bar above).

Overall remarks[edit]

  • Submission very important, decision-making criterion for/ against PubMan. (Submission sehr wichtig, Entscheidungskriterium für/gegen PubMan)
The edit mask should be more aligned to the 'item version view', to make the user more familiar with the order of the metadata (Basic, Persons/org., ...) Rupert 12:03, 21 December 2007 (CET)

Easy submission[edit]

For ideas on easy submission, please visit the PubMan_Easy_Submission page.

Mandatory Fields/Validation[edit]

  • The hurdle for the submission criteria should not be set too low. Each institute should be able to define the mandatory fields of the input mask.
Comment Nicole: For my unerstanding, this can be done via the validation rules for the validation point submit item. --Nicole 09:29, 10 January 2008 (CET)
  • Mandatory fields of the submission mask do make sense; but only if the user receives online help-texts and tips (context sensitive).
Comment Nicole: already considered in the specificaiton/implementation.--Nicole 09:29, 10 January 2008 (CET)
  • Obligatory metadata should not be specified only according to collection level, but also according to user roles and preferences.
  • Publication workflow should be configurable in such a way, that "validate item version" function could have restrictive as well as informative character.
  • There should be different validation types with different validation rules. (e.g. for catalogs, BibTeX files, different Genre types, different users).
  • minimal data for Repository Managers should be configurable (mandatory fields, "warning fields", fields that can be hidden)
  • After the user has saved for the first time, he should be given system "warnings" as to which data are still missing. But it should also be possible to save without this check. The warnings should be graded according to their importance (example: traffic-lights-system)
If the validation failed and the user has to change/add something it would make sense to show the relevant fields below the message for fast entry. Rupert 12:09, 21 December 2007 (CET)

Allowed Genre as collection setting[edit]

Discussion on genres transfered from Jira AS-269

Kiefl Rupert - [12/Dec/07 11:53 PM]

The collection defines genres available for submission. Is this done to block explicitly all other genres?

Lets walk through the case: The user wants to create a new revision. He chooses a different collection and wants to submit. The system states he has a wrong genre and can not submit.

The user has the following options:

  1. Change the genre (just to be able to submit?)
  2. Contact the administrator to add a new genre to the collection?

Both ways seem to be not satisfying. Can we add a genre to the collection automatically if an item was added with an unknown/not allowed genre?

Tschida, Ulla - [13/Dec/07 09:47 AM ]

see my answers to your questions below:

The collection defines genres available for submission. Is this done to block explicitly all other genres? => It is due to the reason, that some institutes are not at all interested in our 15(?) genres, but just in some of them. By defining allowed genres for a collection, they have a "customized" drop down list, for their mostly relevant publication types.

use case create new revision: indeed a critical point...background is, we have the feature that genres are "allowed" for a collection (see comment above). but when creating revisions, you might want to change the genre, and you might want to create the revision in a new collection, and then the collection and the genre are not compatible.

I know that proposed solution is not optimal. Alternatively, we could say: when creating a revision, the item data are pre-filled (from source item), except genre. Therefore, user would have to state the genre again, when creating a revision. Not sure what is "muehsamer".

The option 2 you mention, is of course not possible. Option 1 neither, he would have to change the collection (collection policies...rules are always mühsam)

We identified when creating a new revision that there may be problems with the genre and in this case we have the following options having in mind genre is "inherited" as a default metadata of the revision.

Reference to use case step 9, options a and b. Option a: if genre is allowed in the collection, genre is inherited Option b: (in my opinion should be): if genre is not allowed in the collection, genre is not inherited Would doubt that creation of a new revision is always a same genre as the previous revision, but may be :) --Natasa 11:11, 21 December 2007 (CET)

OK, agreed Rupert 11:58, 21 December 2007 (CET)

Full texts/Files[edit]

  • Files should be compressed automatically when uploaded. (Addition after validation with SMC: the zipping of files is a technical, not a functional requirement. Questions concerning the concrete functional requirements will be forwarded to the pilot list).
  • Content type "supplementary material" can be used for the moment, but will potentially be revised after the system has been put to production.

Data input[edit]

  • Basic submission should check the minimum input for a genre. But power users should in any case be able to use all metadata fields (expert view), as well as to configure which metadata can be filled in for a specific genre. If the document type is changed at a later point, no data should be lost. (Problem eDoc: When a Genre type is later changed, metadata belonging to fields that are no longer provided get lost.)
  • A flexible submission mask is very important.
  • The connection between persons and affiliations is important. Idea: after an affiliation has been chosen for the first author, it should be used as default for all additional authors (noted in UC_PM_CM_02).
  • The option to enter a checksum is not relevant for Release I.
Addition after checking with SMC: All references to user-run checksums were completely removed from the specification.
  • Input should be supported by classifications/controlled vocabulary, as well as import interfaces from reference management programs.
  • Data should be temporarily saved during input, without the need for the depositor to save them explicitly / actively.
This would not be very nice as the user will after finalization have many versions and system does not know when to triger certain actions after saving the item. Clarify please what is meant with temporary? --Natasa 16:51, 21 December 2007 (CET)
  • Logical constraitns between metadata should be reflected on the input mask. E.g: if the external publication status is "submitted", the field "Publication Date" should not be displayed.
Comment Nicole: This Feedback was also given by Wolfang during the interview on easy submission. Problem: we don't have publication status in our MD set.
  • The context-sensitive help texts of the input mask should be configurable by the institute.
  • During the input, the user should also be given not standardized data, that are already in the system, so that the input mass will be reduced (e.g. set up of a local data pool with conference dates).
  • It sould be possible to enter persons via using the autopsi principle.
  • Initials should be generated automatically by the system. Letters following the first capital letter should be "cut".
  • Data on creator should be: Name, Surname, Institution.
Comment Nicole: already implemented.
  • The input of groups (as a creator) should be offered further on. The group name is sufficient information.
Comment Nicole: already implemented.
  • It should be possible to copy and paste multiple author names into an input field. The system should be able to structure and translate this information into the input mask by means of specific separators.
Comment Nicole: Will be considered.
  • Setup of user groups, should be specified by the input formats.
Comment Nicole: Should be re-checked with the pilots. Don't understand the requirement.
  • It should be possible to change the order of creators
Comment Nicole: Will be considered.

IP-Submission[edit]

Status: IP Submission is currently out of scope --Inga 16:40, 14 September 2007 (CEST)

  • IP- Depositor should provide following additional data, when he wants to make a submission: Name, e-mail, telephone, affiliation (provision of affiliation information should not be mandatory.)
  • A very simple input mask is needed for the IP-Depositors; the input mask should be customizeable by the institutes.
  • Users outside the IP-Range of the MPS should be able to make submissions as well.
  • The option to upload files should be configurable for the IP-based submission.
  • Checking / restriction on IP- Range should be given as an option, and should be administrated by the institute via "access list".
  • In addition to the IP-based submission it should also be possible to send suggestions via E-Mail.
  • As a lot of scientists manage their publications in BibTeX, the web form for suggesting entries for the IR should allow to attach BibTeX files.
  • Configurability of the IP-Depositor submissin mask: should be configurable from a "single-field" form to more complex forms.

Miscellaneous[edit]

  • Automatism for publications that are not yet published: the automatism should put the item on a regular basis into the workspace of the depositor or should send reminders, that the depositor should check the publication status (submitted, accepted and published). It should be possible to switch on /of this automatism.