Difference between revisions of "Talk:PubMan Func Spec Export"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{PubMan_Funtional_Specification}}
=Discussion PubMan_Functional_Specification=
=Discussion PubMan_Functional_Specification=
==UC_PM_EX_01 Export items==
==UC_PM_EX_01 Export items==
Line 5: Line 4:
The user initiates the export for specific versions of one or more items. The export formats are divided into two types: layout format and structured format. A layout format focuses on the layout and presentation of the item data and produces one citation style. Such export formats support different export file formats, e.g. pdf or html. A structured format focuses on the export of item data in a format that can be interpreted and processed by other systems. A structured format supports only one export file format.
The user initiates the export for specific versions of one or more items. The export formats are divided into two types: layout format and structured format. A layout format focuses on the layout and presentation of the item data and produces one citation style. Such export formats support different export file formats, e.g. pdf or html. A structured format focuses on the export of item data in a format that can be interpreted and processed by other systems. A structured format supports only one export file format.
===Status/Schedule===
===Status/Schedule===
*Status: '''in specification'''
*Status: '''in design'''
*Schedule:'''R3'''
*Schedule:'''R3'''


Line 33: Line 32:
***2.2. The user selects a file format.
***2.2. The user selects a file format.
**3. The user enters the recipients for the email.
**3. The user enters the recipients for the email.
**4. (optionally) The user refines the reply-to field of the email.
**4. (optionally) The user refines the reply-to and the CC field of the email.
**5. The user confirms the input.
**5. The user confirms the input.
**6. The system creates the export file, sends the email with the file attached and displays a success message ([[PubMan_System_Messages|MSG_PM_EX_01]]). The use case ends successfully.
**6. The system creates the export file, sends the email with the file attached and displays a success message ([[PubMan_System_Messages|MSG_PM_EX_01]]). The use case ends successfully.
Line 42: Line 41:
===Formats supported===
===Formats supported===
structured formats: Endnote
structured formats: Endnote
Layout formats: Citation styles offered by citation style library
 
Layout formats: APA citation style


===Future development===
===Future development===
Line 57: Line 57:
**2. Continue with Flow of Events step 3.
**2. Continue with Flow of Events step 3.


==Additional information ==
Formats supported:
===Export activities===
BibTex, TEI


https://zim01.gwdg.de/repos/smc/tags/public/PubMan/export_activities.gif
: In Golm we need BibTeX-files as export format--Seesko 16:39, 28 February 2008 (CET)
:: Does TEI refer to [[TEI_Bibliographic_Information|biblStruc]]? --[[User:Inga|Inga]] 20:49, 14 March 2008 (CET)


''Figure: Graphical representation of export activities for PubMan''
reasonable limit for export (obergrenze):


==HTML Prototype==
From the functional point of view all records, the user wants to download should be exported. And if only records without full texts are being exported, I think it should be possible. Giving a limit for records, that can be exported is not possible for my understanding, because the size of a record can differ. If it takes longer to export, then the user should get an information on the fact, that it takes time. Like a sand glass or something.
[https://zim01.gwdg.de/repos/smc/trunk/04_Design/03_GUI_Design/03_Prototyping/HTML-Prototyp/14_Export/index.html Prototype for Export]
Besides that, I think we should only talk on exporting records as in items, describing the metadata of a record and not the attached file, as we didn't specify functionally yet, how the export of files should look like.  
 
 
[[Category:PubMan]]
[[Category:Functional_specification]]
 
 
== Discussion on exporting ==
 
Problem: item export needs a reasonable limit (obergrenze) due to technical reasons.
if it is for technical reasons, it should be possible to specify this limit. [[User:Robert|Robert]] 09:56, 21 December 2007 (CET)
 
From the functional point of view all records, the user wants to download should be exported. And if only records without full texts are being exported, I think it should be possible. Giving a limit for records, that can be exported is not possible for my understanding, because the size of a record can differ. If it takes longer to export, then the user should get an information on the fact, that it takes time. Like a sandglass or something.
Besisdes that, I think we should only talk on exporting records as in items, describing the metadata of a record and not the attached file, as we didn't specify functionally yet, how the export of files should look like.  
I also think, that we should not go for the alternative, suggested by Natasa, because it will cause frustration ;-) for the user. --[[User:Nicole|Nicole]] 15:13, 7 January 2008 (CET)
I also think, that we should not go for the alternative, suggested by Natasa, because it will cause frustration ;-) for the user. --[[User:Nicole|Nicole]] 15:13, 7 January 2008 (CET)


