Annotation Spec

Version 16 by Maria Todorova
on Dec 28, 2011 22:56.

<< Changes from 15 to 16

compared with

Current by Maria Todorova
on Jan 30, 2012 17:35.

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (52)

View Page History

...

{toc}

h3. Used business terms and abbreviations

|| Term || Description ||
| URI | *Uniform Resource Identifier* (*URI*) is a  string of characters used to identify a name or a resource in the Internet |
| Annotation Point (AP) \\ | As an annotation point will be referred any of the following concepts, when displayed on the screen and when no special distinction is required: object record (the root), object statement (Subject, Property, Object), in which the object is either literal or thesaurus value. Each annotation point is a RFD graph node. The object record itself is the root (main node) of the graph, and each field or field value (subject or object) is also a node in the RDF graph. |
| Node | A node may be a URI reference, a literal, or blank node |
| Discussion | A discussion (also known as thread or topic) is a collection of posts, displayed by default from oldest to latest. A discussion is defined by a title, an opening or original post (common abbreviation _OP_) which opens whatever dialogue or makes whatever announcement the poster wished, date and time on which is started as the date and time of the last post. A discussion can contain any number of posts, including multiple posts from the same members, even if they are one after the other. \\
A discussion is contained in a forum. When a member posts in a discussion it will jump to the top since it is the latest updated thread. \\
The following discussion types will be distinguished in the document: |
| Item Discussion | This is type of discussion used as a term in this document. This is discussion directly started on an item -- object record, field or value. This type of discussion has a reference to the data item for which is started. |
| General discussion | This is type of discussion used as a term in this document. This discussion is independent from an object record, it started from the discussions component, but it could contain links to data objects, documents, images, etc |
| Post | A post is a user-submitted message, containing the user's details and the date and time it was submitted. Members are usually allowed to edit or delete their own posts. Posts are contained in discussions. The first post starts the discussion; |
| Main Link \\ | Thus will be called the link between: \\

\- a discussion and the AP to which it has been started \\
\- a discussion and the RS content (document, image, folder, etc.) for which it has been started. \\

Each post/reply of the discussion inherits by default the main link of the discussion. The main link of a post could change if the user while commenting proposes new AP value - in this case the main link of the post will be the link to the newly proposed value, the replies to this post will inherit its main link also. \\

Each post/reply of the discussion inherits by default the main link of the discussion. \\

A General discussion doesn't have a main link. |
| Other Links \\ | Other links will be called all the links inserted in an discussion - links to images, to documents, to APs, to external web pages. |

...

| Annotation Layer \\ | Annotation layer includes attribute assignments, comments, who made them etc; |

h3. State Chart Diagrams

h3. -State Chart Diagrams- \- Not for RS3.2

h4. Object Record Item Versions

h4. AP Versions

* Data entry against an object item AP will create a new version of the item.

* A version record has different states during its lifecycle.
* The state chart diagram below is not full, because in stage 3 only part of the version record’s lifecycle will be developed .

...

* The state chart diagram will be updated after the analysis performed on the next stage.

|| Code || State || Description ||
| OBJPOS | Possible | Active state of a version record \\
This is an informative state of a newly created version of a field value. The researcher may select this status, when he is not sure that the value is correct, but wants to keep it as a reminder for future research, or may want to delete it later. |
| OBJRES | Under Research | Active state of a version record \\
This is also an informative state of a created version. The researcher may select this status together with creating the version or he could change the status of already created version in status Possible to Under Research. This state is created with the purpose of informing other team members, that this value is still not proven. |
| OBJPRO | Proposed | Active state of a version record \\
By changing a version record state to “Proposed” the researches informs his Project Admin, that he has finished his research and he grants that the new version of a record item is correct. |
| OBJDEL | Deleted | End state of a version record \\
The researcher, who created a new version, together with the Project Admin are given the possibility to delete the version in case of mistake due to inadvertence, before the new value is actually approved. \\
Deleted versions are invisible for the project members. |
| OBJREJ | Rejected | End state of a version record \\
After the RS Project Admin receives a proposed value for review he could either approve it or reject it. If he rejects the state of the new version becomes Rejected. Rejected versions of an item are visible fr the project members, but could only be commented on them. \\
The transition to this state will be developed in the next stage of the project. |
| OBJAPI | Approved Internal | Active state of a version record \\
After the RS Project Admin receives a proposed value for review he could either approve it or reject it. If he decides to approve he could select to approve it just internally for the project, but not for publishing to the public web, because of different reasons -- some more clarifications are needed, the research is secret, etc.   \\
The transition to this state will be developed in the next stage of the project. |
| OBJAPP | Approved Publishable | Active state of a version record \\
The RS project Admin could approve proposed value version for publishing. This means that when the publishing procedures are started all values in this status will be published. \\
The transition to this state will be developed in the next stage of the project. |
| OBJPUB | Published | End State of a version record \\
Version records are in this state when published on the web. \\
The transition to this state will be developed in the next stage of the project. |
| OBJORG | Original | End state of a version record \\
All initially loaded/ migrated object record items are in this state. \\
If new object record is created and there is no previous version is status “Original”, when published the items of the record will be in status “Original’. \\
The transition to this state will be developed in the next stage of the project. |

