Skip to end of metadata
Go to start of metadata

20120619 Dominic

Tasha told me that you would like a head start on the data basket utility.
Please find an expansion from the functional requirements document which I have left as draft.
The user cases should give you an indication of what is needed but just fire off questions as they come to you.
I thought that it might be something like a cross between the Top Braid basket and Zotero. Please have a look at Zotero.

Databasket specification.docx

ResearchSpace Data Basket

version

Author

Date

Draft for discussion

 

Dominic Oldman

19 June 2012

 

 

 

 


1                 Introduction

 

The document provides an introduction to a full specification of the data basket. The data basket is described at page 38 and 73 of the functional requirements. This document may make changes to the details of the data basket and provide more details for its implementation.

The functional requirements sections are reproduced below

Page 38

 

The following description was provided within the functional specification

 

While using the research tools users will come across data that they wish to use in the collaboration

environments. It should be possible to add selected data or links to data or assets into a ‘basket’

which can be used to insert into a collaboration post. This should include:

 

·         Data – a user may select some data or an annotation on data.

·         Links to data – a link that when another user clicks on it takes them to the required data.

·         Links to images – as an image tag and a hypertext tag.

·         Links to searches - the ability to provide a link that invokes a search. For example, a user searches

·         and decides to save the search for another to use.

 

Data should be specifically formatted and tagged with its RDF identifier so that it can be reported and used for a search.

 

 

Page 73

1.       Data copied from the Data and Image Annotation tools is recorded here under different sections.

2.       Entries can be selected in two ways, by a tick box and by highlighting.

3.       Highlighted entries can be deleted and the whole data basket can be cleared.

4.       Allows capture of data records, images (through a link), data annotations and image annotations.

5.       Enables data basket entries to be selected for insertion into social networking tools. (Insertion into a

6.       social networking tool should also include a URL link for another user to view the data using the

7.       original research tool).

8.       It should be possible to find entries in the data basket using keyword searching, author, record ID and

9.       field type.

 

 

2                 Objectives

The data basket should achieve the following objectives;

1.     A history of use –tracking the last thing that a user did in any ResearchSpace tool and recording this in a history section the basket. A link would enable a user to start a tool with a particular record or asset loaded rather than have to search for the record or asset again.

2.     Searches – this would allow users to save searches. This can be sent to other users who can save the searches to their own data baskets.

 

3.     User activity - Records all entries made by the user.

 

4.     Recording information - like a field, image (or other assert) or an annotation – this would allow the following;

 

5.     Embed into Collaboration -The ability to embed items into collaboration areas as part of a discussion, wiki entry etc. For example, a user makes an annotation using one of the ResearchSpace tools. They save the entry as a data basket item. They go to the collaboration area and insert the item into the discussion. This means that others can link to the item in context directly.

 

6.     Embed into Tools - The ability to take text from a collaboration area and use it in a research tool – such as an annotation.

 

7.     General Notes and citations (Possibly should be Zotero compatible)

 

8.     Share - Allow users to share their data basket entries.

 

9.     Export – Ability to export data to standard file formats including RDF

 

10.                        Additional – Individual data baskets could be used as a data source for web presentations

 

3                 Assumptions

 

It is assumed that entries, where possible, are accessing existing data rather than duplicating it. (for discussion).

4                 Metadata

Metadata for data basket items

·        Data basket Creator – The person who created the data basket item whether explicitly or implicitly

·        Sent by – The person that sent the data basket item

·        Title – The title of the data basket item

·        Description – Description of the data basket item

·        URL – Address of the data basket item

·        Tool  - The tool it was created in

·        Data Author – The person who created the data that was inserted (e.g. annotation)

·        Data Date – The data that the information was originally created.

·        User metadata and Notes

5                 Use Case Stories

Case 1 -  The user logons on to the system and goes back to a data record or image record that they had been working on in their last session. Clicking on the link in the data basket launches the tool and the record ready for working.

Case 2 – The user goes back to a item they were working on in the current session. They can look through their history and select a link that lunches the record in within the tool they were last working with it in.

Case 3 – The user is working with a collaboration environment. They want to bring others users aware of a record they have been working on within the image annotation tool. They copy the database link into the forum for others to follow. The link will launch the tool and the record for other users.

Case 4 – The user makes a comment in the collaboration forum and wants to use the text in an annotation at a later date. The user can copy the text to the data basket and paste it into an annotation or other field later.

Case 5 – The user wants to leave the collaboration forum while writing a post and make a data entry or annotation using a RS tool. They want to then come back to post and complete the entry and insert new items from their data basket into the post.

