Data Annotation Spec

{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. \\
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. |
| Data Layer \\ | Data layer includes factual statements |
| Annotation Layer \\ | Annotation layer includes attribute assignments, comments, who made them etc; |

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


h4. AP Versions

* Data entry against an AP will create a new version.
* 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


h3. Use Cases

The UCs for Data Annotation, Input Editing and Version Comparison are used by the researchers to review data objects and discussions, annotate data objects (or start discussions), create new versions on an objects items.


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

Diagram 06.2 Use Case Diagram

h4. 06.DAUC01: View Object Record

*Constraints:*
| \\ | 06.DAUC01.R3 | RS3.2 \\ | In RS3 only object records from object type: Painting (P2_has_type rkd-object:painting) will be displayed for review and annotation.   |
* Do Note:* {color:#ff6600}Don't quite understand the constraint - 'Painting'{color}

*Transitions:* No

*Initiating operation/ button:* Link (URI) to Annotation point


*GUI:*
* Object Record Details tab

h4. 06.DAUC02: View/ Sort Versions of AP

*Constraints:*
| \\ | 06.DAUC02.R3 | RS3 \\ | Versions of APs with status “Deleted” from the current project are visible only for the RS and Project Administrators. |
* *

*Transitions:* No

*Initiating operation/ button:* Version Indicator, Version tab


*GUI:*
* Object Record Details tab/ Version Indicator

* Link (URI) to Annotation Point
* Value -- shows the original/new value
* -Research Project- \-the project name, during which the value has been created/changed (not for RS3.2 Iteration)
* Researcher Name - the name of the researcher who created the version
* Date: Time -- the date on which the value version has been updated/changed
* -Status- \-  The status of the version (not for RS3.2 Iteration)
* Discussion Indicator -- discussion indicator here will show that there are/ are not discussions started for this field version, similarly to the discussion indicator, described in DAUC01. If the indicator is selected then will be shown all discussions started for the created field version. The list will be a subset of all existing discussions. The user could start a new discussion for that field version.
* Linked Records Indicator - linked records indicator here will show of there are linked records to each one of the versions. When selected will be opened Linked Records tab. |
| | 06.DAUC02.R7 \\ | RS3.2 | If a version indicator for AP is selected and there are no versions existing then on “Versions” tab is displayed only the original value. |
| | 06.DAUC02.R8 \\ | RS3.2 | If the the version indicator for the object record (the root) is selected, or the Version tab is opened independently when browsing details for an object record - then on Versions tab are listed all existing versions of all APs of the object (if there are no other versions, then only the original versions are displayed). \\ |
| \\ | 06.DAUC02.R9 | RS3.2 \\ | The versions in the Version tab are sorted by default - alphabetically by Link (URI) to Annotation Point and then ascending by version creation date. There is no version number supported. |

| \\ | 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.

\-          Date -- the date and time (in format yyyy-mm-ddThh:mm:ss) when the version is created \\ |
*Post-Conditions*
| 06.DANNOTATION.R9 | 06.DAUC04.R8 | RS3.2 \\ | A new value is created and is visualized on Versions tab. |
* *

h4. 06.DAUC05: Delete Value

| \\ | 06.DAUC05.R3 | RS3 \\ | Values could be deleted only from the researcher who created the version or the RS Project Admin. |
* *

*Transitions:*

\-          Possible >Deleted

\-          Under Research >Deleted

\-          Proposed >Deleted

*Initiating operation/ button:* Delete

*GUI:* tab Versions

*Description:*
| | 06.DAUC05.R4 \\ | RS3.2 \\ | There are 2 scenarios that could happen when the user selects Delete button next to a value: \\ |

| \\ | 06.DAUC05.R5-3 | | * -The version indicator decreases with 1- |
| | 06.DAUC05.R6 \\ | RS3 \\ | When a value is proposed for deletion: \\ |
| | 06.DAUC05.R6-1 \\ | | * The value status changes to "Proposed Deletion" |
| | 06.DAUC05.R6-2 \\ | | * The user must post a comment giving reasons why he proposes the deletion |
*Post-Conditions*
| 06.DANNOTATION.R15-6 | 06.DAUC05.R7 | RS3 \\ | Deleted value is no more visible in Versions tab for normal users but only for the RS Project Admin. |
* *

h4. 06.DAUC06: View and Create Discussions on AP

*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.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]\\ |
*Post-Conditions*
| \\ | 06.DAUC06.R8 | RS3.2 | All discussions linked to an object record are accessible from the Object Record Details screen. |
| \\ | 06.DAUC06.R9 | RS3.2 \\ | A new post/ discussion for AP could be started from the Discussions tab. |
\\



h4. 06.DAUC07: View Linked Records

*Preconditions:*
| 06.DANNOTATION.R6 | 06.DAUC07.R1 | RS3.2 \\ | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
*Constraints:*

*Transitions:*

*Initiating operation/ button:* Linked Records Indicator

*GUI: &nbsp;*

\-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Object Record Details/ Linked Records tab

| \\ | 06.DAUC07.R4 | RS3.2 \\ | For each link in the Linked Records tab are displayed the following values (both for incoming and outgoing links): \\
* Link to the record - when clicked on the link the respective object record is opened and the user is positioned to respective AP
* Discussion Indicator - when selected the discussion indicator the discussion tab opens. In this case in the discussion tab are 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). |
| | 06.DAUC07.R5 \\ | RS3.2 \\ | If a link to record is embedded in more than one discussions (or posts) then it is displayed only once in the Linked Records tab, and in the Discussions tab could be viewed all discussions. \\ |
| | 06.DAUC07.R6 \\ | RS3.2 \\ | The links in the Linked Records tab are sorted alphabetically. \\ |
| | 06.DAUC07.R7 \\ | \\ | TBD: Do we list here also the links to documents, images, external links - embedded into discussion started for the current AP? \\ |
\\

*Preconditions:*
| \\ | 06.DAUC08.R1 | RS3.2 | UC “06.DAUC01” has been performed, and an object record is successfully displayed |
*&nbsp;*

*Constraints:*

*Transitions:*

*Initiating operation/ button:* Add New Relation

*GUI: &nbsp;*

\-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Object Record Details/ Relations tab

*Preconditions:*
| | 06.DAUC09.R1 | RS3.2 | There is existing discussion in the discussion tab |
*&nbsp;*

*Constraints:*
| | 06.DAUC09.R2 | RS3 | Only the RS Project Admin could promote discussions \\ |

*Transitions:*

*Initiating operation/ button:* Promote Discussion


*GUI: &nbsp;*

\-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Discussions tab/ Promote Discussion

*Description:*
| \\
\\ | 06.DAUC09.R3 | RS3.2 \\ | In Discussions tab the user could select a discussion and promote it as general discussion. Promoted discussion becomes visible as general discussion. \\ |
\\

*Post-Conditions*

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.


!Count Discussions.png|border=1!


Diagram 06.3 Count Discussions Diagram