Line 89: Line 77:
*User selects items
*User selects items
*user chooses to export the items
*user chooses to export the items
*the system calculates the total sice of the export
*the system calculates the total size of the export
*user gets an information on how many MB s/he wants to export
*user gets an information on how many MB s/he wants to export
*user can decide if s/he wants to continue exporting/sending the export E-Mail or if s/he wants to deselect some items
*user can decide if s/he wants to continue exporting/sending the export E-Mail or if s/he wants to de-select some items
*if it will take longer to export than a few secounds the user will get a sandglass or something so that s/he knows that it will take some time until the export is finished. This is common pratice (see e.g. WoS).
*if it will take longer to export than a few seconds the user will get a sand glass or something so that s/he knows that it will take some time until the export is finished. This is common practice (see e.g. WoS).
 


::
::
Line 101: Line 88:
--[[User:Natasab|Natasa]] 16:45, 21 December 2007 (CET)
--[[User:Natasab|Natasa]] 16:45, 21 December 2007 (CET)


'''Suggested solution:'''


After talking with Inga on this issue, I would like to suggest, that we put this issue to future development and allow all sizes for now and wait for user feedback.
'''option a):'''
 
User selects items <br/>
user chooses to export the items<br/>
the system calculates the total size of the export<br/>
user gets an information on how many MB s/he wants to export <br/>
: I am not sure if the display of the MB size is a value information here. As probably the time to transform a large number of items into a specific export format can be time consuming. As the export itself are only text files, I do not think that the file size might become a problem. --[[User:Kleinfercher|Friederike]] 09:44, 3 July 2009 (UTC)
 
==Additional information ==
===Export activities===
 
https://zim01.gwdg.de/repos/smc/tags/public/PubMan/export_activities.gif
 
''Figure: Graphical representation of export activities for PubMan''
 