Case 6 – The user wants take a piece of data while using a tool and create a link to that data in a collaboration forum.

Case 7- The user wants to collect thumbnails in their data basket and insert these within the collaboration forum.

Case 8 – The user want to collect a link to a digital asset and insert this into a collaboration forum. The link would take the user to the asset. The link would display a thumbnail.

Case 9 – The user wants to save a current search in the data basket – The entry should provide a link to load a search and invoke the search query.

Case 10 – the user wants to flag entries in the data basket and share them with other project team members.

Case 11 – The user wishes to transfer information between tools. For example, an annotation made against an image might also be made against a data field.

Case 12 – The user wishes to add additional notes and tags to data basket items. The user also wishes to search the data basket.

Relevant Internet examples

Top Braid web data basket

http://composing-the-semantic-web.blogspot.co.uk/2011/04/topbraid-composers-web-data-basket.html

Note: This is not relevant from a UI perspective because the data basket need to be a user friendly UI but is useful in terms of some concepts and ultimately collects RDF.

Zotero

http://www.zotero.org/support/screencast_tutorials

This is more user friendly and may have some future within the data basket system. It has the concept of collecting information and allowing additional notes and tags.

20120711 Maria

Data basket Use case diagram

The following UCs has been identified based on the provided user requirements specification for data basket (see https://confluence.ontotext.com/display/ResearchSpace/Data+Basket+Spec#DataBasketSpec-20120619Dominic)   and workshop in BM in 06.07.2012, where additional clarifications has been made.

Jana: Sort is missing. Share is missing. DBUC12 and DBUC11 - are these to be done? In which iteration?

20.DBUC01: Add Item to Data Basket (RS3.5)

R1 The data basket is personal user store for selected data (bookmarks). Each user has its own data basket, which is empty in the beginning.
R2 TBD: On project level (in the project dashboard) there will be supported shared data basket – accessible from all project team members, where each user could share items from their personal data baskets.
R3 Each item is kept in the data basket as link.
R4 The following items could be added to Data Basket
  • Image
  • Image annotation 
  • Data object
  • Data field 
  • Data annotation
  • Search
  • Forum 
  • Document
  • Web link
  • Text
    DO Notes: Technical we can probably described these in more generic terms. More tools will be added to researchspace and essentially we are talking about links. An image is essentially a link to an image that is resolved. When launching tools the tool should have a URL and allow parameters that load the particular item into it. We need to think how data as opposed to free text is represented and we need to think about how the databasket interacts with the tools so that it is not just a manual cut and paste tool. 
R5 Link to image could be added to Data Basket from:
  • Search result Jana: We don't have image search
  • Image details Jana: Need a button
R6 Link to image annotation could be added to Data Basket from: 
  • Search result Jana: We don't have annotations search
  • Image annotation tool
  • Forum tab (RS3.6)
R7 Link to data object could be added to Data Basket from:
  • Search result Jana: Need to add additional button in Exhibit screen
  • Object Details Jana: Need a button
R8 Link to Data object literal could be added to Data Basket from:
  • Data annotation tool
  • from context menu.
  • Lazily creates the Annotation Point (AP), creates its Title, uses its URI.
  • Invokes Databasket Item dialog, so the user can edit Tags and Note
R9 Link to Data annotation could be added to Data Basket from:
  • Search result Jana: We don't have annotations search
  • Data annotation tool
  • Forum tab (RS3.6)
    DO Note - from the search screen would mean that when you selected a result you should be able to specify the contect in which you took the result link. Is it a serach, it is for data annotation... or another tool, or simply a reference to the image or artefact.
R10 Link to Search sentence could be added from:
  • Search tool Jana: We don't have the UI?
R11 Link to forum discussion could be added from:
  • Forums tab (RS3.6)
R21 Link to Web link could be added from the Data basket/ "Add Web link" button.
  •     When the user selects the button a Databasket Item dialog is invoked,where the user could paste the web link, so the user can edit URL, Tags and Note. This is the only time URL is displayed in this dialog.When the URL is changed, goes out to the web page to fetch the Title
  •     "Add Web Link" should be exposed as a REST web link, so it can be made into a JS bookmark for the user to put in his browser
  • The title is editable
R12 Text could be pasted to Data Basket, after being copied from any source (forum/ discussion/ comment/ nuxeo documents/ external documents/ object records, etc.) Text is inserted into data basket from: Data basket/ "Add Text" button.
  • When the user selects the button a screen opens where he could paste the text into Notes field. The text is stored in rich text format.
  • The Title field is created automatically and contains the first 40 chars from the notes field. The title is in plain text format.
  • The title could be updated by the user
R13 When the user selects “Add to Data Basket” for each of the above items, a default link name (title) to the item is created. The default link name could not be changed by the user.
R14 When the user selects “Paste to Data Basket” a default link name to the pasted text is created. The link name could be changed by the user.
R15 The following metadata are kept for each item in the Data Basket, when created:
  • URL - see R16 below
  • Title - the link (title) to the original item. The item's title is used as a default value and copied to the bookmark title, but then the user can edit the bookmark title (an extra field in the data model!)
  • Type - the type of the original item (data object, image, data annotation, etc.) with specific icon
  • Notes - user notes to the data basket item (the field is empty with the creation of the bookmark, could be inserted free text by the user)
  • Tags - user defined tags Jana: No, they are hardcoded in the system. Possibly for 3.6
  • Added by (Creator) – the person who created the item into the Data Basket
  • Date (Creation date) – the date in which the item has been added to the Data basket
  • Data Author - The author of the original item. To be supported only for image annotations, data annotations and forums. Examine the item type, and fetch dcterms:creator and dcterms:created.
  • Data Date - the date in which the original item is created. To be supported only for image annotations, data annotations and forums.
  • Preview - preview is supported for data objects, images, data fields (Vlado to confirm?). For web links - can we use a web page preview server to fill out the image for Web Link? If we can the the preview should be supported for them also.
R16
The following rules should be observed for URL field:
* For RS (internal) items, display fixed text "ResearchSpace item".* For Text, display nothing.* For Web Link, display its shortened URL. Shorten the Web Link using some URL shortening service (need an extra data field!). Show the short URL in the column, and the full URL in a tooltip (it usually includes useful info, eg a blog link is usually readable)
R17
For each item in the data basket, there will be provided different representation as link (icon, name, image)
R18
When an item is added to the Data Basket is provided a possibility for the user to add notes and tags to the item. The fields are optional.
R19
Notes field is free text field and the user could add any text explanation to the item he is creating. A rich text editor is used for notes field.
R20
As many tags as wanted could be added to an item
  • Tags should use all existing thesauri, plus a specific Tags thesaurus, which is shared per-project
  • Tags are shared per project - which means that there is provided auto completion functionality, and user could select any of the already existing tags in the project, or the create a new one
  • A new tag is always added to the  project Tags thesaurus Jana: No, user cannot add a tag
  • Per data basket item are visible only the tags which are assigned to this item, not all existing tags


20.DBUC02: Insert Item (RS3.5)

R1 Each data basket item (link or text) could be inserted into text editor (TinyMCE), which means into:
  • Image annotation
  • Data annotation
  • Forum discussion
  • Wiki page
    DO Note: Again more generic - as this list will simply increase
R2 The link is inserted as URI. The other metadata like notes, creator, creation date, etc are just for personal information for the user in the data basket.
R5 The text is inserted just as text. No other metadata from the data basket are associated with it.
R6 To insert a data basket item for collaboration, the user must perform the following steps:
  • select the button "Insert link from Data Basket" into the text editor, which opens the user personal Data Basket
  • search/ browse for item in the basket
  • select item for insertion
R7 The link inserted in any collaboration environment, when selected should open the item into the tool it was created in (see R1/ DBUC03)


20.DBUC03: Open link from Data Basket (RS3.5)

R1 When the user clicks on a link to data basket item, the item is opened into the tool it was created in, and is ready for working.
  • Link to image annotation brings to the image annotation tool, with the respective annotation in focus
  • Link to data annotation brings to the data annotation tool, with the respective annotation in focus
  • Link to image brings to image details screen
  • Link to data object brings to data object details screen
  • Link to data field brings to data object details screen with the respective data field in focus
  • Link to general discussion brings to the forum tab with the respective discussion in focus (RS3.6)
  • Link to search opens search sentence tab, with search result listed
  • Link to web link opens the respective web page into a new window
R2 If changes are made into an item, which is kept as link in the data basket, the link in the data basket always opens the latest version of the item.


20.DBUC04: Edit notes/ tags (RS3.5)

R1 The user should be able to edit title, notes and tags to each item in his data basket, which means to delete existing notes and tags, or to update title, notes and add new tags.
R2 No other metadata of an item could be edited.


20.DBUC06: Delete item from Data basket (RS3.5)

R1 Each data basket item could be deleted by the user
R2 The user selects button Delete from arrow button next to an item.
R3 When item is deleted from a Data basket, it is deleted with all its metadata and no history is kept for it.
R4 If an item is deleted from a data basket, it is not deleted from the collaboration tools it has been used in. There remains a valid link.


20.DBUC07: Empty Data basket (RS3.5)

R1
The user could select "Delete all" button or "Empty Selected" in the data basket
R2 If the user selects “Delete all” then all items from the data basket are deleted. The system shows confirmation message “Are you sure you want to permanently delete all items in the Data Basket?” Yes/ No.
R3 If the user selects "Empty selected", then only the selected items are deleted from the data basket. “Are you sure you want to permanently delete the selected items from the Data Basket?” Yes/ No.


20.DBUC08: Filter items in data basket (RS3.5)

R1 All items in the Data basket are automatically sorted by date of creation.
R2 The user could filter items in data basket by the following criteria:
  • Type – this is the type of the item, the system provides a list with all available item types: Data Annotation, Image annotation, Search, Forums, Object Records, Images, Text, web link
  • Date of creation – this is the date of creation of the item in the data basket – the filter should provide Date from and Date to
  • Keywords – this is free text search, that provides the user the possibility to search in item Notes field
  • Tags – this is a list of all tags used in the data basket, and the user is able to select from them. There is tags panel in the data basket, where the user at any time could filter items, by clicking on one or more of the existing tags. Tags in the tags panel are sorted alphabetically.
R3 After user enters the filtering criteria, the system displays only the items in the data basket, which satisfy the criteria
R4 The user should be able to clear the filtering criteria, if he wants to browse all data basket items again.

Search - The user should be able to search the data basket using meta data

MariaT: Dominic, "DBUC08: Filter items in data basket" contains both keyword search and filtering by item type, tags.dates. It is created based on the functionality already developed for search/ filter data and image annotations, as proposed from BVA.  Please, advice search by what other metadata you expect in DataBasket?

External data - Should include external data resources and RDF

Note: Internally a basket item will link to the item with the appropriate tool. Externally the tool will launch within the web context or web site that the data was sourced. (see Korba tool for behaviour)

For future iterations

20.DBUC11: Export data from Data Basket (RS?)

R1 The Data Basket items could be exported in any standard file formats - to pdf, to zotero.
R2 The user selects data basket items (all or some of them) and presses button Export. Then he selects the file format he wants to export them in and the location he wants to keep the exported data.
R3 The system generates a file with all exported data basket items, in the selected format and saves it in the selected location

20.DBUC12: Start Discussion on Data Basket Item (RS3.?)

R1 The user could select one or more items from the data basket and start general discussion on them.
R2 When a discussion is started the selected items are automatically added into the discussion and the user could comment on them
- Copy the selected items into the body of a new comment.
- Copy them in the form of links, one per line.
- Leave the comment title empty.
- Omit bookmark note, creator, created. 
R3
The discussion is saved as general discussion in the forum tab.
  • Sort tags in the tags panel by popularity not for 3.5. TO be decided for which iteration?
  • Additional filed for each data basket item - Number of replies. The number could be next to the Type icon, for specific items:
    • object: number of Replies to all annotations about the object
    • field: number of Replies to annotations about that object field
    • data/image annotation: number of Replies to that annotation
    • image: ?
    • forum:?

Annotate - Should be able to annotate a databasket item from inside the data basket

This should have the same effect as if annotating from a tool and use the same OAC standard. I also think that you hsould be able to link two databasket items again using the OAC technique.

MariaT: Dominic, on the session that we had in London, we discussed that the user should be able to start discussion on one or group of data basket items. The discussion we be started as general discussion in the Forums tab. This is described in the "20.DBUC12.Start Discussion on Data basket item". Is this Annoatate functionality the same as the one in 20.DBUC12, or it is different?

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jul 16, 2012

    The specification is written to specific according to existing tools. However, the way that the data basket works should be generic for existing a nd new tools to come. The production version of research space will require an API that means that all tools that adhear to it can be accessed and inetgrated with the databasket tool. This means that there must be a consistent type of URI / URL with tool parameter so that tools can be launched and placed in the appropriate state. These links should be ones that could be used as a normal web link in a browser (RESTful) so that the links could be used outside the databasket using a simple browser address box. To this end the soecification should also have a technical specification outlining the way in which the databasket woulod interact with the researchspace environment please can this be added to this page for comment and before final sign off. Thanks, Dominic

    1. Jul 20, 2012

      Let's follow up at Data Basket Design