Annotation Spec

Version 10 by Maria Todorova
on Dec 27, 2011 12:01.

<< Changes from 9 to 10

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 (167)

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

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

* *

*Constraints:*

| \\ | 06.DAUC01.R3 | RS3.32 \\ | 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}

...

*Description:*

| 06.DANNOTATION.R6 | 06.DAUC01.R4 | | When the user selects a link to AP, then Object Record Details screen opens. In the screen are displayed all data already available for the data object. |
| -06.DANNOTATION.R6- | -06.DAUC01.R5- | | -The Object Record Details screen is split into the following areas Object Record, Main Sections Outline, Discussions, Thumbnails- |

| | 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.R65-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.DANNOTATION.R15-5- | -06.DAUC01.R7- | - - | *{-}Main Sections Outline{-}* *{-}area{-}{*}-:  Data in a record are grouped into sections. Each main section will correspond to several high level nodes, which must be neighbours. An outline of object’s main sections will be displayed on the left side of the screen and the user will be able to select only a section he is interested in.- \\
-Examples of section outlines are: Basics, Parts, Exhibitions, Auctions, Collections, etc.- |
| -06.DANNOTATION.R15-1- | -06.DAUC01.R7-1- | - - | * -If a section outline is selected then in Object Record area all nodes will be collapsed and only the information for the selected section will be expanded. The user will be positioned on the first node from the section.- |
| \\ | -06.DAUC01.R7-2- | - - | * -At this stage only sections outline list will be prepared for paintings. Different lists with sections for other cultural heritages \--  coins, bones, sculptures, etc. will be developed on a later stage.- |
| -06.DANNOTATION.R13- | -06.DAUC01.R8- | - - | *{-}Discussions area:-* -In this area the user will be able to view all discussions on an object items and will be able to sort and filter discussions (For more details see 06.DAUC06: View and Create Discussions and 06.DAUC07: Sort and Filter Discussions)- |
| -06.DANNOTATION.R17- | -06.DAUC01.R9- | - - | *{-}Thumbnails{-}* -area:  (TBD: or References, because here could also be shown references to wiki pages): Thumbnails of all images linked to a data object will be displayed in this area. (For more details see 06.DAUC09: View Thumbnails)- |
| \\ | -06.DAUC01.R10- | - - | -TBD: Detailed description of GUI fields and labels to be displayed for a Painting- |
| -06.DANNOTATION.R15-5- | -06.DAUC01.R11- \\ | - - | -TBD: Detailed description of outlined sections- |
| 06.DANNOTATION.R15-1 | 06.DAUC01.R12 | | When a record is displayed for review into Object Record Details, by default for the object are displayed only field values with status “Original” or fields with status "Migrated". |
| 06.DANNOTATION.R15-1 | 06.DAUC01.R12-1 | RS3.4 \\ | * If there is no value with status “Original” or "Migrated" then will be displayed an empty value holder, thus the users will be able to propose new values. |

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