==HTML Prototype==
[https://zim01.gwdg.de/repos/smc/trunk/04_Design/03_GUI_Design/03_Prototyping/HTML-Prototyp/14_Export/index.html Prototype for Export]

Latest revision as of 09:44, 3 July 2009

Discussion PubMan_Functional_Specification[edit]

UC_PM_EX_01 Export items[edit]

The user initiates the export for specific versions of one or more items. The export formats are divided into two types: layout format and structured format. A layout format focuses on the layout and presentation of the item data and produces one citation style. Such export formats support different export file formats, e.g. pdf or html. A structured format focuses on the export of item data in a format that can be interpreted and processed by other systems. A structured format supports only one export file format.

Status/Schedule[edit]

  • Status: in design
  • Schedule:R3

Triggers[edit]

  • The user wants to export the selected items.

Actors[edit]

  • User

Pre-Conditions[edit]

  • One or more item versions are selected.

Flow of Events[edit]

  • 1. The user chooses to export the selected items.
  • 2. The system displays a list of supported export formats.
  • 3. The user selects an export format.
  • 5. The user chooses to save the selected items to a file.
  • 6. If the export format is of type layout format,
    • 6.1. the system displays the list of supported export file formats.
    • 6.2. The user selects a file format and confirms the choice.
  • 7. The system creates the export file and makes the file available for saving by the user. The use case ends successfully.

Alternatives[edit]

  • 5a. The user chooses to display the selected items.
    • 1. The system displays the selected items in the chosen export format. For layout formats the export file format is HTML. The use case ends successfully.
  • 5b. The user chooses to send the selected items via email.
    • 1. The system displays an edit view for the email with a predefined subject, text and reply-to field (email of account user if exists).
    • 2. If the export format is of type layout format,
      • 2.1. the system displays the list of supported export file formats.
      • 2.2. The user selects a file format.
    • 3. The user enters the recipients for the email.
    • 4. (optionally) The user refines the reply-to and the CC field of the email.
    • 5. The user confirms the input.
    • 6. The system creates the export file, sends the email with the file attached and displays a success message (MSG_PM_EX_01). The use case ends successfully.

Post-Conditions / Results[edit]

  • The items are exported.

Formats supported[edit]

structured formats: Endnote

Layout formats: APA citation style

Future development[edit]

  • 4. [Not R3] If the export format is of type structured format,
    • 4.1. the system displays the metadata definitions from the target metadata set and preselects the metadata definitions defined as default by the export format.
    • 4.2. (optionally) The user refines the selection.

Alternatives Future development

  • 2a. [Not R3] The system displays the list of export formats defined as default in the user preferences.
    • 1. (optionally) The user chooses to view a list of all supported export formats.
      • 1.1. The system displays a list of supported export formats.
    • 2. Continue with Flow of Events step 3.

Formats supported: BibTex, TEI

In Golm we need BibTeX-files as export format--Seesko 16:39, 28 February 2008 (CET)
Does TEI refer to biblStruc? --Inga 20:49, 14 March 2008 (CET)

reasonable limit for export (obergrenze):

From the functional point of view all records, the user wants to download should be exported. And if only records without full texts are being exported, I think it should be possible. Giving a limit for records, that can be exported is not possible for my understanding, because the size of a record can differ. If it takes longer to export, then the user should get an information on the fact, that it takes time. Like a sand glass or something. Besides that, I think we should only talk on exporting records as in items, describing the metadata of a record and not the attached file, as we didn't specify functionally yet, how the export of files should look like. I also think, that we should not go for the alternative, suggested by Natasa, because it will cause frustration ;-) for the user. --Nicole 15:13, 7 January 2008 (CET)

I agree with Natasa - and I do not see the point where a user will be frustrated and how. Usually the user is not aware that a download can take time. A warning would be good in any case, based on the calculated size/number of items: (you have selected more than XXXX for download, the download can take some time)
Usually I do not like these questions (do you really like ...) but in this case it makes sense.
We can also think about download in steps - like paging (250 - 500, 500 - 750, ...). This can be also specified by UIE in functional prototype during design phase. The functional part is covered in any case. Rupert 21:12, 24 January 2008 (CET)

Possible solution:

  • User selects items
  • user chooses to export the items
  • the system calculates the total size of the export
  • user gets an information on how many MB s/he wants to export
  • user can decide if s/he wants to continue exporting/sending the export E-Mail or if s/he wants to de-select some items
  • if it will take longer to export than a few seconds the user will get a sand glass or something so that s/he knows that it will take some time until the export is finished. This is common practice (see e.g. WoS).

Another alternative:

  • This was somewhere stated as well, i remember that Ulla and me were talking on this. However, as probably users do not really have an idea on what means "n MB" after selection of the items maybe the system may provide some "more friendly" information such as : "You have selected 1000 items, but you can export the first 150 items (number calculated by the system, depending on selections) of your selection due to limitation of the size of the export ..etc.." - and then she decides.
  • Other alternative is that the system takes care if the user specified 1000 items, the system should be able to "split" in reasonable packages and send several emails as "export part 1".."export part n" :)) (But would consider that at some later stage).

--Natasa 16:45, 21 December 2007 (CET)


option a):

User selects items
user chooses to export the items
the system calculates the total size of the export
user gets an information on how many MB s/he wants to export

I am not sure if the display of the MB size is a value information here. As probably the time to transform a large number of items into a specific export format can be time consuming. As the export itself are only text files, I do not think that the file size might become a problem. --Friederike 09:44, 3 July 2009 (UTC)

Additional information[edit]

Export activities[edit]

https://zim01.gwdg.de/repos/smc/tags/public/PubMan/export_activities.gif

Figure: Graphical representation of export activities for PubMan

HTML Prototype[edit]

Prototype for Export