!Object Record Field Status.png|border=1!

Diagram 06.1: Object record item versions State Chart Diagram

h4. Discussion

The state chart diagram of a post/ discussion will be provided in 04. Social Networking

h3. Use Cases

...

!(06) Data Annotation v23.png|border=1!

Diagram 06.2 Use Case Diagram

...

*Preconditions:*

| 06.DANNOTATION.R5 | 06.DAUC01.R1 | RS3.1 \\ | UC [05.SSUC01: Advanced Semantic Search|https://confluence.ontotext.com/display/ResearchSpace/Semantic+Search+Spec#SemanticSearchSpec-05.SSUC01%3AAdvancedSemanticSearch] or [05.SSUC05: Full Text Search|https://confluence.ontotext.com/display/ResearchSpace/Semantic+Search+Spec#SemanticSearchSpec-05.SSUC05%3AFullTextSearch] has been performed, an object record is successfully found and selected for review. |

| 06.DANNOTATION.R5 | 06.DAUC01.R2 | RS3.2 | Link (URI) to a AP (Annotation point) from data layer is selected for review \-  from a Data Basket, Discussion, just browsing object records, etc. |

* *

...

*Description:*

| 06.DANNOTATION.R6 | 06.DAUC01.R4 | RS3.2 | When the user selects a link to AP from the data layer, then Object Record Details tab opens. In the tab are displayed only data in status "Migrated" or "Original" for the data object (the data from the data layer). |

| 06.DANNOTATION.R6 | 06.DAUC01.R5-3 | | * The user is automatically positioned to the selected item, when the screen is opened. If the user has selected a link to the object record, which is represented as a main node in the RDF graph, then he is positioned at the beginning of the Object Record area. |

| \\ | 06.DAUC01.R6 | RS3.2 | Next to each AP in the Object Record details tab will be displayed the following indicators: |

| 06.DANNOTATION.R15-1 | 06.DAUC01.R6-1 | | * *Version Indicator:* If for AP there are other versions than the original, then next to the field will be displayed a version indicator (V) coloured in red. (For details see 06.DAUC02: View Versions of AP). The version indicator will be coloured grey if there are no other versions. |

| 06.DANNOTATION.R1 | 06.DAUC01.R6-2 | | * *Discussion indicator:* If for an AP there are discussions started, then next to it will be displayed a discussion indicator (D), coloured in red. (For details see TBD 06.DAUC06: View and Create Discussions on Object Record). The discussion indicator will be grey coloured if there are no discussions started. |

| 06.DANNOTATION.R10 | 06.DAUC01.R6-3 | | * *Linked Records Indicator:* This indicator (L) counts: Links to AP in the discussions started for the selected one plus links to AP for which are started discussions and the current one is embedded into them. (For details see 06.DAUC07: View Linked Records). |

* *

*Post-Conditions*

* *

...

*Preconditions:*

| | 06.DAUC02.R2 | RS3.2 | Link (URI) to value from annotation layer is selected for review \-  from a Data Basket, Discussion |
* *

...

*Description:*

| 06.DANNOTATION.R15-1 | 06.DAUC02.R4 | RS3.2 | The version indicator (V) next to AP, when coloured in red, shows that there are existing versions in the annotation layer created for that AP. The version indicator next to AP, when coloured in grey means that there are no new versions proposed for the value. \\ |

| | | RS3 | In tab Versions is displayed a list of all existing versions in all statuses (except Deleted) of a value. The original value from the data layer is also listed. \\ |
| \\ | 06.DAUC02.R6 | RS3.2 | (TBD) In tab Versions is visualized the following information for each version:

...

| | | | * The user could sort versions on the Version tab by clicking on the name of each column. If for example the user clicks on Researcher Name column once then the values will be sorted by Researcher name in ascending order, if he clicks second time then values will be sorted by Researcher name in descending order. |
*Post-Conditions*

| \\ | 06.DAUC02.R11 | RS3.2 | UC “06.DAUC03: Edit Field Version” could be started. |
| \\ | 06.DAUC02.R12 | RS3.2 | UC “06.DAUC04: Create Field Version” could be started. |

...

| \\ | 06.DAUC02.R13 | RS3.2 | A discussion for field version could be opened or new one started. |
* *

h4. 06.DAUC03: Edit Existing Version

*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC03.R1 | RS3.2 | UC “06.DAUC02: View Version of AP” has been performed and “Versions” tab is opened. |
* *

*Constraints:*
| \\ | 06.DAUC03.R2 | RS3 | Version records could be edited only from the researcher who created the version or from the RS Project Admin. |
| | 06.DAUC03.R3 \\ | RS3 | The original value of an AP could not be edited. \\ |
* *

*Transitions:*

\-          Possible >Under Research

\-          Possible >Proposed

\-          Under Research >Proposed

*Initiating operation/ button:* Edit

*GUI:* Versions tab

*Description:*
| \\ | 06.DAUC03.R4 | RS3 | The edit mode for a version will be accessible only for the user who created the version and for the RS Project Admin of the current project. |
| \\ | 06.DAUC03.R5 | RS3 \\ | The edit mode will be accessible only for version records in status Possible or Under Research. |
| \\ | 06.DAUC03.R5 | RS3 \\ | The following information for each version could be edited: |
| \\ | 06.DAUC03.R5-1 | | * -Version Status- (Not for RS3.2 iteration) -- the version status could be updated manually from: \\
Possible to Under Research \\
Under Research to Proposed
* Possible to Proposed \\
(TBD: Will we be able to edit version status, or only the discussion status? Vlado said that the version will have the status of the first post in a discussion started for it? What if more than 1 discussions are started?) |
| \\ | 06.DAUC03.R5-2 | RS3.2 \\ | * Value -- Edit functionality for field values is provided for the reasons of unconscious user mistakes, which could be fixed before the version status is changed to Proposed and is sent to the RS Project Admin for approval. |
*Post-Conditions*
| \\ | 06.DAUC03.R6 | RS3.2 | The changes in field version are saved successfully and displayed on the screen. |
* *

h4. 06.DAUC04: Propose New Value

*Preconditions:*
| 06.DANNOTATION.R15-2 | 06.DAUC04.R1 | RS3.2 \\ | UC “06.DAUC02: View Version of AP” has been performed. |
* Constraints:*
| \\ | 06.DAUC04.R2 | RS3.2 \\ | New values could be proposed only for literal or thesauri objects  |
| | 06.DAUC04.R3 \\ | RS3 \\ | New values for compound objects (example Exhibitions) won't be able to be proposed in RS3.2 \\ |
* Transitions:*

\-          New >Possible

\-          New >Under Research

\-          New >Proposed

*Initiating operation/ button:* Propose New Value

*GUI*: Versions tab

*Description:*
| | 06.DAUC04.R4 \\ | RS3.2 \\ | When the user selects a version indicator next to AP, the Version tab opens and the user could select Propose New Value button \\ |
| | 06.DAUC04.R5 \\ | RS3.2 \\ | There are 3 scenarios when new value is proposed: \\
* Add new value - this is the case when there is no existing original value, and the user wants to fill the gaps in the object record. In this case, when opened, the Versions tab is empty for a selected AP.

* Replace old value - this is the case when there is already an existing original value and the user wants to propose new value which he thinks is the correct one. In the Versions tab there is one or more versions for the selected AP.
* TBD: New value for cardinality >1 ... |

| 06.DANNOTATION.R15-2 \\
06.DANNOTATION.R2-1 \\
06.DANNOTATION.R2-2 \\

\\ | | 06.DAUC04.R6 | RS3.2 \\ | When the user selects “Propose New Value” an entry form is opened with the following mandatory fields: \\ |

| 06.DANNOTATION.R8-1 | 06.DAUC04.R6-1 | RS3.2 \\ | * New value -- Based on the field type, for which a new value is created the user will be provided with different data entry fields:

** If the field requires the use of thesauri value, then the data entry form will provide a thesauri control for the new value. Auto-complete will be incorporated. A value will not be saved if not found in the thesaurus.
** If the field requires literal value, then the entry will only be validated for the correct format - validate for Date, String, Integer, etc. |

| \\ | 06.DAUC04.R6-2 | RS3.2 | * Discussion post - It is mandatory the user to give reasons for the new value he proposes. There are 2 options:

** Start new discussion - The first option is the user to input the text in the new comment field opened, and thus new discussion will be started.
** Comment in existing discussion - The user could decide to select any of the discussions already existing for this AP and to comment in it. In this case there is a button Select Discussion, which navigates to tab Discussions for this AP. |

| \\ | 06.DAUC04.R6-3 | RS3 | * -Status-  (not for iteration RS3.2)\- the version status is selected from a codelist. The user could select only between “Possible”, “Under Research” and “Proposed” statuses |

| \\ | 06.DAUC04.R7 | RS3.2 | The newly proposed value could be saved only after the user contributes in a discussion and field value is is validated successfully by format. \\ |

| \\ | 06.DAUC04.R7-1 | | * If the user does not save the new value and cancels the entry then the created discussion/ post is automatically deleted. |

| \\ | 06.DAUC04.R7-2 | | * If the user saves successfully the new value then a new version record is created and the discussion/post is linked to the version record. |

| 06.DANNOTATION.R11 | 06.DAUC04.R8 | RS3.2 | When the version record is saved the following additional metadata are associated: \\

\-          Researcher -- the name of the user who created the new value \\
\-          Research Project -- the project name of the researcher \\

...

*Preconditions:*

...

| | 06.DAUC05.R4-1 \\ | RS3 \\ | * Delete Value: Values could be deleted only if in status “Possible”, “Under Research” and “Proposed” and  only from the researcher who created the value or the RS Project Admin. This is the case when a user has proposed new value and later on realizes that he has made a mistake. There is no need the deletion to be approved by the RS Project Admin. |
| | 06.DAUC05.R4-2 | RS3.2 \\ | * Propose Deletion: A user could propose a value for deletion in case he thinks that such value/event does not exist or is totally wrong. Deletion could be proposed to values from data layer or to values from annotation layer which are proposed from other users. The RS Project Admin should approve the proposal for deletion. |

| \\ | 06.DAUC05.R5-1 | | * The value status changes to “Deleted” |
| \\ | 06.DAUC05.R5-2 | \\ | * The discussion associated with the version is deleted |

...

*Preconditions:*

*Constraints:*

...

*Transitions:*1*

*Initiating operation/ button:* Link to a discussion, Discussion indicator

*GUI:  *

* Object Record Details/ Discussion tab
* Object Record Details/ Discussion indicator
* Object Record Details/ Version tab/ Discussion indicator
* Object Record Details/ Linked Records tab/ Discussion Indicator

*Description:*
| | 06.DAUC06.R2 \\ | RS3.2 \\ | Next to each AP on the Object Record details tab is displayed a discussion indicator (D). \\ |
| | 06.DAUC06.R2-1 \\ | | * When coloured in red the discussion indicator shows that there are one or more discussions started on an AP. If the indicator is coloured grey this means that there are no discussions started. |
| | 06.DAUC06.R2-2 \\ | | * When discussion indicator next to AP is selected then the user is navigated to the Discussions tab. In the Discussions tab the list with available discussions will be restricted only to those on the current AP and all its versions. The user could read and comment on any of the existing discussions or to start a new one. |
| | 06.DAUC06.R2-3 \\ | | * If a new discussion is started in this case it will be linked to “Original” version of the record |
| | 06.DAUC06.R2-4 \\ | | * If the user selects the discussion indicator next to the root AP, or opens directly Discussion tab for an object record then are listed all available discussions for all AP and versions for the current object record. |
| \\ | 06.DAUC06.R3 | RS3.2 | In the Version tab, next to each value in the list with values there is discussion indicator. Discussion indicator colored in red shows that there are discussion started on this particular value. \\ |
| | 06.DAUC06.R3-1 \\ | | * When coloured in red the discussion indicator shows that there are one or more discussions started on an value. If the indicator is coloured grey this means that there are no discussions started. |
| | 06.DAUC06.R3-2 \\ | | * When a discussion indicator next to version record is selected then user will be navigated to the Discussion tab, where will be listed all discussions only for the selected version of the record.  The user could read and comment on any of the existing discussions or to start a new one. |
| | 06.DAUC06.R3-3 \\ | | * If the user selects the discussion indicator next to the root AP, or opens directly Discussion tab for an object record then are listed all available discussions for all AP and versions for the current object record. |
| | 06.DAUC06.R4 \\ | RS3.2 \\ | In the Linked Records tab, next to each value in the list with values there is discussion indicator. Discussion indicator is always coloured in red, because all links in the tab are extracted from existing discussions. |
| | 06.DAUC06.R4-1 \\ | | * When a discussion indicator next to linked record is selected then user will be navigated to the Discussion tab, where will be listed all discussions started for the current AP in which the respective link is embedded (for outgoing links) or all discussions started for the listed record, in which is embedded the current AP (for incoming links). The user could read and comment on any of the existing discussions or to start a new one. |
| \\ | 06.DAUC06.R5 | RS3.2 \\ | When a new discussion is started during creation of new value (see DAUC04: Propose New Value), then: \\ |

| \\ | 06.DAUC06.R5-1 | | * The discussion name is created automatically, based on the following template; “New value <VALUE> for field <FIELD NAME>”. The user is allowed to change the discussion name. |
| \\ | 06.DAUC06.R5-2 | | * The discussion is automatically linked to the respective version record. |

| | 06.DAUC06.R5-3 | | * The discussion indicator next to the new value gets coloured in red |

| \\ | 06.DAUC06.R6 | RS3.2 \\ | If there are no discussions started on any of the APs then the Discussion tab is empty, but the user could open it and select Start New Discussion button. |
| | 06.DAUC06.R7 \\ | | For more details see [SNUC13: View/ Sort Discussions|https://confluence.ontotext.com/display/ResearchSpace/Social+Networking+Reqs#SocialNetworkingReqs-04.SNUC13%3AView%2FSortDiscussions]\\ |

| | | | The discussion indicator on AP increases (gets coloured in red for RS3.2) when:\\
\- a discussion is started for old value - for each new discussion started on the annotation point the indicator increases (or gets coloured in red if it has been grey before that fpr RS3.2) \\
\\
\- a discussion is started for new value - this is valid both for newly proposed value on an old value or newly proposed value without existing old value (like new auction, new collection)  - starting new discussion or commenting on existing discussion is mandatory when new value is proposed. In both cases the discussion indicator for the new value increases (or gets coloured in red for RS3.2) \\ |

...

| 06.DANNOTATION.R10 \\ | 06.DAUC07.R2-1 | | * When coloured in red the linked records indicator shows that there are one or more links to APs, related to the current one. If the indicator is coloured grey this means that there are no related records. |

| | 06.DAUC07.R2-2 \\ | | * When the linked records indicator next to AP is selected then the user is navigated to the Linked Records tab. In the Linked Records tab the list with available links will be restricted only to those on the current AP and all its versions. |
| | 06.DAUC07.R2-3 \\ | | * If the user selects the linked records indicator next to the root AP, or opens directly Linked Records tab for an object record then are listed all linked records to all APs and their versions for the current object record. |
| | 06.DAUC07.R2-4 \\ | | * If a link to record is selected then the respective object record is opened and the user positioned to the selected AP (see UC 06.DAUC01: View Object Records). |

| \\ | 06.DAUC07.R3-1 | | * Outgoing Links: Links to APs which are embedded in discussions started for the current AP. |
| \\ | 06.DAUC07.R3-2 | | * Incoming Links: Links to APs, for which are started discussions and there is link to the current AP, embedded in these discussions |

...

*Post-Conditions*

| 06.DANNOTATION.R10 | | 06.DAUC07.R8 | All items linked to the current object item are counted and listed under linked records indicator. |

h4. 06.DAUC08: View Thumbnails

...

*Description:*

| 06.DANNOTATION.R17-1 \\

\\ | | 06.DAUC08.R2 | RS3.2 \\ | In Relations tab are displayed thumbnails to all images, documents linked to the object record \\ |

| 06.DANNOTATION.R17-2 | 06.DAUC08.R3 | RS3.2 \\ | Thumbnails will provide basic information for an image/document - file size, type, file name and the type of the relation between the image/document and the object record . |

| 06.DANNOTATION.R17-1 \\ | 06.DAUC08.R5 | | Thumbnails to all content associated with an object record are displayed in the Relations tab \\ |

h4. 06.DAUC09: Promote Discussion

...

*Constraints:*

*Transitions:*

...

*Post-Conditions*

h3. Activity Diagrams

h3. UI and Navigation

h4. Data Annotation Mock-ups

h5. Discussion tab

!UI23 - Discussions tab.png|border=1!

h5. Version tab

!UI24 - Versions tab.png|border=1!

h5. Linked Records tab

!UI25 - Linked Records tab.png|border=1!

h4. Data Annotation Navigation

!Navigation - Data Annotation.png|border=1!

h3. -Activity Diagrams- \- Not for RS3.2

The Activity diagram below gives a detailed explanation of how counters for discussion indicators and linked object indicators on an object item are updated, and also which discussions are displayed in the Discussion area for an object record.

...