| 06.DANNOTATION.R15-1 | 06.DAUC01.R13-1 | | * *Version Indicator:* If for a value (subject, predicate option there are other versions than the original, then next to the field will be displayed a version indicator counting the number of versions for a field. (For details see 06.DAUC02: View Field Versions). The version indicator will be empty if there are no other versions. |
| 06.DANNOTATION.R1 | 06.DAUC01.R13-2 | | * *Discussion indicator:* If for an item there are discussions started, then next to it will be displayed a discussion indicator, counting the discussion and posts for that item. (For details see TBD 06.DAUC06: View and Create Discussions on Object Record). The discussion indicator will be empty if there are no discussions started. |
| 06.DANNOTATION.R10 | 06.DAUC01.R13-3 | | * *Linked Records Indicator:* This indicator counts: Items linked to discussions started for the selected one plus items for which are started discussions and the current item is linked to them. (For details see 06.DAUC08: View Linked Records) |
| \\ | 06.DAUC01.R14 | | Indicators, as per the above requirement, are shown also for empty value holders. |

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

| \\ | 06.DAUC01.R7 | RS3.2 | Object record is displayed successfully and indicators next to each AP are coloured properly. |

* *

h4. 06.DAUC02: View Field Versions

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

*Preconditions:*

* *

*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

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

*GUI:*

* Field Versions

* Object Record Details tab/ Version Indicator

*Description:*

| 06.DANNOTATION.R15-1 | 06.DAUC02.R4 | | The version indicator shows the number of versions created for a field. |
| \\ | 06.DAUC02.R4-1 | | * The value with status “Original” is not counted (TBD: Think again -- probably would be better to count it also). |
| 06.DANNOTATION.R9-1 | 06.DAUC02.R5 | | When a user selects a version indicator then a modal screen, named “Field Versions” is opened with the following information for each version: \\

| | 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. \\ |
| | 06.DAUC02.R5 | RS3.2 | When a user selects a version indicator or link to AP from annotation layer then he is transferred to tab “Versions”. |
| | | 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:
* Link (URI) to Annotation Point

* Value -- shows the new/updated original/new value

* Research Project \--the project name, during which the value has been created/changed.

* -Research Project- \-the project name, during which the value has been created/changed (not for RS3.2 Iteration)

* Researcher Name \--the - 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 the number of discussions and posts started only 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. |
| \\ | 06.DAUC02.R6 | | If there are no versions existing for a field then “Field Versions” screen is empty. |
| \\ | 06.DAUC02.R7 | | All field versions with status “Published” from other research projects and all field versions from the current project (except “Deleted”) are displayed. The version with status “Published” is also displayed with its attributes, though not counted (TBD: Is this so?). |
| \\ | 06.DAUC02.R8 | | The version records are sorted by version creation date. There is no version number supported. |

* 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. |
| | | | * 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.DANNOTATION.R15-1 | 06.DAUC02.R9 | | All existing record versions -- the original one, published from other projects and created in the current project are displayed. |

| \\ | 06.DAUC02.R101 | RS3.2 | UC “06.DAUC03: Edit Field Version” could be started. |

| \\ | 06.DAUC02.R112 | RS3.2 | UC “06.DAUC04: Create Field Version” could be started. |

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

* *

h4. 06.DAUC03: Edit Field Versions Existing Version

*Preconditions:*

* *

*Constraints:*

| \\ | 06.DAUC03.R32 | RS3 | Version records could be edited only from the researcher who created the version and or from the RS Project Admin. |

* *

...

*Initiating operation/ button:* Edit

*GUI:* Screen “Field Versions”

*GUI:* Versions tab

*Description:*

| \\ | 06.DAUC03.R4-1 | 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.R4-2 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: Create Field Versions

h4. 06.DAUC04: Propose New Value

*Preconditions:*

| 06.DANNOTATION.R15-2 | 06.DAUC04.R1 | | UC “06.DAUC02: View Field Version” has been performed and screen “Field Versions” is opened. |

* 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 >Proposed

*Initiating operation/ button:* Create New Version

*Initiating operation/ button:* Propose New Value

*GUI*: Screen “Field Versions

*GUI*: Versions tab

*Description:*

| 06.DANNOTATION.R15-2 \\
06.DANNOTATION.R2-1 \\
06.DANNOTATION.R2-2 \\
\\ | 06.DAUC04.R3 | | When the user selects “Create new version” then an entry form is opened with the following mandatory fields: \\
\-          New value -- for the different entries see the requirement below. \\
\-          Version Status - the version status is selected from a codelist. The user could select only between “Possible”, “Under Research” and “Proposed” statuses |

| | 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.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.R4 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: |

| \\ | 06.DAUC04.R4-1 | | * If the field requires the use of thesauri value, then the data entry form will provide a thesauri control for the new value. (TBD: Auto-complete will be incorporated. Is it correct?). A value will not be saved if not found in the thesaurus. |
| \\ | 06.DAUC04.R4-2 | | * If the field requires literal value, then the entry will only be validated for the correct format. (TBD: Will we validate for formats: Date, String, Integer, etc.) |
| 06.DANNOTATION.R9-2 | 06.DAUC04.R5 | | When both the new value and the version status are entered and validated then action “Post in discussion” becomes active and the user could start a new discussion post on an existing discussion for this item or its version records, or could post to create a new discussion. See 06.DAUC06: View and Create Discussion on Object Record. |
| \\ | 06.DAUC04.R6 | | Only after the user contributes in a discussion then the new field version could be saved. |

** 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.R67-1 | | * If the user does not save the new field version value and cancels the entry then the created discussion/ post is automatically deleted. |

| \\ | 06.DAUC04.R6-2 | | * If the user saves successfully the new field version then a new version record is created, the discussion/post is linked to the version record, the version indicator is increased with 1 and the discussion indicator is also increased. |

| | 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.R78 | RS3.2 | When the version record is saved the following additional metadata are created: associated: \\

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

\-          Date -- the date and time (in format yyyy-mm-ddThh:mm:ss) when the version is created \\ |

TBD: or probably we have to collect the following information taken from W3C standard annotation class.
* *annotates* \- \[http://www.w3.org/2000/10/annotation-ns#annotates\] - Relates an Annotation to the resource to which the Annotation applies. The inverse relation is 'has Annotation'. Defined by    \[http://www.w3.org/2000/10/annotation-ns#\]
* *author* \- \[http://www.w3.org/2000/10/annotation-ns#author\]\- The name of the person/s or organization most responsible for creating the Annotation. Sub property of \[http://purl.org/dc/elements/1.1/creator\] - Defined by -- \[http://www.w3.org/2000/10/annotation-ns#\]
* *body* \- \[http://www.w3.org/2000/10/annotation-ns#body\] - Relates the resource representing the 'content' of an Annotation to the Annotation resource. Sub property of related - \[http://www.w3.org/2000/10/annotation-ns#related\] - Defined by \[http://www.w3.org/2000/10/annotation-ns#\]
* *context -* \[http://www.w3.org/2000/10/annotation-ns#context\] - The context within the resource named in 'annotates' to which the Annotation most directly applies. Defined by \[http://www.w3.org/2000/10/annotation-ns#\]
* *created* \- \[http://www.w3.org/2000/10/annotation-ns#created\] - The date and time on which the Annotation was created. yyyy-mm-ddThh:mm:ssZ format recommended. Sub property of     \[http://purl.org/dc/elements/1.1/date\]. Defined by \[http://www.w3.org/2000/10/annotation-ns#\]
* *modified* \- \[http://www.w3.org/2000/10/annotation-ns#modified\] - The date and time on which the Annotation was modified. yyyy-mm-ddThh:mm:ssZ format recommended. Sub property of \[http://purl.org/dc/elements/1.1/date\]. Defined by \[http://www.w3.org/2000/10/annotation-ns#\]
* *related* \- \[http://www.w3.org/2000/10/annotation-ns#related\] - A relationship between an annotation and additional resources that is less specific than 'body'. The 'related' property is expected to be subclassed by more specific relationships. Defined by \[http://www.w3.org/2000/10/annotation-ns#\].: \\ |

*Post-Conditions*

* *

h4. 06.DAUC05: Delete Field Versions Value

*Preconditions:*

| 06.DANNOTATION.R15-2 | 06.DAUC05.R1 | | UC “06.DAUC02: View Field Version” has been performed and screen “Field Versions” is opened. |

| \\ | 06.DAUC05.R1 | RS3.2 \\ | UC “06.DAUC02: View Versions of AP” has been performed and tab Versions is opened. |
* Constraints:*
| \\ | 06.DAUC05.R2 | RS3 \\ | Values could be deleted only if in status “Possible”, “Under Research” and “Proposed”. |
| \\ | 06.DAUC05.R3 | RS3 \\ | Values could be deleted only from the researcher who created the version or the RS Project Admin. |

* *

*Transitions:*

...

*Initiating operation/ button:* Delete

*GUI:* Screen “Field Versions

*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.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 | RS3 \\ | When a value is deleted: |
| \\ | 06.DAUC05.R5-1 | | * The value status changes to “Deleted” |
| \\ | 06.DAUC05.R5-2 | \\ | * The discussion associated with the version is deleted |
| \\ | 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*

* *

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

*Preconditions:*

*Constraints:*

| \\ | 06.DAUC06.R2 | | The user could view all discussions on an object or object item started in the current project and all discussions on the same object with status “Published” and “Original” from other projects |
| \\ | 06.DAUC06.R3 | | A discussion could not be started on a blank node (TBD: Is this so? That is what we have decided). |
| \\ | 06.DAUC06.R4 | | TBD: Will there be restrictions of discussions per users and groups at this stage ? In this UC such requirements are missing. |
*Transitions:*

New > Created

*Transitions:*1*

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

*GUI:  *

\-          Object Record Details/ Discussion area

* 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

\-          Object Record area/ Discussion indicator

\-          Object Record area/ Version indicator/ Version Screen/ Discussion indicator

*Description:*

| 06.DANNOTATION.R1 | 06.DAUC06.R5 | | One or more discussions  could be started on any item of an object record |
| 06.DANNOTATION.R1 | 06.DAUC06.R6 | | One or more discussions could be started on each version record of a field value. |
| 06.DANNOTATION.R13 | 06.DAUC06.R7 | | The Discussion area will be split on 2 parts: Item Discussions and Related discussions: |
| 06.DANNOTATION.R13 | 06.DAUC06.R8 | | In the Discussion area/ Items Discussions the user will be able to view links to all discussions on an object: (TBD: Probably discussion area could be just a special view in the Discussion module, restricted only to discussions per this object, instead of developing special screen where to show and sort/filter discussions). For more details see diagram 06.3: Count Discussions. |
| \\ | 06.DAUC06.R9 | | For each discussion in the Discussion area/ Items Discussions will be displayed |
| \\ | 06.DAUC06.R9-1 | | * Link to the discussion - If the link to discussion is selected then the discussion is opened with all its posts. |
| \\ | 06.DAUC06.R9-2 | | * Item link (URI) for which the discussion is started -- If the link is selected then the user is positioned to selected node on the Object Record area |
| \\ | 06.DAUC06.R9-3 | | * Researcher -- the name of the user who has started the discussion, |
| \\ | 06.DAUC06.R9-4 | | * Project -- the project name, to which the user who started the discussion is part of. |
| \\ | 06.DAUC06.R9-5 | | * Date: Time -- the date and time of the last post in the discussion |
| \\ | 06.DAUC06.R9-6 | | * Status of the discussion |
| \\ | 06.DAUC06.R9-7 | | * Number posts per each discussion. |
| 06.DANNOTATION.R13 | 06.DAUC06.R10 | | In the Discussion area/ Related discussions the user will be able to view \\
* Links to general discussions in which there is a link to an item from the current data object and * Links to other items discussions -- these are links to discussions started for other object records in which there is a link to an item from the current object. \\
For more details see diagram 06.3. Count Discussions. |
| \\ | 06.DAUC06.R11 | | For each discussion in the Discussion area/ Related discussions will be displayed: |
| \\ | 06.DAUC06.R11-1 | | * Link to the discussion - If the link to discussion is selected then the discussion is opened with all its posts. |
| \\ | 06.DAUC06.R11-2 | | * Link to the post, in which is mention the current record item -- when selected the discussion will be opened and the user will be positioned to post. If there are more than one posts in a discussions with links to current object items, then they will be listed as different records in the area. |
| \\ | 06.DAUC06.R11-3 | | * Researcher -- the name of the user who made the post |
| \\ | 06.DAUC06.R11-4 | | * Project -- the project name, to which the user who posted in the discussion is part of. |
| \\ | 06.DAUC06.R11-5 | | * Date: Time -- the date and time on which the post is made |
| \\ | 06.DAUC06.R11-6 | | * Status of the post |
| \\ | 06.DAUC06.R12 | | The discussions will be displayed in a table view. (TBD: Probably not in a table, but just the parameters will listed next to the discussion name. In this case will not be able to sort by column). |
| 06.DANNOTATION.R14 | 06.DAUC06.R13 | | By default discussions in Discussion area are sorted by Date: Time of last post, thus the recent discussions are on the top. (TBD: It is also possible to be sorted by Date: Time of starting the discussion). |
| \\ | 06.DAUC06.R14 | | Next to each item is displayed a discussion indicator, showing the number of discussions and the total number of posts for this item. If the indicator is next to a field and there are versions existing for it, it displays also the total number of discussions for all its versions. |
| \\ | 06.DAUC06.R15 | | When discussion indicator next to an item is selected then the user will be navigated to the Discussions component. In the Discussions component the list with available discussions will be restricted only to those on the current item 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 \\ | 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 \\ | 06.DAUC06.R15-1 | | * When If a new discussion is started in this case it will be linked to “Original” version of the record |

| \\ | 06.DAUC06.R15-2 | | * Discussions on a record (discussions on the record as whole) could be started on the main node of the record by selecting the discussion indicator, similarly to starting discussions on any other existing node. |
| \\ | 06.DAUC06.R15-3 | | * The new discussion/ post will be created with status “Created” (TBD: What are the reasonable statuses for a discussion -- should we keep different statuses for posts and whole discussions) |

| | 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 \\ | 06.DAUC06.R16 | | * When a discussion indicator next to version record is selected then user will be navigated to the discussion component, 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.R17 | | When a new discussion/post is started from the discussion indicator in the “Field Versions” screen (see DAUC02: View Field Versions): |

| | 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.R17-1 06.DAUC06.R5-1 | | * The discussion/post name is created automatically, based on the following template; “New value <VALUE> for field <FIELD NAME>”. The user is allowed to change the discussion/post name. |

| \\ | 06.DAUC06.R18 | | If there are no discussions started on any of the object items then the Discussion area is empty. |
| \\ | 06.DAUC06.R19 | | If there are no discussions started on an item then the Discussion indicator counter shows 0 (TBD: or is colored grey, etc). |
| 06.DANNOTATION.R11 | 06.DAUC06.R20 | | For each discussion and post will be kept the following information taken from W3C standard annotation class.
* *annotates* \- \[http://www.w3.org/2000/10/annotation-ns#annotates\] - Relates an Annotation to the resource to which the Annotation applies. The inverse relation is 'has Annotation'. Defined by    \[http://www.w3.org/2000/10/annotation-ns#\]
* *author* \- \[http://www.w3.org/2000/10/annotation-ns#author\]\- The name of the person/s or organization most responsible for creating the Annotation. Sub property of \[http://purl.org/dc/elements/1.1/creator\] - Defined by -- \[http://www.w3.org/2000/10/annotation-ns#\]
* *body* \- \[http://www.w3.org/2000/10/annotation-ns#body\] - Relates the resource representing the 'content' of an Annotation to the Annotation resource. Sub property of related - \[http://www.w3.org/2000/10/annotation-ns#related\] - Defined by \[http://www.w3.org/2000/10/annotation-ns#\]
* *context -* \[http://www.w3.org/2000/10/annotation-ns#context\] - The context within the resource named in 'annotates' to which the Annotation most directly applies. Defined by \[http://www.w3.org/2000/10/annotation-ns#\]
* *created* \- \[http://www.w3.org/2000/10/annotation-ns#created\] - The date and time on which the Annotation was created. yyyy-mm-ddThh:mm:ssZ format recommended. Sub property of     \[http://purl.org/dc/elements/1.1/date\]. Defined by \[http://www.w3.org/2000/10/annotation-ns#\]
* *modified* \- \[http://www.w3.org/2000/10/annotation-ns#modified\] - The date and time on which the Annotation was modified. yyyy-mm-ddThh:mm:ssZ format recommended. Sub property of \[http://purl.org/dc/elements/1.1/date\]. Defined by \[http://www.w3.org/2000/10/annotation-ns#\]-          *related* \- \[http://www.w3.org/2000/10/annotation-ns#related\] - A relationship between an annotation and additional resources that is less specific than 'body'. The 'related' property is expected to be subclassed by more specific relationships. Defined by \[http://www.w3.org/2000/10/annotation-ns#\]. |

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

*Post-Conditions*

| \\ | 06.DAUC06.R21 06.DAUC06.R8 | RS3.2 | All discussions linked to an object record are accessible from the Object Record Details screen. |

| \\ | 06.DAUC06.R22 | | A new post/ discussion for a node/ record could be started easily from the Object Record Details screen. |
| | 06.DAUC06.R23 \\ | | The RS Project Admin is notified for the new discussion started. (TBD: Probably for RS4) \\ |

| \\ | 06.DAUC06.R9 | RS3.2 \\ | A new post/ discussion for AP could be started from the Discussions tab. |

h4. 06.DAUC07: Sort and Filter Discussions on Object Record

h4. 06.DAUC07: View Linked Records

*Preconditions:*

| 06.DANNOTATION.R1 | 06.DAUC07.R2 | | UC “06.DAUC06: View and Create Discussions” has been performed successfully and there are existing discussions in the Discussions area. |

*Constraints:*

*Transitions:*

*Initiating operation/ button:* Search Discussion

*Initiating operation/ button:* Linked Records Indicator

*GUI:  *

\-          Object Record Details/ Discussion area Linked Records tab

*Description:*

| 06.DANNOTATION.R12 | 06.DAUC07.R3 | | The discussion records in the Discussion area could be filtered by the following criteria: |
| 06.DANNOTATION.R12-2 | 06.DAUC07.R3-1 | | * Project - the field will have 2 values “Current Project” and “All Projects” (TBD: if other values, and all RS project list will be supported). If Current Project value is selected will be displayed only discussions created in this project, or discussions created in other projects but commented from users from the current project. The value set by default is “All Projects” |
| 06.DANNOTATION.R12-1 | 06.DAUC07.R3-2 | | * Researcher -- the field will support a list of all current RS Project users and based on the selected user will be listed all discussions started from the user and/or discussions posted by the user. |
| \\ | 06.DAUC07.R3-3 | | * Date From -- Based on the calendar date entered, will be listed all discussions created in or after that date and discussions with comments in or after that date. |
| \\ | 06.DAUC07.R3-4 | | * Date To - Based on the calendar date entered, will be listed all discussions created before or in that date and discussions with comments before or in that date. |
| \\ | 06.DAUC07.R3-5 | | * Status -- The user will be able to select a status from code-list. Will be listed only the discussions and posts with the selected status. (TBD: This is not true because still don’t know if statuses will be on discussions or in discussion threads, better to remove this requirement). |
| 06.DANNOTATION.R12-1 | 06.DAUC07.R3-6 | | * Field - Filter by item on which is started the discussion |
| | 06.DAUC07.R3-7 | | * Free Text Search - the user will be able to filter discussion based on free text search on them (search will be performed on discussion name plus all posts). |
| \\ | 06.DAUC07.R4 | | Both Item and Related Discussions are filtered with the same filter criteria, but the result is shown separated.   |
| 06.DANNOTATION.R14 \\
06.DANNOTATION.R14-1 | 06.DAUC07.R5 | | The discussion list in the discussion area could be sorted in ascending/ descending order by different criteria by clicking the respective column. (TBD: Only if discussions are kept in a table). |
*Post-Conditions*
| 06.DANNOTATION.R12 \\
06.DANNOTATION.R14 | 06.DAUC07.R6 | | The discussions are sorted/ filtered based on the selected criteria. |

| | 06.DAUC07.R2 \\ | RS3.2 \\ | Next to each AP on the Object Record details tab is displayed a Linked Records indicator (R). |
| \\ | 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 | RS3.2 \\ | The Linked Records tab is split in to 2 sections \\ |
| \\ | 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 |
| \\ | 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? \\ |

h4. 06.DAUC08: View Linked Records

h4. 06.DAUC08: View Thumbnails

*Preconditions:*

* *

*Constraints:*

*Transitions:*

*Initiating operation/ button:* Linked Records Indicator Add New Relation

*GUI:  *

\-          Object Record/ Linked Records

\-          Object Record Details/ Relations tab

*Description:*

| 06.DANNOTATION.R10 | 06.DAUC07.R2 | | The linked records indicator is  available for any object item. |
| 06.DANNOTATION.R10 | 06.DAUC07.R3 | | This indicator counts (For detailed description see Diagram 06.3: Count Discussions diagram): |
| \\ | 06.DAUC07.R3-1 | | * Items from the current object record or items from other object records which participate in discussions started for the current item. |
| \\ | 06.DAUC07.R3-2 | | * Items from the current object record or items form object records, for which are started discussions and the current item is participating in this discussions |
| \\ | 06.DAUC07.R4 \\ | | If an item is already counted as a linked record and is met more than once in different or the same discussions, it is not counted again. |
| \\ | 06.DAUC07.R5 | | If there are no linked records to an item, then the counter in the indicator shows 0.  (TBD: or is colored grey, etc.) |
| \\ | 06.DAUC07.R6 | | When the user selects the linked records indicator, next to an item, then a modal screen Linked Records. If a link is selected then the respective object record is opened and the user positioned to the selected item (see UC 06.DAUC01: View Object Records). |

| | 06.DAUC08.R2 | RS3.2 \\ | In Relations tab are displayed thumbnails to all images, documents linked to the object record \\ |
| | 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.DAUC08.R4 | RS3 \\ | Thumbnails to images will be used as links to Image Annotation tool |
| | 06.DAUC08.R5 \\ | RS3.2 \\ | The user could add new relations by selecting "Add New Relation" button from the Relations tab. \\ |

\\

*Post-Conditions*

h4. 06.DAUC09: View Thumbnails

h4. 06.DAUC09: Promote Discussion

*Preconditions:*

* *

*Constraints:*

*Transitions:*

*Initiating operation/ button:* Promote Discussion

*GUI:  *

\-          Object Record/ Images Thumbnails

\-          Discussions tab/ Promote Discussion

*Description:*

| 06.DANNOTATION.R17-1 \\

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

...